diff --git a/Gopkg.lock b/Gopkg.lock
index 73593a6de..4b8344a65 100644
--- a/Gopkg.lock
+++ b/Gopkg.lock
@@ -215,7 +215,7 @@
branch = "master"
name = "google.golang.org/api"
packages = ["gensupport","googleapi","googleapi/internal/uritemplates","storage/v1"]
- revision = "65b0d8655182691ad23b4fac11e6f7b897d9b634"
+ revision = "dbbc13f71100fa6ece308335445fca6bb0dd5c2f"
[[projects]]
name = "google.golang.org/appengine"
diff --git a/vendor/google.golang.org/api/abusiveexperiencereport/v1/abusiveexperiencereport-api.json b/vendor/google.golang.org/api/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
index 3dee47f8e..1a857a34f 100644
--- a/vendor/google.golang.org/api/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
+++ b/vendor/google.golang.org/api/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
@@ -1,242 +1,4 @@
{
- "ownerDomain": "google.com",
- "name": "abusiveexperiencereport",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Abusive Experience Report API",
- "ownerName": "Google",
- "resources": {
- "sites": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "SiteSummaryResponse"
- },
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^sites/[^/]+$",
- "location": "path",
- "description": "The required site name. This is the site property whose abusive\nexperiences have been reviewed, and it must be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field\nreturned by the API will lead to the verification page, prompting the user\nto go through that process before they can gain access to the Abusive\nExperience Report."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
- "flatPath": "v1/sites/{sitesId}",
- "id": "abusiveexperiencereport.sites.get",
- "path": "v1/{+name}",
- "description": "Gets a summary of the abusive experience rating of a site."
- }
- }
- },
- "violatingSites": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ViolatingSitesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
- "parameters": {},
- "flatPath": "v1/violatingSites",
- "path": "v1/violatingSites",
- "id": "abusiveexperiencereport.violatingSites.list",
- "description": "Lists sites with Abusive Experience Report statuses of \"Failing\"."
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://abusiveexperiencereport.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.",
- "servicePath": "",
- "basePath": "",
- "revision": "20171129",
- "documentationLink": "https://developers.google.com/abusive-experience-report/",
- "id": "abusiveexperiencereport:v1",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "ViolatingSitesResponse": {
- "properties": {
- "violatingSites": {
- "description": "A list of summaries of violating sites.",
- "type": "array",
- "items": {
- "$ref": "SiteSummaryResponse"
- }
- }
- },
- "id": "ViolatingSitesResponse",
- "description": "Response message for ListViolatingSites.",
- "type": "object"
- },
- "SiteSummaryResponse": {
- "type": "object",
- "properties": {
- "abusiveStatus": {
- "enumDescriptions": [
- "Not reviewed.",
- "Passing.",
- "Failing."
- ],
- "enum": [
- "UNKNOWN",
- "PASSING",
- "FAILING"
- ],
- "description": "The status of the site reviewed for the abusive experiences.",
- "type": "string"
- },
- "enforcementTime": {
- "description": "The date on which enforcement begins.",
- "format": "google-datetime",
- "type": "string"
- },
- "filterStatus": {
- "description": "The abusive experience enforcement status of the site.",
- "type": "string",
- "enumDescriptions": [
- "N/A.",
- "Ad filtering is on.",
- "Ad filtering is off.",
- "Ad filtering is paused.",
- "Ad filtering is pending."
- ],
- "enum": [
- "UNKNOWN",
- "ON",
- "OFF",
- "PAUSED",
- "PENDING"
- ]
- },
- "underReview": {
- "description": "Whether the site is currently under review.",
- "type": "boolean"
- },
- "reportUrl": {
- "description": "A link that leads to a full abusive experience report.",
- "type": "string"
- },
- "reviewedSite": {
- "type": "string",
- "description": "The name of the site reviewed."
- },
- "lastChangeTime": {
- "description": "The last time that the site changed status.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "SiteSummaryResponse",
- "description": "Response message for GetSiteSummary."
- }
- },
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "Abusive Experience Report",
"auth": {
"oauth2": {
"scopes": {
@@ -246,5 +8,243 @@
}
}
},
- "rootUrl": "https://abusiveexperiencereport.googleapis.com/"
-}
+ "basePath": "",
+ "baseUrl": "https://abusiveexperiencereport.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Abusive Experience Report",
+ "description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/abusive-experience-report/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "abusiveexperiencereport:v1",
+ "kind": "discovery#restDescription",
+ "name": "abusiveexperiencereport",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "sites": {
+ "methods": {
+ "get": {
+ "description": "Gets a summary of the abusive experience rating of a site.",
+ "flatPath": "v1/sites/{sitesId}",
+ "httpMethod": "GET",
+ "id": "abusiveexperiencereport.sites.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The required site name. This is the site property whose abusive\nexperiences have been reviewed, and it must be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field\nreturned by the API will lead to the verification page, prompting the user\nto go through that process before they can gain access to the Abusive\nExperience Report.",
+ "location": "path",
+ "pattern": "^sites/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "SiteSummaryResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ]
+ }
+ }
+ },
+ "violatingSites": {
+ "methods": {
+ "list": {
+ "description": "Lists sites with Abusive Experience Report statuses of \"Failing\".",
+ "flatPath": "v1/violatingSites",
+ "httpMethod": "GET",
+ "id": "abusiveexperiencereport.violatingSites.list",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/violatingSites",
+ "response": {
+ "$ref": "ViolatingSitesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180129",
+ "rootUrl": "https://abusiveexperiencereport.googleapis.com/",
+ "schemas": {
+ "SiteSummaryResponse": {
+ "description": "Response message for GetSiteSummary.",
+ "id": "SiteSummaryResponse",
+ "properties": {
+ "abusiveStatus": {
+ "description": "The status of the site reviewed for the abusive experiences.",
+ "enum": [
+ "UNKNOWN",
+ "PASSING",
+ "FAILING"
+ ],
+ "enumDescriptions": [
+ "Not reviewed.",
+ "Passing.",
+ "Failing."
+ ],
+ "type": "string"
+ },
+ "enforcementTime": {
+ "description": "The date on which enforcement begins.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "filterStatus": {
+ "description": "The abusive experience enforcement status of the site.",
+ "enum": [
+ "UNKNOWN",
+ "ON",
+ "OFF",
+ "PAUSED",
+ "PENDING"
+ ],
+ "enumDescriptions": [
+ "N/A.",
+ "Ad filtering is on.",
+ "Ad filtering is off.",
+ "Ad filtering is paused.",
+ "Ad filtering is pending."
+ ],
+ "type": "string"
+ },
+ "lastChangeTime": {
+ "description": "The last time that the site changed status.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "reportUrl": {
+ "description": "A link that leads to a full abusive experience report.",
+ "type": "string"
+ },
+ "reviewedSite": {
+ "description": "The name of the site reviewed.",
+ "type": "string"
+ },
+ "underReview": {
+ "description": "Whether the site is currently under review.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ViolatingSitesResponse": {
+ "description": "Response message for ListViolatingSites.",
+ "id": "ViolatingSitesResponse",
+ "properties": {
+ "violatingSites": {
+ "description": "A list of summaries of violating sites.",
+ "items": {
+ "$ref": "SiteSummaryResponse"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Google Abusive Experience Report API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json b/vendor/google.golang.org/api/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
index 465279810..b0b23f040 100644
--- a/vendor/google.golang.org/api/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
+++ b/vendor/google.golang.org/api/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
@@ -1,169 +1,157 @@
{
- "ownerName": "Google",
+ "basePath": "",
+ "baseUrl": "https://acceleratedmobilepageurl.googleapis.com/",
+ "batchPath": "batch",
+ "description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
"discoveryVersion": "v1",
- "version_module": true,
- "resources": {
- "ampUrls": {
- "methods": {
- "batchGet": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "BatchGetAmpUrlsResponse"
- },
- "parameters": {},
- "flatPath": "v1/ampUrls:batchGet",
- "id": "acceleratedmobilepageurl.ampUrls.batchGet",
- "path": "v1/ampUrls:batchGet",
- "request": {
- "$ref": "BatchGetAmpUrlsRequest"
- },
- "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format)."
- }
- }
- }
+ "documentationLink": "https://developers.google.com/amp/cache/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "id": "acceleratedmobilepageurl:v1",
+ "kind": "discovery#restDescription",
+ "name": "acceleratedmobilepageurl",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
"parameters": {
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
"$.xgafv": {
- "location": "query",
+ "description": "V1 error format.",
"enum": [
"1",
"2"
],
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ]
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
},
"alt": {
- "type": "string",
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "key": {
- "location": "query",
- "description": "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.",
"type": "string"
},
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
"type": "string"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
"type": "string"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
"location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
+ "type": "string"
}
},
- "schemas": {
- "BatchGetAmpUrlsResponse": {
- "type": "object",
- "properties": {
- "ampUrls": {
- "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.",
- "type": "array",
- "items": {
- "$ref": "AmpUrl"
- }
- },
- "urlErrors": {
- "type": "array",
- "items": {
- "$ref": "AmpUrlError"
+ "protocol": "rest",
+ "resources": {
+ "ampUrls": {
+ "methods": {
+ "batchGet": {
+ "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
+ "flatPath": "v1/ampUrls:batchGet",
+ "httpMethod": "POST",
+ "id": "acceleratedmobilepageurl.ampUrls.batchGet",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/ampUrls:batchGet",
+ "request": {
+ "$ref": "BatchGetAmpUrlsRequest"
},
- "description": "The errors for requested URLs that have no AMP URL."
+ "response": {
+ "$ref": "BatchGetAmpUrlsResponse"
+ }
}
- },
- "id": "BatchGetAmpUrlsResponse",
- "description": "Batch AMP URL response."
- },
+ }
+ }
+ },
+ "revision": "20180203",
+ "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
+ "schemas": {
"AmpUrl": {
- "type": "object",
- "properties": {
- "cdnAmpUrl": {
- "type": "string",
- "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache."
- },
- "originalUrl": {
- "type": "string",
- "description": "The original non-AMP URL."
- },
- "ampUrl": {
- "type": "string",
- "description": "The AMP URL pointing to the publisher's web server."
- }
- },
+ "description": "AMP URL response for a requested URL.",
"id": "AmpUrl",
- "description": "AMP URL response for a requested URL."
- },
- "AmpUrlError": {
- "type": "object",
"properties": {
+ "ampUrl": {
+ "description": "The AMP URL pointing to the publisher's web server.",
+ "type": "string"
+ },
+ "cdnAmpUrl": {
+ "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.",
+ "type": "string"
+ },
"originalUrl": {
"description": "The original non-AMP URL.",
"type": "string"
- },
- "errorMessage": {
- "type": "string",
- "description": "An optional descriptive error message."
- },
+ }
+ },
+ "type": "object"
+ },
+ "AmpUrlError": {
+ "description": "AMP URL Error resource for a requested URL that couldn't be found.",
+ "id": "AmpUrlError",
+ "properties": {
"errorCode": {
+ "description": "The error code of an API call.",
"enum": [
"ERROR_CODE_UNSPECIFIED",
"INPUT_URL_NOT_FOUND",
@@ -172,8 +160,6 @@
"URL_IS_VALID_AMP",
"URL_IS_INVALID_AMP"
],
- "description": "The error code of an API call.",
- "type": "string",
"enumDescriptions": [
"Not specified error.",
"Indicates the requested URL is not found in the index, possibly because\nit's unable to be found, not able to be accessed by Googlebot, or some\nother error.",
@@ -181,56 +167,70 @@
"Indicates some kind of application error occurred at the server.\nClient advised to retry.",
"DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a\nnon-error state, should not be relied upon as a sign of success or\nfailure. It will be removed in future versions of the API.",
"Indicates that an AMP URL has been found that corresponds to the request\nURL, but it is not valid AMP HTML."
- ]
+ ],
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "An optional descriptive error message.",
+ "type": "string"
+ },
+ "originalUrl": {
+ "description": "The original non-AMP URL.",
+ "type": "string"
}
},
- "id": "AmpUrlError",
- "description": "AMP URL Error resource for a requested URL that couldn't be found."
+ "type": "object"
},
"BatchGetAmpUrlsRequest": {
"description": "AMP URL request for a batch of URLs.",
- "type": "object",
+ "id": "BatchGetAmpUrlsRequest",
"properties": {
- "urls": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits))."
- },
"lookupStrategy": {
+ "description": "The lookup_strategy being requested.",
"enum": [
"FETCH_LIVE_DOC",
"IN_INDEX_DOC"
],
- "description": "The lookup_strategy being requested.",
- "type": "string",
"enumDescriptions": [
"FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.",
"IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended."
- ]
+ ],
+ "type": "string"
+ },
+ "urls": {
+ "description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "BatchGetAmpUrlsRequest"
+ "type": "object"
+ },
+ "BatchGetAmpUrlsResponse": {
+ "description": "Batch AMP URL response.",
+ "id": "BatchGetAmpUrlsResponse",
+ "properties": {
+ "ampUrls": {
+ "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.",
+ "items": {
+ "$ref": "AmpUrl"
+ },
+ "type": "array"
+ },
+ "urlErrors": {
+ "description": "The errors for requested URLs that have no AMP URL.",
+ "items": {
+ "$ref": "AmpUrlError"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
}
},
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "version": "v1",
- "baseUrl": "https://acceleratedmobilepageurl.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
"servicePath": "",
- "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "acceleratedmobilepageurl",
- "batchPath": "batch",
- "id": "acceleratedmobilepageurl:v1",
- "documentationLink": "https://developers.google.com/amp/cache/",
- "revision": "20180110",
- "title": "Accelerated Mobile Pages (AMP) URL API"
-}
+ "title": "Accelerated Mobile Pages (AMP) URL API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-api.json b/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-api.json
index cb383ac18..4a0fec7c7 100644
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-api.json
+++ b/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-api.json
@@ -1,596 +1,596 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/-1DKqIhPUpLfO8DBj8P3gNrIPtE\"",
- "discoveryVersion": "v1",
- "id": "adexchangebuyer:v1.2",
- "name": "adexchangebuyer",
- "canonicalName": "Ad Exchange Buyer",
- "version": "v1.2",
- "revision": "20170810",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.2/",
- "basePath": "/adexchangebuyer/v1.2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangebuyer/v1.2/",
- "batchPath": "batch/adexchangebuyer/v1.2",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Configuration data for an Ad Exchange buyer account.",
- "properties": {
- "bidderLocation": {
- "type": "array",
- "description": "Your bidder locations that have distinct URLs.",
- "items": {
- "type": "object",
- "properties": {
- "maximumQps": {
- "type": "integer",
- "description": "The maximum queries per second the Ad Exchange will send.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
- },
- "url": {
- "type": "string",
- "description": "The URL to which the Ad Exchange will send bid requests."
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.buyer": {
+ "description": "Manage your Ad Exchange buyer account configuration"
+ }
}
- }
- },
- "cookieMatchingNid": {
- "type": "string",
- "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
- },
- "cookieMatchingUrl": {
- "type": "string",
- "description": "The base URL used in cookie match requests."
- },
- "id": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#account"
- },
- "maximumActiveCreatives": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "maximumTotalQps": {
- "type": "integer",
- "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "numberActiveCreatives": {
- "type": "integer",
- "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
- "format": "int32"
}
- }
},
- "AccountsList": {
- "id": "AccountsList",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#accountsList"
- }
- }
+ "basePath": "/adexchangebuyer/v1.2/",
+ "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.2/",
+ "batchPath": "batch/adexchangebuyer/v1.2",
+ "canonicalName": "Ad Exchange Buyer",
+ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/-1DKqIhPUpLfO8DBj8P3gNrIPtE\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
+ "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
},
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "A creative and its classification data.",
- "properties": {
- "HTMLSnippet": {
- "type": "string",
- "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set."
- },
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "advertiserId": {
- "type": "array",
- "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "advertiserName": {
- "type": "string",
- "description": "The name of the company being advertised in the creative.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "agencyId": {
- "type": "string",
- "description": "The agency id for this creative.",
- "format": "int64"
- },
- "apiUploadTimestamp": {
- "type": "string",
- "description": "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).",
- "format": "date-time"
- },
- "attribute": {
- "type": "array",
- "description": "All attributes for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "A buyer-specific id identifying the creative in this ad.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "clickThroughUrl": {
- "type": "array",
- "description": "The set of destination urls for the snippet.",
- "items": {
+ "id": "adexchangebuyer:v1.2",
+ "kind": "discovery#restDescription",
+ "name": "adexchangebuyer",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- },
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
},
- "corrections": {
- "type": "array",
- "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the correction.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The type of correction that was applied to the creative."
- }
- }
- }
- },
- "disapprovalReasons": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the reason for disapproval.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The categorized reason for disapproval."
- }
- }
- }
- },
- "filteringReasons": {
- "type": "object",
- "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
- },
- "reasons": {
- "type": "array",
- "description": "The filtering reasons.",
- "items": {
- "type": "object",
- "properties": {
- "filteringCount": {
- "type": "string",
- "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
- "format": "int64"
- },
- "filteringStatus": {
- "type": "integer",
- "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
- "format": "int32"
- }
- }
- }
- }
- }
- },
- "height": {
- "type": "integer",
- "description": "Ad height.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The set of urls to be called to record an impression.",
- "items": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
},
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creative"
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
},
- "productCategories": {
- "type": "array",
- "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "restrictedCategories": {
- "type": "array",
- "description": "All restricted categories for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
},
- "sensitiveCategories": {
- "type": "array",
- "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
},
- "status": {
- "type": "string",
- "description": "Creative serving status. Read-only. This field should not be set in requests."
- },
- "vendorType": {
- "type": "array",
- "description": "All vendor types for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "version": {
- "type": "integer",
- "description": "The version for this creative. Read-only. This field should not be set in requests.",
- "format": "int32"
- },
- "videoURL": {
- "type": "string",
- "description": "The url to fetch a video ad. If set, HTMLSnippet should not be set."
- },
- "width": {
- "type": "integer",
- "description": "Ad width.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "CreativesList": {
- "id": "CreativesList",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of creatives.",
- "items": {
- "$ref": "Creative"
- }
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one account by ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the authenticated user's list of accounts.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.list",
+ "path": "accounts",
+ "response": {
+ "$ref": "AccountsList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.accounts.patch",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.accounts.update",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
+ "creatives": {
+ "methods": {
+ "get": {
+ "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.get",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Submit a new creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.insert",
+ "path": "creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.list",
+ "parameters": {
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "statusFilter": {
+ "description": "When specified, only creatives having the given status are returned.",
+ "enum": [
+ "approved",
+ "disapproved",
+ "not_checked"
+ ],
+ "enumDescriptions": [
+ "Creatives which have been approved.",
+ "Creatives which have been disapproved.",
+ "Creatives whose status is not yet checked."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "creatives",
+ "response": {
+ "$ref": "CreativesList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
}
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.accounts.get",
- "path": "accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of accounts.",
- "response": {
- "$ref": "AccountsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.accounts.patch",
- "path": "accounts/{id}",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.accounts.update",
- "path": "accounts/{id}",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
},
- "creatives": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.creatives.get",
- "path": "creatives/{accountId}/{buyerCreativeId}",
- "httpMethod": "GET",
- "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
+ "revision": "20170810",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Configuration data for an Ad Exchange buyer account.",
+ "id": "Account",
+ "properties": {
+ "bidderLocation": {
+ "description": "Your bidder locations that have distinct URLs.",
+ "items": {
+ "properties": {
+ "maximumQps": {
+ "description": "The maximum queries per second the Ad Exchange will send.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "region": {
+ "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL to which the Ad Exchange will send bid requests.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "cookieMatchingNid": {
+ "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.",
+ "type": "string"
+ },
+ "cookieMatchingUrl": {
+ "description": "The base URL used in cookie match requests.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "adexchangebuyer#account",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "maximumActiveCreatives": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumTotalQps": {
+ "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "numberActiveCreatives": {
+ "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
+ "format": "int32",
+ "type": "integer"
+ }
},
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
},
- "insert": {
- "id": "adexchangebuyer.creatives.insert",
- "path": "creatives",
- "httpMethod": "POST",
- "description": "Submit a new creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "AccountsList": {
+ "description": "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.",
+ "id": "AccountsList",
+ "properties": {
+ "items": {
+ "description": "A list of accounts.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#accountsList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "list": {
- "id": "adexchangebuyer.creatives.list",
- "path": "creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
+ "Creative": {
+ "description": "A creative and its classification data.",
+ "id": "Creative",
+ "properties": {
+ "HTMLSnippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.",
+ "type": "string"
+ },
+ "accountId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "advertiserId": {
+ "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "advertiserName": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "agencyId": {
+ "description": "The agency id for this creative.",
+ "format": "int64",
+ "type": "string"
+ },
+ "apiUploadTimestamp": {
+ "description": "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).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "attribute": {
+ "description": "All attributes for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "buyerCreativeId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "A buyer-specific id identifying the creative in this ad.",
+ "type": "string"
+ },
+ "clickThroughUrl": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The set of destination urls for the snippet.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "corrections": {
+ "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the correction.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The type of correction that was applied to the creative.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "disapprovalReasons": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the reason for disapproval.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The categorized reason for disapproval.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "filteringReasons": {
+ "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
+ "properties": {
+ "date": {
+ "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.",
+ "type": "string"
+ },
+ "reasons": {
+ "description": "The filtering reasons.",
+ "items": {
+ "properties": {
+ "filteringCount": {
+ "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
+ "format": "int64",
+ "type": "string"
+ },
+ "filteringStatus": {
+ "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "height": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad height.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionTrackingUrl": {
+ "description": "The set of urls to be called to record an impression.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creative",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "productCategories": {
+ "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "restrictedCategories": {
+ "description": "All restricted categories for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "sensitiveCategories": {
+ "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "Creative serving status. Read-only. This field should not be set in requests.",
+ "type": "string"
+ },
+ "vendorType": {
+ "description": "All vendor types for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "version": {
+ "description": "The version for this creative. Read-only. This field should not be set in requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "videoURL": {
+ "description": "The url to fetch a video ad. If set, HTMLSnippet should not be set.",
+ "type": "string"
+ },
+ "width": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad width.",
+ "format": "int32",
+ "type": "integer"
+ }
},
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "type": "object"
+ },
+ "CreativesList": {
+ "description": "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.",
+ "id": "CreativesList",
+ "properties": {
+ "items": {
+ "description": "A list of creatives.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creativesList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
},
- "statusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given status are returned.",
- "enum": [
- "approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved.",
- "Creatives which have been disapproved.",
- "Creatives whose status is not yet checked."
- ],
- "location": "query"
- }
- },
- "response": {
- "$ref": "CreativesList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "type": "object"
}
- }
- }
- }
-}
+ },
+ "servicePath": "adexchangebuyer/v1.2/",
+ "title": "Ad Exchange Buyer API",
+ "version": "v1.2"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-api.json b/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-api.json
index 1edf96a39..7efe5463c 100644
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-api.json
+++ b/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-api.json
@@ -1,1668 +1,1668 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/_RwUq281eKa7d-tJKPdh-IE_OEk\"",
- "discoveryVersion": "v1",
- "id": "adexchangebuyer:v1.3",
- "name": "adexchangebuyer",
- "canonicalName": "Ad Exchange Buyer",
- "version": "v1.3",
- "revision": "20170810",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.3/",
- "basePath": "/adexchangebuyer/v1.3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangebuyer/v1.3/",
- "batchPath": "batch/adexchangebuyer/v1.3",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Configuration data for an Ad Exchange buyer account.",
- "properties": {
- "bidderLocation": {
- "type": "array",
- "description": "Your bidder locations that have distinct URLs.",
- "items": {
- "type": "object",
- "properties": {
- "maximumQps": {
- "type": "integer",
- "description": "The maximum queries per second the Ad Exchange will send.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
- },
- "url": {
- "type": "string",
- "description": "The URL to which the Ad Exchange will send bid requests."
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.buyer": {
+ "description": "Manage your Ad Exchange buyer account configuration"
+ }
}
- }
- },
- "cookieMatchingNid": {
- "type": "string",
- "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
- },
- "cookieMatchingUrl": {
- "type": "string",
- "description": "The base URL used in cookie match requests."
- },
- "id": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#account"
- },
- "maximumActiveCreatives": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "maximumTotalQps": {
- "type": "integer",
- "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "numberActiveCreatives": {
- "type": "integer",
- "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
- "format": "int32"
}
- }
},
- "AccountsList": {
- "id": "AccountsList",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#accountsList"
- }
- }
+ "basePath": "/adexchangebuyer/v1.3/",
+ "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.3/",
+ "batchPath": "batch/adexchangebuyer/v1.3",
+ "canonicalName": "Ad Exchange Buyer",
+ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/_RwUq281eKa7d-tJKPdh-IE_OEk\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
+ "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
},
- "BillingInfo": {
- "id": "BillingInfo",
- "type": "object",
- "description": "The configuration data for an Ad Exchange billing info.",
- "properties": {
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "accountName": {
- "type": "string",
- "description": "Account name."
- },
- "billingId": {
- "type": "array",
- "description": "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.",
- "items": {
+ "id": "adexchangebuyer:v1.3",
+ "kind": "discovery#restDescription",
+ "name": "adexchangebuyer",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
},
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfo"
- }
- }
- },
- "BillingInfoList": {
- "id": "BillingInfoList",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of billing info relevant for your account.",
- "items": {
- "$ref": "BillingInfo"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfoList"
- }
- }
- },
- "Budget": {
- "id": "Budget",
- "type": "object",
- "description": "The configuration data for Ad Exchange RTB - Budget API.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The id of the account. This is required for get and update requests.",
- "format": "int64"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
- "format": "int64"
- },
- "budgetAmount": {
- "type": "string",
- "description": "The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.",
- "format": "int64"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code for the buyer. This cannot be altered here."
- },
- "id": {
- "type": "string",
- "description": "The unique id that describes this item."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
- "default": "adexchangebuyer#budget"
- }
- }
- },
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "A creative and its classification data.",
- "properties": {
- "HTMLSnippet": {
- "type": "string",
- "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set."
- },
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "advertiserId": {
- "type": "array",
- "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "advertiserName": {
- "type": "string",
- "description": "The name of the company being advertised in the creative.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "agencyId": {
- "type": "string",
- "description": "The agency id for this creative.",
- "format": "int64"
- },
- "apiUploadTimestamp": {
- "type": "string",
- "description": "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).",
- "format": "date-time"
- },
- "attribute": {
- "type": "array",
- "description": "All attributes for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "A buyer-specific id identifying the creative in this ad.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "clickThroughUrl": {
- "type": "array",
- "description": "The set of destination urls for the snippet.",
- "items": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- },
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
},
- "corrections": {
- "type": "array",
- "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the correction.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The type of correction that was applied to the creative."
- }
- }
- }
- },
- "disapprovalReasons": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the reason for disapproval.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The categorized reason for disapproval."
- }
- }
- }
- },
- "filteringReasons": {
- "type": "object",
- "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
- },
- "reasons": {
- "type": "array",
- "description": "The filtering reasons.",
- "items": {
- "type": "object",
- "properties": {
- "filteringCount": {
- "type": "string",
- "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
- "format": "int64"
- },
- "filteringStatus": {
- "type": "integer",
- "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
- "format": "int32"
- }
- }
- }
- }
- }
- },
- "height": {
- "type": "integer",
- "description": "Ad height.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The set of urls to be called to record an impression.",
- "items": {
+ "key": {
+ "description": "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.",
+ "location": "query",
"type": "string"
- }
},
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creative"
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "nativeAd": {
- "type": "object",
- "description": "If nativeAd is set, HTMLSnippet and videoURL should not be set.",
- "properties": {
- "advertiser": {
- "type": "string"
- },
- "appIcon": {
- "type": "object",
- "description": "The app icon, for app download ads.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one account by ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
- "url": {
- "type": "string"
+ "list": {
+ "description": "Retrieves the authenticated user's list of accounts.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.list",
+ "path": "accounts",
+ "response": {
+ "$ref": "AccountsList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
- "width": {
- "type": "integer",
- "format": "int32"
+ "patch": {
+ "description": "Updates an existing account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.accounts.patch",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.accounts.update",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
- }
- },
- "body": {
- "type": "string",
- "description": "A long description of the ad."
- },
- "callToAction": {
- "type": "string",
- "description": "A label for the button that the user is supposed to click."
- },
- "clickTrackingUrl": {
- "type": "string",
- "description": "The URL to use for click tracking."
- },
- "headline": {
- "type": "string",
- "description": "A short title for the ad."
- },
- "image": {
- "type": "object",
- "description": "A large image.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The URLs are called when the impression is rendered.",
- "items": {
- "type": "string"
- }
- },
- "logo": {
- "type": "object",
- "description": "A smaller image, for the advertiser logo.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "price": {
- "type": "string",
- "description": "The price of the promoted app including the currency info."
- },
- "starRating": {
- "type": "number",
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "format": "double"
- },
- "store": {
- "type": "string",
- "description": "The URL to the app store to purchase/download the promoted app."
}
- }
},
- "productCategories": {
- "type": "array",
- "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
+ "billingInfo": {
+ "methods": {
+ "get": {
+ "description": "Returns the billing information for one account specified by account ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.billingInfo.get",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "billinginfo/{accountId}",
+ "response": {
+ "$ref": "BillingInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.billingInfo.list",
+ "path": "billinginfo",
+ "response": {
+ "$ref": "BillingInfoList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "restrictedCategories": {
- "type": "array",
- "description": "All restricted categories for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
+ "budget": {
+ "methods": {
+ "get": {
+ "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.budget.get",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the budget information for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id to get the budget information for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.budget.patch",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "request": {
+ "$ref": "Budget"
+ },
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.budget.update",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "request": {
+ "$ref": "Budget"
+ },
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "sensitiveCategories": {
- "type": "array",
- "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
+ "creatives": {
+ "methods": {
+ "get": {
+ "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.get",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Submit a new creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.insert",
+ "path": "creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.list",
+ "parameters": {
+ "accountId": {
+ "description": "When specified, only creatives for the given account ids are returned.",
+ "format": "int32",
+ "location": "query",
+ "repeated": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "When specified, only creatives for the given buyer creative ids are returned.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "statusFilter": {
+ "description": "When specified, only creatives having the given status are returned.",
+ "enum": [
+ "approved",
+ "disapproved",
+ "not_checked"
+ ],
+ "enumDescriptions": [
+ "Creatives which have been approved.",
+ "Creatives which have been disapproved.",
+ "Creatives whose status is not yet checked."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "creatives",
+ "response": {
+ "$ref": "CreativesList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "status": {
- "type": "string",
- "description": "Creative serving status. Read-only. This field should not be set in requests."
- },
- "vendorType": {
- "type": "array",
- "description": "All vendor types for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "version": {
- "type": "integer",
- "description": "The version for this creative. Read-only. This field should not be set in requests.",
- "format": "int32"
- },
- "videoURL": {
- "type": "string",
- "description": "The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set."
- },
- "width": {
- "type": "integer",
- "description": "Ad width.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- }
- }
- },
- "CreativesList": {
- "id": "CreativesList",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of creatives.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "DirectDeal": {
- "id": "DirectDeal",
- "type": "object",
- "description": "The configuration data for an Ad Exchange direct deal.",
- "properties": {
- "accountId": {
- "type": "integer",
- "description": "The account id of the buyer this deal is for.",
- "format": "int32"
- },
- "advertiser": {
- "type": "string",
- "description": "The name of the advertiser this deal is for."
- },
- "allowsAlcohol": {
- "type": "boolean",
- "description": "Whether the publisher for this deal is eligible for alcohol ads."
- },
- "buyerAccountId": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD."
- },
- "dealTier": {
- "type": "string",
- "description": "The deal type such as programmatic reservation or fixed price and so on."
- },
- "endTime": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "fixedCpm": {
- "type": "string",
- "description": "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).",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Deal id.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#directDeal"
- },
- "name": {
- "type": "string",
- "description": "Deal name."
- },
- "privateExchangeMinCpm": {
- "type": "string",
- "description": "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).",
- "format": "int64"
- },
- "publisherBlocksOverriden": {
- "type": "boolean",
- "description": "If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal."
- },
- "sellerNetwork": {
- "type": "string",
- "description": "The name of the publisher offering this direct deal."
- },
- "startTime": {
- "type": "string",
- "description": "Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.",
- "format": "int64"
- }
- }
- },
- "DirectDealsList": {
- "id": "DirectDealsList",
- "type": "object",
- "description": "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.",
- "properties": {
"directDeals": {
- "type": "array",
- "description": "A list of direct deals relevant for your account.",
- "items": {
- "$ref": "DirectDeal"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#directDealsList"
- }
- }
- },
- "PerformanceReport": {
- "id": "PerformanceReport",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "bidRate": {
- "type": "number",
- "description": "The number of bid responses with an ad.",
- "format": "double"
- },
- "bidRequestRate": {
- "type": "number",
- "description": "The number of bid requests sent to your bidder.",
- "format": "double"
- },
- "calloutStatusRate": {
- "type": "array",
- "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "cookieMatcherStatusRate": {
- "type": "array",
- "description": "Average QPS for cookie matcher operations.",
- "items": {
- "type": "any"
- }
- },
- "creativeStatusRate": {
- "type": "array",
- "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "filteredBidRate": {
- "type": "number",
- "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
- "format": "double"
- },
- "hostedMatchStatusRate": {
- "type": "array",
- "description": "Average QPS for hosted match operations.",
- "items": {
- "type": "any"
- }
- },
- "inventoryMatchRate": {
- "type": "number",
- "description": "The number of potential queries based on your pretargeting settings.",
- "format": "double"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReport"
- },
- "latency50thPercentile": {
- "type": "number",
- "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency85thPercentile": {
- "type": "number",
- "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency95thPercentile": {
- "type": "number",
- "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "noQuotaInRegion": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "outOfQuota": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "pixelMatchRequests": {
- "type": "number",
- "description": "Average QPS for pixel match requests from clients.",
- "format": "double"
- },
- "pixelMatchResponses": {
- "type": "number",
- "description": "Average QPS for pixel match responses from clients.",
- "format": "double"
- },
- "quotaConfiguredLimit": {
- "type": "number",
- "description": "The configured quota limits for this account.",
- "format": "double"
- },
- "quotaThrottledLimit": {
- "type": "number",
- "description": "The throttled quota limits for this account.",
- "format": "double"
- },
- "region": {
- "type": "string",
- "description": "The trading location of this data."
- },
- "successfulRequestRate": {
- "type": "number",
- "description": "The number of properly formed bid responses received by our servers within the deadline.",
- "format": "double"
- },
- "timestamp": {
- "type": "string",
- "description": "The unix timestamp of the starting time of this performance data.",
- "format": "int64"
- },
- "unsuccessfulRequestRate": {
- "type": "number",
- "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
- "format": "double"
- }
- }
- },
- "PerformanceReportList": {
- "id": "PerformanceReportList",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReportList"
+ "methods": {
+ "get": {
+ "description": "Gets one direct deal by ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.directDeals.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The direct deal id",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "directdeals/{id}",
+ "response": {
+ "$ref": "DirectDeal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the authenticated user's list of direct deals.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.directDeals.list",
+ "path": "directdeals",
+ "response": {
+ "$ref": "DirectDealsList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
"performanceReport": {
- "type": "array",
- "description": "A list of performance reports relevant for the account.",
- "items": {
- "$ref": "PerformanceReport"
- }
+ "methods": {
+ "list": {
+ "description": "Retrieves the authenticated user's list of performance metrics.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.performanceReport.list",
+ "parameterOrder": [
+ "accountId",
+ "endDateTime",
+ "startDateTime"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the reports.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "endDateTime": {
+ "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "startDateTime": {
+ "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "performancereport",
+ "response": {
+ "$ref": "PerformanceReportList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "pretargetingConfig": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing pretargeting config.",
+ "httpMethod": "DELETE",
+ "id": "adexchangebuyer.pretargetingConfig.delete",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to delete the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to delete.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Gets a specific pretargeting configuration",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pretargetingConfig.get",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to retrieve.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new pretargeting configuration.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.pretargetingConfig.insert",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to insert the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pretargetingConfig.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the pretargeting configs for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}",
+ "response": {
+ "$ref": "PretargetingConfigList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing pretargeting config. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.pretargetingConfig.patch",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to update the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to update.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing pretargeting config.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.pretargetingConfig.update",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to update the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to update.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
}
- }
},
- "PretargetingConfig": {
- "id": "PretargetingConfig",
- "type": "object",
- "properties": {
- "billingId": {
- "type": "string",
- "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
- "format": "int64"
- },
- "configId": {
- "type": "string",
- "description": "The config id; generated automatically. Leave this field blank for insert requests.",
- "format": "int64"
- },
- "configName": {
- "type": "string",
- "description": "The name of the config. Must be unique. Required for all requests."
- },
- "creativeType": {
- "type": "array",
- "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
- "items": {
- "type": "string"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
- "items": {
- "type": "object",
+ "revision": "20170810",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Configuration data for an Ad Exchange buyer account.",
+ "id": "Account",
"properties": {
- "height": {
- "type": "string",
- "description": "Height in pixels.",
- "format": "int64"
- },
- "width": {
- "type": "string",
- "description": "Width in pixels.",
- "format": "int64"
- }
- }
- }
+ "bidderLocation": {
+ "description": "Your bidder locations that have distinct URLs.",
+ "items": {
+ "properties": {
+ "maximumQps": {
+ "description": "The maximum queries per second the Ad Exchange will send.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "region": {
+ "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL to which the Ad Exchange will send bid requests.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "cookieMatchingNid": {
+ "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.",
+ "type": "string"
+ },
+ "cookieMatchingUrl": {
+ "description": "The base URL used in cookie match requests.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "adexchangebuyer#account",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "maximumActiveCreatives": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumTotalQps": {
+ "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "numberActiveCreatives": {
+ "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
- "excludedContentLabels": {
- "type": "array",
- "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedGeoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedPlacements": {
- "type": "array",
- "description": "Requests containing any of these placements will not match.",
- "items": {
- "type": "object",
+ "AccountsList": {
+ "description": "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.",
+ "id": "AccountsList",
"properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
+ "items": {
+ "description": "A list of accounts.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#accountsList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "excludedUserLists": {
- "type": "array",
- "description": "Requests containing any of these users list ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedVerticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "geoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "isActive": {
- "type": "boolean",
- "description": "Whether this config is active. Required for all requests."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
- "default": "adexchangebuyer#pretargetingConfig"
- },
- "languages": {
- "type": "array",
- "description": "Request containing any of these language codes will match.",
- "items": {
- "type": "string"
- }
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileDevices": {
- "type": "array",
- "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileOperatingSystemVersions": {
- "type": "array",
- "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "placements": {
- "type": "array",
- "description": "Requests containing any of these placements will match.",
- "items": {
- "type": "object",
+ "BillingInfo": {
+ "description": "The configuration data for an Ad Exchange billing info.",
+ "id": "BillingInfo",
"properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
+ "accountId": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "accountName": {
+ "description": "Account name.",
+ "type": "string"
+ },
+ "billingId": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#billingInfo",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "platforms": {
- "type": "array",
- "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
- "items": {
- "type": "string"
- }
+ "BillingInfoList": {
+ "description": "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.",
+ "id": "BillingInfoList",
+ "properties": {
+ "items": {
+ "description": "A list of billing info relevant for your account.",
+ "items": {
+ "$ref": "BillingInfo"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#billingInfoList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "supportedCreativeAttributes": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string",
- "format": "int64"
- }
+ "Budget": {
+ "description": "The configuration data for Ad Exchange RTB - Budget API.",
+ "id": "Budget",
+ "properties": {
+ "accountId": {
+ "description": "The id of the account. This is required for get and update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "budgetAmount": {
+ "description": "The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The currency code for the buyer. This cannot be altered here.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique id that describes this item.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#budget",
+ "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "userLists": {
- "type": "array",
- "description": "Requests containing any of these user list ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
+ "Creative": {
+ "description": "A creative and its classification data.",
+ "id": "Creative",
+ "properties": {
+ "HTMLSnippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.",
+ "type": "string"
+ },
+ "accountId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "advertiserId": {
+ "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "advertiserName": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "agencyId": {
+ "description": "The agency id for this creative.",
+ "format": "int64",
+ "type": "string"
+ },
+ "apiUploadTimestamp": {
+ "description": "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).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "attribute": {
+ "description": "All attributes for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "buyerCreativeId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "A buyer-specific id identifying the creative in this ad.",
+ "type": "string"
+ },
+ "clickThroughUrl": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The set of destination urls for the snippet.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "corrections": {
+ "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the correction.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The type of correction that was applied to the creative.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "disapprovalReasons": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the reason for disapproval.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The categorized reason for disapproval.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "filteringReasons": {
+ "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
+ "properties": {
+ "date": {
+ "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.",
+ "type": "string"
+ },
+ "reasons": {
+ "description": "The filtering reasons.",
+ "items": {
+ "properties": {
+ "filteringCount": {
+ "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
+ "format": "int64",
+ "type": "string"
+ },
+ "filteringStatus": {
+ "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "height": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad height.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionTrackingUrl": {
+ "description": "The set of urls to be called to record an impression.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creative",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nativeAd": {
+ "description": "If nativeAd is set, HTMLSnippet and videoURL should not be set.",
+ "properties": {
+ "advertiser": {
+ "type": "string"
+ },
+ "appIcon": {
+ "description": "The app icon, for app download ads.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "body": {
+ "description": "A long description of the ad.",
+ "type": "string"
+ },
+ "callToAction": {
+ "description": "A label for the button that the user is supposed to click.",
+ "type": "string"
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "A short title for the ad.",
+ "type": "string"
+ },
+ "image": {
+ "description": "A large image.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "impressionTrackingUrl": {
+ "description": "The URLs are called when the impression is rendered.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logo": {
+ "description": "A smaller image, for the advertiser logo.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "price": {
+ "description": "The price of the promoted app including the currency info.",
+ "type": "string"
+ },
+ "starRating": {
+ "description": "The app rating in the app store. Must be in the range [0-5].",
+ "format": "double",
+ "type": "number"
+ },
+ "store": {
+ "description": "The URL to the app store to purchase/download the promoted app.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "productCategories": {
+ "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "restrictedCategories": {
+ "description": "All restricted categories for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "sensitiveCategories": {
+ "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "Creative serving status. Read-only. This field should not be set in requests.",
+ "type": "string"
+ },
+ "vendorType": {
+ "description": "All vendor types for the ads that may be shown from this snippet.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "version": {
+ "description": "The version for this creative. Read-only. This field should not be set in requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "videoURL": {
+ "description": "The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set.",
+ "type": "string"
+ },
+ "width": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad width.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
- "vendorTypes": {
- "type": "array",
- "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
+ "CreativesList": {
+ "description": "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.",
+ "id": "CreativesList",
+ "properties": {
+ "items": {
+ "description": "A list of creatives.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creativesList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "verticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
+ "DirectDeal": {
+ "description": "The configuration data for an Ad Exchange direct deal.",
+ "id": "DirectDeal",
+ "properties": {
+ "accountId": {
+ "description": "The account id of the buyer this deal is for.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "advertiser": {
+ "description": "The name of the advertiser this deal is for.",
+ "type": "string"
+ },
+ "allowsAlcohol": {
+ "description": "Whether the publisher for this deal is eligible for alcohol ads.",
+ "type": "boolean"
+ },
+ "buyerAccountId": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.",
+ "type": "string"
+ },
+ "dealTier": {
+ "description": "The deal type such as programmatic reservation or fixed price and so on.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "fixedCpm": {
+ "description": "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).",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Deal id.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#directDeal",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Deal name.",
+ "type": "string"
+ },
+ "privateExchangeMinCpm": {
+ "description": "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).",
+ "format": "int64",
+ "type": "string"
+ },
+ "publisherBlocksOverriden": {
+ "description": "If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal.",
+ "type": "boolean"
+ },
+ "sellerNetwork": {
+ "description": "The name of the publisher offering this direct deal.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DirectDealsList": {
+ "description": "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.",
+ "id": "DirectDealsList",
+ "properties": {
+ "directDeals": {
+ "description": "A list of direct deals relevant for your account.",
+ "items": {
+ "$ref": "DirectDeal"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#directDealsList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PerformanceReport": {
+ "description": "The configuration data for an Ad Exchange performance report list.",
+ "id": "PerformanceReport",
+ "properties": {
+ "bidRate": {
+ "description": "The number of bid responses with an ad.",
+ "format": "double",
+ "type": "number"
+ },
+ "bidRequestRate": {
+ "description": "The number of bid requests sent to your bidder.",
+ "format": "double",
+ "type": "number"
+ },
+ "calloutStatusRate": {
+ "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "cookieMatcherStatusRate": {
+ "description": "Average QPS for cookie matcher operations.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "creativeStatusRate": {
+ "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "filteredBidRate": {
+ "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
+ "format": "double",
+ "type": "number"
+ },
+ "hostedMatchStatusRate": {
+ "description": "Average QPS for hosted match operations.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "inventoryMatchRate": {
+ "description": "The number of potential queries based on your pretargeting settings.",
+ "format": "double",
+ "type": "number"
+ },
+ "kind": {
+ "default": "adexchangebuyer#performanceReport",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "latency50thPercentile": {
+ "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "latency85thPercentile": {
+ "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "latency95thPercentile": {
+ "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "noQuotaInRegion": {
+ "description": "Rate of various quota account statuses per quota check.",
+ "format": "double",
+ "type": "number"
+ },
+ "outOfQuota": {
+ "description": "Rate of various quota account statuses per quota check.",
+ "format": "double",
+ "type": "number"
+ },
+ "pixelMatchRequests": {
+ "description": "Average QPS for pixel match requests from clients.",
+ "format": "double",
+ "type": "number"
+ },
+ "pixelMatchResponses": {
+ "description": "Average QPS for pixel match responses from clients.",
+ "format": "double",
+ "type": "number"
+ },
+ "quotaConfiguredLimit": {
+ "description": "The configured quota limits for this account.",
+ "format": "double",
+ "type": "number"
+ },
+ "quotaThrottledLimit": {
+ "description": "The throttled quota limits for this account.",
+ "format": "double",
+ "type": "number"
+ },
+ "region": {
+ "description": "The trading location of this data.",
+ "type": "string"
+ },
+ "successfulRequestRate": {
+ "description": "The number of properly formed bid responses received by our servers within the deadline.",
+ "format": "double",
+ "type": "number"
+ },
+ "timestamp": {
+ "description": "The unix timestamp of the starting time of this performance data.",
+ "format": "int64",
+ "type": "string"
+ },
+ "unsuccessfulRequestRate": {
+ "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "PerformanceReportList": {
+ "description": "The configuration data for an Ad Exchange performance report list.",
+ "id": "PerformanceReportList",
+ "properties": {
+ "kind": {
+ "default": "adexchangebuyer#performanceReportList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "performanceReport": {
+ "description": "A list of performance reports relevant for the account.",
+ "items": {
+ "$ref": "PerformanceReport"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PretargetingConfig": {
+ "id": "PretargetingConfig",
+ "properties": {
+ "billingId": {
+ "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configId": {
+ "description": "The config id; generated automatically. Leave this field blank for insert requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configName": {
+ "description": "The name of the config. Must be unique. Required for all requests.",
+ "type": "string"
+ },
+ "creativeType": {
+ "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
+ "items": {
+ "properties": {
+ "height": {
+ "description": "Height in pixels.",
+ "format": "int64",
+ "type": "string"
+ },
+ "width": {
+ "description": "Width in pixels.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "excludedContentLabels": {
+ "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedGeoCriteriaIds": {
+ "description": "Requests containing any of these geo criteria ids will not match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedPlacements": {
+ "description": "Requests containing any of these placements will not match.",
+ "items": {
+ "properties": {
+ "token": {
+ "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the placement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "excludedUserLists": {
+ "description": "Requests containing any of these users list ids will not match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedVerticals": {
+ "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "geoCriteriaIds": {
+ "description": "Requests containing any of these geo criteria ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "isActive": {
+ "description": "Whether this config is active. Required for all requests.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#pretargetingConfig",
+ "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
+ "type": "string"
+ },
+ "languages": {
+ "description": "Request containing any of these language codes will match.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileCarriers": {
+ "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileDevices": {
+ "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileOperatingSystemVersions": {
+ "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "placements": {
+ "description": "Requests containing any of these placements will match.",
+ "items": {
+ "properties": {
+ "token": {
+ "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the placement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "platforms": {
+ "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportedCreativeAttributes": {
+ "description": "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.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "userLists": {
+ "description": "Requests containing any of these user list ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "vendorTypes": {
+ "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "verticals": {
+ "description": "Requests containing any of these vertical ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PretargetingConfigList": {
+ "id": "PretargetingConfigList",
+ "properties": {
+ "items": {
+ "description": "A list of pretargeting configs",
+ "items": {
+ "$ref": "PretargetingConfig"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#pretargetingConfigList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "PretargetingConfigList": {
- "id": "PretargetingConfigList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of pretargeting configs",
- "items": {
- "$ref": "PretargetingConfig"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#pretargetingConfigList"
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.accounts.get",
- "path": "accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of accounts.",
- "response": {
- "$ref": "AccountsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.accounts.patch",
- "path": "accounts/{id}",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.accounts.update",
- "path": "accounts/{id}",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "billingInfo": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.billingInfo.get",
- "path": "billinginfo/{accountId}",
- "httpMethod": "GET",
- "description": "Returns the billing information for one account specified by account ID.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The account id.",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "BillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.billingInfo.list",
- "path": "billinginfo",
- "httpMethod": "GET",
- "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
- "response": {
- "$ref": "BillingInfoList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "budget": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.budget.get",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "GET",
- "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.budget.patch",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PATCH",
- "description": "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.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.budget.update",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PUT",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.creatives.get",
- "path": "creatives/{accountId}/{buyerCreativeId}",
- "httpMethod": "GET",
- "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.creatives.insert",
- "path": "creatives",
- "httpMethod": "POST",
- "description": "Submit a new creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.creatives.list",
- "path": "creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "When specified, only creatives for the given account ids are returned.",
- "format": "int32",
- "repeated": true,
- "location": "query"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "When specified, only creatives for the given buyer creative ids are returned.",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "statusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given status are returned.",
- "enum": [
- "approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved.",
- "Creatives which have been disapproved.",
- "Creatives whose status is not yet checked."
- ],
- "location": "query"
- }
- },
- "response": {
- "$ref": "CreativesList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "directDeals": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.directDeals.get",
- "path": "directdeals/{id}",
- "httpMethod": "GET",
- "description": "Gets one direct deal by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "The direct deal id",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "DirectDeal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.directDeals.list",
- "path": "directdeals",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of direct deals.",
- "response": {
- "$ref": "DirectDealsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "performanceReport": {
- "methods": {
- "list": {
- "id": "adexchangebuyer.performanceReport.list",
- "path": "performancereport",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of performance metrics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the reports.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "endDateTime": {
- "type": "string",
- "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "startDateTime": {
- "type": "string",
- "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "endDateTime",
- "startDateTime"
- ],
- "response": {
- "$ref": "PerformanceReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "pretargetingConfig": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.pretargetingConfig.delete",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to delete the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to delete.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "get": {
- "id": "adexchangebuyer.pretargetingConfig.get",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "GET",
- "description": "Gets a specific pretargeting configuration",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to retrieve.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.pretargetingConfig.insert",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "POST",
- "description": "Inserts a new pretargeting configuration.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to insert the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.pretargetingConfig.list",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting configs for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "PretargetingConfigList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.pretargetingConfig.patch",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing pretargeting config. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.pretargetingConfig.update",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PUT",
- "description": "Updates an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "adexchangebuyer/v1.3/",
+ "title": "Ad Exchange Buyer API",
+ "version": "v1.3"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-api.json b/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-api.json
index 239a0bb7d..c656b5664 100644
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-api.json
+++ b/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-api.json
@@ -1,3640 +1,3686 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/nD15-sVgx0hSdEaD_RN4E40IFV8\"",
- "discoveryVersion": "v1",
- "id": "adexchangebuyer:v1.4",
- "name": "adexchangebuyer",
- "canonicalName": "Ad Exchange Buyer",
- "version": "v1.4",
- "revision": "20170810",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.4/",
- "basePath": "/adexchangebuyer/v1.4/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangebuyer/v1.4/",
- "batchPath": "batch/adexchangebuyer/v1.4",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Configuration data for an Ad Exchange buyer account.",
- "properties": {
- "bidderLocation": {
- "type": "array",
- "description": "Your bidder locations that have distinct URLs.",
- "items": {
- "type": "object",
- "properties": {
- "bidProtocol": {
- "type": "string",
- "description": "The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: \n- PROTOCOL_ADX \n- PROTOCOL_OPENRTB_2_2 \n- PROTOCOL_OPENRTB_2_3 \n- PROTOCOL_OPENRTB_2_4 \n- PROTOCOL_OPENRTB_2_5 \n- PROTOCOL_OPENRTB_PROTOBUF_2_3 \n- PROTOCOL_OPENRTB_PROTOBUF_2_4 \n- PROTOCOL_OPENRTB_PROTOBUF_2_5"
- },
- "maximumQps": {
- "type": "integer",
- "description": "The maximum queries per second the Ad Exchange will send.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
- },
- "url": {
- "type": "string",
- "description": "The URL to which the Ad Exchange will send bid requests."
- }
- }
- }
- },
- "cookieMatchingNid": {
- "type": "string",
- "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
- },
- "cookieMatchingUrl": {
- "type": "string",
- "description": "The base URL used in cookie match requests."
- },
- "id": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#account"
- },
- "maximumActiveCreatives": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "maximumTotalQps": {
- "type": "integer",
- "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "numberActiveCreatives": {
- "type": "integer",
- "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
- "format": "int32"
- }
- }
- },
- "AccountsList": {
- "id": "AccountsList",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#accountsList"
- }
- }
- },
- "AddOrderDealsRequest": {
- "id": "AddOrderDealsRequest",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "The list of deals to add",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The last known proposal revision number.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string",
- "description": "Indicates an optional action to take on the proposal"
- }
- }
- },
- "AddOrderDealsResponse": {
- "id": "AddOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals added (in the same proposal as passed in the request)",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The updated revision number for the proposal.",
- "format": "int64"
- }
- }
- },
- "AddOrderNotesRequest": {
- "id": "AddOrderNotesRequest",
- "type": "object",
- "properties": {
- "notes": {
- "type": "array",
- "description": "The list of notes to add.",
- "items": {
- "$ref": "MarketplaceNote"
- }
- }
- }
- },
- "AddOrderNotesResponse": {
- "id": "AddOrderNotesResponse",
- "type": "object",
- "properties": {
- "notes": {
- "type": "array",
- "items": {
- "$ref": "MarketplaceNote"
- }
- }
- }
- },
- "BillingInfo": {
- "id": "BillingInfo",
- "type": "object",
- "description": "The configuration data for an Ad Exchange billing info.",
- "properties": {
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "accountName": {
- "type": "string",
- "description": "Account name."
- },
- "billingId": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfo"
- }
- }
- },
- "BillingInfoList": {
- "id": "BillingInfoList",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of billing info relevant for your account.",
- "items": {
- "$ref": "BillingInfo"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfoList"
- }
- }
- },
- "Budget": {
- "id": "Budget",
- "type": "object",
- "description": "The configuration data for Ad Exchange RTB - Budget API.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The id of the account. This is required for get and update requests.",
- "format": "int64"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
- "format": "int64"
- },
- "budgetAmount": {
- "type": "string",
- "description": "The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.",
- "format": "int64"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code for the buyer. This cannot be altered here."
- },
- "id": {
- "type": "string",
- "description": "The unique id that describes this item."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
- "default": "adexchangebuyer#budget"
- }
- }
- },
- "Buyer": {
- "id": "Buyer",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Adx account id of the buyer."
- }
- }
- },
- "ContactInformation": {
- "id": "ContactInformation",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the contact."
- },
- "name": {
- "type": "string",
- "description": "The name of the contact."
- }
- }
- },
- "CreateOrdersRequest": {
- "id": "CreateOrdersRequest",
- "type": "object",
- "properties": {
- "proposals": {
- "type": "array",
- "description": "The list of proposals to create.",
- "items": {
- "$ref": "Proposal"
- }
- },
- "webPropertyCode": {
- "type": "string",
- "description": "Web property id of the seller creating these orders"
- }
- }
- },
- "CreateOrdersResponse": {
- "id": "CreateOrdersResponse",
- "type": "object",
- "properties": {
- "proposals": {
- "type": "array",
- "description": "The list of proposals successfully created.",
- "items": {
- "$ref": "Proposal"
- }
- }
- }
- },
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "A creative and its classification data.",
- "properties": {
- "HTMLSnippet": {
- "type": "string",
- "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set."
- },
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "adChoicesDestinationUrl": {
- "type": "string",
- "description": "The link to the Ad Preferences page. This is only supported for native ads."
- },
- "advertiserId": {
- "type": "array",
- "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "advertiserName": {
- "type": "string",
- "description": "The name of the company being advertised in the creative. The value provided must exist in the advertisers.txt file.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "agencyId": {
- "type": "string",
- "description": "The agency id for this creative.",
- "format": "int64"
- },
- "apiUploadTimestamp": {
- "type": "string",
- "description": "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).",
- "format": "date-time"
- },
- "attribute": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "A buyer-specific id identifying the creative in this ad.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "clickThroughUrl": {
- "type": "array",
- "description": "The set of destination urls for the snippet.",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "corrections": {
- "type": "array",
- "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "contexts": {
- "type": "array",
- "description": "All known serving contexts containing serving status information.",
- "items": {
- "type": "object",
- "properties": {
- "auctionType": {
- "type": "array",
- "description": "Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.",
- "items": {
- "type": "string"
- }
- },
- "contextType": {
- "type": "string",
- "description": "The type of context (e.g., location, platform, auction type, SSL-ness)."
- },
- "geoCriteriaId": {
- "type": "array",
- "description": "Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "platform": {
- "type": "array",
- "description": "Only set when contextType=PLATFORM. Represents the platforms this correction applies to.",
- "items": {
- "type": "string"
- }
- }
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.buyer": {
+ "description": "Manage your Ad Exchange buyer account configuration"
}
- },
- "details": {
- "type": "array",
- "description": "Additional details about the correction.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The type of correction that was applied to the creative."
- }
}
- }
- },
- "dealsStatus": {
- "type": "string",
- "description": "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."
- },
- "detectedDomains": {
- "type": "array",
- "description": "Detected domains for this creative. Read-only. This field should not be set in requests.",
- "items": {
+ }
+ },
+ "basePath": "/adexchangebuyer/v1.4/",
+ "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.4/",
+ "batchPath": "batch/adexchangebuyer/v1.4",
+ "canonicalName": "Ad Exchange Buyer",
+ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/X7x239uWJ65N2aEP-IhQZbTrqjc\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
+ "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
+ },
+ "id": "adexchangebuyer:v1.4",
+ "kind": "discovery#restDescription",
+ "name": "adexchangebuyer",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
},
- "filteringReasons": {
- "type": "object",
- "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
- },
- "reasons": {
- "type": "array",
- "description": "The filtering reasons.",
- "items": {
- "type": "object",
- "properties": {
- "filteringCount": {
- "type": "string",
- "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
- "format": "int64"
- },
- "filteringStatus": {
- "type": "integer",
- "description": "The filtering status code as defined in creative-status-codes.txt.",
- "format": "int32"
- }
- }
- }
- }
- }
- },
- "height": {
- "type": "integer",
- "description": "Ad height.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The set of urls to be called to record an impression.",
- "items": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creative"
- },
- "languages": {
- "type": "array",
- "description": "Detected languages for this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string"
- }
- },
- "nativeAd": {
- "type": "object",
- "description": "If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)",
- "properties": {
- "advertiser": {
- "type": "string"
- },
- "appIcon": {
- "type": "object",
- "description": "The app icon, for app download ads.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "body": {
- "type": "string",
- "description": "A long description of the ad."
- },
- "callToAction": {
- "type": "string",
- "description": "A label for the button that the user is supposed to click."
- },
- "clickLinkUrl": {
- "type": "string",
- "description": "The URL that the browser/SDK will load when the user clicks the ad."
- },
- "clickTrackingUrl": {
- "type": "string",
- "description": "The URL to use for click tracking."
- },
- "headline": {
- "type": "string",
- "description": "A short title for the ad."
- },
- "image": {
- "type": "object",
- "description": "A large image.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The URLs are called when the impression is rendered.",
- "items": {
- "type": "string"
- }
- },
- "logo": {
- "type": "object",
- "description": "A smaller image, for the advertiser logo.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "price": {
- "type": "string",
- "description": "The price of the promoted app including the currency info."
- },
- "starRating": {
- "type": "number",
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "format": "double"
- },
- "store": {
- "type": "string",
- "description": "The URL to the app store to purchase/download the promoted app."
- },
- "videoURL": {
- "type": "string",
- "description": "The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url."
- }
- }
- },
- "openAuctionStatus": {
- "type": "string",
- "description": "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."
- },
- "productCategories": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "restrictedCategories": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "sensitiveCategories": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "servingRestrictions": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
- "properties": {
- "contexts": {
- "type": "array",
- "description": "All known contexts/restrictions.",
- "items": {
- "type": "object",
- "properties": {
- "auctionType": {
- "type": "array",
- "description": "Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.",
- "items": {
- "type": "string"
- }
- },
- "contextType": {
- "type": "string",
- "description": "The type of context (e.g., location, platform, auction type, SSL-ness)."
- },
- "geoCriteriaId": {
- "type": "array",
- "description": "Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "platform": {
- "type": "array",
- "description": "Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "disapprovalReasons": {
- "type": "array",
- "description": "The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the reason for disapproval.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The categorized reason for disapproval."
- }
- }
- }
- },
- "reason": {
- "type": "string",
- "description": "Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review)."
- }
- }
- }
- },
- "vendorType": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "version": {
- "type": "integer",
- "description": "The version for this creative. Read-only. This field should not be set in requests.",
- "format": "int32"
- },
- "videoURL": {
- "type": "string",
- "description": "The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is different from resource.native_ad.video_url above."
- },
- "width": {
- "type": "integer",
- "description": "Ad width.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- }
- }
- },
- "CreativeDealIds": {
- "id": "CreativeDealIds",
- "type": "object",
- "description": "The external deal ids associated with a creative.",
- "properties": {
- "dealStatuses": {
- "type": "array",
- "description": "A list of external deal ids and ARC approval status.",
- "items": {
- "type": "object",
- "properties": {
- "arcStatus": {
- "type": "string",
- "description": "ARC approval status."
- },
- "dealId": {
- "type": "string",
- "description": "External deal ID.",
- "format": "int64"
- },
- "webPropertyId": {
- "type": "integer",
- "description": "Publisher ID.",
- "format": "int32"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativeDealIds"
- }
- }
- },
- "CreativesList": {
- "id": "CreativesList",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of creatives.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "DealServingMetadata": {
- "id": "DealServingMetadata",
- "type": "object",
- "properties": {
- "alcoholAdsAllowed": {
- "type": "boolean",
- "description": "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"
- },
- "dealPauseStatus": {
- "$ref": "DealServingMetadataDealPauseStatus",
- "description": "Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)"
- }
- }
- },
- "DealServingMetadataDealPauseStatus": {
- "id": "DealServingMetadataDealPauseStatus",
- "type": "object",
- "description": "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.",
- "properties": {
- "buyerPauseReason": {
- "type": "string"
- },
- "firstPausedBy": {
- "type": "string",
- "description": "If the deal is paused, records which party paused the deal first."
- },
- "hasBuyerPaused": {
- "type": "boolean"
- },
- "hasSellerPaused": {
- "type": "boolean"
- },
- "sellerPauseReason": {
- "type": "string"
- }
- }
- },
- "DealTerms": {
- "id": "DealTerms",
- "type": "object",
- "properties": {
- "brandingType": {
- "type": "string",
- "description": "Visibilty of the URL in bid requests."
- },
- "crossListedExternalDealIdType": {
- "type": "string",
- "description": "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."
- },
- "description": {
- "type": "string",
- "description": "Description for the proposed terms of the deal."
- },
- "estimatedGrossSpend": {
- "$ref": "Price",
- "description": "Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller."
- },
- "estimatedImpressionsPerDay": {
- "type": "string",
- "description": "Non-binding estimate of the impressions served per day Can be set by buyer or seller.",
- "format": "int64"
- },
- "guaranteedFixedPriceTerms": {
- "$ref": "DealTermsGuaranteedFixedPriceTerms",
- "description": "The terms for guaranteed fixed price deals."
- },
- "nonGuaranteedAuctionTerms": {
- "$ref": "DealTermsNonGuaranteedAuctionTerms",
- "description": "The terms for non-guaranteed auction deals."
- },
- "nonGuaranteedFixedPriceTerms": {
- "$ref": "DealTermsNonGuaranteedFixedPriceTerms",
- "description": "The terms for non-guaranteed fixed price deals."
- },
- "rubiconNonGuaranteedTerms": {
- "$ref": "DealTermsRubiconNonGuaranteedTerms",
- "description": "The terms for rubicon non-guaranteed deals."
- },
- "sellerTimeZone": {
- "type": "string",
- "description": "For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)"
- }
- }
- },
- "DealTermsGuaranteedFixedPriceTerms": {
- "id": "DealTermsGuaranteedFixedPriceTerms",
- "type": "object",
- "properties": {
- "billingInfo": {
- "$ref": "DealTermsGuaranteedFixedPriceTermsBillingInfo",
- "description": "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."
- },
- "fixedPrices": {
- "type": "array",
- "description": "Fixed price for the specified buyer.",
- "items": {
- "$ref": "PricePerBuyer"
- }
- },
- "guaranteedImpressions": {
- "type": "string",
- "description": "Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.",
- "format": "int64"
- },
- "guaranteedLooks": {
- "type": "string",
- "description": "Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.",
- "format": "int64"
- },
- "minimumDailyLooks": {
- "type": "string",
- "description": "Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.",
- "format": "int64"
- }
- }
- },
- "DealTermsGuaranteedFixedPriceTermsBillingInfo": {
- "id": "DealTermsGuaranteedFixedPriceTermsBillingInfo",
- "type": "object",
- "properties": {
- "currencyConversionTimeMs": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "dfpLineItemId": {
- "type": "string",
- "description": "The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.",
- "format": "int64"
- },
- "originalContractedQuantity": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "price": {
- "$ref": "Price",
- "description": "The original reservation price for the deal, if the currency code is different from the one used in negotiation."
- }
- }
- },
- "DealTermsNonGuaranteedAuctionTerms": {
- "id": "DealTermsNonGuaranteedAuctionTerms",
- "type": "object",
- "properties": {
- "autoOptimizePrivateAuction": {
- "type": "boolean",
- "description": "True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly)."
- },
- "reservePricePerBuyers": {
- "type": "array",
- "description": "Reserve price for the specified buyer.",
- "items": {
- "$ref": "PricePerBuyer"
- }
- }
- }
- },
- "DealTermsNonGuaranteedFixedPriceTerms": {
- "id": "DealTermsNonGuaranteedFixedPriceTerms",
- "type": "object",
- "properties": {
- "fixedPrices": {
- "type": "array",
- "description": "Fixed price for the specified buyer.",
- "items": {
- "$ref": "PricePerBuyer"
- }
- }
- }
- },
- "DealTermsRubiconNonGuaranteedTerms": {
- "id": "DealTermsRubiconNonGuaranteedTerms",
- "type": "object",
- "properties": {
- "priorityPrice": {
- "$ref": "Price",
- "description": "Optional price for Rubicon priority access in the auction."
- },
- "standardPrice": {
- "$ref": "Price",
- "description": "Optional price for Rubicon standard access in the auction."
- }
- }
- },
- "DeleteOrderDealsRequest": {
- "id": "DeleteOrderDealsRequest",
- "type": "object",
- "properties": {
- "dealIds": {
- "type": "array",
- "description": "List of deals to delete for a given proposal",
- "items": {
- "type": "string"
- }
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The last known proposal revision number.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string",
- "description": "Indicates an optional action to take on the proposal"
- }
- }
- },
- "DeleteOrderDealsResponse": {
- "id": "DeleteOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals deleted (in the same proposal as passed in the request)",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The updated revision number for the proposal.",
- "format": "int64"
- }
- }
- },
- "DeliveryControl": {
- "id": "DeliveryControl",
- "type": "object",
- "properties": {
- "creativeBlockingLevel": {
- "type": "string"
- },
- "deliveryRateType": {
- "type": "string"
- },
- "frequencyCaps": {
- "type": "array",
- "items": {
- "$ref": "DeliveryControlFrequencyCap"
- }
- }
- }
- },
- "DeliveryControlFrequencyCap": {
- "id": "DeliveryControlFrequencyCap",
- "type": "object",
- "properties": {
- "maxImpressions": {
- "type": "integer",
- "format": "int32"
- },
- "numTimeUnits": {
- "type": "integer",
- "format": "int32"
- },
- "timeUnitType": {
- "type": "string"
- }
- }
- },
- "Dimension": {
- "id": "Dimension",
- "type": "object",
- "description": "This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}",
- "properties": {
- "dimensionType": {
- "type": "string"
- },
- "dimensionValues": {
- "type": "array",
- "items": {
- "$ref": "DimensionDimensionValue"
- }
- }
- }
- },
- "DimensionDimensionValue": {
- "id": "DimensionDimensionValue",
- "type": "object",
- "description": "Value of the dimension.",
- "properties": {
- "id": {
- "type": "integer",
- "description": "Id of the dimension.",
- "format": "int32"
- },
- "name": {
- "type": "string",
- "description": "Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids."
- },
- "percentage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- }
- }
- },
- "EditAllOrderDealsRequest": {
- "id": "EditAllOrderDealsRequest",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "proposal": {
- "$ref": "Proposal",
- "description": "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."
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The last known revision number for the proposal.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string",
- "description": "Indicates an optional action to take on the proposal"
- }
- }
- },
- "EditAllOrderDealsResponse": {
- "id": "EditAllOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of all deals in the proposal after edit.",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "orderRevisionNumber": {
- "type": "string",
- "description": "The latest revision number after the update has been applied.",
- "format": "int64"
- }
- }
- },
- "GetOffersResponse": {
- "id": "GetOffersResponse",
- "type": "object",
- "properties": {
- "products": {
- "type": "array",
- "description": "The returned list of products.",
- "items": {
- "$ref": "Product"
- }
- }
- }
- },
- "GetOrderDealsResponse": {
- "id": "GetOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals for the proposal",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- }
- }
- },
- "GetOrderNotesResponse": {
- "id": "GetOrderNotesResponse",
- "type": "object",
- "properties": {
- "notes": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "MarketplaceNote"
- }
- }
- }
- },
- "GetOrdersResponse": {
- "id": "GetOrdersResponse",
- "type": "object",
- "properties": {
- "proposals": {
- "type": "array",
- "description": "The list of matching proposals.",
- "items": {
- "$ref": "Proposal"
- }
- }
- }
- },
- "GetPublisherProfilesByAccountIdResponse": {
- "id": "GetPublisherProfilesByAccountIdResponse",
- "type": "object",
- "properties": {
- "profiles": {
- "type": "array",
- "description": "Profiles for the requested publisher",
- "items": {
- "$ref": "PublisherProfileApiProto"
- }
- }
- }
- },
- "MarketplaceDeal": {
- "id": "MarketplaceDeal",
- "type": "object",
- "description": "A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.",
- "properties": {
- "buyerPrivateData": {
- "$ref": "PrivateData",
- "description": "Buyer private data (hidden from seller)."
- },
- "creationTimeMs": {
- "type": "string",
- "description": "The time (ms since epoch) of the deal creation. (readonly)",
- "format": "int64"
- },
- "creativePreApprovalPolicy": {
- "type": "string",
- "description": "Specifies the creative pre-approval policy (buyer-readonly)"
- },
- "creativeSafeFrameCompatibility": {
- "type": "string",
- "description": "Specifies whether the creative is safeFrame compatible (buyer-readonly)"
- },
- "dealId": {
- "type": "string",
- "description": "A unique deal-id for the deal (readonly)."
- },
- "dealServingMetadata": {
- "$ref": "DealServingMetadata",
- "description": "Metadata about the serving status of this deal (readonly, writes via custom actions)"
- },
- "deliveryControl": {
- "$ref": "DeliveryControl",
- "description": "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."
- },
- "externalDealId": {
- "type": "string",
- "description": "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)"
- },
- "flightEndTimeMs": {
- "type": "string",
- "description": "Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
- "format": "int64"
- },
- "flightStartTimeMs": {
- "type": "string",
- "description": "Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
- "format": "int64"
- },
- "inventoryDescription": {
- "type": "string",
- "description": "Description for the deal terms. (buyer-readonly)"
- },
- "isRfpTemplate": {
- "type": "boolean",
- "description": "Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products."
- },
- "isSetupComplete": {
- "type": "boolean",
- "description": "True, if the buyside inventory setup is complete for this deal. (readonly, except via OrderSetupCompleted action)"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceDeal\".",
- "default": "adexchangebuyer#marketplaceDeal"
- },
- "lastUpdateTimeMs": {
- "type": "string",
- "description": "The time (ms since epoch) when the deal was last updated. (readonly)",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "The name of the deal. (updatable)"
- },
- "productId": {
- "type": "string",
- "description": "The product-id from which this deal was created. (readonly, except on create)"
- },
- "productRevisionNumber": {
- "type": "string",
- "description": "The revision number of the product that the deal was created from (readonly, except on create)",
- "format": "int64"
- },
- "programmaticCreativeSource": {
- "type": "string",
- "description": "Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)"
- },
- "proposalId": {
- "type": "string"
- },
- "sellerContacts": {
- "type": "array",
- "description": "Optional Seller contact information for the deal (buyer-readonly)",
- "items": {
- "$ref": "ContactInformation"
- }
- },
- "sharedTargetings": {
- "type": "array",
- "description": "The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)",
- "items": {
- "$ref": "SharedTargeting"
- }
- },
- "syndicationProduct": {
- "type": "string",
- "description": "The syndication product associated with the deal. (readonly, except on create)"
- },
- "terms": {
- "$ref": "DealTerms",
- "description": "The negotiable terms of the deal. (updatable)"
- },
- "webPropertyCode": {
- "type": "string"
- }
- }
- },
- "MarketplaceDealParty": {
- "id": "MarketplaceDealParty",
- "type": "object",
- "properties": {
- "buyer": {
- "$ref": "Buyer",
- "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party."
- },
- "seller": {
- "$ref": "Seller",
- "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party."
- }
- }
- },
- "MarketplaceLabel": {
- "id": "MarketplaceLabel",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The accountId of the party that created the label."
- },
- "createTimeMs": {
- "type": "string",
- "description": "The creation time (in ms since epoch) for the label.",
- "format": "int64"
- },
- "deprecatedMarketplaceDealParty": {
- "$ref": "MarketplaceDealParty",
- "description": "Information about the party that created the label."
- },
- "label": {
- "type": "string",
- "description": "The label to use."
- }
- }
- },
- "MarketplaceNote": {
- "id": "MarketplaceNote",
- "type": "object",
- "description": "A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.",
- "properties": {
- "creatorRole": {
- "type": "string",
- "description": "The role of the person (buyer/seller) creating the note. (readonly)"
- },
- "dealId": {
- "type": "string",
- "description": "Notes can optionally be associated with a deal. (readonly, except on create)"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceNote\".",
- "default": "adexchangebuyer#marketplaceNote"
- },
- "note": {
- "type": "string",
- "description": "The actual note to attach. (readonly, except on create)"
- },
- "noteId": {
- "type": "string",
- "description": "The unique id for the note. (readonly)"
- },
- "proposalId": {
- "type": "string",
- "description": "The proposalId that a note is attached to. (readonly)"
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "If the note is associated with a proposal revision number, then store that here. (readonly, except on create)",
- "format": "int64"
- },
- "timestampMs": {
- "type": "string",
- "description": "The timestamp (ms since epoch) that this note was created. (readonly)",
- "format": "int64"
- }
- }
- },
- "PerformanceReport": {
- "id": "PerformanceReport",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "bidRate": {
- "type": "number",
- "description": "The number of bid responses with an ad.",
- "format": "double"
- },
- "bidRequestRate": {
- "type": "number",
- "description": "The number of bid requests sent to your bidder.",
- "format": "double"
- },
- "calloutStatusRate": {
- "type": "array",
- "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "cookieMatcherStatusRate": {
- "type": "array",
- "description": "Average QPS for cookie matcher operations.",
- "items": {
- "type": "any"
- }
- },
- "creativeStatusRate": {
- "type": "array",
- "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "filteredBidRate": {
- "type": "number",
- "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
- "format": "double"
- },
- "hostedMatchStatusRate": {
- "type": "array",
- "description": "Average QPS for hosted match operations.",
- "items": {
- "type": "any"
- }
- },
- "inventoryMatchRate": {
- "type": "number",
- "description": "The number of potential queries based on your pretargeting settings.",
- "format": "double"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReport"
- },
- "latency50thPercentile": {
- "type": "number",
- "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency85thPercentile": {
- "type": "number",
- "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency95thPercentile": {
- "type": "number",
- "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "noQuotaInRegion": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "outOfQuota": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "pixelMatchRequests": {
- "type": "number",
- "description": "Average QPS for pixel match requests from clients.",
- "format": "double"
- },
- "pixelMatchResponses": {
- "type": "number",
- "description": "Average QPS for pixel match responses from clients.",
- "format": "double"
- },
- "quotaConfiguredLimit": {
- "type": "number",
- "description": "The configured quota limits for this account.",
- "format": "double"
- },
- "quotaThrottledLimit": {
- "type": "number",
- "description": "The throttled quota limits for this account.",
- "format": "double"
- },
- "region": {
- "type": "string",
- "description": "The trading location of this data."
- },
- "successfulRequestRate": {
- "type": "number",
- "description": "The number of properly formed bid responses received by our servers within the deadline.",
- "format": "double"
- },
- "timestamp": {
- "type": "string",
- "description": "The unix timestamp of the starting time of this performance data.",
- "format": "int64"
- },
- "unsuccessfulRequestRate": {
- "type": "number",
- "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
- "format": "double"
- }
- }
- },
- "PerformanceReportList": {
- "id": "PerformanceReportList",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReportList"
- },
- "performanceReport": {
- "type": "array",
- "description": "A list of performance reports relevant for the account.",
- "items": {
- "$ref": "PerformanceReport"
- }
- }
- }
- },
- "PretargetingConfig": {
- "id": "PretargetingConfig",
- "type": "object",
- "properties": {
- "billingId": {
- "type": "string",
- "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
- "format": "int64"
- },
- "configId": {
- "type": "string",
- "description": "The config id; generated automatically. Leave this field blank for insert requests.",
- "format": "int64"
- },
- "configName": {
- "type": "string",
- "description": "The name of the config. Must be unique. Required for all requests."
- },
- "creativeType": {
- "type": "array",
- "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
- "items": {
- "type": "string"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
- "items": {
- "type": "object",
- "properties": {
- "height": {
- "type": "string",
- "description": "Height in pixels.",
- "format": "int64"
- },
- "width": {
- "type": "string",
- "description": "Width in pixels.",
- "format": "int64"
- }
- }
- }
- },
- "excludedContentLabels": {
- "type": "array",
- "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedGeoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedPlacements": {
- "type": "array",
- "description": "Requests containing any of these placements will not match.",
- "items": {
- "type": "object",
- "properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
- },
- "excludedUserLists": {
- "type": "array",
- "description": "Requests containing any of these users list ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedVerticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "geoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "isActive": {
- "type": "boolean",
- "description": "Whether this config is active. Required for all requests."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
- "default": "adexchangebuyer#pretargetingConfig"
- },
- "languages": {
- "type": "array",
- "description": "Request containing any of these language codes will match.",
- "items": {
- "type": "string"
- }
- },
- "minimumViewabilityDecile": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileDevices": {
- "type": "array",
- "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileOperatingSystemVersions": {
- "type": "array",
- "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "placements": {
- "type": "array",
- "description": "Requests containing any of these placements will match.",
- "items": {
- "type": "object",
- "properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
- },
- "platforms": {
- "type": "array",
- "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
- "items": {
- "type": "string"
- }
- },
- "supportedCreativeAttributes": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "userIdentifierDataRequired": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "userLists": {
- "type": "array",
- "description": "Requests containing any of these user list ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "vendorTypes": {
- "type": "array",
- "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "verticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "videoPlayerSizes": {
- "type": "array",
- "description": "Video requests satisfying any of these player size constraints will match.",
- "items": {
- "type": "object",
- "properties": {
- "aspectRatio": {
- "type": "string",
- "description": "The type of aspect ratio. Leave this field blank to match all aspect ratios."
- },
- "minHeight": {
- "type": "string",
- "description": "The minimum player height in pixels. Leave this field blank to match any player height.",
- "format": "int64"
- },
- "minWidth": {
- "type": "string",
- "description": "The minimum player width in pixels. Leave this field blank to match any player width.",
- "format": "int64"
- }
- }
- }
- }
- }
- },
- "PretargetingConfigList": {
- "id": "PretargetingConfigList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of pretargeting configs",
- "items": {
- "$ref": "PretargetingConfig"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#pretargetingConfigList"
- }
- }
- },
- "Price": {
- "id": "Price",
- "type": "object",
- "properties": {
- "amountMicros": {
- "type": "number",
- "description": "The price value in micros.",
- "format": "double"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code for the price."
- },
- "expectedCpmMicros": {
- "type": "number",
- "description": "In case of CPD deals, the expected CPM in micros.",
- "format": "double"
- },
- "pricingType": {
- "type": "string",
- "description": "The pricing type for the deal/product."
- }
- }
- },
- "PricePerBuyer": {
- "id": "PricePerBuyer",
- "type": "object",
- "description": "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.",
- "properties": {
- "auctionTier": {
- "type": "string",
- "description": "Optional access type for this buyer."
- },
- "billedBuyer": {
- "$ref": "Buyer",
- "description": "Reference to the buyer that will get billed."
- },
- "buyer": {
- "$ref": "Buyer",
- "description": "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)."
- },
- "price": {
- "$ref": "Price",
- "description": "The specified price"
- }
- }
- },
- "PrivateData": {
- "id": "PrivateData",
- "type": "object",
- "properties": {
- "referenceId": {
- "type": "string"
- },
- "referencePayload": {
- "type": "string",
- "format": "byte"
- }
- }
- },
- "Product": {
- "id": "Product",
- "type": "object",
- "description": "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:\n\n(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.",
- "properties": {
- "billedBuyer": {
- "$ref": "Buyer",
- "description": "The billed buyer corresponding to the buyer that created the offer. (readonly, except on create)"
- },
- "buyer": {
- "$ref": "Buyer",
- "description": "The buyer that created the offer if this is a buyer initiated offer (readonly, except on create)"
- },
- "creationTimeMs": {
- "type": "string",
- "description": "Creation time in ms. since epoch (readonly)",
- "format": "int64"
- },
- "creatorContacts": {
- "type": "array",
- "description": "Optional contact information for the creator of this product. (buyer-readonly)",
- "items": {
- "$ref": "ContactInformation"
- }
- },
- "creatorRole": {
- "type": "string",
- "description": "The role that created the offer. Set to BUYER for buyer initiated offers."
- },
- "deliveryControl": {
- "$ref": "DeliveryControl",
- "description": "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."
- },
- "flightEndTimeMs": {
- "type": "string",
- "description": "The proposed end time for the deal (ms since epoch) (buyer-readonly)",
- "format": "int64"
- },
- "flightStartTimeMs": {
- "type": "string",
- "description": "Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)",
- "format": "int64"
- },
- "hasCreatorSignedOff": {
- "type": "boolean",
- "description": "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."
- },
- "inventorySource": {
- "type": "string",
- "description": "What exchange will provide this inventory (readonly, except on create)."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#product\".",
- "default": "adexchangebuyer#product"
- },
- "labels": {
- "type": "array",
- "description": "Optional List of labels for the product (optional, buyer-readonly).",
- "items": {
- "$ref": "MarketplaceLabel"
- }
- },
- "lastUpdateTimeMs": {
- "type": "string",
- "description": "Time of last update in ms. since epoch (readonly)",
- "format": "int64"
- },
- "legacyOfferId": {
- "type": "string",
- "description": "Optional legacy offer id if this offer is a preferred deal offer."
- },
- "marketplacePublisherProfileId": {
- "type": "string",
- "description": "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."
- },
- "name": {
- "type": "string",
- "description": "The name for this product as set by the seller. (buyer-readonly)"
- },
- "privateAuctionId": {
- "type": "string",
- "description": "Optional private auction id if this offer is a private auction offer."
- },
- "productId": {
- "type": "string",
- "description": "The unique id for the product (readonly)"
- },
- "publisherProfileId": {
- "type": "string",
- "description": "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."
- },
- "publisherProvidedForecast": {
- "$ref": "PublisherProvidedForecast",
- "description": "Publisher self-provided forecast information."
- },
- "revisionNumber": {
- "type": "string",
- "description": "The revision number of the product. (readonly)",
- "format": "int64"
- },
- "seller": {
- "$ref": "Seller",
- "description": "Information about the seller that created this product (readonly, except on create)"
- },
- "sharedTargetings": {
- "type": "array",
- "description": "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)",
- "items": {
- "$ref": "SharedTargeting"
- }
- },
- "state": {
- "type": "string",
- "description": "The state of the product. (buyer-readonly)"
- },
- "syndicationProduct": {
- "type": "string",
- "description": "The syndication product associated with the deal. (readonly, except on create)"
- },
- "terms": {
- "$ref": "DealTerms",
- "description": "The negotiable terms of the deal (buyer-readonly)"
- },
- "webPropertyCode": {
- "type": "string",
- "description": "The web property code for the seller. This field is meant to be copied over as is when creating deals."
- }
- }
- },
- "Proposal": {
- "id": "Proposal",
- "type": "object",
- "description": "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:\n\n(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.",
- "properties": {
- "billedBuyer": {
- "$ref": "Buyer",
- "description": "Reference to the buyer that will get billed for this proposal. (readonly)"
- },
- "buyer": {
- "$ref": "Buyer",
- "description": "Reference to the buyer on the proposal. (readonly, except on create)"
- },
- "buyerContacts": {
- "type": "array",
- "description": "Optional contact information of the buyer. (seller-readonly)",
- "items": {
- "$ref": "ContactInformation"
- }
- },
- "buyerPrivateData": {
- "$ref": "PrivateData",
- "description": "Private data for buyer. (hidden from seller)."
- },
- "dbmAdvertiserIds": {
- "type": "array",
- "description": "IDs of DBM advertisers permission to this proposal.",
- "items": {
- "type": "string"
- }
- },
- "hasBuyerSignedOff": {
- "type": "boolean",
- "description": "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)"
- },
- "hasSellerSignedOff": {
- "type": "boolean",
- "description": "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)"
- },
- "inventorySource": {
- "type": "string",
- "description": "What exchange will provide this inventory (readonly, except on create)."
- },
- "isRenegotiating": {
- "type": "boolean",
- "description": "True if the proposal is being renegotiated (readonly)."
- },
- "isSetupComplete": {
- "type": "boolean",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#proposal\".",
- "default": "adexchangebuyer#proposal"
- },
- "labels": {
- "type": "array",
- "description": "List of labels associated with the proposal. (readonly)",
- "items": {
- "$ref": "MarketplaceLabel"
- }
- },
- "lastUpdaterOrCommentorRole": {
- "type": "string",
- "description": "The role of the last user that either updated the proposal or left a comment. (readonly)"
- },
- "name": {
- "type": "string",
- "description": "The name for the proposal (updatable)"
- },
- "negotiationId": {
- "type": "string",
- "description": "Optional negotiation id if this proposal is a preferred deal proposal."
- },
- "originatorRole": {
- "type": "string",
- "description": "Indicates whether the buyer/seller created the proposal.(readonly)"
- },
- "privateAuctionId": {
- "type": "string",
- "description": "Optional private auction id if this proposal is a private auction proposal."
- },
- "proposalId": {
- "type": "string",
- "description": "The unique id of the proposal. (readonly)."
- },
- "proposalState": {
- "type": "string",
- "description": "The current state of the proposal. (readonly)"
- },
- "revisionNumber": {
- "type": "string",
- "description": "The revision number for the proposal (readonly).",
- "format": "int64"
- },
- "revisionTimeMs": {
- "type": "string",
- "description": "The time (ms since epoch) when the proposal was last revised (readonly).",
- "format": "int64"
- },
- "seller": {
- "$ref": "Seller",
- "description": "Reference to the seller on the proposal. (readonly, except on create)"
- },
- "sellerContacts": {
- "type": "array",
- "description": "Optional contact information of the seller (buyer-readonly).",
- "items": {
- "$ref": "ContactInformation"
- }
- }
- }
- },
- "PublisherProfileApiProto": {
- "id": "PublisherProfileApiProto",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Deprecated: use the seller.account_id. The account id of the seller."
- },
- "audience": {
- "type": "string",
- "description": "Publisher provided info on its audience."
- },
- "buyerPitchStatement": {
- "type": "string",
- "description": "A pitch statement for the buyer"
- },
- "directContact": {
- "type": "string",
- "description": "Direct contact for the publisher profile."
- },
- "exchange": {
- "type": "string",
- "description": "Exchange where this publisher profile is from. E.g. AdX, Rubicon etc..."
- },
- "googlePlusLink": {
- "type": "string",
- "description": "Link to publisher's Google+ page."
- },
- "isParent": {
- "type": "boolean",
- "description": "True, if this is the parent profile, which represents all domains owned by the publisher."
- },
- "isPublished": {
- "type": "boolean",
- "description": "True, if this profile is published. Deprecated for state."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#publisherProfileApiProto\".",
- "default": "adexchangebuyer#publisherProfileApiProto"
- },
- "logoUrl": {
- "type": "string",
- "description": "The url to the logo for the publisher."
- },
- "mediaKitLink": {
- "type": "string",
- "description": "The url for additional marketing and sales materials."
- },
- "name": {
- "type": "string"
- },
- "overview": {
- "type": "string",
- "description": "Publisher provided overview."
- },
- "profileId": {
- "type": "integer",
- "description": "The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher.",
- "format": "int32"
- },
- "programmaticContact": {
- "type": "string",
- "description": "Programmatic contact for the publisher profile."
- },
- "publisherDomains": {
- "type": "array",
- "description": "The list of domains represented in this publisher profile. Empty if this is a parent profile.",
- "items": {
- "type": "string"
- }
- },
- "publisherProfileId": {
- "type": "string",
- "description": "Unique Id for publisher profile."
- },
- "publisherProvidedForecast": {
- "$ref": "PublisherProvidedForecast",
- "description": "Publisher provided forecasting information."
- },
- "rateCardInfoLink": {
- "type": "string",
- "description": "Link to publisher rate card"
- },
- "samplePageLink": {
- "type": "string",
- "description": "Link for a sample content page."
- },
- "seller": {
- "$ref": "Seller",
- "description": "Seller of the publisher profile."
- },
- "state": {
- "type": "string",
- "description": "State of the publisher profile."
- },
- "topHeadlines": {
- "type": "array",
- "description": "Publisher provided key metrics and rankings.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "PublisherProvidedForecast": {
- "id": "PublisherProvidedForecast",
- "type": "object",
- "description": "This message carries publisher provided forecasting information.",
- "properties": {
- "dimensions": {
- "type": "array",
- "description": "Publisher provided dimensions. E.g. geo, sizes etc...",
- "items": {
- "$ref": "Dimension"
- }
- },
- "weeklyImpressions": {
- "type": "string",
- "description": "Publisher provided weekly impressions.",
- "format": "int64"
- },
- "weeklyUniques": {
- "type": "string",
- "description": "Publisher provided weekly uniques.",
- "format": "int64"
- }
- }
- },
- "Seller": {
- "id": "Seller",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product."
- },
- "subAccountId": {
- "type": "string",
- "description": "Optional sub-account id for the seller."
- }
- }
- },
- "SharedTargeting": {
- "id": "SharedTargeting",
- "type": "object",
- "properties": {
- "exclusions": {
- "type": "array",
- "description": "The list of values to exclude from targeting. Each value is AND'd together.",
- "items": {
- "$ref": "TargetingValue"
- }
- },
- "inclusions": {
- "type": "array",
- "description": "The list of value to include as part of the targeting. Each value is OR'd together.",
- "items": {
- "$ref": "TargetingValue"
- }
},
"key": {
- "type": "string",
- "description": "The key representing the shared targeting criterion."
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "TargetingValue": {
- "id": "TargetingValue",
- "type": "object",
- "properties": {
- "creativeSizeValue": {
- "$ref": "TargetingValueCreativeSize",
- "description": "The creative size value to exclude/include."
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Gets one account by ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the authenticated user's list of accounts.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.accounts.list",
+ "path": "accounts",
+ "response": {
+ "$ref": "AccountsList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.accounts.patch",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "confirmUnsafeAccountChange": {
+ "description": "Confirmation for erasing bidder and cookie matching urls.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing account.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.accounts.update",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "confirmUnsafeAccountChange": {
+ "description": "Confirmation for erasing bidder and cookie matching urls.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The account id",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{id}",
+ "request": {
+ "$ref": "Account"
+ },
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "dayPartTargetingValue": {
- "$ref": "TargetingValueDayPartTargeting",
- "description": "The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING."
+ "billingInfo": {
+ "methods": {
+ "get": {
+ "description": "Returns the billing information for one account specified by account ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.billingInfo.get",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "billinginfo/{accountId}",
+ "response": {
+ "$ref": "BillingInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.billingInfo.list",
+ "path": "billinginfo",
+ "response": {
+ "$ref": "BillingInfoList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "longValue": {
- "type": "string",
- "description": "The long value to exclude/include.",
- "format": "int64"
+ "budget": {
+ "methods": {
+ "get": {
+ "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.budget.get",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the budget information for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id to get the budget information for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.budget.patch",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "request": {
+ "$ref": "Budget"
+ },
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.budget.update",
+ "parameterOrder": [
+ "accountId",
+ "billingId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id associated with the budget being updated.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "billinginfo/{accountId}/{billingId}",
+ "request": {
+ "$ref": "Budget"
+ },
+ "response": {
+ "$ref": "Budget"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "stringValue": {
- "type": "string",
- "description": "The string value to exclude/include."
+ "creatives": {
+ "methods": {
+ "addDeal": {
+ "description": "Add a deal id association for the creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.addDeal",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId",
+ "dealId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "dealId": {
+ "description": "The id of the deal id to associate with this creative.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}/addDeal/{dealId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.get",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Submit a new creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.insert",
+ "path": "creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.list",
+ "parameters": {
+ "accountId": {
+ "description": "When specified, only creatives for the given account ids are returned.",
+ "format": "int32",
+ "location": "query",
+ "repeated": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "When specified, only creatives for the given buyer creative ids are returned.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "dealsStatusFilter": {
+ "description": "When specified, only creatives having the given deals status are returned.",
+ "enum": [
+ "approved",
+ "conditionally_approved",
+ "disapproved",
+ "not_checked"
+ ],
+ "enumDescriptions": [
+ "Creatives which have been approved for serving on deals.",
+ "Creatives which have been conditionally approved for serving on deals.",
+ "Creatives which have been disapproved for serving on deals.",
+ "Creatives whose deals status is not yet checked."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "openAuctionStatusFilter": {
+ "description": "When specified, only creatives having the given open auction status are returned.",
+ "enum": [
+ "approved",
+ "conditionally_approved",
+ "disapproved",
+ "not_checked"
+ ],
+ "enumDescriptions": [
+ "Creatives which have been approved for serving on the open auction.",
+ "Creatives which have been conditionally approved for serving on the open auction.",
+ "Creatives which have been disapproved for serving on the open auction.",
+ "Creatives whose open auction status is not yet checked."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "creatives",
+ "response": {
+ "$ref": "CreativesList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "listDeals": {
+ "description": "Lists the external deal ids associated with the creative.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.creatives.listDeals",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}/listDeals",
+ "response": {
+ "$ref": "CreativeDealIds"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "removeDeal": {
+ "description": "Remove a deal id associated with the creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.creatives.removeDeal",
+ "parameterOrder": [
+ "accountId",
+ "buyerCreativeId",
+ "dealId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The id for the account that will serve this creative.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "buyerCreativeId": {
+ "description": "The buyer-specific id for this creative.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "dealId": {
+ "description": "The id of the deal id to disassociate with this creative.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "creatives/{accountId}/{buyerCreativeId}/removeDeal/{dealId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "marketplacedeals": {
+ "methods": {
+ "delete": {
+ "description": "Delete the specified deals from the proposal",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplacedeals.delete",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposalId to delete deals from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/deals/delete",
+ "request": {
+ "$ref": "DeleteOrderDealsRequest"
+ },
+ "response": {
+ "$ref": "DeleteOrderDealsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Add new deals for the specified proposal",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplacedeals.insert",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "proposalId for which deals need to be added.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/deals/insert",
+ "request": {
+ "$ref": "AddOrderDealsRequest"
+ },
+ "response": {
+ "$ref": "AddOrderDealsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "List all the deals for a given proposal",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.marketplacedeals.list",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "pqlQuery": {
+ "description": "Query string to retrieve specific deals.",
+ "location": "query",
+ "type": "string"
+ },
+ "proposalId": {
+ "description": "The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/deals",
+ "response": {
+ "$ref": "GetOrderDealsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Replaces all the deals in the proposal with the passed in deals",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplacedeals.update",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposalId to edit deals on.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/deals/update",
+ "request": {
+ "$ref": "EditAllOrderDealsRequest"
+ },
+ "response": {
+ "$ref": "EditAllOrderDealsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "marketplacenotes": {
+ "methods": {
+ "insert": {
+ "description": "Add notes to the proposal",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplacenotes.insert",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposalId to add notes for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/notes/insert",
+ "request": {
+ "$ref": "AddOrderNotesRequest"
+ },
+ "response": {
+ "$ref": "AddOrderNotesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Get all the notes associated with a proposal",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.marketplacenotes.list",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "pqlQuery": {
+ "description": "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%\"",
+ "location": "query",
+ "type": "string"
+ },
+ "proposalId": {
+ "description": "The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/notes",
+ "response": {
+ "$ref": "GetOrderNotesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "marketplaceprivateauction": {
+ "methods": {
+ "updateproposal": {
+ "description": "Update a given private auction proposal",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.marketplaceprivateauction.updateproposal",
+ "parameterOrder": [
+ "privateAuctionId"
+ ],
+ "parameters": {
+ "privateAuctionId": {
+ "description": "The private auction id to be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "privateauction/{privateAuctionId}/updateproposal",
+ "request": {
+ "$ref": "UpdatePrivateAuctionProposalRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "performanceReport": {
+ "methods": {
+ "list": {
+ "description": "Retrieves the authenticated user's list of performance metrics.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.performanceReport.list",
+ "parameterOrder": [
+ "accountId",
+ "endDateTime",
+ "startDateTime"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the reports.",
+ "format": "int64",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "endDateTime": {
+ "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "startDateTime": {
+ "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "performancereport",
+ "response": {
+ "$ref": "PerformanceReportList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "pretargetingConfig": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing pretargeting config.",
+ "httpMethod": "DELETE",
+ "id": "adexchangebuyer.pretargetingConfig.delete",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to delete the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to delete.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Gets a specific pretargeting configuration",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pretargetingConfig.get",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to retrieve.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new pretargeting configuration.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.pretargetingConfig.insert",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to insert the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pretargetingConfig.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to get the pretargeting configs for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}",
+ "response": {
+ "$ref": "PretargetingConfigList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing pretargeting config. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.pretargetingConfig.patch",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to update the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to update.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing pretargeting config.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.pretargetingConfig.update",
+ "parameterOrder": [
+ "accountId",
+ "configId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account id to update the pretargeting config for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "description": "The specific id of the configuration to update.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "pretargetingconfigs/{accountId}/{configId}",
+ "request": {
+ "$ref": "PretargetingConfig"
+ },
+ "response": {
+ "$ref": "PretargetingConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "products": {
+ "methods": {
+ "get": {
+ "description": "Gets the requested product by id.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.products.get",
+ "parameterOrder": [
+ "productId"
+ ],
+ "parameters": {
+ "productId": {
+ "description": "The id for the product to get the head revision for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "products/{productId}",
+ "response": {
+ "$ref": "Product"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "search": {
+ "description": "Gets the requested product.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.products.search",
+ "parameters": {
+ "pqlQuery": {
+ "description": "The pql query used to query for products.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "products/search",
+ "response": {
+ "$ref": "GetOffersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "proposals": {
+ "methods": {
+ "get": {
+ "description": "Get a proposal given its id",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.proposals.get",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "Id of the proposal to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}",
+ "response": {
+ "$ref": "Proposal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "insert": {
+ "description": "Create the given list of proposals",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.proposals.insert",
+ "path": "proposals/insert",
+ "request": {
+ "$ref": "CreateOrdersRequest"
+ },
+ "response": {
+ "$ref": "CreateOrdersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "patch": {
+ "description": "Update the given proposal. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adexchangebuyer.proposals.patch",
+ "parameterOrder": [
+ "proposalId",
+ "revisionNumber",
+ "updateAction"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposal id to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "revisionNumber": {
+ "description": "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.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
+ "enum": [
+ "accept",
+ "cancel",
+ "propose",
+ "proposeAndAccept",
+ "unknownAction",
+ "updateNonTerms"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
+ "request": {
+ "$ref": "Proposal"
+ },
+ "response": {
+ "$ref": "Proposal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "search": {
+ "description": "Search for proposals using pql query",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.proposals.search",
+ "parameters": {
+ "pqlQuery": {
+ "description": "Query string to retrieve specific proposals.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "proposals/search",
+ "response": {
+ "$ref": "GetOrdersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "setupcomplete": {
+ "description": "Update the given proposal to indicate that setup has been completed.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer.proposals.setupcomplete",
+ "parameterOrder": [
+ "proposalId"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposal id for which the setup is complete",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/setupcomplete",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Update the given proposal",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer.proposals.update",
+ "parameterOrder": [
+ "proposalId",
+ "revisionNumber",
+ "updateAction"
+ ],
+ "parameters": {
+ "proposalId": {
+ "description": "The proposal id to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "revisionNumber": {
+ "description": "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.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
+ "enum": [
+ "accept",
+ "cancel",
+ "propose",
+ "proposeAndAccept",
+ "unknownAction",
+ "updateNonTerms"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
+ "request": {
+ "$ref": "Proposal"
+ },
+ "response": {
+ "$ref": "Proposal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "pubprofiles": {
+ "methods": {
+ "list": {
+ "description": "Gets the requested publisher profile(s) by publisher accountId.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer.pubprofiles.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The accountId of the publisher to get profiles for.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "publisher/{accountId}/profiles",
+ "response": {
+ "$ref": "GetPublisherProfilesByAccountIdResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
}
- }
},
- "TargetingValueCreativeSize": {
- "id": "TargetingValueCreativeSize",
- "type": "object",
- "properties": {
- "companionSizes": {
- "type": "array",
- "description": "For video size type, the list of companion sizes.",
- "items": {
- "$ref": "TargetingValueSize"
- }
+ "revision": "20180222",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "Configuration data for an Ad Exchange buyer account.",
+ "id": "Account",
+ "properties": {
+ "applyPretargetingToNonGuaranteedDeals": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "bidderLocation": {
+ "description": "Your bidder locations that have distinct URLs.",
+ "items": {
+ "properties": {
+ "bidProtocol": {
+ "description": "The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: \n- PROTOCOL_ADX \n- PROTOCOL_OPENRTB_2_2 \n- PROTOCOL_OPENRTB_2_3 \n- PROTOCOL_OPENRTB_2_4 \n- PROTOCOL_OPENRTB_2_5 \n- PROTOCOL_OPENRTB_PROTOBUF_2_3 \n- PROTOCOL_OPENRTB_PROTOBUF_2_4 \n- PROTOCOL_OPENRTB_PROTOBUF_2_5",
+ "type": "string"
+ },
+ "maximumQps": {
+ "description": "The maximum queries per second the Ad Exchange will send.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "region": {
+ "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL to which the Ad Exchange will send bid requests.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "cookieMatchingNid": {
+ "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.",
+ "type": "string"
+ },
+ "cookieMatchingUrl": {
+ "description": "The base URL used in cookie match requests.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "adexchangebuyer#account",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "maximumActiveCreatives": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumTotalQps": {
+ "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "numberActiveCreatives": {
+ "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
- "creativeSizeType": {
- "type": "string",
- "description": "The Creative size type."
+ "AccountsList": {
+ "description": "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.",
+ "id": "AccountsList",
+ "properties": {
+ "items": {
+ "description": "A list of accounts.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#accountsList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "nativeTemplate": {
- "type": "string",
- "description": "The native template for native ad."
+ "AddOrderDealsRequest": {
+ "id": "AddOrderDealsRequest",
+ "properties": {
+ "deals": {
+ "description": "The list of deals to add",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "proposalRevisionNumber": {
+ "description": "The last known proposal revision number.",
+ "format": "int64",
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "Indicates an optional action to take on the proposal",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "size": {
- "$ref": "TargetingValueSize",
- "description": "For regular or video creative size type, specifies the size of the creative."
+ "AddOrderDealsResponse": {
+ "id": "AddOrderDealsResponse",
+ "properties": {
+ "deals": {
+ "description": "List of deals added (in the same proposal as passed in the request)",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "proposalRevisionNumber": {
+ "description": "The updated revision number for the proposal.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "skippableAdType": {
- "type": "string",
- "description": "The skippable ad type for video size."
+ "AddOrderNotesRequest": {
+ "id": "AddOrderNotesRequest",
+ "properties": {
+ "notes": {
+ "description": "The list of notes to add.",
+ "items": {
+ "$ref": "MarketplaceNote"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AddOrderNotesResponse": {
+ "id": "AddOrderNotesResponse",
+ "properties": {
+ "notes": {
+ "items": {
+ "$ref": "MarketplaceNote"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "BillingInfo": {
+ "description": "The configuration data for an Ad Exchange billing info.",
+ "id": "BillingInfo",
+ "properties": {
+ "accountId": {
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "accountName": {
+ "description": "Account name.",
+ "type": "string"
+ },
+ "billingId": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#billingInfo",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BillingInfoList": {
+ "description": "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.",
+ "id": "BillingInfoList",
+ "properties": {
+ "items": {
+ "description": "A list of billing info relevant for your account.",
+ "items": {
+ "$ref": "BillingInfo"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#billingInfoList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Budget": {
+ "description": "The configuration data for Ad Exchange RTB - Budget API.",
+ "id": "Budget",
+ "properties": {
+ "accountId": {
+ "description": "The id of the account. This is required for get and update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "billingId": {
+ "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "budgetAmount": {
+ "description": "The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The currency code for the buyer. This cannot be altered here.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique id that describes this item.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#budget",
+ "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Buyer": {
+ "id": "Buyer",
+ "properties": {
+ "accountId": {
+ "description": "Adx account id of the buyer.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContactInformation": {
+ "id": "ContactInformation",
+ "properties": {
+ "email": {
+ "description": "Email address of the contact.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the contact.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateOrdersRequest": {
+ "id": "CreateOrdersRequest",
+ "properties": {
+ "proposals": {
+ "description": "The list of proposals to create.",
+ "items": {
+ "$ref": "Proposal"
+ },
+ "type": "array"
+ },
+ "webPropertyCode": {
+ "description": "Web property id of the seller creating these orders",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateOrdersResponse": {
+ "id": "CreateOrdersResponse",
+ "properties": {
+ "proposals": {
+ "description": "The list of proposals successfully created.",
+ "items": {
+ "$ref": "Proposal"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Creative": {
+ "description": "A creative and its classification data.",
+ "id": "Creative",
+ "properties": {
+ "HTMLSnippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.",
+ "type": "string"
+ },
+ "accountId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Account id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "adChoicesDestinationUrl": {
+ "description": "The link to the Ad Preferences page. This is only supported for native ads.",
+ "type": "string"
+ },
+ "advertiserId": {
+ "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "advertiserName": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The name of the company being advertised in the creative. The value provided must exist in the advertisers.txt file.",
+ "type": "string"
+ },
+ "agencyId": {
+ "description": "The agency id for this creative.",
+ "format": "int64",
+ "type": "string"
+ },
+ "apiUploadTimestamp": {
+ "description": "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).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "attribute": {
+ "description": "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.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "buyerCreativeId": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "A buyer-specific id identifying the creative in this ad.",
+ "type": "string"
+ },
+ "clickThroughUrl": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "The set of destination urls for the snippet.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "corrections": {
+ "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "properties": {
+ "contexts": {
+ "description": "All known serving contexts containing serving status information.",
+ "items": {
+ "properties": {
+ "auctionType": {
+ "description": "Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "contextType": {
+ "description": "The type of context (e.g., location, platform, auction type, SSL-ness).",
+ "type": "string"
+ },
+ "geoCriteriaId": {
+ "description": "Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "platform": {
+ "description": "Only set when contextType=PLATFORM. Represents the platforms this correction applies to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "details": {
+ "description": "Additional details about the correction.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The type of correction that was applied to the creative.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "dealsStatus": {
+ "description": "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.",
+ "type": "string"
+ },
+ "detectedDomains": {
+ "description": "Detected domains for this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filteringReasons": {
+ "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
+ "properties": {
+ "date": {
+ "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.",
+ "type": "string"
+ },
+ "reasons": {
+ "description": "The filtering reasons.",
+ "items": {
+ "properties": {
+ "filteringCount": {
+ "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
+ "format": "int64",
+ "type": "string"
+ },
+ "filteringStatus": {
+ "description": "The filtering status code as defined in creative-status-codes.txt.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "height": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad height.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionTrackingUrl": {
+ "description": "The set of urls to be called to record an impression.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creative",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "languages": {
+ "description": "Detected languages for this creative. Read-only. This field should not be set in requests.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "nativeAd": {
+ "description": "If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)",
+ "properties": {
+ "advertiser": {
+ "type": "string"
+ },
+ "appIcon": {
+ "description": "The app icon, for app download ads.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "body": {
+ "description": "A long description of the ad.",
+ "type": "string"
+ },
+ "callToAction": {
+ "description": "A label for the button that the user is supposed to click.",
+ "type": "string"
+ },
+ "clickLinkUrl": {
+ "description": "The URL that the browser/SDK will load when the user clicks the ad.",
+ "type": "string"
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "A short title for the ad.",
+ "type": "string"
+ },
+ "image": {
+ "description": "A large image.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "impressionTrackingUrl": {
+ "description": "The URLs are called when the impression is rendered.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logo": {
+ "description": "A smaller image, for the advertiser logo.",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "price": {
+ "description": "The price of the promoted app including the currency info.",
+ "type": "string"
+ },
+ "starRating": {
+ "description": "The app rating in the app store. Must be in the range [0-5].",
+ "format": "double",
+ "type": "number"
+ },
+ "store": {
+ "description": "The URL to the app store to purchase/download the promoted app.",
+ "type": "string"
+ },
+ "videoURL": {
+ "description": "The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "openAuctionStatus": {
+ "description": "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.",
+ "type": "string"
+ },
+ "productCategories": {
+ "description": "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.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "restrictedCategories": {
+ "description": "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.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "sensitiveCategories": {
+ "description": "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.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "servingRestrictions": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "contexts": {
+ "description": "All known contexts/restrictions.",
+ "items": {
+ "properties": {
+ "auctionType": {
+ "description": "Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "contextType": {
+ "description": "The type of context (e.g., location, platform, auction type, SSL-ness).",
+ "type": "string"
+ },
+ "geoCriteriaId": {
+ "description": "Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "platform": {
+ "description": "Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "disapprovalReasons": {
+ "description": "The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.",
+ "items": {
+ "properties": {
+ "details": {
+ "description": "Additional details about the reason for disapproval.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "The categorized reason for disapproval.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "reason": {
+ "description": "Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "vendorType": {
+ "description": "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.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "version": {
+ "description": "The version for this creative. Read-only. This field should not be set in requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "videoURL": {
+ "description": "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.",
+ "type": "string"
+ },
+ "videoVastXML": {
+ "description": "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.",
+ "type": "string"
+ },
+ "width": {
+ "annotations": {
+ "required": [
+ "adexchangebuyer.creatives.insert"
+ ]
+ },
+ "description": "Ad width.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeDealIds": {
+ "description": "The external deal ids associated with a creative.",
+ "id": "CreativeDealIds",
+ "properties": {
+ "dealStatuses": {
+ "description": "A list of external deal ids and ARC approval status.",
+ "items": {
+ "properties": {
+ "arcStatus": {
+ "description": "ARC approval status.",
+ "type": "string"
+ },
+ "dealId": {
+ "description": "External deal ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Publisher ID.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creativeDealIds",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativesList": {
+ "description": "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.",
+ "id": "CreativesList",
+ "properties": {
+ "items": {
+ "description": "A list of creatives.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#creativesList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DealServingMetadata": {
+ "id": "DealServingMetadata",
+ "properties": {
+ "alcoholAdsAllowed": {
+ "description": "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",
+ "type": "boolean"
+ },
+ "dealPauseStatus": {
+ "$ref": "DealServingMetadataDealPauseStatus",
+ "description": "Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)"
+ }
+ },
+ "type": "object"
+ },
+ "DealServingMetadataDealPauseStatus": {
+ "description": "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.",
+ "id": "DealServingMetadataDealPauseStatus",
+ "properties": {
+ "buyerPauseReason": {
+ "type": "string"
+ },
+ "firstPausedBy": {
+ "description": "If the deal is paused, records which party paused the deal first.",
+ "type": "string"
+ },
+ "hasBuyerPaused": {
+ "type": "boolean"
+ },
+ "hasSellerPaused": {
+ "type": "boolean"
+ },
+ "sellerPauseReason": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DealTerms": {
+ "id": "DealTerms",
+ "properties": {
+ "brandingType": {
+ "description": "Visibilty of the URL in bid requests.",
+ "type": "string"
+ },
+ "crossListedExternalDealIdType": {
+ "description": "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.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description for the proposed terms of the deal.",
+ "type": "string"
+ },
+ "estimatedGrossSpend": {
+ "$ref": "Price",
+ "description": "Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller."
+ },
+ "estimatedImpressionsPerDay": {
+ "description": "Non-binding estimate of the impressions served per day Can be set by buyer or seller.",
+ "format": "int64",
+ "type": "string"
+ },
+ "guaranteedFixedPriceTerms": {
+ "$ref": "DealTermsGuaranteedFixedPriceTerms",
+ "description": "The terms for guaranteed fixed price deals."
+ },
+ "nonGuaranteedAuctionTerms": {
+ "$ref": "DealTermsNonGuaranteedAuctionTerms",
+ "description": "The terms for non-guaranteed auction deals."
+ },
+ "nonGuaranteedFixedPriceTerms": {
+ "$ref": "DealTermsNonGuaranteedFixedPriceTerms",
+ "description": "The terms for non-guaranteed fixed price deals."
+ },
+ "rubiconNonGuaranteedTerms": {
+ "$ref": "DealTermsRubiconNonGuaranteedTerms",
+ "description": "The terms for rubicon non-guaranteed deals."
+ },
+ "sellerTimeZone": {
+ "description": "For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsGuaranteedFixedPriceTerms": {
+ "id": "DealTermsGuaranteedFixedPriceTerms",
+ "properties": {
+ "billingInfo": {
+ "$ref": "DealTermsGuaranteedFixedPriceTermsBillingInfo",
+ "description": "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."
+ },
+ "fixedPrices": {
+ "description": "Fixed price for the specified buyer.",
+ "items": {
+ "$ref": "PricePerBuyer"
+ },
+ "type": "array"
+ },
+ "guaranteedImpressions": {
+ "description": "Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.",
+ "format": "int64",
+ "type": "string"
+ },
+ "guaranteedLooks": {
+ "description": "Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.",
+ "format": "int64",
+ "type": "string"
+ },
+ "minimumDailyLooks": {
+ "description": "Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsGuaranteedFixedPriceTermsBillingInfo": {
+ "id": "DealTermsGuaranteedFixedPriceTermsBillingInfo",
+ "properties": {
+ "currencyConversionTimeMs": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dfpLineItemId": {
+ "description": "The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.",
+ "format": "int64",
+ "type": "string"
+ },
+ "originalContractedQuantity": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "The original reservation price for the deal, if the currency code is different from the one used in negotiation."
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsNonGuaranteedAuctionTerms": {
+ "id": "DealTermsNonGuaranteedAuctionTerms",
+ "properties": {
+ "autoOptimizePrivateAuction": {
+ "description": "True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).",
+ "type": "boolean"
+ },
+ "reservePricePerBuyers": {
+ "description": "Reserve price for the specified buyer.",
+ "items": {
+ "$ref": "PricePerBuyer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsNonGuaranteedFixedPriceTerms": {
+ "id": "DealTermsNonGuaranteedFixedPriceTerms",
+ "properties": {
+ "fixedPrices": {
+ "description": "Fixed price for the specified buyer.",
+ "items": {
+ "$ref": "PricePerBuyer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DealTermsRubiconNonGuaranteedTerms": {
+ "id": "DealTermsRubiconNonGuaranteedTerms",
+ "properties": {
+ "priorityPrice": {
+ "$ref": "Price",
+ "description": "Optional price for Rubicon priority access in the auction."
+ },
+ "standardPrice": {
+ "$ref": "Price",
+ "description": "Optional price for Rubicon standard access in the auction."
+ }
+ },
+ "type": "object"
+ },
+ "DeleteOrderDealsRequest": {
+ "id": "DeleteOrderDealsRequest",
+ "properties": {
+ "dealIds": {
+ "description": "List of deals to delete for a given proposal",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "proposalRevisionNumber": {
+ "description": "The last known proposal revision number.",
+ "format": "int64",
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "Indicates an optional action to take on the proposal",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeleteOrderDealsResponse": {
+ "id": "DeleteOrderDealsResponse",
+ "properties": {
+ "deals": {
+ "description": "List of deals deleted (in the same proposal as passed in the request)",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "proposalRevisionNumber": {
+ "description": "The updated revision number for the proposal.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeliveryControl": {
+ "id": "DeliveryControl",
+ "properties": {
+ "creativeBlockingLevel": {
+ "type": "string"
+ },
+ "deliveryRateType": {
+ "type": "string"
+ },
+ "frequencyCaps": {
+ "items": {
+ "$ref": "DeliveryControlFrequencyCap"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DeliveryControlFrequencyCap": {
+ "id": "DeliveryControlFrequencyCap",
+ "properties": {
+ "maxImpressions": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "numTimeUnits": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "timeUnitType": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Dimension": {
+ "description": "This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}",
+ "id": "Dimension",
+ "properties": {
+ "dimensionType": {
+ "type": "string"
+ },
+ "dimensionValues": {
+ "items": {
+ "$ref": "DimensionDimensionValue"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionDimensionValue": {
+ "description": "Value of the dimension.",
+ "id": "DimensionDimensionValue",
+ "properties": {
+ "id": {
+ "description": "Id of the dimension.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids.",
+ "type": "string"
+ },
+ "percentage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "EditAllOrderDealsRequest": {
+ "id": "EditAllOrderDealsRequest",
+ "properties": {
+ "deals": {
+ "description": "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.",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "proposal": {
+ "$ref": "Proposal",
+ "description": "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."
+ },
+ "proposalRevisionNumber": {
+ "description": "The last known revision number for the proposal.",
+ "format": "int64",
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "Indicates an optional action to take on the proposal",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EditAllOrderDealsResponse": {
+ "id": "EditAllOrderDealsResponse",
+ "properties": {
+ "deals": {
+ "description": "List of all deals in the proposal after edit.",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ },
+ "orderRevisionNumber": {
+ "description": "The latest revision number after the update has been applied.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GetOffersResponse": {
+ "id": "GetOffersResponse",
+ "properties": {
+ "products": {
+ "description": "The returned list of products.",
+ "items": {
+ "$ref": "Product"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetOrderDealsResponse": {
+ "id": "GetOrderDealsResponse",
+ "properties": {
+ "deals": {
+ "description": "List of deals for the proposal",
+ "items": {
+ "$ref": "MarketplaceDeal"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetOrderNotesResponse": {
+ "id": "GetOrderNotesResponse",
+ "properties": {
+ "notes": {
+ "description": "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.",
+ "items": {
+ "$ref": "MarketplaceNote"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetOrdersResponse": {
+ "id": "GetOrdersResponse",
+ "properties": {
+ "proposals": {
+ "description": "The list of matching proposals.",
+ "items": {
+ "$ref": "Proposal"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetPublisherProfilesByAccountIdResponse": {
+ "id": "GetPublisherProfilesByAccountIdResponse",
+ "properties": {
+ "profiles": {
+ "description": "Profiles for the requested publisher",
+ "items": {
+ "$ref": "PublisherProfileApiProto"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MarketplaceDeal": {
+ "description": "A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.",
+ "id": "MarketplaceDeal",
+ "properties": {
+ "buyerPrivateData": {
+ "$ref": "PrivateData",
+ "description": "Buyer private data (hidden from seller)."
+ },
+ "creationTimeMs": {
+ "description": "The time (ms since epoch) of the deal creation. (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "creativePreApprovalPolicy": {
+ "description": "Specifies the creative pre-approval policy (buyer-readonly)",
+ "type": "string"
+ },
+ "creativeSafeFrameCompatibility": {
+ "description": "Specifies whether the creative is safeFrame compatible (buyer-readonly)",
+ "type": "string"
+ },
+ "dealId": {
+ "description": "A unique deal-id for the deal (readonly).",
+ "type": "string"
+ },
+ "dealServingMetadata": {
+ "$ref": "DealServingMetadata",
+ "description": "Metadata about the serving status of this deal (readonly, writes via custom actions)"
+ },
+ "deliveryControl": {
+ "$ref": "DeliveryControl",
+ "description": "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."
+ },
+ "externalDealId": {
+ "description": "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)",
+ "type": "string"
+ },
+ "flightEndTimeMs": {
+ "description": "Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
+ "format": "int64",
+ "type": "string"
+ },
+ "flightStartTimeMs": {
+ "description": "Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
+ "format": "int64",
+ "type": "string"
+ },
+ "inventoryDescription": {
+ "description": "Description for the deal terms. (buyer-readonly)",
+ "type": "string"
+ },
+ "isRfpTemplate": {
+ "description": "Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.",
+ "type": "boolean"
+ },
+ "isSetupComplete": {
+ "description": "True, if the buyside inventory setup is complete for this deal. (readonly, except via OrderSetupCompleted action)",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#marketplaceDeal",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceDeal\".",
+ "type": "string"
+ },
+ "lastUpdateTimeMs": {
+ "description": "The time (ms since epoch) when the deal was last updated. (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the deal. (updatable)",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The product-id from which this deal was created. (readonly, except on create)",
+ "type": "string"
+ },
+ "productRevisionNumber": {
+ "description": "The revision number of the product that the deal was created from (readonly, except on create)",
+ "format": "int64",
+ "type": "string"
+ },
+ "programmaticCreativeSource": {
+ "description": "Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)",
+ "type": "string"
+ },
+ "proposalId": {
+ "type": "string"
+ },
+ "sellerContacts": {
+ "description": "Optional Seller contact information for the deal (buyer-readonly)",
+ "items": {
+ "$ref": "ContactInformation"
+ },
+ "type": "array"
+ },
+ "sharedTargetings": {
+ "description": "The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)",
+ "items": {
+ "$ref": "SharedTargeting"
+ },
+ "type": "array"
+ },
+ "syndicationProduct": {
+ "description": "The syndication product associated with the deal. (readonly, except on create)",
+ "type": "string"
+ },
+ "terms": {
+ "$ref": "DealTerms",
+ "description": "The negotiable terms of the deal. (updatable)"
+ },
+ "webPropertyCode": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MarketplaceDealParty": {
+ "id": "MarketplaceDealParty",
+ "properties": {
+ "buyer": {
+ "$ref": "Buyer",
+ "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party."
+ },
+ "seller": {
+ "$ref": "Seller",
+ "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party."
+ }
+ },
+ "type": "object"
+ },
+ "MarketplaceLabel": {
+ "id": "MarketplaceLabel",
+ "properties": {
+ "accountId": {
+ "description": "The accountId of the party that created the label.",
+ "type": "string"
+ },
+ "createTimeMs": {
+ "description": "The creation time (in ms since epoch) for the label.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deprecatedMarketplaceDealParty": {
+ "$ref": "MarketplaceDealParty",
+ "description": "Information about the party that created the label."
+ },
+ "label": {
+ "description": "The label to use.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MarketplaceNote": {
+ "description": "A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.",
+ "id": "MarketplaceNote",
+ "properties": {
+ "creatorRole": {
+ "description": "The role of the person (buyer/seller) creating the note. (readonly)",
+ "type": "string"
+ },
+ "dealId": {
+ "description": "Notes can optionally be associated with a deal. (readonly, except on create)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#marketplaceNote",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceNote\".",
+ "type": "string"
+ },
+ "note": {
+ "description": "The actual note to attach. (readonly, except on create)",
+ "type": "string"
+ },
+ "noteId": {
+ "description": "The unique id for the note. (readonly)",
+ "type": "string"
+ },
+ "proposalId": {
+ "description": "The proposalId that a note is attached to. (readonly)",
+ "type": "string"
+ },
+ "proposalRevisionNumber": {
+ "description": "If the note is associated with a proposal revision number, then store that here. (readonly, except on create)",
+ "format": "int64",
+ "type": "string"
+ },
+ "timestampMs": {
+ "description": "The timestamp (ms since epoch) that this note was created. (readonly)",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PerformanceReport": {
+ "description": "The configuration data for an Ad Exchange performance report list.",
+ "id": "PerformanceReport",
+ "properties": {
+ "bidRate": {
+ "description": "The number of bid responses with an ad.",
+ "format": "double",
+ "type": "number"
+ },
+ "bidRequestRate": {
+ "description": "The number of bid requests sent to your bidder.",
+ "format": "double",
+ "type": "number"
+ },
+ "calloutStatusRate": {
+ "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "cookieMatcherStatusRate": {
+ "description": "Average QPS for cookie matcher operations.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "creativeStatusRate": {
+ "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "filteredBidRate": {
+ "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
+ "format": "double",
+ "type": "number"
+ },
+ "hostedMatchStatusRate": {
+ "description": "Average QPS for hosted match operations.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "inventoryMatchRate": {
+ "description": "The number of potential queries based on your pretargeting settings.",
+ "format": "double",
+ "type": "number"
+ },
+ "kind": {
+ "default": "adexchangebuyer#performanceReport",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "latency50thPercentile": {
+ "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "latency85thPercentile": {
+ "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "latency95thPercentile": {
+ "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
+ "format": "double",
+ "type": "number"
+ },
+ "noQuotaInRegion": {
+ "description": "Rate of various quota account statuses per quota check.",
+ "format": "double",
+ "type": "number"
+ },
+ "outOfQuota": {
+ "description": "Rate of various quota account statuses per quota check.",
+ "format": "double",
+ "type": "number"
+ },
+ "pixelMatchRequests": {
+ "description": "Average QPS for pixel match requests from clients.",
+ "format": "double",
+ "type": "number"
+ },
+ "pixelMatchResponses": {
+ "description": "Average QPS for pixel match responses from clients.",
+ "format": "double",
+ "type": "number"
+ },
+ "quotaConfiguredLimit": {
+ "description": "The configured quota limits for this account.",
+ "format": "double",
+ "type": "number"
+ },
+ "quotaThrottledLimit": {
+ "description": "The throttled quota limits for this account.",
+ "format": "double",
+ "type": "number"
+ },
+ "region": {
+ "description": "The trading location of this data.",
+ "type": "string"
+ },
+ "successfulRequestRate": {
+ "description": "The number of properly formed bid responses received by our servers within the deadline.",
+ "format": "double",
+ "type": "number"
+ },
+ "timestamp": {
+ "description": "The unix timestamp of the starting time of this performance data.",
+ "format": "int64",
+ "type": "string"
+ },
+ "unsuccessfulRequestRate": {
+ "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "PerformanceReportList": {
+ "description": "The configuration data for an Ad Exchange performance report list.",
+ "id": "PerformanceReportList",
+ "properties": {
+ "kind": {
+ "default": "adexchangebuyer#performanceReportList",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "performanceReport": {
+ "description": "A list of performance reports relevant for the account.",
+ "items": {
+ "$ref": "PerformanceReport"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PretargetingConfig": {
+ "id": "PretargetingConfig",
+ "properties": {
+ "billingId": {
+ "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configId": {
+ "description": "The config id; generated automatically. Leave this field blank for insert requests.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configName": {
+ "description": "The name of the config. Must be unique. Required for all requests.",
+ "type": "string"
+ },
+ "creativeType": {
+ "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
+ "items": {
+ "properties": {
+ "height": {
+ "description": "Height in pixels.",
+ "format": "int64",
+ "type": "string"
+ },
+ "width": {
+ "description": "Width in pixels.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "excludedContentLabels": {
+ "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedGeoCriteriaIds": {
+ "description": "Requests containing any of these geo criteria ids will not match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedPlacements": {
+ "description": "Requests containing any of these placements will not match.",
+ "items": {
+ "properties": {
+ "token": {
+ "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the placement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "excludedUserLists": {
+ "description": "Requests containing any of these users list ids will not match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedVerticals": {
+ "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "geoCriteriaIds": {
+ "description": "Requests containing any of these geo criteria ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "isActive": {
+ "description": "Whether this config is active. Required for all requests.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#pretargetingConfig",
+ "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
+ "type": "string"
+ },
+ "languages": {
+ "description": "Request containing any of these language codes will match.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "minimumViewabilityDecile": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "mobileCarriers": {
+ "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileDevices": {
+ "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileOperatingSystemVersions": {
+ "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "placements": {
+ "description": "Requests containing any of these placements will match.",
+ "items": {
+ "properties": {
+ "token": {
+ "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the placement.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "platforms": {
+ "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportedCreativeAttributes": {
+ "description": "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.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "userIdentifierDataRequired": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "userLists": {
+ "description": "Requests containing any of these user list ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "vendorTypes": {
+ "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "verticals": {
+ "description": "Requests containing any of these vertical ids will match.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "videoPlayerSizes": {
+ "description": "Video requests satisfying any of these player size constraints will match.",
+ "items": {
+ "properties": {
+ "aspectRatio": {
+ "description": "The type of aspect ratio. Leave this field blank to match all aspect ratios.",
+ "type": "string"
+ },
+ "minHeight": {
+ "description": "The minimum player height in pixels. Leave this field blank to match any player height.",
+ "format": "int64",
+ "type": "string"
+ },
+ "minWidth": {
+ "description": "The minimum player width in pixels. Leave this field blank to match any player width.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PretargetingConfigList": {
+ "id": "PretargetingConfigList",
+ "properties": {
+ "items": {
+ "description": "A list of pretargeting configs",
+ "items": {
+ "$ref": "PretargetingConfig"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangebuyer#pretargetingConfigList",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Price": {
+ "id": "Price",
+ "properties": {
+ "amountMicros": {
+ "description": "The price value in micros.",
+ "format": "double",
+ "type": "number"
+ },
+ "currencyCode": {
+ "description": "The currency code for the price.",
+ "type": "string"
+ },
+ "expectedCpmMicros": {
+ "description": "In case of CPD deals, the expected CPM in micros.",
+ "format": "double",
+ "type": "number"
+ },
+ "pricingType": {
+ "description": "The pricing type for the deal/product.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PricePerBuyer": {
+ "description": "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.",
+ "id": "PricePerBuyer",
+ "properties": {
+ "auctionTier": {
+ "description": "Optional access type for this buyer.",
+ "type": "string"
+ },
+ "billedBuyer": {
+ "$ref": "Buyer",
+ "description": "Reference to the buyer that will get billed."
+ },
+ "buyer": {
+ "$ref": "Buyer",
+ "description": "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)."
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "The specified price"
+ }
+ },
+ "type": "object"
+ },
+ "PrivateData": {
+ "id": "PrivateData",
+ "properties": {
+ "referenceId": {
+ "type": "string"
+ },
+ "referencePayload": {
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Product": {
+ "description": "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:\n\n(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.",
+ "id": "Product",
+ "properties": {
+ "billedBuyer": {
+ "$ref": "Buyer",
+ "description": "The billed buyer corresponding to the buyer that created the offer. (readonly, except on create)"
+ },
+ "buyer": {
+ "$ref": "Buyer",
+ "description": "The buyer that created the offer if this is a buyer initiated offer (readonly, except on create)"
+ },
+ "creationTimeMs": {
+ "description": "Creation time in ms. since epoch (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "creatorContacts": {
+ "description": "Optional contact information for the creator of this product. (buyer-readonly)",
+ "items": {
+ "$ref": "ContactInformation"
+ },
+ "type": "array"
+ },
+ "creatorRole": {
+ "description": "The role that created the offer. Set to BUYER for buyer initiated offers.",
+ "type": "string"
+ },
+ "deliveryControl": {
+ "$ref": "DeliveryControl",
+ "description": "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."
+ },
+ "flightEndTimeMs": {
+ "description": "The proposed end time for the deal (ms since epoch) (buyer-readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "flightStartTimeMs": {
+ "description": "Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "hasCreatorSignedOff": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "inventorySource": {
+ "description": "What exchange will provide this inventory (readonly, except on create).",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangebuyer#product",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#product\".",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Optional List of labels for the product (optional, buyer-readonly).",
+ "items": {
+ "$ref": "MarketplaceLabel"
+ },
+ "type": "array"
+ },
+ "lastUpdateTimeMs": {
+ "description": "Time of last update in ms. since epoch (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "legacyOfferId": {
+ "description": "Optional legacy offer id if this offer is a preferred deal offer.",
+ "type": "string"
+ },
+ "marketplacePublisherProfileId": {
+ "description": "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.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name for this product as set by the seller. (buyer-readonly)",
+ "type": "string"
+ },
+ "privateAuctionId": {
+ "description": "Optional private auction id if this offer is a private auction offer.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The unique id for the product (readonly)",
+ "type": "string"
+ },
+ "publisherProfileId": {
+ "description": "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.",
+ "type": "string"
+ },
+ "publisherProvidedForecast": {
+ "$ref": "PublisherProvidedForecast",
+ "description": "Publisher self-provided forecast information."
+ },
+ "revisionNumber": {
+ "description": "The revision number of the product. (readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "seller": {
+ "$ref": "Seller",
+ "description": "Information about the seller that created this product (readonly, except on create)"
+ },
+ "sharedTargetings": {
+ "description": "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)",
+ "items": {
+ "$ref": "SharedTargeting"
+ },
+ "type": "array"
+ },
+ "state": {
+ "description": "The state of the product. (buyer-readonly)",
+ "type": "string"
+ },
+ "syndicationProduct": {
+ "description": "The syndication product associated with the deal. (readonly, except on create)",
+ "type": "string"
+ },
+ "terms": {
+ "$ref": "DealTerms",
+ "description": "The negotiable terms of the deal (buyer-readonly)"
+ },
+ "webPropertyCode": {
+ "description": "The web property code for the seller. This field is meant to be copied over as is when creating deals.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Proposal": {
+ "description": "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:\n\n(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.",
+ "id": "Proposal",
+ "properties": {
+ "billedBuyer": {
+ "$ref": "Buyer",
+ "description": "Reference to the buyer that will get billed for this proposal. (readonly)"
+ },
+ "buyer": {
+ "$ref": "Buyer",
+ "description": "Reference to the buyer on the proposal. (readonly, except on create)"
+ },
+ "buyerContacts": {
+ "description": "Optional contact information of the buyer. (seller-readonly)",
+ "items": {
+ "$ref": "ContactInformation"
+ },
+ "type": "array"
+ },
+ "buyerPrivateData": {
+ "$ref": "PrivateData",
+ "description": "Private data for buyer. (hidden from seller)."
+ },
+ "dbmAdvertiserIds": {
+ "description": "IDs of DBM advertisers permission to this proposal.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "hasBuyerSignedOff": {
+ "description": "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)",
+ "type": "boolean"
+ },
+ "hasSellerSignedOff": {
+ "description": "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)",
+ "type": "boolean"
+ },
+ "inventorySource": {
+ "description": "What exchange will provide this inventory (readonly, except on create).",
+ "type": "string"
+ },
+ "isRenegotiating": {
+ "description": "True if the proposal is being renegotiated (readonly).",
+ "type": "boolean"
+ },
+ "isSetupComplete": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#proposal",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#proposal\".",
+ "type": "string"
+ },
+ "labels": {
+ "description": "List of labels associated with the proposal. (readonly)",
+ "items": {
+ "$ref": "MarketplaceLabel"
+ },
+ "type": "array"
+ },
+ "lastUpdaterOrCommentorRole": {
+ "description": "The role of the last user that either updated the proposal or left a comment. (readonly)",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name for the proposal (updatable)",
+ "type": "string"
+ },
+ "negotiationId": {
+ "description": "Optional negotiation id if this proposal is a preferred deal proposal.",
+ "type": "string"
+ },
+ "originatorRole": {
+ "description": "Indicates whether the buyer/seller created the proposal.(readonly)",
+ "type": "string"
+ },
+ "privateAuctionId": {
+ "description": "Optional private auction id if this proposal is a private auction proposal.",
+ "type": "string"
+ },
+ "proposalId": {
+ "description": "The unique id of the proposal. (readonly).",
+ "type": "string"
+ },
+ "proposalState": {
+ "description": "The current state of the proposal. (readonly)",
+ "type": "string"
+ },
+ "revisionNumber": {
+ "description": "The revision number for the proposal (readonly).",
+ "format": "int64",
+ "type": "string"
+ },
+ "revisionTimeMs": {
+ "description": "The time (ms since epoch) when the proposal was last revised (readonly).",
+ "format": "int64",
+ "type": "string"
+ },
+ "seller": {
+ "$ref": "Seller",
+ "description": "Reference to the seller on the proposal. (readonly, except on create)"
+ },
+ "sellerContacts": {
+ "description": "Optional contact information of the seller (buyer-readonly).",
+ "items": {
+ "$ref": "ContactInformation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PublisherProfileApiProto": {
+ "id": "PublisherProfileApiProto",
+ "properties": {
+ "accountId": {
+ "description": "Deprecated: use the seller.account_id. The account id of the seller.",
+ "type": "string"
+ },
+ "audience": {
+ "description": "Publisher provided info on its audience.",
+ "type": "string"
+ },
+ "buyerPitchStatement": {
+ "description": "A pitch statement for the buyer",
+ "type": "string"
+ },
+ "directContact": {
+ "description": "Direct contact for the publisher profile.",
+ "type": "string"
+ },
+ "exchange": {
+ "description": "Exchange where this publisher profile is from. E.g. AdX, Rubicon etc...",
+ "type": "string"
+ },
+ "googlePlusLink": {
+ "description": "Link to publisher's Google+ page.",
+ "type": "string"
+ },
+ "isParent": {
+ "description": "True, if this is the parent profile, which represents all domains owned by the publisher.",
+ "type": "boolean"
+ },
+ "isPublished": {
+ "description": "True, if this profile is published. Deprecated for state.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adexchangebuyer#publisherProfileApiProto",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#publisherProfileApiProto\".",
+ "type": "string"
+ },
+ "logoUrl": {
+ "description": "The url to the logo for the publisher.",
+ "type": "string"
+ },
+ "mediaKitLink": {
+ "description": "The url for additional marketing and sales materials.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "overview": {
+ "description": "Publisher provided overview.",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "programmaticContact": {
+ "description": "Programmatic contact for the publisher profile.",
+ "type": "string"
+ },
+ "publisherDomains": {
+ "description": "The list of domains represented in this publisher profile. Empty if this is a parent profile.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "publisherProfileId": {
+ "description": "Unique Id for publisher profile.",
+ "type": "string"
+ },
+ "publisherProvidedForecast": {
+ "$ref": "PublisherProvidedForecast",
+ "description": "Publisher provided forecasting information."
+ },
+ "rateCardInfoLink": {
+ "description": "Link to publisher rate card",
+ "type": "string"
+ },
+ "samplePageLink": {
+ "description": "Link for a sample content page.",
+ "type": "string"
+ },
+ "seller": {
+ "$ref": "Seller",
+ "description": "Seller of the publisher profile."
+ },
+ "state": {
+ "description": "State of the publisher profile.",
+ "type": "string"
+ },
+ "topHeadlines": {
+ "description": "Publisher provided key metrics and rankings.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PublisherProvidedForecast": {
+ "description": "This message carries publisher provided forecasting information.",
+ "id": "PublisherProvidedForecast",
+ "properties": {
+ "dimensions": {
+ "description": "Publisher provided dimensions. E.g. geo, sizes etc...",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "weeklyImpressions": {
+ "description": "Publisher provided weekly impressions.",
+ "format": "int64",
+ "type": "string"
+ },
+ "weeklyUniques": {
+ "description": "Publisher provided weekly uniques.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Seller": {
+ "id": "Seller",
+ "properties": {
+ "accountId": {
+ "description": "The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.",
+ "type": "string"
+ },
+ "subAccountId": {
+ "description": "Optional sub-account id for the seller.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SharedTargeting": {
+ "id": "SharedTargeting",
+ "properties": {
+ "exclusions": {
+ "description": "The list of values to exclude from targeting. Each value is AND'd together.",
+ "items": {
+ "$ref": "TargetingValue"
+ },
+ "type": "array"
+ },
+ "inclusions": {
+ "description": "The list of value to include as part of the targeting. Each value is OR'd together.",
+ "items": {
+ "$ref": "TargetingValue"
+ },
+ "type": "array"
+ },
+ "key": {
+ "description": "The key representing the shared targeting criterion.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingValue": {
+ "id": "TargetingValue",
+ "properties": {
+ "creativeSizeValue": {
+ "$ref": "TargetingValueCreativeSize",
+ "description": "The creative size value to exclude/include."
+ },
+ "dayPartTargetingValue": {
+ "$ref": "TargetingValueDayPartTargeting",
+ "description": "The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING."
+ },
+ "demogAgeCriteriaValue": {
+ "$ref": "TargetingValueDemogAgeCriteria"
+ },
+ "demogGenderCriteriaValue": {
+ "$ref": "TargetingValueDemogGenderCriteria"
+ },
+ "longValue": {
+ "description": "The long value to exclude/include.",
+ "format": "int64",
+ "type": "string"
+ },
+ "stringValue": {
+ "description": "The string value to exclude/include.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingValueCreativeSize": {
+ "description": "Next Id: 7",
+ "id": "TargetingValueCreativeSize",
+ "properties": {
+ "allowedFormats": {
+ "description": "The formats allowed by the publisher.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "companionSizes": {
+ "description": "For video size type, the list of companion sizes.",
+ "items": {
+ "$ref": "TargetingValueSize"
+ },
+ "type": "array"
+ },
+ "creativeSizeType": {
+ "description": "The Creative size type.",
+ "type": "string"
+ },
+ "nativeTemplate": {
+ "description": "The native template for native ad.",
+ "type": "string"
+ },
+ "size": {
+ "$ref": "TargetingValueSize",
+ "description": "For regular or video creative size type, specifies the size of the creative."
+ },
+ "skippableAdType": {
+ "description": "The skippable ad type for video size.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingValueDayPartTargeting": {
+ "id": "TargetingValueDayPartTargeting",
+ "properties": {
+ "dayParts": {
+ "items": {
+ "$ref": "TargetingValueDayPartTargetingDayPart"
+ },
+ "type": "array"
+ },
+ "timeZoneType": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingValueDayPartTargetingDayPart": {
+ "id": "TargetingValueDayPartTargetingDayPart",
+ "properties": {
+ "dayOfWeek": {
+ "type": "string"
+ },
+ "endHour": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "endMinute": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "startHour": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "startMinute": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingValueDemogAgeCriteria": {
+ "id": "TargetingValueDemogAgeCriteria",
+ "properties": {
+ "demogAgeCriteriaIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingValueDemogGenderCriteria": {
+ "id": "TargetingValueDemogGenderCriteria",
+ "properties": {
+ "demogGenderCriteriaIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TargetingValueSize": {
+ "id": "TargetingValueSize",
+ "properties": {
+ "height": {
+ "description": "The height of the creative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "width": {
+ "description": "The width of the creative.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "UpdatePrivateAuctionProposalRequest": {
+ "id": "UpdatePrivateAuctionProposalRequest",
+ "properties": {
+ "externalDealId": {
+ "description": "The externalDealId of the deal to be updated.",
+ "type": "string"
+ },
+ "note": {
+ "$ref": "MarketplaceNote",
+ "description": "Optional note to be added."
+ },
+ "proposalRevisionNumber": {
+ "description": "The current revision number of the proposal to be updated.",
+ "format": "int64",
+ "type": "string"
+ },
+ "updateAction": {
+ "description": "The proposed action on the private auction proposal.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "TargetingValueDayPartTargeting": {
- "id": "TargetingValueDayPartTargeting",
- "type": "object",
- "properties": {
- "dayParts": {
- "type": "array",
- "items": {
- "$ref": "TargetingValueDayPartTargetingDayPart"
- }
- },
- "timeZoneType": {
- "type": "string"
- }
- }
- },
- "TargetingValueDayPartTargetingDayPart": {
- "id": "TargetingValueDayPartTargetingDayPart",
- "type": "object",
- "properties": {
- "dayOfWeek": {
- "type": "string"
- },
- "endHour": {
- "type": "integer",
- "format": "int32"
- },
- "endMinute": {
- "type": "integer",
- "format": "int32"
- },
- "startHour": {
- "type": "integer",
- "format": "int32"
- },
- "startMinute": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "TargetingValueSize": {
- "id": "TargetingValueSize",
- "type": "object",
- "properties": {
- "height": {
- "type": "integer",
- "description": "The height of the creative.",
- "format": "int32"
- },
- "width": {
- "type": "integer",
- "description": "The width of the creative.",
- "format": "int32"
- }
- }
- },
- "UpdatePrivateAuctionProposalRequest": {
- "id": "UpdatePrivateAuctionProposalRequest",
- "type": "object",
- "properties": {
- "externalDealId": {
- "type": "string",
- "description": "The externalDealId of the deal to be updated."
- },
- "note": {
- "$ref": "MarketplaceNote",
- "description": "Optional note to be added."
- },
- "proposalRevisionNumber": {
- "type": "string",
- "description": "The current revision number of the proposal to be updated.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string",
- "description": "The proposed action on the private auction proposal."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.accounts.get",
- "path": "accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of accounts.",
- "response": {
- "$ref": "AccountsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.accounts.patch",
- "path": "accounts/{id}",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "confirmUnsafeAccountChange": {
- "type": "boolean",
- "description": "Confirmation for erasing bidder and cookie matching urls.",
- "location": "query"
- },
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.accounts.update",
- "path": "accounts/{id}",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "confirmUnsafeAccountChange": {
- "type": "boolean",
- "description": "Confirmation for erasing bidder and cookie matching urls.",
- "location": "query"
- },
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "billingInfo": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.billingInfo.get",
- "path": "billinginfo/{accountId}",
- "httpMethod": "GET",
- "description": "Returns the billing information for one account specified by account ID.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The account id.",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "BillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.billingInfo.list",
- "path": "billinginfo",
- "httpMethod": "GET",
- "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
- "response": {
- "$ref": "BillingInfoList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "budget": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.budget.get",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "GET",
- "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.budget.patch",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PATCH",
- "description": "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.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.budget.update",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PUT",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "addDeal": {
- "id": "adexchangebuyer.creatives.addDeal",
- "path": "creatives/{accountId}/{buyerCreativeId}/addDeal/{dealId}",
- "httpMethod": "POST",
- "description": "Add a deal id association for the creative.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- },
- "dealId": {
- "type": "string",
- "description": "The id of the deal id to associate with this creative.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId",
- "dealId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "get": {
- "id": "adexchangebuyer.creatives.get",
- "path": "creatives/{accountId}/{buyerCreativeId}",
- "httpMethod": "GET",
- "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.creatives.insert",
- "path": "creatives",
- "httpMethod": "POST",
- "description": "Submit a new creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.creatives.list",
- "path": "creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "When specified, only creatives for the given account ids are returned.",
- "format": "int32",
- "repeated": true,
- "location": "query"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "When specified, only creatives for the given buyer creative ids are returned.",
- "repeated": true,
- "location": "query"
- },
- "dealsStatusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given deals status are returned.",
- "enum": [
- "approved",
- "conditionally_approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved for serving on deals.",
- "Creatives which have been conditionally approved for serving on deals.",
- "Creatives which have been disapproved for serving on deals.",
- "Creatives whose deals status is not yet checked."
- ],
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "openAuctionStatusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given open auction status are returned.",
- "enum": [
- "approved",
- "conditionally_approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved for serving on the open auction.",
- "Creatives which have been conditionally approved for serving on the open auction.",
- "Creatives which have been disapproved for serving on the open auction.",
- "Creatives whose open auction status is not yet checked."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "CreativesList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "listDeals": {
- "id": "adexchangebuyer.creatives.listDeals",
- "path": "creatives/{accountId}/{buyerCreativeId}/listDeals",
- "httpMethod": "GET",
- "description": "Lists the external deal ids associated with the creative.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "CreativeDealIds"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "removeDeal": {
- "id": "adexchangebuyer.creatives.removeDeal",
- "path": "creatives/{accountId}/{buyerCreativeId}/removeDeal/{dealId}",
- "httpMethod": "POST",
- "description": "Remove a deal id associated with the creative.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- },
- "dealId": {
- "type": "string",
- "description": "The id of the deal id to disassociate with this creative.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId",
- "dealId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplacedeals": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.marketplacedeals.delete",
- "path": "proposals/{proposalId}/deals/delete",
- "httpMethod": "POST",
- "description": "Delete the specified deals from the proposal",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposalId to delete deals from.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "request": {
- "$ref": "DeleteOrderDealsRequest"
- },
- "response": {
- "$ref": "DeleteOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.marketplacedeals.insert",
- "path": "proposals/{proposalId}/deals/insert",
- "httpMethod": "POST",
- "description": "Add new deals for the specified proposal",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "proposalId for which deals need to be added.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "request": {
- "$ref": "AddOrderDealsRequest"
- },
- "response": {
- "$ref": "AddOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.marketplacedeals.list",
- "path": "proposals/{proposalId}/deals",
- "httpMethod": "GET",
- "description": "List all the deals for a given proposal",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "Query string to retrieve specific deals.",
- "location": "query"
- },
- "proposalId": {
- "type": "string",
- "description": "The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "response": {
- "$ref": "GetOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.marketplacedeals.update",
- "path": "proposals/{proposalId}/deals/update",
- "httpMethod": "POST",
- "description": "Replaces all the deals in the proposal with the passed in deals",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposalId to edit deals on.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "request": {
- "$ref": "EditAllOrderDealsRequest"
- },
- "response": {
- "$ref": "EditAllOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplacenotes": {
- "methods": {
- "insert": {
- "id": "adexchangebuyer.marketplacenotes.insert",
- "path": "proposals/{proposalId}/notes/insert",
- "httpMethod": "POST",
- "description": "Add notes to the proposal",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposalId to add notes for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "request": {
- "$ref": "AddOrderNotesRequest"
- },
- "response": {
- "$ref": "AddOrderNotesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.marketplacenotes.list",
- "path": "proposals/{proposalId}/notes",
- "httpMethod": "GET",
- "description": "Get all the notes associated with a proposal",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "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%\"",
- "location": "query"
- },
- "proposalId": {
- "type": "string",
- "description": "The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "response": {
- "$ref": "GetOrderNotesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplaceprivateauction": {
- "methods": {
- "updateproposal": {
- "id": "adexchangebuyer.marketplaceprivateauction.updateproposal",
- "path": "privateauction/{privateAuctionId}/updateproposal",
- "httpMethod": "POST",
- "description": "Update a given private auction proposal",
- "parameters": {
- "privateAuctionId": {
- "type": "string",
- "description": "The private auction id to be updated.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "privateAuctionId"
- ],
- "request": {
- "$ref": "UpdatePrivateAuctionProposalRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "performanceReport": {
- "methods": {
- "list": {
- "id": "adexchangebuyer.performanceReport.list",
- "path": "performancereport",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of performance metrics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the reports.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "endDateTime": {
- "type": "string",
- "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "startDateTime": {
- "type": "string",
- "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "endDateTime",
- "startDateTime"
- ],
- "response": {
- "$ref": "PerformanceReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "pretargetingConfig": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.pretargetingConfig.delete",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to delete the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to delete.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "get": {
- "id": "adexchangebuyer.pretargetingConfig.get",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "GET",
- "description": "Gets a specific pretargeting configuration",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to retrieve.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.pretargetingConfig.insert",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "POST",
- "description": "Inserts a new pretargeting configuration.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to insert the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.pretargetingConfig.list",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting configs for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "PretargetingConfigList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.pretargetingConfig.patch",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing pretargeting config. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.pretargetingConfig.update",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PUT",
- "description": "Updates an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "products": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.products.get",
- "path": "products/{productId}",
- "httpMethod": "GET",
- "description": "Gets the requested product by id.",
- "parameters": {
- "productId": {
- "type": "string",
- "description": "The id for the product to get the head revision for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "productId"
- ],
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "search": {
- "id": "adexchangebuyer.products.search",
- "path": "products/search",
- "httpMethod": "GET",
- "description": "Gets the requested product.",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "The pql query used to query for products.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "GetOffersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "proposals": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.proposals.get",
- "path": "proposals/{proposalId}",
- "httpMethod": "GET",
- "description": "Get a proposal given its id",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "Id of the proposal to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "response": {
- "$ref": "Proposal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.proposals.insert",
- "path": "proposals/insert",
- "httpMethod": "POST",
- "description": "Create the given list of proposals",
- "request": {
- "$ref": "CreateOrdersRequest"
- },
- "response": {
- "$ref": "CreateOrdersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.proposals.patch",
- "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
- "httpMethod": "PATCH",
- "description": "Update the given proposal. This method supports patch semantics.",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposal id to update.",
- "required": true,
- "location": "path"
- },
- "revisionNumber": {
- "type": "string",
- "description": "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.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "updateAction": {
- "type": "string",
- "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
- "required": true,
- "enum": [
- "accept",
- "cancel",
- "propose",
- "proposeAndAccept",
- "unknownAction",
- "updateNonTerms"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId",
- "revisionNumber",
- "updateAction"
- ],
- "request": {
- "$ref": "Proposal"
- },
- "response": {
- "$ref": "Proposal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "search": {
- "id": "adexchangebuyer.proposals.search",
- "path": "proposals/search",
- "httpMethod": "GET",
- "description": "Search for proposals using pql query",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "Query string to retrieve specific proposals.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "GetOrdersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "setupcomplete": {
- "id": "adexchangebuyer.proposals.setupcomplete",
- "path": "proposals/{proposalId}/setupcomplete",
- "httpMethod": "POST",
- "description": "Update the given proposal to indicate that setup has been completed.",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposal id for which the setup is complete",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.proposals.update",
- "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
- "httpMethod": "PUT",
- "description": "Update the given proposal",
- "parameters": {
- "proposalId": {
- "type": "string",
- "description": "The proposal id to update.",
- "required": true,
- "location": "path"
- },
- "revisionNumber": {
- "type": "string",
- "description": "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.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "updateAction": {
- "type": "string",
- "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
- "required": true,
- "enum": [
- "accept",
- "cancel",
- "propose",
- "proposeAndAccept",
- "unknownAction",
- "updateNonTerms"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "proposalId",
- "revisionNumber",
- "updateAction"
- ],
- "request": {
- "$ref": "Proposal"
- },
- "response": {
- "$ref": "Proposal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "pubprofiles": {
- "methods": {
- "list": {
- "id": "adexchangebuyer.pubprofiles.list",
- "path": "publisher/{accountId}/profiles",
- "httpMethod": "GET",
- "description": "Gets the requested publisher profile(s) by publisher accountId.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The accountId of the publisher to get profiles for.",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "GetPublisherProfilesByAccountIdResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "adexchangebuyer/v1.4/",
+ "title": "Ad Exchange Buyer API",
+ "version": "v1.4"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-gen.go b/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-gen.go
index a48b43e04..e56f9e45f 100644
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-gen.go
+++ b/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-gen.go
@@ -218,6 +218,14 @@ type PubprofilesService struct {
// Account: Configuration data for an Ad Exchange buyer account.
type Account struct {
+ // ApplyPretargetingToNonGuaranteedDeals: 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 bool `json:"applyPretargetingToNonGuaranteedDeals,omitempty"`
+
// BidderLocation: Your bidder locations that have distinct URLs.
BidderLocation []*AccountBidderLocation `json:"bidderLocation,omitempty"`
@@ -254,21 +262,22 @@ type Account struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "BidderLocation") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
+ // ForceSendFields is a list of field names (e.g.
+ // "ApplyPretargetingToNonGuaranteedDeals") to unconditionally include
+ // in API requests. By default, fields with empty values are omitted
+ // from API requests. However, any non-pointer, non-interface field
+ // appearing in ForceSendFields will be sent to the server regardless of
+ // whether the field is empty or not. This may be used to include empty
+ // fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "BidderLocation") to
- // include in API requests with the JSON null value. By default, fields
- // with empty values are omitted from API requests. However, any field
- // with an empty value appearing in NullFields will be sent to the
- // server as null. It is an error if a field in this list has a
- // non-empty value. This may be used to include null fields in Patch
- // requests.
+ // NullFields is a list of field names (e.g.
+ // "ApplyPretargetingToNonGuaranteedDeals") to include in API requests
+ // with the JSON null value. By default, fields with empty values are
+ // omitted from API requests. However, any field with an empty value
+ // appearing in NullFields will be sent to the server as null. It is an
+ // error if a field in this list has a non-empty value. This may be used
+ // to include null fields in Patch requests.
NullFields []string `json:"-"`
}
@@ -745,7 +754,8 @@ func (s *CreateOrdersResponse) MarshalJSON() ([]byte, error) {
// Creative: A creative and its classification data.
type Creative struct {
// HTMLSnippet: The HTML snippet that displays the ad when inserted in
- // the web page. If set, videoURL should not be set.
+ // the web page. If set, videoURL, videoVastXML, and nativeAd should not
+ // be set.
HTMLSnippet string `json:"HTMLSnippet,omitempty"`
// AccountId: Account id.
@@ -818,9 +828,9 @@ type Creative struct {
// field should not be set in requests.
Languages []string `json:"languages,omitempty"`
- // NativeAd: If nativeAd is set, HTMLSnippet and the videoURL outside of
- // nativeAd should not be set. (The videoURL inside nativeAd can be
- // set.)
+ // NativeAd: If nativeAd is set, HTMLSnippet, videoVastXML, and the
+ // videoURL outside of nativeAd should not be set. (The videoURL inside
+ // nativeAd can be set.)
NativeAd *CreativeNativeAd `json:"nativeAd,omitempty"`
// OpenAuctionStatus: Top-level open auction status. Read-only. This
@@ -865,11 +875,16 @@ type Creative struct {
// not be set in requests.
Version int64 `json:"version,omitempty"`
- // VideoURL: The URL to fetch a video ad. If set, HTMLSnippet and the
- // nativeAd should not be set. Note, this is different from
- // resource.native_ad.video_url above.
+ // VideoURL: 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 `json:"videoURL,omitempty"`
+ // VideoVastXML: 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 `json:"videoVastXML,omitempty"`
+
// Width: Ad width.
Width int64 `json:"width,omitempty"`
@@ -1041,9 +1056,9 @@ func (s *CreativeFilteringReasonsReasons) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// CreativeNativeAd: If nativeAd is set, HTMLSnippet and the videoURL
-// outside of nativeAd should not be set. (The videoURL inside nativeAd
-// can be set.)
+// CreativeNativeAd: If nativeAd is set, HTMLSnippet, videoVastXML, and
+// the videoURL outside of nativeAd should not be set. (The videoURL
+// inside nativeAd can be set.)
type CreativeNativeAd struct {
Advertiser string `json:"advertiser,omitempty"`
@@ -3570,6 +3585,10 @@ type TargetingValue struct {
// Filled in when the key is GOOG_DAYPART_TARGETING.
DayPartTargetingValue *TargetingValueDayPartTargeting `json:"dayPartTargetingValue,omitempty"`
+ DemogAgeCriteriaValue *TargetingValueDemogAgeCriteria `json:"demogAgeCriteriaValue,omitempty"`
+
+ DemogGenderCriteriaValue *TargetingValueDemogGenderCriteria `json:"demogGenderCriteriaValue,omitempty"`
+
// LongValue: The long value to exclude/include.
LongValue int64 `json:"longValue,omitempty,string"`
@@ -3600,7 +3619,11 @@ func (s *TargetingValue) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// TargetingValueCreativeSize: Next Id: 7
type TargetingValueCreativeSize struct {
+ // AllowedFormats: The formats allowed by the publisher.
+ AllowedFormats []string `json:"allowedFormats,omitempty"`
+
// CompanionSizes: For video size type, the list of companion sizes.
CompanionSizes []*TargetingValueSize `json:"companionSizes,omitempty"`
@@ -3617,7 +3640,7 @@ type TargetingValueCreativeSize struct {
// SkippableAdType: The skippable ad type for video size.
SkippableAdType string `json:"skippableAdType,omitempty"`
- // ForceSendFields is a list of field names (e.g. "CompanionSizes") to
+ // ForceSendFields is a list of field names (e.g. "AllowedFormats") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -3625,7 +3648,7 @@ type TargetingValueCreativeSize struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "CompanionSizes") to
+ // NullFields is a list of field names (e.g. "AllowedFormats") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
@@ -3703,6 +3726,61 @@ func (s *TargetingValueDayPartTargetingDayPart) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type TargetingValueDemogAgeCriteria struct {
+ DemogAgeCriteriaIds []string `json:"demogAgeCriteriaIds,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "DemogAgeCriteriaIds")
+ // to unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "DemogAgeCriteriaIds") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *TargetingValueDemogAgeCriteria) MarshalJSON() ([]byte, error) {
+ type NoMethod TargetingValueDemogAgeCriteria
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type TargetingValueDemogGenderCriteria struct {
+ DemogGenderCriteriaIds []string `json:"demogGenderCriteriaIds,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "DemogGenderCriteriaIds") to unconditionally include in API requests.
+ // By default, fields with empty values are omitted from API requests.
+ // However, any non-pointer, non-interface field appearing in
+ // ForceSendFields will be sent to the server regardless of whether the
+ // field is empty or not. This may be used to include empty fields in
+ // Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "DemogGenderCriteriaIds")
+ // to include in API requests with the JSON null value. By default,
+ // fields with empty values are omitted from API requests. However, any
+ // field with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *TargetingValueDemogGenderCriteria) MarshalJSON() ([]byte, error) {
+ type NoMethod TargetingValueDemogGenderCriteria
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type TargetingValueSize struct {
// Height: The height of the creative.
Height int64 `json:"height,omitempty"`
diff --git a/vendor/google.golang.org/api/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json b/vendor/google.golang.org/api/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
index 3cc6c711f..43df8476f 100644
--- a/vendor/google.golang.org/api/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
+++ b/vendor/google.golang.org/api/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
@@ -1,20 +1,2233 @@
{
- "baseUrl": "https://adexchangebuyer.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.buyer": {
+ "description": "Manage your Ad Exchange buyer account configuration"
+ }
+ }
+ }
+ },
"basePath": "",
- "revision": "20180119",
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
- "id": "adexchangebuyer2:v2beta1",
+ "baseUrl": "https://adexchangebuyer.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "AdExchangeBuyerII",
+ "description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
"discoveryVersion": "v1",
- "version_module": true,
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "adexchangebuyer2:v2beta1",
+ "kind": "discovery#restDescription",
+ "name": "adexchangebuyer2",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "resources": {
+ "clients": {
+ "methods": {
+ "create": {
+ "description": "Creates a new client buyer.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.clients.create",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "request": {
+ "$ref": "Client"
+ },
+ "response": {
+ "$ref": "Client"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Gets a client buyer with a given client account ID.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.clients.get",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer to retrieve. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "response": {
+ "$ref": "Client"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Lists all the clients for the current sponsor buyer.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.clients.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
+ "location": "query",
+ "type": "string"
+ },
+ "partnerClientId": {
+ "description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor\nbuyer partner) of the client to return.\nIf specified, at most one client will be returned in the response.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "response": {
+ "$ref": "ListClientsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing client buyer.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer2.accounts.clients.update",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "Unique numerical account ID of the client to update. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "request": {
+ "$ref": "Client"
+ },
+ "response": {
+ "$ref": "Client"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ },
+ "resources": {
+ "invitations": {
+ "methods": {
+ "create": {
+ "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.clients.invitations.create",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "request": {
+ "$ref": "ClientUserInvitation"
+ },
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Retrieves an existing client user invitation.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.clients.invitations.get",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "invitationId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "invitationId": {
+ "description": "Numerical identifier of the user invitation to retrieve. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Lists all the client users invitations for a client\nwith a given account ID.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.clients.invitations.list",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "response": {
+ "$ref": "ListClientUserInvitationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "users": {
+ "methods": {
+ "get": {
+ "description": "Retrieves an existing client user.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.clients.users.get",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "userId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "response": {
+ "$ref": "ClientUser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.clients.users.list",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "response": {
+ "$ref": "ListClientUsersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer2.accounts.clients.users.update",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "userId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "request": {
+ "$ref": "ClientUser"
+ },
+ "response": {
+ "$ref": "ClientUser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "creatives": {
+ "methods": {
+ "create": {
+ "description": "Creates a creative.",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.creatives.create",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "duplicateIdMode": {
+ "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
+ "enum": [
+ "NO_DUPLICATES",
+ "FORCE_ENABLE_DUPLICATE_IDS"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Gets a creative.",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.creatives.get",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The ID of the creative to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Lists creatives.",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.creatives.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
+ "location": "query",
+ "type": "string"
+ },
+ "query": {
+ "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason}\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "response": {
+ "$ref": "ListCreativesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "stopWatching": {
+ "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.creatives.stopWatching",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account of the creative to stop notifications for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "request": {
+ "$ref": "StopWatchingCreativeRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "update": {
+ "description": "Updates a creative.",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer2.accounts.creatives.update",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "watch": {
+ "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.creatives.watch",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account of the creative to watch.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "request": {
+ "$ref": "WatchCreativeRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ },
+ "resources": {
+ "dealAssociations": {
+ "methods": {
+ "add": {
+ "description": "Associate an existing deal with a creative.",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "request": {
+ "$ref": "AddDealAssociationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "List all creative-deal associations.",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
+ "location": "query",
+ "type": "string"
+ },
+ "query": {
+ "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
+ "response": {
+ "$ref": "ListDealAssociationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "remove": {
+ "description": "Remove the association between a deal and a creative.",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
+ "request": {
+ "$ref": "RemoveDealAssociationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "bidders": {
+ "resources": {
+ "accounts": {
+ "resources": {
+ "filterSets": {
+ "methods": {
+ "create": {
+ "description": "Creates the specified filter set for the account with the given account ID.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.create",
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "parameters": {
+ "isTransient": {
+ "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ownerName": {
+ "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "request": {
+ "$ref": "FilterSet"
+ },
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the requested filter set from the account with the given account\nID.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}",
+ "httpMethod": "DELETE",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the requested filter set for the account with the given account\nID.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+name}",
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Lists all filter sets for the account with the given account ID.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.list",
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "parameters": {
+ "ownerName": {
+ "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "response": {
+ "$ref": "ListFilterSetsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ },
+ "resources": {
+ "bidMetrics": {
+ "methods": {
+ "list": {
+ "description": "Lists all metrics that are measured in terms of number of bids.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidMetrics",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/bidMetrics",
+ "response": {
+ "$ref": "ListBidMetricsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "bidResponseErrors": {
+ "methods": {
+ "list": {
+ "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponseErrors",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/bidResponseErrors",
+ "response": {
+ "$ref": "ListBidResponseErrorsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "bidResponsesWithoutBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
+ "response": {
+ "$ref": "ListBidResponsesWithoutBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "filteredBidRequests": {
+ "methods": {
+ "list": {
+ "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/filteredBidRequests",
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "filteredBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/filteredBids",
+ "response": {
+ "$ref": "ListFilteredBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ },
+ "resources": {
+ "creatives": {
+ "methods": {
+ "list": {
+ "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list",
+ "parameterOrder": [
+ "filterSetName",
+ "creativeStatusId"
+ ],
+ "parameters": {
+ "creativeStatusId": {
+ "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives",
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "details": {
+ "methods": {
+ "list": {
+ "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list",
+ "parameterOrder": [
+ "filterSetName",
+ "creativeStatusId"
+ ],
+ "parameters": {
+ "creativeStatusId": {
+ "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details",
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByDetailResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "impressionMetrics": {
+ "methods": {
+ "list": {
+ "description": "Lists all metrics that are measured in terms of number of impressions.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/impressionMetrics",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/impressionMetrics",
+ "response": {
+ "$ref": "ListImpressionMetricsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "losingBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/losingBids",
+ "response": {
+ "$ref": "ListLosingBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "nonBillableWinningBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
+ "response": {
+ "$ref": "ListNonBillableWinningBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "filterSets": {
+ "methods": {
+ "create": {
+ "description": "Creates the specified filter set for the account with the given account ID.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.bidders.filterSets.create",
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "parameters": {
+ "isTransient": {
+ "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "ownerName": {
+ "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "request": {
+ "$ref": "FilterSet"
+ },
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the requested filter set from the account with the given account\nID.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}",
+ "httpMethod": "DELETE",
+ "id": "adexchangebuyer2.bidders.filterSets.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the requested filter set for the account with the given account\nID.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+name}",
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "list": {
+ "description": "Lists all filter sets for the account with the given account ID.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.list",
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "parameters": {
+ "ownerName": {
+ "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "response": {
+ "$ref": "ListFilterSetsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ },
+ "resources": {
+ "bidMetrics": {
+ "methods": {
+ "list": {
+ "description": "Lists all metrics that are measured in terms of number of bids.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/bidMetrics",
+ "response": {
+ "$ref": "ListBidMetricsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "bidResponseErrors": {
+ "methods": {
+ "list": {
+ "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/bidResponseErrors",
+ "response": {
+ "$ref": "ListBidResponseErrorsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "bidResponsesWithoutBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
+ "response": {
+ "$ref": "ListBidResponsesWithoutBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "filteredBidRequests": {
+ "methods": {
+ "list": {
+ "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/filteredBidRequests",
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "filteredBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBids.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/filteredBids",
+ "response": {
+ "$ref": "ListFilteredBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ },
+ "resources": {
+ "creatives": {
+ "methods": {
+ "list": {
+ "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list",
+ "parameterOrder": [
+ "filterSetName",
+ "creativeStatusId"
+ ],
+ "parameters": {
+ "creativeStatusId": {
+ "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives",
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "details": {
+ "methods": {
+ "list": {
+ "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBids.details.list",
+ "parameterOrder": [
+ "filterSetName",
+ "creativeStatusId"
+ ],
+ "parameters": {
+ "creativeStatusId": {
+ "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details",
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByDetailResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "impressionMetrics": {
+ "methods": {
+ "list": {
+ "description": "Lists all metrics that are measured in terms of number of impressions.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/impressionMetrics",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/impressionMetrics",
+ "response": {
+ "$ref": "ListImpressionMetricsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "losingBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.losingBids.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/losingBids",
+ "response": {
+ "$ref": "ListLosingBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "nonBillableWinningBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "location": "path",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
+ "response": {
+ "$ref": "ListNonBillableWinningBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20180326",
+ "rootUrl": "https://adexchangebuyer.googleapis.com/",
"schemas": {
- "ClientUserInvitation": {
- "type": "object",
+ "AbsoluteDateRange": {
+ "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
+ "id": "AbsoluteDateRange",
"properties": {
- "invitationId": {
- "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
+ "endDate": {
+ "$ref": "Date",
+ "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date."
+ },
+ "startDate": {
+ "$ref": "Date",
+ "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date."
+ }
+ },
+ "type": "object"
+ },
+ "AddDealAssociationRequest": {
+ "description": "A request for associating a deal and a creative.",
+ "id": "AddDealAssociationRequest",
+ "properties": {
+ "association": {
+ "$ref": "CreativeDealAssociation",
+ "description": "The association between a creative and a deal that should be added."
+ }
+ },
+ "type": "object"
+ },
+ "AppContext": {
+ "description": "@OutputOnly The app type the restriction applies to for mobile device.",
+ "id": "AppContext",
+ "properties": {
+ "appTypes": {
+ "description": "The app types this restriction applies to.",
+ "enumDescriptions": [
+ "Native app context.",
+ "Mobile web app context."
+ ],
+ "items": {
+ "enum": [
+ "NATIVE",
+ "WEB"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AuctionContext": {
+ "description": "@OutputOnly The auction type the restriction applies to.",
+ "id": "AuctionContext",
+ "properties": {
+ "auctionTypes": {
+ "description": "The auction types this restriction applies to.",
+ "enumDescriptions": [
+ "The restriction applies to open auction.",
+ "The restriction applies to direct deals."
+ ],
+ "items": {
+ "enum": [
+ "OPEN_AUCTION",
+ "DIRECT_DEALS"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "BidMetricsRow": {
+ "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
+ "id": "BidMetricsRow",
+ "properties": {
+ "bids": {
+ "$ref": "MetricValue",
+ "description": "The number of bids that Ad Exchange received from the buyer."
+ },
+ "bidsInAuction": {
+ "$ref": "MetricValue",
+ "description": "The number of bids that were permitted to compete in the auction."
+ },
+ "billedImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the buyer was billed."
+ },
+ "impressionsWon": {
+ "$ref": "MetricValue",
+ "description": "The number of bids that won an impression."
+ },
+ "measurableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ },
+ "viewableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
+ }
+ },
+ "type": "object"
+ },
+ "BidResponseWithoutBidsStatusRow": {
+ "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
+ "id": "BidResponseWithoutBidsStatusRow",
+ "properties": {
+ "impressionCount": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which there was a bid response with the\nspecified status."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ },
+ "status": {
+ "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "RESPONSES_WITHOUT_BIDS",
+ "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
+ "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "The response had no bids.",
+ "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
+ "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CalloutStatusRow": {
+ "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.",
+ "id": "CalloutStatusRow",
+ "properties": {
+ "calloutStatusId": {
+ "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "impressionCount": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ }
+ },
+ "type": "object"
+ },
+ "Client": {
+ "description": "A client resource represents a client buyer\u0026mdash;an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
+ "id": "Client",
+ "properties": {
+ "clientAccountId": {
+ "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clientName": {
+ "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
+ "type": "string"
+ },
+ "entityId": {
+ "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
+ "format": "int64",
+ "type": "string"
+ },
+ "entityName": {
+ "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
+ "type": "string"
+ },
+ "entityType": {
+ "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
+ "enum": [
+ "ENTITY_TYPE_UNSPECIFIED",
+ "ADVERTISER",
+ "BRAND",
+ "AGENCY"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an undefined client entity type. Should not be used.",
+ "An advertiser.",
+ "A brand.",
+ "An advertising agency."
+ ],
+ "type": "string"
+ },
+ "partnerClientId": {
+ "description": "Optional arbitrary unique identifier of this client buyer from the\nstandpoint of its Ad Exchange sponsor buyer.\n\nThis field can be used to associate a client buyer with the identifier\nin the namespace of its sponsor buyer, lookup client buyers by that\nidentifier and verify whether an Ad Exchange counterpart of a given client\nbuyer already exists.\n\nIf present, must be unique among all the client buyers for its\nAd Exchange sponsor buyer.",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.",
+ "enum": [
+ "CLIENT_ROLE_UNSPECIFIED",
+ "CLIENT_DEAL_VIEWER",
+ "CLIENT_DEAL_NEGOTIATOR",
+ "CLIENT_DEAL_APPROVER"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an undefined client role.",
+ "Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.",
+ "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
+ "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
+ ],
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the client buyer.",
+ "enum": [
+ "CLIENT_STATUS_UNSPECIFIED",
+ "DISABLED",
+ "ACTIVE"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an undefined client status.",
+ "A client that is currently disabled.",
+ "A client that is currently active."
+ ],
+ "type": "string"
+ },
+ "visibleToSeller": {
+ "description": "Whether the client buyer will be visible to sellers.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ClientUser": {
+ "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
+ "id": "ClientUser",
+ "properties": {
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
+ "format": "int64",
+ "type": "string"
+ },
+ "email": {
+ "description": "User's email address. The value of this field\nis ignored in an update operation.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the client user.",
+ "enum": [
+ "USER_STATUS_UNSPECIFIED",
+ "PENDING",
+ "ACTIVE",
+ "DISABLED"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an undefined user status.",
+ "A user who was already created but hasn't accepted the invitation yet.",
+ "A user that is currently active.",
+ "A user that is currently disabled."
+ ],
+ "type": "string"
+ },
+ "userId": {
+ "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClientUserInvitation": {
+ "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
+ "id": "ClientUserInvitation",
+ "properties": {
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
"format": "int64",
"type": "string"
},
@@ -22,297 +2235,121 @@
"description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
"type": "string"
},
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
+ "invitationId": {
+ "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
"format": "int64",
"type": "string"
}
},
- "id": "ClientUserInvitation",
- "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified."
- },
- "ListClientUserInvitationsResponse": {
- "type": "object",
- "properties": {
- "invitations": {
- "description": "The returned list of client users.",
- "type": "array",
- "items": {
- "$ref": "ClientUserInvitation"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
- "type": "string"
- }
- },
- "id": "ListClientUserInvitationsResponse"
- },
- "ListClientUsersResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
- "type": "string"
- },
- "users": {
- "description": "The returned list of client users.",
- "type": "array",
- "items": {
- "$ref": "ClientUser"
- }
- }
- },
- "id": "ListClientUsersResponse"
- },
- "ListCreativeStatusBreakdownByDetailResponse": {
- "type": "object",
- "properties": {
- "filteredBidDetailRows": {
- "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
- "type": "array",
- "items": {
- "$ref": "FilteredBidDetailRow"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the filteredBids.details.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "detailType": {
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
- "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
- "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
- "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).",
- "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
- ],
- "enum": [
- "DETAIL_TYPE_UNSPECIFIED",
- "CREATIVE_ATTRIBUTE",
- "VENDOR",
- "SENSITIVE_CATEGORY",
- "PRODUCT_CATEGORY",
- "DISAPPROVAL_REASON"
- ],
- "description": "The type of detail that the detail IDs represent."
- }
- },
- "id": "ListCreativeStatusBreakdownByDetailResponse",
- "description": "Response message for listing all details associated with a given filtered bid\nreason."
- },
- "LocationContext": {
- "description": "@OutputOnly The Geo criteria the restriction applies to.",
- "type": "object",
- "properties": {
- "geoCriteriaIds": {
- "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "id": "LocationContext"
- },
- "PlatformContext": {
- "description": "@OutputOnly The type of platform the restriction applies to.",
- "type": "object",
- "properties": {
- "platforms": {
- "description": "The platforms this restriction applies to.",
- "type": "array",
- "items": {
- "enum": [
- "DESKTOP",
- "ANDROID",
- "IOS"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Desktop platform.",
- "Android platform.",
- "iOS platform."
- ]
- }
- },
- "id": "PlatformContext"
- },
- "MetricValue": {
- "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).",
- "type": "object",
- "properties": {
- "variance": {
- "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value",
- "format": "int64",
- "type": "string"
- },
- "value": {
- "description": "The expected value of the metric.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "MetricValue"
- },
- "ClientUser": {
- "properties": {
- "status": {
- "enumDescriptions": [
- "A placeholder for an undefined user status.",
- "A user who was already created but hasn't accepted the invitation yet.",
- "A user that is currently active.",
- "A user that is currently disabled."
- ],
- "enum": [
- "USER_STATUS_UNSPECIFIED",
- "PENDING",
- "ACTIVE",
- "DISABLED"
- ],
- "description": "The status of the client user.",
- "type": "string"
- },
- "userId": {
- "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
- "format": "int64",
- "type": "string"
- },
- "email": {
- "type": "string",
- "description": "User's email address. The value of this field\nis ignored in an update operation."
- },
- "clientAccountId": {
- "type": "string",
- "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
- "format": "int64"
- }
- },
- "id": "ClientUser",
- "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
"type": "object"
},
- "CreativeDealAssociation": {
+ "Correction": {
+ "description": "@OutputOnly Shows any corrections that were applied to this creative.",
+ "id": "Correction",
"properties": {
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
- "type": "string"
+ "contexts": {
+ "description": "The contexts for the correction.",
+ "items": {
+ "$ref": "ServingContext"
+ },
+ "type": "array"
},
- "dealsId": {
- "description": "The externalDealId for the deal associated with the creative.",
- "type": "string"
+ "details": {
+ "description": "Additional details about what was corrected.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "accountId": {
- "description": "The account the creative belongs to.",
+ "type": {
+ "description": "The type of correction that was applied to the creative.",
+ "enum": [
+ "CORRECTION_TYPE_UNSPECIFIED",
+ "VENDOR_IDS_ADDED",
+ "SSL_ATTRIBUTE_REMOVED",
+ "FLASH_FREE_ATTRIBUTE_REMOVED",
+ "FLASH_FREE_ATTRIBUTE_ADDED",
+ "REQUIRED_ATTRIBUTE_ADDED",
+ "REQUIRED_VENDOR_ADDED",
+ "SSL_ATTRIBUTE_ADDED",
+ "IN_BANNER_VIDEO_ATTRIBUTE_ADDED",
+ "MRAID_ATTRIBUTE_ADDED",
+ "FLASH_ATTRIBUTE_REMOVED",
+ "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
+ ],
+ "enumDescriptions": [
+ "The correction type is unknown. Refer to the details for more information.",
+ "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.",
+ "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.",
+ "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.",
+ "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.",
+ "The ad did not declare a required creative attribute.\nThe attribute was added.",
+ "The ad did not declare a required technology vendor.\nThe technology vendor was added.",
+ "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.",
+ "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.",
+ "The ad makes calls to the MRAID API so the MRAID attribute was added.",
+ "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.",
+ "The ad contains video content."
+ ],
"type": "string"
}
},
- "id": "CreativeDealAssociation",
- "description": "The association between a creative and a deal.",
"type": "object"
},
"Creative": {
- "description": "A creative and its classification data.",
- "type": "object",
+ "description": "A creative and its classification data.\n\nNext ID: 31",
+ "id": "Creative",
"properties": {
- "version": {
- "description": "@OutputOnly The version of this creative.",
- "format": "int32",
- "type": "integer"
- },
- "vendorIds": {
- "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "impressionTrackingUrls": {
- "description": "The set of URLs to be called to record an impression.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "html": {
- "$ref": "HtmlContent",
- "description": "An HTML creative."
- },
- "detectedProductCategories": {
- "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "dealsStatus": {
- "enumDescriptions": [
- "The status is unknown.",
- "The creative has not been checked.",
- "The creative has been conditionally approved.\nSee serving_restrictions for details.",
- "The creative has been approved.",
- "The creative has been disapproved."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "NOT_CHECKED",
- "CONDITIONALLY_APPROVED",
- "APPROVED",
- "DISAPPROVED"
- ],
- "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "accountId": {
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type": "string"
},
- "openAuctionStatus": {
- "enumDescriptions": [
- "The status is unknown.",
- "The creative has not been checked.",
- "The creative has been conditionally approved.\nSee serving_restrictions for details.",
- "The creative has been approved.",
- "The creative has been disapproved."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "NOT_CHECKED",
- "CONDITIONALLY_APPROVED",
- "APPROVED",
- "DISAPPROVED"
- ],
- "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "adChoicesDestinationUrl": {
+ "description": "The link to AdChoices destination page.",
"type": "string"
},
"advertiserName": {
"description": "The name of the company being advertised in the creative.",
"type": "string"
},
- "detectedAdvertiserIds": {
- "description": "@OutputOnly Detected advertiser IDs, if any.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
+ "agencyId": {
+ "description": "The agency ID for this creative.",
+ "format": "int64",
+ "type": "string"
},
- "detectedDomains": {
- "description": "@OutputOnly\nThe detected domains for this creative.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "filteringStats": {
- "$ref": "FilteringStats",
- "description": "@OutputOnly The filtering stats for this creative."
+ "apiUpdateTime": {
+ "description": "@OutputOnly The last update timestamp of the creative via API.",
+ "format": "google-datetime",
+ "type": "string"
},
"attributes": {
"description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "array",
+ "enumDescriptions": [
+ "Do not use. This is a placeholder value only.",
+ "The creative is tagged.",
+ "The creative is cookie targeted.",
+ "The creative is user interest targeted.",
+ "The creative does not expand.",
+ "The creative expands up.",
+ "The creative expands down.",
+ "The creative expands left.",
+ "The creative expands right.",
+ "The creative expands up and left.",
+ "The creative expands up and right.",
+ "The creative expands down and left.",
+ "The creative expands down and right.",
+ "The creative expands up or down.",
+ "The creative expands left or right.",
+ "The creative expands on any diagonal.",
+ "The creative expands when rolled over.",
+ "The instream vast video type is vpaid flash.",
+ "The creative is MRAID",
+ "The creative is SSL.",
+ "The creative is an interstitial.",
+ "The creative is eligible for native.",
+ "The creative is not eligible for native.",
+ "The creative can dynamically resize to fill a variety of slot sizes."
+ ],
"items": {
"enum": [
"ATTRIBUTE_UNSPECIFIED",
@@ -342,470 +2379,235 @@
],
"type": "string"
},
- "enumDescriptions": [
- "Do not use. This is a placeholder value only.",
- "The creative is tagged.",
- "The creative is cookie targeted.",
- "The creative is user interest targeted.",
- "The creative does not expand.",
- "The creative expands up.",
- "The creative expands down.",
- "The creative expands left.",
- "The creative expands right.",
- "The creative expands up and left.",
- "The creative expands up and right.",
- "The creative expands down and left.",
- "The creative expands down and right.",
- "The creative expands up or down.",
- "The creative expands left or right.",
- "The creative expands on any diagonal.",
- "The creative expands when rolled over.",
- "The instream vast video type is vpaid flash.",
- "The creative is MRAID",
- "The creative is SSL.",
- "The creative is an interstitial.",
- "The creative is eligible for native.",
- "The creative is not eligible for native.",
- "The creative can dynamically resize to fill a variety of slot sizes."
- ]
+ "type": "array"
},
- "apiUpdateTime": {
- "description": "@OutputOnly The last update timestamp of the creative via API.",
- "format": "google-datetime",
- "type": "string"
- },
- "detectedLanguages": {
- "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
- "type": "array",
+ "clickThroughUrls": {
+ "description": "The set of destination URLs for the creative.",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
+ },
+ "corrections": {
+ "description": "@OutputOnly Shows any corrections that were applied to this creative.",
+ "items": {
+ "$ref": "Correction"
+ },
+ "type": "array"
},
"creativeId": {
"description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type": "string"
},
- "accountId": {
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "dealsStatus": {
+ "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "NOT_CHECKED",
+ "CONDITIONALLY_APPROVED",
+ "APPROVED",
+ "DISAPPROVED"
+ ],
+ "enumDescriptions": [
+ "The status is unknown.",
+ "The creative has not been checked.",
+ "The creative has been conditionally approved.\nSee serving_restrictions for details.",
+ "The creative has been approved.",
+ "The creative has been disapproved."
+ ],
"type": "string"
},
- "native": {
- "description": "A native creative.",
- "$ref": "NativeContent"
- },
- "video": {
- "$ref": "VideoContent",
- "description": "A video creative."
- },
- "servingRestrictions": {
- "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
- "type": "array",
+ "detectedAdvertiserIds": {
+ "description": "@OutputOnly Detected advertiser IDs, if any.",
"items": {
- "$ref": "ServingRestriction"
- }
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
},
- "agencyId": {
- "description": "The agency ID for this creative.",
- "format": "int64",
- "type": "string"
- },
- "clickThroughUrls": {
- "description": "The set of destination URLs for the creative.",
- "type": "array",
+ "detectedDomains": {
+ "description": "@OutputOnly\nThe detected domains for this creative.",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
},
- "adChoicesDestinationUrl": {
- "type": "string",
- "description": "The link to AdChoices destination page."
+ "detectedLanguages": {
+ "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "detectedSensitiveCategories": {
- "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
- "type": "array",
+ "detectedProductCategories": {
+ "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
"items": {
"format": "int32",
"type": "integer"
- }
+ },
+ "type": "array"
+ },
+ "detectedSensitiveCategories": {
+ "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "filteringStats": {
+ "$ref": "FilteringStats",
+ "description": "@OutputOnly The filtering stats for this creative."
+ },
+ "html": {
+ "$ref": "HtmlContent",
+ "description": "An HTML creative."
+ },
+ "impressionTrackingUrls": {
+ "description": "The set of URLs to be called to record an impression.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "native": {
+ "$ref": "NativeContent",
+ "description": "A native creative."
+ },
+ "openAuctionStatus": {
+ "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "NOT_CHECKED",
+ "CONDITIONALLY_APPROVED",
+ "APPROVED",
+ "DISAPPROVED"
+ ],
+ "enumDescriptions": [
+ "The status is unknown.",
+ "The creative has not been checked.",
+ "The creative has been conditionally approved.\nSee serving_restrictions for details.",
+ "The creative has been approved.",
+ "The creative has been disapproved."
+ ],
+ "type": "string"
},
"restrictedCategories": {
+ "description": "All restricted categories for the ads that may be shown from this creative.",
"enumDescriptions": [
"The ad has no restricted categories",
"The alcohol restricted category."
],
- "description": "All restricted categories for the ads that may be shown from this creative.",
- "type": "array",
"items": {
"enum": [
"NO_RESTRICTED_CATEGORIES",
"ALCOHOL"
],
"type": "string"
- }
- },
- "corrections": {
- "description": "@OutputOnly Shows any corrections that were applied to this creative.",
- "type": "array",
- "items": {
- "$ref": "Correction"
- }
- }
- },
- "id": "Creative"
- },
- "FilteringStats": {
- "type": "object",
- "properties": {
- "reasons": {
- "description": "The set of filtering reasons for this date.",
- "type": "array",
- "items": {
- "$ref": "Reason"
- }
- },
- "date": {
- "$ref": "Date",
- "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24."
- }
- },
- "id": "FilteringStats",
- "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific)."
- },
- "RemoveDealAssociationRequest": {
- "description": "A request for removing the association between a deal and a creative.",
- "type": "object",
- "properties": {
- "association": {
- "$ref": "CreativeDealAssociation",
- "description": "The association between a creative and a deal that should be removed."
- }
- },
- "id": "RemoveDealAssociationRequest"
- },
- "Client": {
- "type": "object",
- "properties": {
- "entityType": {
- "enumDescriptions": [
- "A placeholder for an undefined client entity type. Should not be used.",
- "An advertiser.",
- "A brand.",
- "An advertising agency."
- ],
- "enum": [
- "ENTITY_TYPE_UNSPECIFIED",
- "ADVERTISER",
- "BRAND",
- "AGENCY"
- ],
- "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
- "type": "string"
- },
- "clientName": {
- "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
- "type": "string"
- },
- "role": {
- "enum": [
- "CLIENT_ROLE_UNSPECIFIED",
- "CLIENT_DEAL_VIEWER",
- "CLIENT_DEAL_NEGOTIATOR",
- "CLIENT_DEAL_APPROVER"
- ],
- "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined client role.",
- "Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.",
- "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
- "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
- ]
- },
- "visibleToSeller": {
- "description": "Whether the client buyer will be visible to sellers.",
- "type": "boolean"
- },
- "entityId": {
- "type": "string",
- "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
- "format": "int64"
- },
- "clientAccountId": {
- "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
- "format": "int64",
- "type": "string"
- },
- "entityName": {
- "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "A placeholder for an undefined client status.",
- "A client that is currently disabled.",
- "A client that is currently active."
- ],
- "enum": [
- "CLIENT_STATUS_UNSPECIFIED",
- "DISABLED",
- "ACTIVE"
- ],
- "description": "The status of the client buyer.",
- "type": "string"
- },
- "partnerClientId": {
- "description": "Optional arbitrary unique identifier of this client buyer from the\nstandpoint of its Ad Exchange sponsor buyer.\n\nThis field can be used to associate a client buyer with the identifier\nin the namespace of its sponsor buyer, lookup client buyers by that\nidentifier and verify whether an Ad Exchange counterpart of a given client\nbuyer already exists.\n\nIf present, must be unique among all the client buyers for its\nAd Exchange sponsor buyer.",
- "type": "string"
- }
- },
- "id": "Client",
- "description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified."
- },
- "ListCreativeStatusBreakdownByCreativeResponse": {
- "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the filteredBids.creatives.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "filteredBidCreativeRows": {
- "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
- "type": "array",
- "items": {
- "$ref": "FilteredBidCreativeRow"
- }
- }
- },
- "id": "ListCreativeStatusBreakdownByCreativeResponse"
- },
- "Correction": {
- "description": "@OutputOnly Shows any corrections that were applied to this creative.",
- "type": "object",
- "properties": {
- "details": {
- "description": "Additional details about what was corrected.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "enumDescriptions": [
- "The correction type is unknown. Refer to the details for more information.",
- "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.",
- "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.",
- "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.",
- "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.",
- "The ad did not declare a required creative attribute.\nThe attribute was added.",
- "The ad did not declare a required technology vendor.\nThe technology vendor was added.",
- "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.",
- "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.",
- "The ad makes calls to the MRAID API so the MRAID attribute was added.",
- "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.",
- "The ad contains video content."
- ],
- "enum": [
- "CORRECTION_TYPE_UNSPECIFIED",
- "VENDOR_IDS_ADDED",
- "SSL_ATTRIBUTE_REMOVED",
- "FLASH_FREE_ATTRIBUTE_REMOVED",
- "FLASH_FREE_ATTRIBUTE_ADDED",
- "REQUIRED_ATTRIBUTE_ADDED",
- "REQUIRED_VENDOR_ADDED",
- "SSL_ATTRIBUTE_ADDED",
- "IN_BANNER_VIDEO_ATTRIBUTE_ADDED",
- "MRAID_ATTRIBUTE_ADDED",
- "FLASH_ATTRIBUTE_REMOVED",
- "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
- ],
- "description": "The type of correction that was applied to the creative.",
- "type": "string"
- },
- "contexts": {
- "description": "The contexts for the correction.",
- "type": "array",
- "items": {
- "$ref": "ServingContext"
- }
- }
- },
- "id": "Correction"
- },
- "FilterSet": {
- "properties": {
- "absoluteDateRange": {
- "$ref": "AbsoluteDateRange",
- "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
- },
- "environment": {
- "enum": [
- "ENVIRONMENT_UNSPECIFIED",
- "WEB",
- "APP"
- ],
- "description": "The environment on which to filter; optional.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
- "The ad impression appears on the web.",
- "The ad impression appears in an app."
- ]
- },
- "format": {
- "enum": [
- "FORMAT_UNSPECIFIED",
- "DISPLAY",
- "VIDEO"
- ],
- "description": "DEPRECATED: use repeated formats field instead.\nThe format on which to filter; optional.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
- "The ad impression is display format (i.e. an image).",
- "The ad impression is video format."
- ]
- },
- "dealId": {
- "description": "The ID of the deal on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.",
- "format": "int64",
- "type": "string"
- },
- "timeSeriesGranularity": {
- "enum": [
- "TIME_SERIES_GRANULARITY_UNSPECIFIED",
- "HOURLY",
- "DAILY"
- ],
- "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.",
- "Indicates that data will be broken down by the hour.",
- "Indicates that data will be broken down by the day."
- ]
- },
- "realtimeTimeRange": {
- "$ref": "RealtimeTimeRange",
- "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp."
- },
- "formats": {
- "description": "The list of formats on which to filter; may be empty. The filters\nrepresented by multiple formats are ORed together (i.e. if non-empty,\nresults must match any one of the formats).",
- "type": "array",
- "items": {
- "enum": [
- "FORMAT_UNSPECIFIED",
- "DISPLAY",
- "VIDEO"
- ],
- "type": "string"
},
- "enumDescriptions": [
- "A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
- "The ad impression is display format (i.e. an image).",
- "The ad impression is video format."
- ]
+ "type": "array"
},
- "creativeId": {
- "description": "The ID of the creative on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.",
- "type": "string"
- },
- "relativeDateRange": {
- "$ref": "RelativeDateRange",
- "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
- },
- "platforms": {
- "type": "array",
+ "servingRestrictions": {
+ "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
"items": {
- "enum": [
- "PLATFORM_UNSPECIFIED",
- "DESKTOP",
- "TABLET",
- "MOBILE"
- ],
- "type": "string"
+ "$ref": "ServingRestriction"
},
- "enumDescriptions": [
- "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
- "The ad impression appears on a desktop.",
- "The ad impression appears on a tablet.",
- "The ad impression appears on a mobile device."
- ],
- "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms)."
+ "type": "array"
},
- "name": {
- "description": "A user-defined name of the filter set. Filter set names must be unique\nglobally and match one of the patterns:\n\n- `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting\ndata)\n- `bidders/*/accounts/*/filterSets/*` (for accessing account-level\ntroubleshooting data)\n\nThis field is required in create operations.",
- "type": "string"
- },
- "sellerNetworkIds": {
- "type": "array",
+ "vendorIds": {
+ "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
"items": {
- "type": "integer",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
- "description": "The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs."
- }
- },
- "id": "FilterSet",
- "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"",
- "type": "object"
- },
- "CalloutStatusRow": {
- "properties": {
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
+ "type": "array"
},
- "calloutStatusId": {
- "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
+ "version": {
+ "description": "@OutputOnly The version of this creative.",
"format": "int32",
"type": "integer"
},
- "impressionCount": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
+ "video": {
+ "$ref": "VideoContent",
+ "description": "A video creative."
}
},
- "id": "CalloutStatusRow",
- "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.",
"type": "object"
},
- "ListDealAssociationsResponse": {
- "description": "A response for listing creative and deal associations",
- "type": "object",
+ "CreativeDealAssociation": {
+ "description": "The association between a creative and a deal.",
+ "id": "CreativeDealAssociation",
"properties": {
- "associations": {
- "description": "The list of associations.",
- "type": "array",
- "items": {
- "$ref": "CreativeDealAssociation"
- }
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "type": "string"
},
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
+ "type": "string"
+ },
+ "dealsId": {
+ "description": "The externalDealId for the deal associated with the creative.",
"type": "string"
}
},
- "id": "ListDealAssociationsResponse"
+ "type": "object"
},
- "StopWatchingCreativeRequest": {
- "description": "A request for stopping notifications for changes to creative Status.",
- "type": "object",
- "properties": {},
- "id": "StopWatchingCreativeRequest"
+ "CreativeStatusRow": {
+ "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
+ "id": "CreativeStatusRow",
+ "properties": {
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified status."
+ },
+ "creativeStatusId": {
+ "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ }
+ },
+ "type": "object"
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "id": "Date",
+ "properties": {
+ "day": {
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
"Disapproval": {
"description": "@OutputOnly The reason and details for a disapproval.",
- "type": "object",
+ "id": "Disapproval",
"properties": {
"details": {
"description": "Additional details about the reason for disapproval.",
- "type": "array",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
},
"reason": {
+ "description": "The categorized reason for disapproval.",
"enum": [
"LENGTH_OF_IMAGE_ANIMATION",
"BROKEN_URL",
@@ -902,8 +2704,6 @@
"PERSONAL_LOANS",
"UNSUPPORTED_FLASH_CONTENT"
],
- "description": "The categorized reason for disapproval.",
- "type": "string",
"enumDescriptions": [
"The length of the image animation is longer than allowed.",
"The click through URL doesn't work properly.",
@@ -966,9 +2766,9 @@
"The ad tries to circumvent Google's advertising systems.",
"The ad promotes dangerous knives.",
"The ad promotes explosives.",
- "The ad promotes guns & parts.",
- "The ad promotes recreational drugs/services & related equipment.",
- "The ad promotes tobacco products/services & related equipment.",
+ "The ad promotes guns \u0026 parts.",
+ "The ad promotes recreational drugs/services \u0026 related equipment.",
+ "The ad promotes tobacco products/services \u0026 related equipment.",
"The ad promotes weapons.",
"The ad is unclear or irrelevant to the destination site.",
"The ad does not meet professional standards.",
@@ -981,7 +2781,7 @@
"Offensive or inappropriate content.",
"Capitalizing on sensitive events.",
"Shocking content.",
- "Products & Services that enable dishonest behavior.",
+ "Products \u0026 Services that enable dishonest behavior.",
"The ad does not meet technical requirements.",
"Restricted political content.",
"Unsupported content.",
@@ -999,480 +2799,149 @@
"Maximum number of cookies exceeded.",
"Financial service ad does not adhere to specifications.",
"Flash content was found in an unsupported context."
- ]
- }
- },
- "id": "Disapproval"
- },
- "ServingRestriction": {
- "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
- "type": "object",
- "properties": {
- "contexts": {
- "description": "The contexts for the restriction.",
- "type": "array",
- "items": {
- "$ref": "ServingContext"
- }
- },
- "status": {
- "enumDescriptions": [
- "The status is not known.",
- "The ad was disapproved in this context.",
- "The ad is pending review in this context."
],
- "enum": [
- "STATUS_UNSPECIFIED",
- "DISAPPROVAL",
- "PENDING_REVIEW"
- ],
- "description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).",
"type": "string"
- },
- "disapprovalReasons": {
- "type": "array",
- "items": {
- "$ref": "Disapproval"
- },
- "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod."
}
},
- "id": "ServingRestriction"
- },
- "Date": {
- "id": "Date",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object",
- "properties": {
- "year": {
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "format": "int32",
- "type": "integer"
- },
- "day": {
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
- "format": "int32",
- "type": "integer"
- },
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "RowDimensions": {
- "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
- "type": "object",
- "properties": {
- "timeInterval": {
- "description": "The time interval that this row represents.",
- "$ref": "TimeInterval"
- }
- },
- "id": "RowDimensions"
+ "type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
+ "id": "Empty",
"properties": {},
- "id": "Empty"
- },
- "AppContext": {
- "description": "@OutputOnly The app type the restriction applies to for mobile device.",
- "type": "object",
- "properties": {
- "appTypes": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "NATIVE",
- "WEB"
- ]
- },
- "enumDescriptions": [
- "Native app context.",
- "Mobile web app context."
- ],
- "description": "The app types this restriction applies to."
- }
- },
- "id": "AppContext"
- },
- "ListFilteredBidsResponse": {
- "properties": {
- "creativeStatusRows": {
- "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).",
- "type": "array",
- "items": {
- "$ref": "CreativeStatusRow"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the filteredBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListFilteredBidsResponse",
- "description": "Response message for listing all reasons that bids were filtered from the\nauction.",
"type": "object"
},
- "SecurityContext": {
- "id": "SecurityContext",
- "description": "@OutputOnly A security context.",
- "type": "object",
+ "FilterSet": {
+ "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"",
+ "id": "FilterSet",
"properties": {
- "securities": {
- "description": "The security types in this context.",
- "type": "array",
- "items": {
- "enum": [
- "INSECURE",
- "SSL"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Matches impressions that require insecure compatibility.",
- "Matches impressions that require SSL compatibility."
- ]
- }
- }
- },
- "HtmlContent": {
- "description": "HTML content for a creative.",
- "type": "object",
- "properties": {
- "width": {
- "description": "The width of the HTML snippet in pixels.",
- "format": "int32",
- "type": "integer"
+ "absoluteDateRange": {
+ "$ref": "AbsoluteDateRange",
+ "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
},
- "snippet": {
- "description": "The HTML snippet that displays the ad when inserted in the web page.",
+ "creativeId": {
+ "description": "The ID of the creative on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.",
"type": "string"
},
- "height": {
- "description": "The height of the HTML snippet in pixels.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "HtmlContent"
- },
- "ListCreativesResponse": {
- "description": "A response for listing creatives.",
- "type": "object",
- "properties": {
- "creatives": {
- "description": "The list of creatives.",
- "type": "array",
- "items": {
- "$ref": "Creative"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
- "type": "string"
- }
- },
- "id": "ListCreativesResponse"
- },
- "ListFilteredBidRequestsResponse": {
- "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
- "type": "object",
- "properties": {
- "calloutStatusRows": {
- "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
- "type": "array",
- "items": {
- "$ref": "CalloutStatusRow"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the filteredBidRequests.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListFilteredBidRequestsResponse"
- },
- "ListBidMetricsResponse": {
- "description": "Response message for listing the metrics that are measured in number of bids.",
- "type": "object",
- "properties": {
- "bidMetricsRows": {
- "description": "List of rows, each containing a set of bid metrics.",
- "type": "array",
- "items": {
- "$ref": "BidMetricsRow"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the bidMetrics.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListBidMetricsResponse"
- },
- "Reason": {
- "description": "A specific filtering status and how many times it occurred.",
- "type": "object",
- "properties": {
- "status": {
- "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
- "format": "int32",
- "type": "integer"
- },
- "count": {
- "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
+ "dealId": {
+ "description": "The ID of the deal on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.",
"format": "int64",
"type": "string"
- }
- },
- "id": "Reason"
- },
- "ListNonBillableWinningBidsResponse": {
- "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
- "type": "object",
- "properties": {
- "nonBillableWinningBidStatusRows": {
- "description": "List of rows, with counts of bids not billed aggregated by reason.",
- "type": "array",
- "items": {
- "$ref": "NonBillableWinningBidStatusRow"
- }
},
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the nonBillableWinningBids.list\nmethod to retrieve the next page of results."
- }
- },
- "id": "ListNonBillableWinningBidsResponse"
- },
- "ListLosingBidsResponse": {
- "description": "Response message for listing all reasons that bids lost in the auction.",
- "type": "object",
- "properties": {
- "creativeStatusRows": {
- "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
- "type": "array",
- "items": {
- "$ref": "CreativeStatusRow"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the losingBids.list\nmethod to retrieve the next page of results."
- }
- },
- "id": "ListLosingBidsResponse"
- },
- "VideoContent": {
- "properties": {
- "videoUrl": {
- "description": "The URL to fetch a video ad.",
+ "environment": {
+ "description": "The environment on which to filter; optional.",
+ "enum": [
+ "ENVIRONMENT_UNSPECIFIED",
+ "WEB",
+ "APP"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
+ "The ad impression appears on the web.",
+ "The ad impression appears in an app."
+ ],
"type": "string"
- }
- },
- "id": "VideoContent",
- "description": "Video content for a creative.",
- "type": "object"
- },
- "ImpressionMetricsRow": {
- "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.",
- "type": "object",
- "properties": {
- "responsesWithBids": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
},
- "successfulResponses": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
- },
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "availableImpressions": {
- "$ref": "MetricValue",
- "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable."
- },
- "inventoryMatches": {
- "$ref": "MetricValue",
- "description": "The number of impressions that match the buyer's inventory pretargeting."
- },
- "bidRequests": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
- }
- },
- "id": "ImpressionMetricsRow"
- },
- "AuctionContext": {
- "properties": {
- "auctionTypes": {
- "description": "The auction types this restriction applies to.",
- "type": "array",
+ "formats": {
+ "description": "The list of formats on which to filter; may be empty. The filters\nrepresented by multiple formats are ORed together (i.e. if non-empty,\nresults must match any one of the formats).",
+ "enumDescriptions": [
+ "A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
+ "The ad impression is a native ad, and display (i.e. image) format.",
+ "The ad impression is a native ad, and video format.",
+ "The ad impression is not a native ad, and display (i.e. image) format.",
+ "The ad impression is not a native ad, and video format."
+ ],
"items": {
"enum": [
- "OPEN_AUCTION",
- "DIRECT_DEALS"
+ "FORMAT_UNSPECIFIED",
+ "NATIVE_DISPLAY",
+ "NATIVE_VIDEO",
+ "NON_NATIVE_DISPLAY",
+ "NON_NATIVE_VIDEO"
],
"type": "string"
},
+ "type": "array"
+ },
+ "name": {
+ "description": "A user-defined name of the filter set. Filter set names must be unique\nglobally and match one of the patterns:\n\n- `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting\ndata)\n- `bidders/*/accounts/*/filterSets/*` (for accessing account-level\ntroubleshooting data)\n\nThis field is required in create operations.",
+ "type": "string"
+ },
+ "platforms": {
+ "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms).",
"enumDescriptions": [
- "The restriction applies to open auction.",
- "The restriction applies to direct deals."
- ]
+ "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
+ "The ad impression appears on a desktop.",
+ "The ad impression appears on a tablet.",
+ "The ad impression appears on a mobile device."
+ ],
+ "items": {
+ "enum": [
+ "PLATFORM_UNSPECIFIED",
+ "DESKTOP",
+ "TABLET",
+ "MOBILE"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "realtimeTimeRange": {
+ "$ref": "RealtimeTimeRange",
+ "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp."
+ },
+ "relativeDateRange": {
+ "$ref": "RelativeDateRange",
+ "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
+ },
+ "sellerNetworkIds": {
+ "description": "The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "timeSeriesGranularity": {
+ "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
+ "enum": [
+ "TIME_SERIES_GRANULARITY_UNSPECIFIED",
+ "HOURLY",
+ "DAILY"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.",
+ "Indicates that data will be broken down by the hour.",
+ "Indicates that data will be broken down by the day."
+ ],
+ "type": "string"
}
},
- "id": "AuctionContext",
- "description": "@OutputOnly The auction type the restriction applies to.",
"type": "object"
},
- "ListImpressionMetricsResponse": {
- "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
- "type": "object",
+ "FilteredBidCreativeRow": {
+ "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
+ "id": "FilteredBidCreativeRow",
"properties": {
- "impressionMetricsRows": {
- "type": "array",
- "items": {
- "$ref": "ImpressionMetricsRow"
- },
- "description": "List of rows, each containing a set of impression metrics."
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the impressionMetrics.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListImpressionMetricsResponse"
- },
- "BidMetricsRow": {
- "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
- "type": "object",
- "properties": {
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
- },
- "impressionsWon": {
- "$ref": "MetricValue",
- "description": "The number of bids that won an impression."
- },
- "viewableImpressions": {
- "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View).",
- "$ref": "MetricValue"
- },
- "measurableImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)."
- },
- "bids": {
- "$ref": "MetricValue",
- "description": "The number of bids that Ad Exchange received from the buyer."
- },
- "billedImpressions": {
- "description": "The number of bids for which the buyer was billed.",
- "$ref": "MetricValue"
- },
- "bidsInAuction": {
- "$ref": "MetricValue",
- "description": "The number of bids that were permitted to compete in the auction."
- }
- },
- "id": "BidMetricsRow"
- },
- "ListBidResponseErrorsResponse": {
- "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
- "type": "object",
- "properties": {
- "calloutStatusRows": {
- "description": "List of rows, with counts of bid responses aggregated by callout status.",
- "type": "array",
- "items": {
- "$ref": "CalloutStatusRow"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the bidResponseErrors.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListBidResponseErrorsResponse"
- },
- "CreativeStatusRow": {
- "id": "CreativeStatusRow",
- "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
- "type": "object",
- "properties": {
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
- },
- "creativeStatusId": {
- "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
- "format": "int32",
- "type": "integer"
- },
"bidCount": {
"$ref": "MetricValue",
- "description": "The number of bids with the specified status."
- }
- }
- },
- "RealtimeTimeRange": {
- "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
- "type": "object",
- "properties": {
- "startTimestamp": {
- "description": "The start timestamp of the real-time RTB metrics aggregation.",
- "format": "google-datetime",
+ "description": "The number of bids with the specified creative."
+ },
+ "creativeId": {
+ "description": "The ID of the creative.",
"type": "string"
- }
- },
- "id": "RealtimeTimeRange"
- },
- "NonBillableWinningBidStatusRow": {
- "id": "NonBillableWinningBidStatusRow",
- "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
- "type": "object",
- "properties": {
- "status": {
- "description": "The status specifying why the winning bids were not billed.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "The buyer was not billed because the ad was not rendered by the\npublisher.",
- "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "AD_NOT_RENDERED",
- "INVALID_IMPRESSION"
- ]
},
"rowDimensions": {
"$ref": "RowDimensions",
"description": "The values of all dimensions associated with metric values in this row."
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified status."
}
- }
+ },
+ "type": "object"
},
"FilteredBidDetailRow": {
- "id": "FilteredBidDetailRow",
"description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
- "type": "object",
+ "id": "FilteredBidDetailRow",
"properties": {
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
- },
"bidCount": {
"$ref": "MetricValue",
"description": "The number of bids with the specified detail."
@@ -1481,85 +2950,587 @@
"description": "The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.",
"format": "int32",
"type": "integer"
- }
- }
- },
- "AbsoluteDateRange": {
- "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
- "type": "object",
- "properties": {
- "startDate": {
- "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date.",
- "$ref": "Date"
},
- "endDate": {
- "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date.",
- "$ref": "Date"
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
}
},
- "id": "AbsoluteDateRange"
+ "type": "object"
},
- "AddDealAssociationRequest": {
- "id": "AddDealAssociationRequest",
- "description": "A request for associating a deal and a creative.",
- "type": "object",
+ "FilteringStats": {
+ "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
+ "id": "FilteringStats",
"properties": {
- "association": {
- "$ref": "CreativeDealAssociation",
- "description": "The association between a creative and a deal that should be added."
- }
- }
- },
- "WatchCreativeRequest": {
- "type": "object",
- "properties": {
- "topic": {
- "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.",
- "type": "string"
+ "date": {
+ "$ref": "Date",
+ "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24."
+ },
+ "reasons": {
+ "description": "The set of filtering reasons for this date.",
+ "items": {
+ "$ref": "Reason"
+ },
+ "type": "array"
}
},
- "id": "WatchCreativeRequest",
- "description": "A request for watching changes to creative Status."
+ "type": "object"
},
- "TimeInterval": {
- "description": "An interval of time, with an absolute start and end.",
- "type": "object",
+ "HtmlContent": {
+ "description": "HTML content for a creative.",
+ "id": "HtmlContent",
"properties": {
- "endTime": {
- "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
- "format": "google-datetime",
+ "height": {
+ "description": "The height of the HTML snippet in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "snippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page.",
"type": "string"
},
- "startTime": {
- "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
- "format": "google-datetime",
- "type": "string"
+ "width": {
+ "description": "The width of the HTML snippet in pixels.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "TimeInterval"
+ "type": "object"
},
- "FilteredBidCreativeRow": {
+ "Image": {
+ "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
+ "id": "Image",
"properties": {
+ "height": {
+ "description": "Image height in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "description": "The URL of the image.",
+ "type": "string"
+ },
+ "width": {
+ "description": "Image width in pixels.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ImpressionMetricsRow": {
+ "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.",
+ "id": "ImpressionMetricsRow",
+ "properties": {
+ "availableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable."
+ },
+ "bidRequests": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
+ },
+ "inventoryMatches": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions that match the buyer's inventory pretargeting."
+ },
+ "responsesWithBids": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
+ },
"rowDimensions": {
"$ref": "RowDimensions",
"description": "The values of all dimensions associated with metric values in this row."
},
- "bidCount": {
+ "successfulResponses": {
"$ref": "MetricValue",
- "description": "The number of bids with the specified creative."
+ "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
+ }
+ },
+ "type": "object"
+ },
+ "ListBidMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of bids.",
+ "id": "ListBidMetricsResponse",
+ "properties": {
+ "bidMetricsRows": {
+ "description": "List of rows, each containing a set of bid metrics.",
+ "items": {
+ "$ref": "BidMetricsRow"
+ },
+ "type": "array"
},
- "creativeId": {
- "description": "The ID of the creative.",
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the bidMetrics.list\nmethod to retrieve the next page of results.",
"type": "string"
}
},
- "id": "FilteredBidCreativeRow",
- "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
+ "type": "object"
+ },
+ "ListBidResponseErrorsResponse": {
+ "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
+ "id": "ListBidResponseErrorsResponse",
+ "properties": {
+ "calloutStatusRows": {
+ "description": "List of rows, with counts of bid responses aggregated by callout status.",
+ "items": {
+ "$ref": "CalloutStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the bidResponseErrors.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListBidResponsesWithoutBidsResponse": {
+ "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
+ "id": "ListBidResponsesWithoutBidsResponse",
+ "properties": {
+ "bidResponseWithoutBidsStatusRows": {
+ "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
+ "items": {
+ "$ref": "BidResponseWithoutBidsStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListClientUserInvitationsResponse": {
+ "id": "ListClientUserInvitationsResponse",
+ "properties": {
+ "invitations": {
+ "description": "The returned list of client users.",
+ "items": {
+ "$ref": "ClientUserInvitation"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListClientUsersResponse": {
+ "id": "ListClientUsersResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
+ "type": "string"
+ },
+ "users": {
+ "description": "The returned list of client users.",
+ "items": {
+ "$ref": "ClientUser"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListClientsResponse": {
+ "id": "ListClientsResponse",
+ "properties": {
+ "clients": {
+ "description": "The returned list of clients.",
+ "items": {
+ "$ref": "Client"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListCreativeStatusBreakdownByCreativeResponse": {
+ "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
+ "id": "ListCreativeStatusBreakdownByCreativeResponse",
+ "properties": {
+ "filteredBidCreativeRows": {
+ "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
+ "items": {
+ "$ref": "FilteredBidCreativeRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the filteredBids.creatives.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListCreativeStatusBreakdownByDetailResponse": {
+ "description": "Response message for listing all details associated with a given filtered bid\nreason.",
+ "id": "ListCreativeStatusBreakdownByDetailResponse",
+ "properties": {
+ "detailType": {
+ "description": "The type of detail that the detail IDs represent.",
+ "enum": [
+ "DETAIL_TYPE_UNSPECIFIED",
+ "CREATIVE_ATTRIBUTE",
+ "VENDOR",
+ "SENSITIVE_CATEGORY",
+ "PRODUCT_CATEGORY",
+ "DISAPPROVAL_REASON"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
+ "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
+ "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
+ "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).",
+ "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
+ ],
+ "type": "string"
+ },
+ "filteredBidDetailRows": {
+ "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
+ "items": {
+ "$ref": "FilteredBidDetailRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the filteredBids.details.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListCreativesResponse": {
+ "description": "A response for listing creatives.",
+ "id": "ListCreativesResponse",
+ "properties": {
+ "creatives": {
+ "description": "The list of creatives.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListDealAssociationsResponse": {
+ "description": "A response for listing creative and deal associations",
+ "id": "ListDealAssociationsResponse",
+ "properties": {
+ "associations": {
+ "description": "The list of associations.",
+ "items": {
+ "$ref": "CreativeDealAssociation"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListFilterSetsResponse": {
+ "description": "Response message for listing filter sets.",
+ "id": "ListFilterSetsResponse",
+ "properties": {
+ "filterSets": {
+ "description": "The filter sets belonging to the buyer.",
+ "items": {
+ "$ref": "FilterSet"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListFilteredBidRequestsResponse": {
+ "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
+ "id": "ListFilteredBidRequestsResponse",
+ "properties": {
+ "calloutStatusRows": {
+ "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
+ "items": {
+ "$ref": "CalloutStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the filteredBidRequests.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListFilteredBidsResponse": {
+ "description": "Response message for listing all reasons that bids were filtered from the\nauction.",
+ "id": "ListFilteredBidsResponse",
+ "properties": {
+ "creativeStatusRows": {
+ "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).",
+ "items": {
+ "$ref": "CreativeStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the filteredBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListImpressionMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
+ "id": "ListImpressionMetricsResponse",
+ "properties": {
+ "impressionMetricsRows": {
+ "description": "List of rows, each containing a set of impression metrics.",
+ "items": {
+ "$ref": "ImpressionMetricsRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the impressionMetrics.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListLosingBidsResponse": {
+ "description": "Response message for listing all reasons that bids lost in the auction.",
+ "id": "ListLosingBidsResponse",
+ "properties": {
+ "creativeStatusRows": {
+ "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
+ "items": {
+ "$ref": "CreativeStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the losingBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListNonBillableWinningBidsResponse": {
+ "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
+ "id": "ListNonBillableWinningBidsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the nonBillableWinningBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
+ "nonBillableWinningBidStatusRows": {
+ "description": "List of rows, with counts of bids not billed aggregated by reason.",
+ "items": {
+ "$ref": "NonBillableWinningBidStatusRow"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LocationContext": {
+ "description": "@OutputOnly The Geo criteria the restriction applies to.",
+ "id": "LocationContext",
+ "properties": {
+ "geoCriteriaIds": {
+ "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MetricValue": {
+ "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).",
+ "id": "MetricValue",
+ "properties": {
+ "value": {
+ "description": "The expected value of the metric.",
+ "format": "int64",
+ "type": "string"
+ },
+ "variance": {
+ "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NativeContent": {
+ "description": "Native content for a creative.",
+ "id": "NativeContent",
+ "properties": {
+ "advertiserName": {
+ "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
+ "type": "string"
+ },
+ "appIcon": {
+ "$ref": "Image",
+ "description": "The app icon, for app download ads."
+ },
+ "body": {
+ "description": "A long description of the ad.",
+ "type": "string"
+ },
+ "callToAction": {
+ "description": "A label for the button that the user is supposed to click.",
+ "type": "string"
+ },
+ "clickLinkUrl": {
+ "description": "The URL that the browser/SDK will load when the user clicks the ad.",
+ "type": "string"
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "A short title for the ad.",
+ "type": "string"
+ },
+ "image": {
+ "$ref": "Image",
+ "description": "A large image."
+ },
+ "logo": {
+ "$ref": "Image",
+ "description": "A smaller image, for the advertiser's logo."
+ },
+ "priceDisplayText": {
+ "description": "The price of the promoted app including currency info.",
+ "type": "string"
+ },
+ "starRating": {
+ "description": "The app rating in the app store. Must be in the range [0-5].",
+ "format": "double",
+ "type": "number"
+ },
+ "storeUrl": {
+ "description": "The URL to the app store to purchase/download the promoted app.",
+ "type": "string"
+ },
+ "videoUrl": {
+ "description": "The URL to fetch a native video ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NonBillableWinningBidStatusRow": {
+ "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
+ "id": "NonBillableWinningBidStatusRow",
+ "properties": {
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified status."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ },
+ "status": {
+ "description": "The status specifying why the winning bids were not billed.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "AD_NOT_RENDERED",
+ "INVALID_IMPRESSION"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "The buyer was not billed because the ad was not rendered by the\npublisher.",
+ "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PlatformContext": {
+ "description": "@OutputOnly The type of platform the restriction applies to.",
+ "id": "PlatformContext",
+ "properties": {
+ "platforms": {
+ "description": "The platforms this restriction applies to.",
+ "enumDescriptions": [
+ "Desktop platform.",
+ "Android platform.",
+ "iOS platform."
+ ],
+ "items": {
+ "enum": [
+ "DESKTOP",
+ "ANDROID",
+ "IOS"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RealtimeTimeRange": {
+ "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
+ "id": "RealtimeTimeRange",
+ "properties": {
+ "startTimestamp": {
+ "description": "The start timestamp of the real-time RTB metrics aggregation.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Reason": {
+ "description": "A specific filtering status and how many times it occurred.",
+ "id": "Reason",
+ "properties": {
+ "count": {
+ "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
"type": "object"
},
"RelativeDateRange": {
"description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days \u003e= 0\nduration_days \u003e= 1\noffset_days + duration_days \u003c= 30",
- "type": "object",
+ "id": "RelativeDateRange",
"properties": {
"durationDays": {
"description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
@@ -1572,2163 +3543,176 @@
"type": "integer"
}
},
- "id": "RelativeDateRange"
+ "type": "object"
},
- "NativeContent": {
- "description": "Native content for a creative.",
- "type": "object",
+ "RemoveDealAssociationRequest": {
+ "description": "A request for removing the association between a deal and a creative.",
+ "id": "RemoveDealAssociationRequest",
"properties": {
- "videoUrl": {
- "description": "The URL to fetch a native video ad.",
- "type": "string"
- },
- "clickLinkUrl": {
- "description": "The URL that the browser/SDK will load when the user clicks the ad.",
- "type": "string"
- },
- "logo": {
- "$ref": "Image",
- "description": "A smaller image, for the advertiser's logo."
- },
- "priceDisplayText": {
- "description": "The price of the promoted app including currency info.",
- "type": "string"
- },
- "image": {
- "$ref": "Image",
- "description": "A large image."
- },
- "clickTrackingUrl": {
- "description": "The URL to use for click tracking.",
- "type": "string"
- },
- "advertiserName": {
- "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
- "type": "string"
- },
- "storeUrl": {
- "description": "The URL to the app store to purchase/download the promoted app.",
- "type": "string"
- },
- "headline": {
- "description": "A short title for the ad.",
- "type": "string"
- },
- "appIcon": {
- "$ref": "Image",
- "description": "The app icon, for app download ads."
- },
- "callToAction": {
- "description": "A label for the button that the user is supposed to click.",
- "type": "string"
- },
- "body": {
- "description": "A long description of the ad.",
- "type": "string"
- },
- "starRating": {
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "format": "double",
- "type": "number"
+ "association": {
+ "$ref": "CreativeDealAssociation",
+ "description": "The association between a creative and a deal that should be removed."
}
},
- "id": "NativeContent"
+ "type": "object"
},
- "ListClientsResponse": {
- "id": "ListClientsResponse",
- "type": "object",
+ "RowDimensions": {
+ "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
+ "id": "RowDimensions",
"properties": {
- "clients": {
- "description": "The returned list of clients.",
- "type": "array",
- "items": {
- "$ref": "Client"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results."
- }
- }
- },
- "ListBidResponsesWithoutBidsResponse": {
- "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
- "type": "object",
- "properties": {
- "bidResponseWithoutBidsStatusRows": {
- "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
- "type": "array",
- "items": {
- "$ref": "BidResponseWithoutBidsStatusRow"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
+ "timeInterval": {
+ "$ref": "TimeInterval",
+ "description": "The time interval that this row represents."
}
},
- "id": "ListBidResponsesWithoutBidsResponse"
+ "type": "object"
+ },
+ "SecurityContext": {
+ "description": "@OutputOnly A security context.",
+ "id": "SecurityContext",
+ "properties": {
+ "securities": {
+ "description": "The security types in this context.",
+ "enumDescriptions": [
+ "Matches impressions that require insecure compatibility.",
+ "Matches impressions that require SSL compatibility."
+ ],
+ "items": {
+ "enum": [
+ "INSECURE",
+ "SSL"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"ServingContext": {
+ "description": "The serving context for this restriction.",
+ "id": "ServingContext",
"properties": {
"all": {
- "enumDescriptions": [
- "A simple context."
- ],
+ "description": "Matches all contexts.",
"enum": [
"SIMPLE_CONTEXT"
],
- "description": "Matches all contexts.",
+ "enumDescriptions": [
+ "A simple context."
+ ],
"type": "string"
},
"appType": {
- "description": "Matches impressions for a particular app type.",
- "$ref": "AppContext"
+ "$ref": "AppContext",
+ "description": "Matches impressions for a particular app type."
},
- "securityType": {
- "$ref": "SecurityContext",
- "description": "Matches impressions for a particular security type."
- },
- "platform": {
- "$ref": "PlatformContext",
- "description": "Matches impressions coming from a particular platform."
+ "auctionType": {
+ "$ref": "AuctionContext",
+ "description": "Matches impressions for a particular auction type."
},
"location": {
"$ref": "LocationContext",
"description": "Matches impressions coming from users *or* publishers in a specific\nlocation."
},
- "auctionType": {
- "$ref": "AuctionContext",
- "description": "Matches impressions for a particular auction type."
+ "platform": {
+ "$ref": "PlatformContext",
+ "description": "Matches impressions coming from a particular platform."
+ },
+ "securityType": {
+ "$ref": "SecurityContext",
+ "description": "Matches impressions for a particular security type."
}
},
- "id": "ServingContext",
- "description": "The serving context for this restriction.",
"type": "object"
},
- "Image": {
- "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
- "type": "object",
+ "ServingRestriction": {
+ "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
+ "id": "ServingRestriction",
"properties": {
- "height": {
- "description": "Image height in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "width": {
- "description": "Image width in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "url": {
- "description": "The URL of the image.",
- "type": "string"
- }
- },
- "id": "Image"
- },
- "ListFilterSetsResponse": {
- "description": "Response message for listing filter sets.",
- "type": "object",
- "properties": {
- "filterSets": {
- "description": "The filter sets belonging to the buyer.",
- "type": "array",
+ "contexts": {
+ "description": "The contexts for the restriction.",
"items": {
- "$ref": "FilterSet"
- }
+ "$ref": "ServingContext"
+ },
+ "type": "array"
},
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results."
- }
- },
- "id": "ListFilterSetsResponse"
- },
- "BidResponseWithoutBidsStatusRow": {
- "properties": {
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "impressionCount": {
- "description": "The number of impressions for which there was a bid response with the\nspecified status.",
- "$ref": "MetricValue"
+ "disapprovalReasons": {
+ "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "items": {
+ "$ref": "Disapproval"
+ },
+ "type": "array"
},
"status": {
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "The response had no bids.",
- "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
- "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
- ],
+ "description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).",
"enum": [
"STATUS_UNSPECIFIED",
- "RESPONSES_WITHOUT_BIDS",
- "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
- "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
+ "DISAPPROVAL",
+ "PENDING_REVIEW"
+ ],
+ "enumDescriptions": [
+ "The status is not known.",
+ "The ad was disapproved in this context.",
+ "The ad is pending review in this context."
],
- "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
"type": "string"
}
},
- "id": "BidResponseWithoutBidsStatusRow",
- "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
+ "type": "object"
+ },
+ "StopWatchingCreativeRequest": {
+ "description": "A request for stopping notifications for changes to creative Status.",
+ "id": "StopWatchingCreativeRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "TimeInterval": {
+ "description": "An interval of time, with an absolute start and end.",
+ "id": "TimeInterval",
+ "properties": {
+ "endTime": {
+ "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "VideoContent": {
+ "description": "Video content for a creative.",
+ "id": "VideoContent",
+ "properties": {
+ "videoUrl": {
+ "description": "The URL to fetch a video ad.",
+ "type": "string"
+ },
+ "videoVastXml": {
+ "description": "The contents of a VAST document for a video ad.\nThis document should conform to the VAST 2.0 or 3.0 standard.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "WatchCreativeRequest": {
+ "description": "A request for watching changes to creative Status.",
+ "id": "WatchCreativeRequest",
+ "properties": {
+ "topic": {
+ "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.",
+ "type": "string"
+ }
+ },
"type": "object"
}
},
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "AdExchangeBuyerII",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "rootUrl": "https://adexchangebuyer.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "adexchangebuyer2",
- "batchPath": "batch",
+ "servicePath": "",
"title": "Ad Exchange Buyer API II",
- "ownerName": "Google",
- "resources": {
- "bidders": {
- "resources": {
- "filterSets": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}",
- "path": "v2beta1/{+name}",
- "id": "adexchangebuyer2.bidders.filterSets.delete",
- "description": "Deletes the requested filter set from the account with the given account\nID."
- },
- "get": {
- "description": "Retrieves the requested filter set for the account with the given account\nID.",
- "response": {
- "$ref": "FilterSet"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}",
- "path": "v2beta1/{+name}",
- "id": "adexchangebuyer2.bidders.filterSets.get"
- },
- "list": {
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets",
- "id": "adexchangebuyer2.bidders.filterSets.list",
- "path": "v2beta1/{+ownerName}/filterSets",
- "description": "Lists all filter sets for the account with the given account ID.",
- "httpMethod": "GET",
- "parameterOrder": [
- "ownerName"
- ],
- "response": {
- "$ref": "ListFilterSetsResponse"
- },
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "ownerName": {
- "pattern": "^bidders/[^/]+$",
- "location": "path",
- "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "create": {
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "isTransient": {
- "location": "query",
- "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
- "type": "boolean"
- },
- "ownerName": {
- "pattern": "^bidders/[^/]+$",
- "location": "path",
- "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets",
- "path": "v2beta1/{+ownerName}/filterSets",
- "id": "adexchangebuyer2.bidders.filterSets.create",
- "description": "Creates the specified filter set for the account with the given account ID.",
- "request": {
- "$ref": "FilterSet"
- },
- "response": {
- "$ref": "FilterSet"
- },
- "parameterOrder": [
- "ownerName"
- ],
- "httpMethod": "POST"
- }
- },
- "resources": {
- "nonBillableWinningBids": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListNonBillableWinningBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filterSetName": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids",
- "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
- "id": "adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list",
- "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason."
- }
- }
- },
- "filteredBids": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListFilteredBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids",
- "path": "v2beta1/{+filterSetName}/filteredBids",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBids.list",
- "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason."
- }
- },
- "resources": {
- "creatives": {
- "methods": {
- "list": {
- "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
- },
- "parameterOrder": [
- "filterSetName",
- "creativeStatusId"
- ],
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "creativeStatusId": {
- "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
- "format": "int32",
- "required": true,
- "type": "integer",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod."
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list",
- "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives"
- }
- }
- },
- "details": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListCreativeStatusBreakdownByDetailResponse"
- },
- "parameterOrder": [
- "filterSetName",
- "creativeStatusId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "creativeStatusId": {
- "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
- "format": "int32",
- "required": true,
- "type": "integer",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details",
- "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBids.details.list",
- "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail."
- }
- }
- }
- }
- },
- "losingBids": {
- "methods": {
- "list": {
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids",
- "path": "v2beta1/{+filterSetName}/losingBids",
- "id": "adexchangebuyer2.bidders.filterSets.losingBids.list",
- "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
- "response": {
- "$ref": "ListLosingBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filterSetName": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "impressionMetrics": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListImpressionMetricsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/impressionMetrics",
- "path": "v2beta1/{+filterSetName}/impressionMetrics",
- "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list",
- "description": "Lists all metrics that are measured in terms of number of impressions."
- }
- }
- },
- "bidMetrics": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBidMetricsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics",
- "path": "v2beta1/{+filterSetName}/bidMetrics",
- "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list",
- "description": "Lists all metrics that are measured in terms of number of bids."
- }
- }
- },
- "bidResponseErrors": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBidResponseErrorsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filterSetName": {
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors",
- "path": "v2beta1/{+filterSetName}/bidResponseErrors",
- "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list",
- "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason."
- }
- }
- },
- "bidResponsesWithoutBids": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBidResponsesWithoutBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filterSetName": {
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
- "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
- "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list",
- "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason."
- }
- }
- },
- "filteredBidRequests": {
- "methods": {
- "list": {
- "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListFilteredBidRequestsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list",
- "path": "v2beta1/{+filterSetName}/filteredBidRequests"
- }
- }
- }
- }
- },
- "accounts": {
- "resources": {
- "filterSets": {
- "methods": {
- "create": {
- "request": {
- "$ref": "FilterSet"
- },
- "description": "Creates the specified filter set for the account with the given account ID.",
- "response": {
- "$ref": "FilterSet"
- },
- "parameterOrder": [
- "ownerName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "isTransient": {
- "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
- "type": "boolean",
- "location": "query"
- },
- "ownerName": {
- "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
- "path": "v2beta1/{+ownerName}/filterSets",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.create"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}",
- "path": "v2beta1/{+name}",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.delete",
- "description": "Deletes the requested filter set from the account with the given account\nID."
- },
- "get": {
- "id": "adexchangebuyer2.bidders.accounts.filterSets.get",
- "path": "v2beta1/{+name}",
- "description": "Retrieves the requested filter set for the account with the given account\nID.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "FilterSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "name": {
- "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}"
- },
- "list": {
- "description": "Lists all filter sets for the account with the given account ID.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListFilterSetsResponse"
- },
- "parameterOrder": [
- "ownerName"
- ],
- "parameters": {
- "ownerName": {
- "location": "path",
- "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+$"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.list",
- "path": "v2beta1/{+ownerName}/filterSets"
- }
- },
- "resources": {
- "bidResponsesWithoutBids": {
- "methods": {
- "list": {
- "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list",
- "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
- "response": {
- "$ref": "ListBidResponsesWithoutBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filterSetName": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids"
- }
- }
- },
- "filteredBidRequests": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListFilteredBidRequestsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests",
- "path": "v2beta1/{+filterSetName}/filteredBidRequests",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list",
- "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason."
- }
- }
- },
- "filteredBids": {
- "methods": {
- "list": {
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids",
- "path": "v2beta1/{+filterSetName}/filteredBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list",
- "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
- "response": {
- "$ref": "ListFilteredBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod."
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- }
- }
- },
- "resources": {
- "details": {
- "methods": {
- "list": {
- "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
- "response": {
- "$ref": "ListCreativeStatusBreakdownByDetailResponse"
- },
- "parameterOrder": [
- "filterSetName",
- "creativeStatusId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- },
- "creativeStatusId": {
- "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
- "format": "int32",
- "required": true,
- "type": "integer",
- "location": "path"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details",
- "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list"
- }
- }
- },
- "creatives": {
- "methods": {
- "list": {
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
- "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list",
- "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
- "response": {
- "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
- },
- "parameterOrder": [
- "filterSetName",
- "creativeStatusId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "creativeStatusId": {
- "location": "path",
- "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
- "format": "int32",
- "required": true,
- "type": "integer"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- }
- }
- }
- }
- }
- },
- "nonBillableWinningBids": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListNonBillableWinningBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids",
- "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list",
- "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason."
- }
- }
- },
- "losingBids": {
- "methods": {
- "list": {
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list",
- "path": "v2beta1/{+filterSetName}/losingBids",
- "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
- "response": {
- "$ref": "ListLosingBidsResponse"
- },
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "impressionMetrics": {
- "methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/impressionMetrics",
- "path": "v2beta1/{+filterSetName}/impressionMetrics",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list",
- "description": "Lists all metrics that are measured in terms of number of impressions.",
- "response": {
- "$ref": "ListImpressionMetricsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET"
- }
- }
- },
- "bidMetrics": {
- "methods": {
- "list": {
- "id": "adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list",
- "path": "v2beta1/{+filterSetName}/bidMetrics",
- "description": "Lists all metrics that are measured in terms of number of bids.",
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
- "response": {
- "$ref": "ListBidMetricsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filterSetName": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.",
- "type": "string"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidMetrics"
- }
- }
- },
- "bidResponseErrors": {
- "methods": {
- "list": {
- "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
- "response": {
- "$ref": "ListBidResponseErrorsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32"
- },
- "filterSetName": {
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponseErrors",
- "path": "v2beta1/{+filterSetName}/bidResponseErrors",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "accounts": {
- "resources": {
- "clients": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Client"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.get",
- "description": "Gets a client buyer with a given client account ID."
- },
- "list": {
- "response": {
- "$ref": "ListClientsResponse"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
- "type": "string"
- },
- "partnerClientId": {
- "location": "query",
- "description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor\nbuyer partner) of the client to return.\nIf specified, at most one client will be returned in the response.",
- "type": "string"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients",
- "path": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.list",
- "description": "Lists all the clients for the current sponsor buyer."
- },
- "update": {
- "request": {
- "$ref": "Client"
- },
- "description": "Updates an existing client buyer.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "response": {
- "$ref": "Client"
- },
- "parameters": {
- "accountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
- "format": "int64"
- },
- "clientAccountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Unique numerical account ID of the client to update. (required)",
- "format": "int64"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.update",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}"
- },
- "create": {
- "flatPath": "v2beta1/accounts/{accountId}/clients",
- "path": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.create",
- "request": {
- "$ref": "Client"
- },
- "description": "Creates a new client buyer.",
- "response": {
- "$ref": "Client"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "accountId": {
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- },
- "resources": {
- "invitations": {
- "methods": {
- "get": {
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
- "id": "adexchangebuyer2.accounts.clients.invitations.get",
- "description": "Retrieves an existing client user invitation.",
- "response": {
- "$ref": "ClientUserInvitation"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "invitationId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "invitationId": {
- "location": "path",
- "description": "Numerical identifier of the user invitation to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "accountId": {
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "clientAccountId": {
- "location": "path",
- "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}"
- },
- "list": {
- "response": {
- "$ref": "ListClientUserInvitationsResponse"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
- "type": "string"
- },
- "accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "clientAccountId": {
- "location": "path",
- "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.list",
- "description": "Lists all the client users invitations for a client\nwith a given account ID."
- },
- "create": {
- "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
- "request": {
- "$ref": "ClientUserInvitation"
- },
- "response": {
- "$ref": "ClientUserInvitation"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clientAccountId": {
- "location": "path",
- "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.create"
- }
- }
- },
- "users": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListClientUsersResponse"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "clientAccountId": {
- "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
- "type": "string"
- },
- "accountId": {
- "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "id": "adexchangebuyer2.accounts.clients.users.list",
- "description": "Lists all the known client users for a specified\nsponsor buyer account ID."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "response": {
- "$ref": "ClientUser"
- },
- "parameters": {
- "clientAccountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
- "format": "int64"
- },
- "userId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64"
- },
- "accountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.get",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "description": "Retrieves an existing client user."
- },
- "update": {
- "response": {
- "$ref": "ClientUser"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "accountId": {
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "clientAccountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
- "format": "int64"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.update",
- "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
- "request": {
- "$ref": "ClientUser"
- }
- }
- }
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Creative"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "accountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The account the creative belongs to."
- },
- "creativeId": {
- "description": "The ID of the creative to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.get",
- "description": "Gets a creative."
- },
- "watch": {
- "request": {
- "$ref": "WatchCreativeRequest"
- },
- "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "The account of the creative to watch.",
- "required": true,
- "type": "string"
- },
- "creativeId": {
- "location": "path",
- "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "id": "adexchangebuyer2.accounts.creatives.watch"
- },
- "update": {
- "description": "Updates a creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "required": true,
- "type": "string"
- },
- "creativeId": {
- "location": "path",
- "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "required": true,
- "type": "string"
- },
- "accountId1": {
- "description": "The account the creative belongs to.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.update"
- },
- "list": {
- "response": {
- "$ref": "ListCreativesResponse"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "query": {
- "location": "query",
- "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason}\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'",
- "type": "string"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
- "type": "string",
- "location": "query"
- },
- "accountId": {
- "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.list",
- "description": "Lists creatives."
- },
- "create": {
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.create",
- "description": "Creates a creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "accountId1": {
- "location": "query",
- "description": "The account the creative belongs to.",
- "type": "string"
- },
- "duplicateIdMode": {
- "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
- "type": "string",
- "location": "query",
- "enum": [
- "NO_DUPLICATES",
- "FORCE_ENABLE_DUPLICATE_IDS"
- ]
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives"
- },
- "stopWatching": {
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "The account of the creative to stop notifications for.",
- "required": true,
- "type": "string"
- },
- "creativeId": {
- "location": "path",
- "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "id": "adexchangebuyer2.accounts.creatives.stopWatching",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "request": {
- "$ref": "StopWatchingCreativeRequest"
- },
- "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status."
- }
- },
- "resources": {
- "dealAssociations": {
- "methods": {
- "list": {
- "description": "List all creative-deal associations.",
- "response": {
- "$ref": "ListDealAssociationsResponse"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
- "type": "string",
- "location": "query"
- },
- "accountId": {
- "location": "path",
- "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "query": {
- "location": "query",
- "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
- "type": "string"
- },
- "creativeId": {
- "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list"
- },
- "add": {
- "request": {
- "$ref": "AddDealAssociationRequest"
- },
- "description": "Associate an existing deal with a creative.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "accountId": {
- "description": "The account the creative belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add"
- },
- "remove": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "The account the creative belongs to.",
- "required": true,
- "type": "string"
- },
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
- "description": "Remove the association between a deal and a creative.",
- "request": {
- "$ref": "RemoveDealAssociationRequest"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "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."
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v2beta1"
-}
+ "version": "v2beta1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adexchangebuyer2/v2beta1/adexchangebuyer2-gen.go b/vendor/google.golang.org/api/adexchangebuyer2/v2beta1/adexchangebuyer2-gen.go
index 04905e508..5194c6554 100644
--- a/vendor/google.golang.org/api/adexchangebuyer2/v2beta1/adexchangebuyer2-gen.go
+++ b/vendor/google.golang.org/api/adexchangebuyer2/v2beta1/adexchangebuyer2-gen.go
@@ -1065,6 +1065,8 @@ func (s *Correction) MarshalJSON() ([]byte, error) {
}
// Creative: A creative and its classification data.
+//
+// Next ID: 31
type Creative struct {
// AccountId: The account that this creative belongs to.
// Can be used to filter the response of the
@@ -1673,17 +1675,6 @@ type FilterSet struct {
// "APP" - The ad impression appears in an app.
Environment string `json:"environment,omitempty"`
- // Format: DEPRECATED: use repeated formats field instead.
- // The format on which to filter; optional.
- //
- // Possible values:
- // "FORMAT_UNSPECIFIED" - A placeholder for an undefined format;
- // indicates that no format filter
- // will be applied.
- // "DISPLAY" - The ad impression is display format (i.e. an image).
- // "VIDEO" - The ad impression is video format.
- Format string `json:"format,omitempty"`
-
// Formats: The list of formats on which to filter; may be empty. The
// filters
// represented by multiple formats are ORed together (i.e. if
@@ -1694,8 +1685,14 @@ type FilterSet struct {
// "FORMAT_UNSPECIFIED" - A placeholder for an undefined format;
// indicates that no format filter
// will be applied.
- // "DISPLAY" - The ad impression is display format (i.e. an image).
- // "VIDEO" - The ad impression is video format.
+ // "NATIVE_DISPLAY" - The ad impression is a native ad, and display
+ // (i.e. image) format.
+ // "NATIVE_VIDEO" - The ad impression is a native ad, and video
+ // format.
+ // "NON_NATIVE_DISPLAY" - The ad impression is not a native ad, and
+ // display (i.e. image) format.
+ // "NON_NATIVE_VIDEO" - The ad impression is not a native ad, and
+ // video format.
Formats []string `json:"formats,omitempty"`
// Name: A user-defined name of the filter set. Filter set names must be
@@ -3347,6 +3344,10 @@ type VideoContent struct {
// VideoUrl: The URL to fetch a video ad.
VideoUrl string `json:"videoUrl,omitempty"`
+ // VideoVastXml: 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 `json:"videoVastXml,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "VideoUrl") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -5095,13 +5096,6 @@ func (r *AccountsCreativesService) Create(accountId string, creative *Creative)
return c
}
-// AccountId1 sets the optional parameter "accountId1": The account the
-// creative belongs to.
-func (c *AccountsCreativesCreateCall) AccountId1(accountId1 string) *AccountsCreativesCreateCall {
- c.urlParams_.Set("accountId1", accountId1)
- return c
-}
-
// DuplicateIdMode sets the optional parameter "duplicateIdMode":
// Indicates if multiple creatives can share an ID or not. Default
// is
@@ -5215,11 +5209,6 @@ func (c *AccountsCreativesCreateCall) Do(opts ...googleapi.CallOption) (*Creativ
// "required": true,
// "type": "string"
// },
- // "accountId1": {
- // "description": "The account the creative belongs to.",
- // "location": "query",
- // "type": "string"
- // },
// "duplicateIdMode": {
// "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
// "enum": [
@@ -5784,13 +5773,6 @@ func (r *AccountsCreativesService) Update(accountId string, creativeId string, c
return c
}
-// AccountId1 sets the optional parameter "accountId1": The account the
-// creative belongs to.
-func (c *AccountsCreativesUpdateCall) AccountId1(accountId1 string) *AccountsCreativesUpdateCall {
- c.urlParams_.Set("accountId1", accountId1)
- return c
-}
-
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -5893,11 +5875,6 @@ func (c *AccountsCreativesUpdateCall) Do(opts ...googleapi.CallOption) (*Creativ
// "required": true,
// "type": "string"
// },
- // "accountId1": {
- // "description": "The account the creative belongs to.",
- // "location": "query",
- // "type": "string"
- // },
// "creativeId": {
// "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
// "location": "path",
diff --git a/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-api.json b/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-api.json
index 9dae67df8..2126e85af 100644
--- a/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-api.json
+++ b/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-api.json
@@ -1,1241 +1,1241 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/Dz_LMqDcbtnyBd4CwnrsbswCFU4\"",
- "discoveryVersion": "v1",
- "id": "adexchangeseller:v1.1",
- "name": "adexchangeseller",
- "canonicalName": "Ad Exchange Seller",
- "version": "v1.1",
- "revision": "20160805",
- "title": "Ad Exchange Seller API",
- "description": "Accesses the inventory of Ad Exchange seller users and generates reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangeseller/v1.1/",
- "basePath": "/adexchangeseller/v1.1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangeseller/v1.1/",
- "batchPath": "batch/adexchangeseller/v1.1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.seller": {
- "description": "View and manage your Ad Exchange data"
- },
- "https://www.googleapis.com/auth/adexchange.seller.readonly": {
- "description": "View your Ad Exchange data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#account.",
- "default": "adexchangeseller#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adClient.",
- "default": "adexchangeseller#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adClients.",
- "default": "adexchangeseller#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adUnit.",
- "default": "adexchangeseller#adUnit"
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- }
- }
- },
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adUnits.",
- "default": "adexchangeseller#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Alert": {
- "id": "Alert",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#alert.",
- "default": "adexchangeseller#alert"
- },
- "message": {
- "type": "string",
- "description": "The localized alert message."
- },
- "severity": {
- "type": "string",
- "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE."
- },
- "type": {
- "type": "string",
- "description": "Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD."
- }
- }
- },
- "Alerts": {
- "id": "Alerts",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The alerts returned in this list response.",
- "items": {
- "$ref": "Alert"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#alerts.",
- "default": "adexchangeseller#alerts"
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#customChannel.",
- "default": "adexchangeseller#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
- }
- }
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#customChannels.",
- "default": "adexchangeseller#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "ReportingMetadataEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#metadata.",
- "default": "adexchangeseller#metadata"
- }
- }
- },
- "PreferredDeal": {
- "id": "PreferredDeal",
- "type": "object",
- "properties": {
- "advertiserName": {
- "type": "string",
- "description": "The name of the advertiser this deal is for."
- },
- "buyerNetworkName": {
- "type": "string",
- "description": "The name of the buyer network this deal is for."
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD."
- },
- "endTime": {
- "type": "string",
- "description": "Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.",
- "format": "uint64"
- },
- "fixedCpm": {
- "type": "string",
- "description": "The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this preferred deal.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#preferredDeal.",
- "default": "adexchangeseller#preferredDeal"
- },
- "startTime": {
- "type": "string",
- "description": "Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.",
- "format": "uint64"
- }
- }
- },
- "PreferredDeals": {
- "id": "PreferredDeals",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The preferred deals returned in this list response.",
- "items": {
- "$ref": "PreferredDeal"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#preferredDeals.",
- "default": "adexchangeseller#preferredDeals"
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "headers": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adexchangeseller#report.",
- "default": "adexchangeseller#report"
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ReportingMetadataEntry": {
- "id": "ReportingMetadataEntry",
- "type": "object",
- "properties": {
- "compatibleDimensions": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "compatibleMetrics": {
- "type": "array",
- "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry.",
- "default": "adexchangeseller#reportingMetadataEntry"
- },
- "requiredDimensions": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "requiredMetrics": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "supportedProducts": {
- "type": "array",
- "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#savedReport.",
- "default": "adexchangeseller#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#savedReports.",
- "default": "adexchangeseller#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#urlChannel.",
- "default": "adexchangeseller#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#urlChannels.",
- "default": "adexchangeseller#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangeseller.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about. Tip: 'myaccount' is a valid ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "adclients": {
- "methods": {
- "list": {
- "id": "adexchangeseller.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adexchangeseller.adunits.get",
- "path": "adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.adunits.list",
- "path": "adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.adunits.customchannels.list",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.seller": {
+ "description": "View and manage your Ad Exchange data"
},
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "https://www.googleapis.com/auth/adexchange.seller.readonly": {
+ "description": "View your Ad Exchange data"
}
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
}
- }
}
- }
},
- "alerts": {
- "methods": {
- "list": {
- "id": "adexchangeseller.alerts.list",
- "path": "alerts",
- "httpMethod": "GET",
- "description": "List the alerts for this Ad Exchange account.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
+ "basePath": "/adexchangeseller/v1.1/",
+ "baseUrl": "https://www.googleapis.com/adexchangeseller/v1.1/",
+ "batchPath": "batch/adexchangeseller/v1.1",
+ "canonicalName": "Ad Exchange Seller",
+ "description": "Accesses the inventory of Ad Exchange seller users and generates reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/ptWrH6xTfYx9JmkFvi4WlT7efFk\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
+ "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
},
- "customchannels": {
- "methods": {
- "get": {
- "id": "adexchangeseller.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
+ "id": "adexchangeseller:v1.1",
+ "kind": "discovery#restDescription",
+ "name": "adexchangeseller",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "csv",
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of text/csv",
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "list": {
- "id": "adexchangeseller.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- },
- "resources": {
+ },
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Get information about the selected Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.get",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to get information about. Tip: 'myaccount' is a valid ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
+ "adclients": {
+ "methods": {
+ "list": {
+ "description": "List all ad clients in this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.adclients.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
"adunits": {
- "methods": {
- "list": {
- "id": "adexchangeseller.customchannels.adunits.list",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
+ "methods": {
+ "get": {
+ "description": "Gets the specified ad unit in the specified ad client.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.adunits.get",
+ "parameterOrder": [
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to get the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
+ "$ref": "AdUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
},
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "list": {
+ "description": "List all ad units in the specified ad client for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.adunits.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "customchannels": {
+ "methods": {
+ "list": {
+ "description": "List all custom channels which the specified ad unit belongs to.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.adunits.customchannels.list",
+ "parameterOrder": [
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
}
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
}
- }
- }
- }
- },
- "metadata": {
- "resources": {
- "dimensions": {
- "methods": {
- "list": {
- "id": "adexchangeseller.metadata.dimensions.list",
- "path": "metadata/dimensions",
- "httpMethod": "GET",
- "description": "List the metadata for the dimensions available to this AdExchange account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
},
- "metrics": {
- "methods": {
- "list": {
- "id": "adexchangeseller.metadata.metrics.list",
- "path": "metadata/metrics",
- "httpMethod": "GET",
- "description": "List the metadata for the metrics available to this AdExchange account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
+ "alerts": {
+ "methods": {
+ "list": {
+ "description": "List the alerts for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.alerts.list",
+ "parameters": {
+ "locale": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "alerts",
+ "response": {
+ "$ref": "Alerts"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
}
- }
- }
- }
- },
- "preferreddeals": {
- "methods": {
- "get": {
- "id": "adexchangeseller.preferreddeals.get",
- "path": "preferreddeals/{dealId}",
- "httpMethod": "GET",
- "description": "Get information about the selected Ad Exchange Preferred Deal.",
- "parameters": {
- "dealId": {
- "type": "string",
- "description": "Preferred deal to get information about.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "dealId"
- ],
- "response": {
- "$ref": "PreferredDeal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
},
- "list": {
- "id": "adexchangeseller.preferreddeals.list",
- "path": "preferreddeals",
- "httpMethod": "GET",
- "description": "List the preferred deals for this Ad Exchange account.",
- "response": {
- "$ref": "PreferredDeals"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange 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.",
- "parameters": {
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "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.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.reports.saved.generate",
- "path": "reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
+ "customchannels": {
+ "methods": {
+ "get": {
+ "description": "Get the specified custom channel from the specified ad client.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.customchannels.get",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}",
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
},
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
+ "list": {
+ "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.customchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
}
- },
- "parameterOrder": [
- "savedReportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
},
- "list": {
- "id": "adexchangeseller.reports.saved.list",
- "path": "reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "resources": {
+ "adunits": {
+ "methods": {
+ "list": {
+ "description": "List all ad units in the specified custom channel.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.customchannels.adunits.list",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "resources": {
+ "dimensions": {
+ "methods": {
+ "list": {
+ "description": "List the metadata for the dimensions available to this AdExchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.metadata.dimensions.list",
+ "path": "metadata/dimensions",
+ "response": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "list": {
+ "description": "List the metadata for the metrics available to this AdExchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.metadata.metrics.list",
+ "path": "metadata/metrics",
+ "response": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "preferreddeals": {
+ "methods": {
+ "get": {
+ "description": "Get information about the selected Ad Exchange Preferred Deal.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.preferreddeals.get",
+ "parameterOrder": [
+ "dealId"
+ ],
+ "parameters": {
+ "dealId": {
+ "description": "Preferred deal to get information about.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "preferreddeals/{dealId}",
+ "response": {
+ "$ref": "PreferredDeal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ },
+ "list": {
+ "description": "List the preferred deals for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.preferreddeals.list",
+ "path": "preferreddeals",
+ "response": {
+ "$ref": "PreferredDeals"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "generate": {
+ "description": "Generate an Ad Exchange 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.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.reports.generate",
+ "parameterOrder": [
+ "startDate",
+ "endDate"
+ ],
+ "parameters": {
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters to be run on the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "reports",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ],
+ "supportsMediaDownload": true
+ }
+ },
+ "resources": {
+ "saved": {
+ "methods": {
+ "generate": {
+ "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.reports.saved.generate",
+ "parameterOrder": [
+ "savedReportId"
+ ],
+ "parameters": {
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "savedReportId": {
+ "description": "The saved report to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "reports/{savedReportId}",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all saved reports in this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.reports.saved.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of saved reports to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "reports/saved",
+ "response": {
+ "$ref": "SavedReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "urlchannels": {
+ "methods": {
+ "list": {
+ "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.urlchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list URL channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/urlchannels",
+ "response": {
+ "$ref": "UrlChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
}
- },
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
}
- }
}
- }
},
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
+ "revision": "20171101",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "id": "Account",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of this account.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#account",
+ "description": "Kind of resource this is, in this case adexchangeseller#account.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account.",
+ "type": "string"
+ }
},
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
+ "type": "object"
+ },
+ "AdClient": {
+ "id": "AdClient",
+ "properties": {
+ "arcOptIn": {
+ "description": "Whether this ad client is opted in to ARC.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Unique identifier of this ad client.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#adClient",
+ "description": "Kind of resource this is, in this case adexchangeseller#adClient.",
+ "type": "string"
+ },
+ "productCode": {
+ "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.",
+ "type": "string"
+ },
+ "supportsReporting": {
+ "description": "Whether this ad client supports being reported on.",
+ "type": "boolean"
+ }
},
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
+ "type": "object"
+ },
+ "AdClients": {
+ "id": "AdClients",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The ad clients returned in this list response.",
+ "items": {
+ "$ref": "AdClient"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#adClients",
+ "description": "Kind of list this is, in this case adexchangeseller#adClients.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdUnit": {
+ "id": "AdUnit",
+ "properties": {
+ "code": {
+ "description": "Identity code of this ad unit, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#adUnit",
+ "description": "Kind of resource this is, in this case adexchangeseller#adUnit.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this ad unit.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdUnits": {
+ "id": "AdUnits",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The ad units returned in this list response.",
+ "items": {
+ "$ref": "AdUnit"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#adUnits",
+ "description": "Kind of list this is, in this case adexchangeseller#adUnits.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Alert": {
+ "id": "Alert",
+ "properties": {
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#alert",
+ "description": "Kind of resource this is, in this case adexchangeseller#alert.",
+ "type": "string"
+ },
+ "message": {
+ "description": "The localized alert message.",
+ "type": "string"
+ },
+ "severity": {
+ "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ }
+ },
+ "type": "object"
+ },
+ "Alerts": {
+ "id": "Alerts",
+ "properties": {
+ "items": {
+ "description": "The alerts returned in this list response.",
+ "items": {
+ "$ref": "Alert"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#alerts",
+ "description": "Kind of list this is, in this case adexchangeseller#alerts.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannel": {
+ "id": "CustomChannel",
+ "properties": {
+ "code": {
+ "description": "Code of this custom channel, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#customChannel",
+ "description": "Kind of resource this is, in this case adexchangeseller#customChannel.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this custom channel.",
+ "type": "string"
+ },
+ "targetingInfo": {
+ "description": "The targeting information of this custom channel, if activated.",
+ "properties": {
+ "adsAppearOn": {
+ "description": "The name used to describe this channel externally.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The external description of the channel.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.",
+ "type": "string"
+ },
+ "siteLanguage": {
+ "description": "The language of the sites ads will be displayed on.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannels": {
+ "id": "CustomChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The custom channels returned in this list response.",
+ "items": {
+ "$ref": "CustomChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#customChannels",
+ "description": "Kind of list this is, in this case adexchangeseller#customChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Metadata": {
+ "id": "Metadata",
+ "properties": {
+ "items": {
+ "items": {
+ "$ref": "ReportingMetadataEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#metadata",
+ "description": "Kind of list this is, in this case adexchangeseller#metadata.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PreferredDeal": {
+ "id": "PreferredDeal",
+ "properties": {
+ "advertiserName": {
+ "description": "The name of the advertiser this deal is for.",
+ "type": "string"
+ },
+ "buyerNetworkName": {
+ "description": "The name of the buyer network this deal is for.",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "fixedCpm": {
+ "description": "The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of this preferred deal.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#preferredDeal",
+ "description": "Kind of resource this is, in this case adexchangeseller#preferredDeal.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PreferredDeals": {
+ "id": "PreferredDeals",
+ "properties": {
+ "items": {
+ "description": "The preferred deals returned in this list response.",
+ "items": {
+ "$ref": "PreferredDeal"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#preferredDeals",
+ "description": "Kind of list this is, in this case adexchangeseller#preferredDeals.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "id": "Report",
+ "properties": {
+ "averages": {
+ "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "currency": {
+ "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#report",
+ "description": "Kind this is, in this case adexchangeseller#report.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "totalMatchedRows": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totals": {
+ "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "warnings": {
+ "description": "Any warnings associated with generation of the report.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReportingMetadataEntry": {
+ "id": "ReportingMetadataEntry",
+ "properties": {
+ "compatibleDimensions": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "compatibleMetrics": {
+ "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#reportingMetadataEntry",
+ "description": "Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry.",
+ "type": "string"
+ },
+ "requiredDimensions": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "requiredMetrics": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportedProducts": {
+ "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SavedReport": {
+ "id": "SavedReport",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of this saved report.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#savedReport",
+ "description": "Kind of resource this is, in this case adexchangeseller#savedReport.",
+ "type": "string"
+ },
+ "name": {
+ "description": "This saved report's name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SavedReports": {
+ "id": "SavedReports",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The saved reports returned in this list response.",
+ "items": {
+ "$ref": "SavedReport"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#savedReports",
+ "description": "Kind of list this is, in this case adexchangeseller#savedReports.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannel": {
+ "id": "UrlChannel",
+ "properties": {
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#urlChannel",
+ "description": "Kind of resource this is, in this case adexchangeseller#urlChannel.",
+ "type": "string"
+ },
+ "urlPattern": {
+ "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannels": {
+ "id": "UrlChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The URL channels returned in this list response.",
+ "items": {
+ "$ref": "UrlChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#urlChannels",
+ "description": "Kind of list this is, in this case adexchangeseller#urlChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
- }
- }
-}
+ },
+ "servicePath": "adexchangeseller/v1.1/",
+ "title": "Ad Exchange Seller API",
+ "version": "v1.1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-api.json b/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-api.json
index 19545cba9..30fc0e9bf 100644
--- a/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-api.json
+++ b/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-api.json
@@ -1,918 +1,918 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/EberIAMM9RntL16aqUh0FmyQxWY\"",
- "discoveryVersion": "v1",
- "id": "adexchangeseller:v1",
- "name": "adexchangeseller",
- "canonicalName": "Ad Exchange Seller",
- "version": "v1",
- "revision": "20160805",
- "title": "Ad Exchange Seller API",
- "description": "Accesses the inventory of Ad Exchange seller users and generates reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangeseller/v1/",
- "basePath": "/adexchangeseller/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangeseller/v1/",
- "batchPath": "batch/adexchangeseller/v1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.seller": {
- "description": "View and manage your Ad Exchange data"
- },
- "https://www.googleapis.com/auth/adexchange.seller.readonly": {
- "description": "View your Ad Exchange data"
- }
- }
- }
- },
- "schemas": {
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adClient.",
- "default": "adexchangeseller#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adClients.",
- "default": "adexchangeseller#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adUnit.",
- "default": "adexchangeseller#adUnit"
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- }
- }
- },
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adUnits.",
- "default": "adexchangeseller#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#customChannel.",
- "default": "adexchangeseller#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
- }
- }
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#customChannels.",
- "default": "adexchangeseller#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "headers": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adexchangeseller#report.",
- "default": "adexchangeseller#report"
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#savedReport.",
- "default": "adexchangeseller#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#savedReports.",
- "default": "adexchangeseller#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#urlChannel.",
- "default": "adexchangeseller#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#urlChannels.",
- "default": "adexchangeseller#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "adclients": {
- "methods": {
- "list": {
- "id": "adexchangeseller.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adexchangeseller.adunits.get",
- "path": "adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.adunits.list",
- "path": "adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.adunits.customchannels.list",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.seller": {
+ "description": "View and manage your Ad Exchange data"
},
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "https://www.googleapis.com/auth/adexchange.seller.readonly": {
+ "description": "View your Ad Exchange data"
}
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
}
- }
}
- }
},
- "customchannels": {
- "methods": {
- "get": {
- "id": "adexchangeseller.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
+ "basePath": "/adexchangeseller/v1/",
+ "baseUrl": "https://www.googleapis.com/adexchangeseller/v1/",
+ "batchPath": "batch/adexchangeseller/v1",
+ "canonicalName": "Ad Exchange Seller",
+ "description": "Accesses the inventory of Ad Exchange seller users and generates reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/LZjbJqGI4YbMK1jq7CAP1O0QwyE\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
+ "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
+ },
+ "id": "adexchangeseller:v1",
+ "kind": "discovery#restDescription",
+ "name": "adexchangeseller",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "csv",
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of text/csv",
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "list": {
- "id": "adexchangeseller.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- },
- "resources": {
+ },
+ "protocol": "rest",
+ "resources": {
+ "adclients": {
+ "methods": {
+ "list": {
+ "description": "List all ad clients in this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.adclients.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
"adunits": {
- "methods": {
- "list": {
- "id": "adexchangeseller.customchannels.adunits.list",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
+ "methods": {
+ "get": {
+ "description": "Gets the specified ad unit in the specified ad client.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.adunits.get",
+ "parameterOrder": [
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to get the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
+ "$ref": "AdUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
},
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "list": {
+ "description": "List all ad units in the specified ad client for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.adunits.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "customchannels": {
+ "methods": {
+ "list": {
+ "description": "List all custom channels which the specified ad unit belongs to.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.adunits.customchannels.list",
+ "parameterOrder": [
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "customchannels": {
+ "methods": {
+ "get": {
+ "description": "Get the specified custom channel from the specified ad client.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.customchannels.get",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}",
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.customchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "adunits": {
+ "methods": {
+ "list": {
+ "description": "List all ad units in the specified custom channel.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.customchannels.adunits.list",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "generate": {
+ "description": "Generate an Ad Exchange 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.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.reports.generate",
+ "parameterOrder": [
+ "startDate",
+ "endDate"
+ ],
+ "parameters": {
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters to be run on the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "reports",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ],
+ "supportsMediaDownload": true
+ }
+ },
+ "resources": {
+ "saved": {
+ "methods": {
+ "generate": {
+ "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.reports.saved.generate",
+ "parameterOrder": [
+ "savedReportId"
+ ],
+ "parameters": {
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "savedReportId": {
+ "description": "The saved report to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "reports/{savedReportId}",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all saved reports in this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.reports.saved.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of saved reports to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "reports/saved",
+ "response": {
+ "$ref": "SavedReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "urlchannels": {
+ "methods": {
+ "list": {
+ "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.urlchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list URL channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/urlchannels",
+ "response": {
+ "$ref": "UrlChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
}
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
}
- }
}
- }
},
- "reports": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange 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.",
- "parameters": {
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "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.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.reports.saved.generate",
- "path": "reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
+ "revision": "20171101",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "AdClient": {
+ "id": "AdClient",
+ "properties": {
+ "arcOptIn": {
+ "description": "Whether this ad client is opted in to ARC.",
+ "type": "boolean"
},
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
+ "id": {
+ "description": "Unique identifier of this ad client.",
+ "type": "string"
},
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
+ "kind": {
+ "default": "adexchangeseller#adClient",
+ "description": "Kind of resource this is, in this case adexchangeseller#adClient.",
+ "type": "string"
},
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
+ "productCode": {
+ "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.",
+ "type": "string"
+ },
+ "supportsReporting": {
+ "description": "Whether this ad client supports being reported on.",
+ "type": "boolean"
}
- },
- "parameterOrder": [
- "savedReportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
},
- "list": {
- "id": "adexchangeseller.reports.saved.list",
- "path": "reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
+ "type": "object"
+ },
+ "AdClients": {
+ "id": "AdClients",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
},
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "items": {
+ "description": "The ad clients returned in this list response.",
+ "items": {
+ "$ref": "AdClient"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#adClients",
+ "description": "Kind of list this is, in this case adexchangeseller#adClients.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
}
- },
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
+ },
+ "type": "object"
+ },
+ "AdUnit": {
+ "id": "AdUnit",
+ "properties": {
+ "code": {
+ "description": "Identity code of this ad unit, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#adUnit",
+ "description": "Kind of resource this is, in this case adexchangeseller#adUnit.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this ad unit.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdUnits": {
+ "id": "AdUnits",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The ad units returned in this list response.",
+ "items": {
+ "$ref": "AdUnit"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#adUnits",
+ "description": "Kind of list this is, in this case adexchangeseller#adUnits.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannel": {
+ "id": "CustomChannel",
+ "properties": {
+ "code": {
+ "description": "Code of this custom channel, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#customChannel",
+ "description": "Kind of resource this is, in this case adexchangeseller#customChannel.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this custom channel.",
+ "type": "string"
+ },
+ "targetingInfo": {
+ "description": "The targeting information of this custom channel, if activated.",
+ "properties": {
+ "adsAppearOn": {
+ "description": "The name used to describe this channel externally.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The external description of the channel.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.",
+ "type": "string"
+ },
+ "siteLanguage": {
+ "description": "The language of the sites ads will be displayed on.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannels": {
+ "id": "CustomChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The custom channels returned in this list response.",
+ "items": {
+ "$ref": "CustomChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#customChannels",
+ "description": "Kind of list this is, in this case adexchangeseller#customChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "id": "Report",
+ "properties": {
+ "averages": {
+ "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "currency": {
+ "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#report",
+ "description": "Kind this is, in this case adexchangeseller#report.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "totalMatchedRows": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totals": {
+ "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "warnings": {
+ "description": "Any warnings associated with generation of the report.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SavedReport": {
+ "id": "SavedReport",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of this saved report.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#savedReport",
+ "description": "Kind of resource this is, in this case adexchangeseller#savedReport.",
+ "type": "string"
+ },
+ "name": {
+ "description": "This saved report's name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SavedReports": {
+ "id": "SavedReports",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The saved reports returned in this list response.",
+ "items": {
+ "$ref": "SavedReport"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#savedReports",
+ "description": "Kind of list this is, in this case adexchangeseller#savedReports.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannel": {
+ "id": "UrlChannel",
+ "properties": {
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#urlChannel",
+ "description": "Kind of resource this is, in this case adexchangeseller#urlChannel.",
+ "type": "string"
+ },
+ "urlPattern": {
+ "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannels": {
+ "id": "UrlChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The URL channels returned in this list response.",
+ "items": {
+ "$ref": "UrlChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#urlChannels",
+ "description": "Kind of list this is, in this case adexchangeseller#urlChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "adexchangeseller/v1/",
+ "title": "Ad Exchange Seller API",
+ "version": "v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-api.json b/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-api.json
index 99d812aed..51d5ea80d 100644
--- a/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-api.json
+++ b/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-api.json
@@ -1,1164 +1,1164 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/1XDufO4826VKTkrV2WU9EmKApiQ\"",
- "discoveryVersion": "v1",
- "id": "adexchangeseller:v2.0",
- "name": "adexchangeseller",
- "canonicalName": "Ad Exchange Seller",
- "version": "v2.0",
- "revision": "20160805",
- "title": "Ad Exchange Seller API",
- "description": "Accesses the inventory of Ad Exchange seller users and generates reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangeseller/v2.0/",
- "basePath": "/adexchangeseller/v2.0/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangeseller/v2.0/",
- "batchPath": "batch/adexchangeseller/v2.0",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.seller": {
- "description": "View and manage your Ad Exchange data"
- },
- "https://www.googleapis.com/auth/adexchange.seller.readonly": {
- "description": "View your Ad Exchange data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#account.",
- "default": "adexchangeseller#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The accounts returned in this list response.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#accounts.",
- "default": "adexchangeseller#accounts"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adClient.",
- "default": "adexchangeseller#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adClients.",
- "default": "adexchangeseller#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Alert": {
- "id": "Alert",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#alert.",
- "default": "adexchangeseller#alert"
- },
- "message": {
- "type": "string",
- "description": "The localized alert message."
- },
- "severity": {
- "type": "string",
- "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE."
- },
- "type": {
- "type": "string",
- "description": "Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD."
- }
- }
- },
- "Alerts": {
- "id": "Alerts",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The alerts returned in this list response.",
- "items": {
- "$ref": "Alert"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#alerts.",
- "default": "adexchangeseller#alerts"
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#customChannel.",
- "default": "adexchangeseller#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.seller": {
+ "description": "View and manage your Ad Exchange data"
+ },
+ "https://www.googleapis.com/auth/adexchange.seller.readonly": {
+ "description": "View your Ad Exchange data"
+ }
}
- }
}
- }
},
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#customChannels.",
- "default": "adexchangeseller#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
+ "basePath": "/adexchangeseller/v2.0/",
+ "baseUrl": "https://www.googleapis.com/adexchangeseller/v2.0/",
+ "batchPath": "batch/adexchangeseller/v2.0",
+ "canonicalName": "Ad Exchange Seller",
+ "description": "Accesses the inventory of Ad Exchange seller users and generates reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/yPQ_FKbZQkgdh3799oQXrXWTC8I\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
+ "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
},
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "ReportingMetadataEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#metadata.",
- "default": "adexchangeseller#metadata"
- }
- }
- },
- "PreferredDeal": {
- "id": "PreferredDeal",
- "type": "object",
- "properties": {
- "advertiserName": {
- "type": "string",
- "description": "The name of the advertiser this deal is for."
- },
- "buyerNetworkName": {
- "type": "string",
- "description": "The name of the buyer network this deal is for."
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD."
- },
- "endTime": {
- "type": "string",
- "description": "Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.",
- "format": "uint64"
- },
- "fixedCpm": {
- "type": "string",
- "description": "The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this preferred deal.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#preferredDeal.",
- "default": "adexchangeseller#preferredDeal"
- },
- "startTime": {
- "type": "string",
- "description": "Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.",
- "format": "uint64"
- }
- }
- },
- "PreferredDeals": {
- "id": "PreferredDeals",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The preferred deals returned in this list response.",
- "items": {
- "$ref": "PreferredDeal"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#preferredDeals.",
- "default": "adexchangeseller#preferredDeals"
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
+ "id": "adexchangeseller:v2.0",
+ "kind": "discovery#restDescription",
+ "name": "adexchangeseller",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "csv",
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of text/csv",
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
},
- "headers": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Get information about the selected Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.get",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to get information about. Tip: 'myaccount' is a valid ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all accounts available to this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of accounts to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts",
+ "response": {
+ "$ref": "Accounts"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "adclients": {
+ "methods": {
+ "list": {
+ "description": "List all ad clients in this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.adclients.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
+ "alerts": {
+ "methods": {
+ "list": {
+ "description": "List the alerts for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.alerts.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account owning the alerts.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/alerts",
+ "response": {
+ "$ref": "Alerts"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
+ "customchannels": {
+ "methods": {
+ "get": {
+ "description": "Get the specified custom channel from the specified ad client.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.customchannels.get",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.customchannels.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
+ "metadata": {
+ "resources": {
+ "dimensions": {
+ "methods": {
+ "list": {
+ "description": "List the metadata for the dimensions available to this AdExchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.metadata.dimensions.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account with visibility to the dimensions.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/metadata/dimensions",
+ "response": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "list": {
+ "description": "List the metadata for the metrics available to this AdExchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.metadata.metrics.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account with visibility to the metrics.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/metadata/metrics",
+ "response": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "preferreddeals": {
+ "methods": {
+ "get": {
+ "description": "Get information about the selected Ad Exchange Preferred Deal.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.preferreddeals.get",
+ "parameterOrder": [
+ "accountId",
+ "dealId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account owning the deal.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "dealId": {
+ "description": "Preferred deal to get information about.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/preferreddeals/{dealId}",
+ "response": {
+ "$ref": "PreferredDeal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ },
+ "list": {
+ "description": "List the preferred deals for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.preferreddeals.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account owning the deals.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/preferreddeals",
+ "response": {
+ "$ref": "PreferredDeals"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "generate": {
+ "description": "Generate an Ad Exchange 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.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.reports.generate",
+ "parameterOrder": [
+ "accountId",
+ "startDate",
+ "endDate"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which owns the generated report.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters to be run on the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{accountId}/reports",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ],
+ "supportsMediaDownload": true
+ }
+ },
+ "resources": {
+ "saved": {
+ "methods": {
+ "generate": {
+ "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.reports.saved.generate",
+ "parameterOrder": [
+ "accountId",
+ "savedReportId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account owning the saved report.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "savedReportId": {
+ "description": "The saved report to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{accountId}/reports/{savedReportId}",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all saved reports in this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.reports.saved.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account owning the saved reports.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of saved reports to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/reports/saved",
+ "response": {
+ "$ref": "SavedReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "urlchannels": {
+ "methods": {
+ "list": {
+ "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
+ "httpMethod": "GET",
+ "id": "adexchangeseller.accounts.urlchannels.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to list URL channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
+ "response": {
+ "$ref": "UrlChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.seller",
+ "https://www.googleapis.com/auth/adexchange.seller.readonly"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20171101",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "id": "Account",
"properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adexchangeseller#report.",
- "default": "adexchangeseller#report"
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ReportingMetadataEntry": {
- "id": "ReportingMetadataEntry",
- "type": "object",
- "properties": {
- "compatibleDimensions": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "compatibleMetrics": {
- "type": "array",
- "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry.",
- "default": "adexchangeseller#reportingMetadataEntry"
- },
- "requiredDimensions": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "requiredMetrics": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "supportedProducts": {
- "type": "array",
- "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#savedReport.",
- "default": "adexchangeseller#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#savedReports.",
- "default": "adexchangeseller#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#urlChannel.",
- "default": "adexchangeseller#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#urlChannels.",
- "default": "adexchangeseller#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangeseller.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about. Tip: 'myaccount' is a valid ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "List all accounts available to this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of accounts to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
+ "id": {
+ "description": "Unique identifier of this account.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#account",
+ "description": "Kind of resource this is, in this case adexchangeseller#account.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account.",
+ "type": "string"
+ }
},
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
+ "type": "object"
+ },
+ "Accounts": {
+ "id": "Accounts",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The accounts returned in this list response.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#accounts",
+ "description": "Kind of list this is, in this case adexchangeseller#accounts.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdClient": {
+ "id": "AdClient",
+ "properties": {
+ "arcOptIn": {
+ "description": "Whether this ad client is opted in to ARC.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Unique identifier of this ad client.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#adClient",
+ "description": "Kind of resource this is, in this case adexchangeseller#adClient.",
+ "type": "string"
+ },
+ "productCode": {
+ "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.",
+ "type": "string"
+ },
+ "supportsReporting": {
+ "description": "Whether this ad client supports being reported on.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AdClients": {
+ "id": "AdClients",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The ad clients returned in this list response.",
+ "items": {
+ "$ref": "AdClient"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#adClients",
+ "description": "Kind of list this is, in this case adexchangeseller#adClients.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Alert": {
+ "id": "Alert",
+ "properties": {
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#alert",
+ "description": "Kind of resource this is, in this case adexchangeseller#alert.",
+ "type": "string"
+ },
+ "message": {
+ "description": "The localized alert message.",
+ "type": "string"
+ },
+ "severity": {
+ "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ }
+ },
+ "type": "object"
+ },
+ "Alerts": {
+ "id": "Alerts",
+ "properties": {
+ "items": {
+ "description": "The alerts returned in this list response.",
+ "items": {
+ "$ref": "Alert"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#alerts",
+ "description": "Kind of list this is, in this case adexchangeseller#alerts.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannel": {
+ "id": "CustomChannel",
+ "properties": {
+ "code": {
+ "description": "Code of this custom channel, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#customChannel",
+ "description": "Kind of resource this is, in this case adexchangeseller#customChannel.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this custom channel.",
+ "type": "string"
+ },
+ "targetingInfo": {
+ "description": "The targeting information of this custom channel, if activated.",
+ "properties": {
+ "adsAppearOn": {
+ "description": "The name used to describe this channel externally.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The external description of the channel.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.",
+ "type": "string"
+ },
+ "siteLanguage": {
+ "description": "The language of the sites ads will be displayed on.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannels": {
+ "id": "CustomChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The custom channels returned in this list response.",
+ "items": {
+ "$ref": "CustomChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#customChannels",
+ "description": "Kind of list this is, in this case adexchangeseller#customChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Metadata": {
+ "id": "Metadata",
+ "properties": {
+ "items": {
+ "items": {
+ "$ref": "ReportingMetadataEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#metadata",
+ "description": "Kind of list this is, in this case adexchangeseller#metadata.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PreferredDeal": {
+ "id": "PreferredDeal",
+ "properties": {
+ "advertiserName": {
+ "description": "The name of the advertiser this deal is for.",
+ "type": "string"
+ },
+ "buyerNetworkName": {
+ "description": "The name of the buyer network this deal is for.",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "fixedCpm": {
+ "description": "The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of this preferred deal.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#preferredDeal",
+ "description": "Kind of resource this is, in this case adexchangeseller#preferredDeal.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PreferredDeals": {
+ "id": "PreferredDeals",
+ "properties": {
+ "items": {
+ "description": "The preferred deals returned in this list response.",
+ "items": {
+ "$ref": "PreferredDeal"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#preferredDeals",
+ "description": "Kind of list this is, in this case adexchangeseller#preferredDeals.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "id": "Report",
+ "properties": {
+ "averages": {
+ "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "currency": {
+ "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#report",
+ "description": "Kind this is, in this case adexchangeseller#report.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "totalMatchedRows": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totals": {
+ "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "warnings": {
+ "description": "Any warnings associated with generation of the report.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReportingMetadataEntry": {
+ "id": "ReportingMetadataEntry",
+ "properties": {
+ "compatibleDimensions": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "compatibleMetrics": {
+ "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#reportingMetadataEntry",
+ "description": "Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry.",
+ "type": "string"
+ },
+ "requiredDimensions": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "requiredMetrics": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportedProducts": {
+ "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SavedReport": {
+ "id": "SavedReport",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of this saved report.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#savedReport",
+ "description": "Kind of resource this is, in this case adexchangeseller#savedReport.",
+ "type": "string"
+ },
+ "name": {
+ "description": "This saved report's name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SavedReports": {
+ "id": "SavedReports",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The saved reports returned in this list response.",
+ "items": {
+ "$ref": "SavedReport"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#savedReports",
+ "description": "Kind of list this is, in this case adexchangeseller#savedReports.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannel": {
+ "id": "UrlChannel",
+ "properties": {
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adexchangeseller#urlChannel",
+ "description": "Kind of resource this is, in this case adexchangeseller#urlChannel.",
+ "type": "string"
+ },
+ "urlPattern": {
+ "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannels": {
+ "id": "UrlChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The URL channels returned in this list response.",
+ "items": {
+ "$ref": "UrlChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adexchangeseller#urlChannels",
+ "description": "Kind of list this is, in this case adexchangeseller#urlChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- },
- "resources": {
- "adclients": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "alerts": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.alerts.list",
- "path": "accounts/{accountId}/alerts",
- "httpMethod": "GET",
- "description": "List the alerts for this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the alerts.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adexchangeseller.accounts.customchannels.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.accounts.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "metadata": {
- "resources": {
- "dimensions": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.metadata.dimensions.list",
- "path": "accounts/{accountId}/metadata/dimensions",
- "httpMethod": "GET",
- "description": "List the metadata for the dimensions available to this AdExchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account with visibility to the dimensions.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "metrics": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.metadata.metrics.list",
- "path": "accounts/{accountId}/metadata/metrics",
- "httpMethod": "GET",
- "description": "List the metadata for the metrics available to this AdExchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account with visibility to the metrics.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "preferreddeals": {
- "methods": {
- "get": {
- "id": "adexchangeseller.accounts.preferreddeals.get",
- "path": "accounts/{accountId}/preferreddeals/{dealId}",
- "httpMethod": "GET",
- "description": "Get information about the selected Ad Exchange Preferred Deal.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the deal.",
- "required": true,
- "location": "path"
- },
- "dealId": {
- "type": "string",
- "description": "Preferred deal to get information about.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "dealId"
- ],
- "response": {
- "$ref": "PreferredDeal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.accounts.preferreddeals.list",
- "path": "accounts/{accountId}/preferreddeals",
- "httpMethod": "GET",
- "description": "List the preferred deals for this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the deals.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "PreferredDeals"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.accounts.reports.generate",
- "path": "accounts/{accountId}/reports",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange 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.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which owns the generated report.",
- "required": true,
- "location": "path"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "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.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.accounts.reports.saved.generate",
- "path": "accounts/{accountId}/reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the saved report.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "savedReportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.accounts.reports.saved.list",
- "path": "accounts/{accountId}/reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the saved reports.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.urlchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- }
- }
-}
+ },
+ "servicePath": "adexchangeseller/v2.0/",
+ "title": "Ad Exchange Seller API",
+ "version": "v2.0"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adexperiencereport/v1/adexperiencereport-api.json b/vendor/google.golang.org/api/adexperiencereport/v1/adexperiencereport-api.json
index 12852c531..061bd4f09 100644
--- a/vendor/google.golang.org/api/adexperiencereport/v1/adexperiencereport-api.json
+++ b/vendor/google.golang.org/api/adexperiencereport/v1/adexperiencereport-api.json
@@ -1,273 +1,4 @@
{
- "batchPath": "batch",
- "title": "Google Ad Experience Report API",
- "ownerName": "Google",
- "resources": {
- "sites": {
- "methods": {
- "get": {
- "description": "Gets a summary of the ad experience rating of a site.",
- "response": {
- "$ref": "SiteSummaryResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.",
- "required": true,
- "type": "string",
- "pattern": "^sites/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
- "flatPath": "v1/sites/{sitesId}",
- "path": "v1/{+name}",
- "id": "adexperiencereport.sites.get"
- }
- }
- },
- "violatingSites": {
- "methods": {
- "list": {
- "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".",
- "response": {
- "$ref": "ViolatingSitesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
- "flatPath": "v1/violatingSites",
- "path": "v1/violatingSites",
- "id": "adexperiencereport.violatingSites.list"
- }
- }
- }
- },
- "parameters": {
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1",
- "baseUrl": "https://adexperiencereport.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
- "servicePath": "",
- "basePath": "",
- "id": "adexperiencereport:v1",
- "documentationLink": "https://developers.google.com/ad-experience-report/",
- "revision": "20171129",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "ViolatingSitesResponse": {
- "description": "Response message for ListViolatingSites.",
- "type": "object",
- "properties": {
- "violatingSites": {
- "description": "A list of summaries of violating sites.",
- "type": "array",
- "items": {
- "$ref": "SiteSummaryResponse"
- }
- }
- },
- "id": "ViolatingSitesResponse"
- },
- "SiteSummaryResponse": {
- "description": "Response message for GetSiteSummary.",
- "type": "object",
- "properties": {
- "mobileSummary": {
- "description": "Summary for the mobile review of the site.",
- "$ref": "PlatformSummary"
- },
- "reviewedSite": {
- "description": "The name of the site reviewed.",
- "type": "string"
- },
- "desktopSummary": {
- "$ref": "PlatformSummary",
- "description": "Summary for the desktop review of the site."
- }
- },
- "id": "SiteSummaryResponse"
- },
- "PlatformSummary": {
- "description": "Summary of the ad experience rating of a site for a specific platform.",
- "type": "object",
- "properties": {
- "enforcementTime": {
- "description": "The date on which ad filtering begins.",
- "format": "google-datetime",
- "type": "string"
- },
- "region": {
- "enumDescriptions": [
- "Ad standard not yet defined for your region.",
- "Region A.",
- "Region B."
- ],
- "description": "The assigned regions for the site and platform.",
- "type": "array",
- "items": {
- "enum": [
- "REGION_UNKNOWN",
- "REGION_A",
- "REGION_B"
- ],
- "type": "string"
- }
- },
- "filterStatus": {
- "description": "The ad filtering status of the site.",
- "type": "string",
- "enumDescriptions": [
- "N/A.",
- "Ad filtering is on.",
- "Ad filtering is off.",
- "Ad filtering is paused.",
- "Ad filtering is pending."
- ],
- "enum": [
- "UNKNOWN",
- "ON",
- "OFF",
- "PAUSED",
- "PENDING"
- ]
- },
- "underReview": {
- "description": "Whether the site is currently under review.",
- "type": "boolean"
- },
- "reportUrl": {
- "description": "A link that leads to a full ad experience report.",
- "type": "string"
- },
- "lastChangeTime": {
- "description": "The last time that the site changed status.",
- "format": "google-datetime",
- "type": "string"
- },
- "betterAdsStatus": {
- "description": "The status of the site reviewed for the Better Ads Standards.",
- "type": "string",
- "enumDescriptions": [
- "Not reviewed.",
- "Passing.",
- "Warning.",
- "Failing."
- ],
- "enum": [
- "UNKNOWN",
- "PASSING",
- "WARNING",
- "FAILING"
- ]
- }
- },
- "id": "PlatformSummary"
- }
- },
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "canonicalName": "Ad Experience Report",
"auth": {
"oauth2": {
"scopes": {
@@ -277,7 +8,276 @@
}
}
},
- "rootUrl": "https://adexperiencereport.googleapis.com/",
+ "basePath": "",
+ "baseUrl": "https://adexperiencereport.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Ad Experience Report",
+ "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/ad-experience-report/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "adexperiencereport:v1",
+ "kind": "discovery#restDescription",
+ "name": "adexperiencereport",
"ownerDomain": "google.com",
- "name": "adexperiencereport"
-}
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "sites": {
+ "methods": {
+ "get": {
+ "description": "Gets a summary of the ad experience rating of a site.",
+ "flatPath": "v1/sites/{sitesId}",
+ "httpMethod": "GET",
+ "id": "adexperiencereport.sites.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.",
+ "location": "path",
+ "pattern": "^sites/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "SiteSummaryResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ]
+ }
+ }
+ },
+ "violatingSites": {
+ "methods": {
+ "list": {
+ "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".",
+ "flatPath": "v1/violatingSites",
+ "httpMethod": "GET",
+ "id": "adexperiencereport.violatingSites.list",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/violatingSites",
+ "response": {
+ "$ref": "ViolatingSitesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180129",
+ "rootUrl": "https://adexperiencereport.googleapis.com/",
+ "schemas": {
+ "PlatformSummary": {
+ "description": "Summary of the ad experience rating of a site for a specific platform.",
+ "id": "PlatformSummary",
+ "properties": {
+ "betterAdsStatus": {
+ "description": "The status of the site reviewed for the Better Ads Standards.",
+ "enum": [
+ "UNKNOWN",
+ "PASSING",
+ "WARNING",
+ "FAILING"
+ ],
+ "enumDescriptions": [
+ "Not reviewed.",
+ "Passing.",
+ "Warning.",
+ "Failing."
+ ],
+ "type": "string"
+ },
+ "enforcementTime": {
+ "description": "The date on which ad filtering begins.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "filterStatus": {
+ "description": "The ad filtering status of the site.",
+ "enum": [
+ "UNKNOWN",
+ "ON",
+ "OFF",
+ "PAUSED",
+ "PENDING"
+ ],
+ "enumDescriptions": [
+ "N/A.",
+ "Ad filtering is on.",
+ "Ad filtering is off.",
+ "Ad filtering is paused.",
+ "Ad filtering is pending."
+ ],
+ "type": "string"
+ },
+ "lastChangeTime": {
+ "description": "The last time that the site changed status.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "region": {
+ "description": "The assigned regions for the site and platform.",
+ "enumDescriptions": [
+ "Ad standard not yet defined for your region.",
+ "Region A.",
+ "Region B."
+ ],
+ "items": {
+ "enum": [
+ "REGION_UNKNOWN",
+ "REGION_A",
+ "REGION_B"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reportUrl": {
+ "description": "A link that leads to a full ad experience report.",
+ "type": "string"
+ },
+ "underReview": {
+ "description": "Whether the site is currently under review.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SiteSummaryResponse": {
+ "description": "Response message for GetSiteSummary.",
+ "id": "SiteSummaryResponse",
+ "properties": {
+ "desktopSummary": {
+ "$ref": "PlatformSummary",
+ "description": "Summary for the desktop review of the site."
+ },
+ "mobileSummary": {
+ "$ref": "PlatformSummary",
+ "description": "Summary for the mobile review of the site."
+ },
+ "reviewedSite": {
+ "description": "The name of the site reviewed.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ViolatingSitesResponse": {
+ "description": "Response message for ListViolatingSites.",
+ "id": "ViolatingSitesResponse",
+ "properties": {
+ "violatingSites": {
+ "description": "A list of summaries of violating sites.",
+ "items": {
+ "$ref": "SiteSummaryResponse"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Google Ad Experience Report API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/admin/datatransfer/v1/admin-api.json b/vendor/google.golang.org/api/admin/datatransfer/v1/admin-api.json
index 0f43659eb..496e2a326 100644
--- a/vendor/google.golang.org/api/admin/datatransfer/v1/admin-api.json
+++ b/vendor/google.golang.org/api/admin/datatransfer/v1/admin-api.json
@@ -1,411 +1,411 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/69RNEuIs-2cMvhRHgpkaoTAmcFU\"",
- "discoveryVersion": "v1",
- "id": "admin:datatransfer_v1",
- "name": "admin",
- "canonicalName": "DataTransfer",
- "version": "datatransfer_v1",
- "revision": "20160223",
- "title": "Admin Data Transfer API",
- "description": "Transfers user data from one user to another.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "packagePath": "admin",
- "icons": {
- "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
- "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/data-transfer/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/admin/datatransfer/v1/",
- "basePath": "/admin/datatransfer/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "admin/datatransfer/v1/",
- "batchPath": "batch/admin/datatransfer_v1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/admin.datatransfer": {
- "description": "View and manage data transfers between users in your organization"
- },
- "https://www.googleapis.com/auth/admin.datatransfer.readonly": {
- "description": "View data transfers between users in your organization"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/admin.datatransfer": {
+ "description": "View and manage data transfers between users in your organization"
+ },
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly": {
+ "description": "View data transfers between users in your organization"
+ }
+ }
}
- }
- }
- },
- "schemas": {
- "Application": {
- "id": "Application",
- "type": "object",
- "description": "The JSON template for an Application resource.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The application's ID.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a DataTransfer Application Resource.",
- "default": "admin#datatransfer#ApplicationResource"
- },
- "name": {
- "type": "string",
- "description": "The application's name."
- },
- "transferParams": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "ApplicationTransferParam"
- }
- }
- }
},
- "ApplicationDataTransfer": {
- "id": "ApplicationDataTransfer",
- "type": "object",
- "description": "Template to map fields of ApplicationDataTransfer resource.",
- "properties": {
- "applicationId": {
- "type": "string",
- "description": "The application's ID.",
- "format": "int64"
- },
- "applicationTransferParams": {
- "type": "array",
- "description": "The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.",
- "items": {
- "$ref": "ApplicationTransferParam"
- }
- },
- "applicationTransferStatus": {
- "type": "string",
- "description": "Current status of transfer for this application. (Read-only)"
- }
- }
+ "basePath": "/admin/datatransfer/v1/",
+ "baseUrl": "https://www.googleapis.com/admin/datatransfer/v1/",
+ "batchPath": "batch/admin/datatransfer_v1",
+ "canonicalName": "DataTransfer",
+ "description": "Transfers user data from one user to another.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/admin-sdk/data-transfer/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/69RNEuIs-2cMvhRHgpkaoTAmcFU\"",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
- "ApplicationTransferParam": {
- "id": "ApplicationTransferParam",
- "type": "object",
- "description": "Template for application transfer parameters.",
- "properties": {
- "key": {
- "type": "string",
- "description": "The type of the transfer parameter. eg: 'PRIVACY_LEVEL'"
- },
- "value": {
- "type": "array",
- "description": "The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
- "items": {
+ "id": "admin:datatransfer_v1",
+ "kind": "discovery#restDescription",
+ "name": "admin",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "packagePath": "admin",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
"type": "string"
- }
}
- }
},
- "ApplicationsListResponse": {
- "id": "ApplicationsListResponse",
- "type": "object",
- "description": "Template for a collection of Applications.",
- "properties": {
+ "protocol": "rest",
+ "resources": {
"applications": {
- "type": "array",
- "description": "List of applications that support data transfer and are also installed for the customer.",
- "items": {
- "$ref": "Application"
- }
+ "methods": {
+ "get": {
+ "description": "Retrieves information about an application for the given application ID.",
+ "httpMethod": "GET",
+ "id": "datatransfer.applications.get",
+ "parameterOrder": [
+ "applicationId"
+ ],
+ "parameters": {
+ "applicationId": {
+ "description": "ID of the application resource to be retrieved.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "applications/{applicationId}",
+ "response": {
+ "$ref": "Application"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer",
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly"
+ ]
+ },
+ "list": {
+ "description": "Lists the applications available for data transfer for a customer.",
+ "httpMethod": "GET",
+ "id": "datatransfer.applications.list",
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the Google Apps account.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 100.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "500",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify next page in the list.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "applications",
+ "response": {
+ "$ref": "ApplicationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer",
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly"
+ ]
+ }
+ }
},
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a collection of Applications.",
- "default": "admin#datatransfer#applicationsList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token which will be used to specify next page in list API."
+ "transfers": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a data transfer request by its resource ID.",
+ "httpMethod": "GET",
+ "id": "datatransfer.transfers.get",
+ "parameterOrder": [
+ "dataTransferId"
+ ],
+ "parameters": {
+ "dataTransferId": {
+ "description": "ID of the resource to be retrieved. This is returned in the response from the insert method.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "transfers/{dataTransferId}",
+ "response": {
+ "$ref": "DataTransfer"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer",
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a data transfer request.",
+ "httpMethod": "POST",
+ "id": "datatransfer.transfers.insert",
+ "path": "transfers",
+ "request": {
+ "$ref": "DataTransfer"
+ },
+ "response": {
+ "$ref": "DataTransfer"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer"
+ ]
+ },
+ "list": {
+ "description": "Lists the transfers for a customer by source user, destination user, or status.",
+ "httpMethod": "GET",
+ "id": "datatransfer.transfers.list",
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the Google Apps account.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 100.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "500",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "newOwnerUserId": {
+ "description": "Destination user's profile ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "oldOwnerUserId": {
+ "description": "Source user's profile ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify the next page in the list.",
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the transfer.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "transfers",
+ "response": {
+ "$ref": "DataTransfersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.datatransfer",
+ "https://www.googleapis.com/auth/admin.datatransfer.readonly"
+ ]
+ }
+ }
}
- }
},
- "DataTransfer": {
- "id": "DataTransfer",
- "type": "object",
- "description": "The JSON template for a DataTransfer resource.",
- "properties": {
- "applicationDataTransfers": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "ApplicationDataTransfer"
- }
+ "revision": "20160223",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Application": {
+ "description": "The JSON template for an Application resource.",
+ "id": "Application",
+ "properties": {
+ "etag": {
+ "description": "Etag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The application's ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#datatransfer#ApplicationResource",
+ "description": "Identifies the resource as a DataTransfer Application Resource.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The application's name.",
+ "type": "string"
+ },
+ "transferParams": {
+ "description": "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.",
+ "items": {
+ "$ref": "ApplicationTransferParam"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
+ "ApplicationDataTransfer": {
+ "description": "Template to map fields of ApplicationDataTransfer resource.",
+ "id": "ApplicationDataTransfer",
+ "properties": {
+ "applicationId": {
+ "description": "The application's ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "applicationTransferParams": {
+ "description": "The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.",
+ "items": {
+ "$ref": "ApplicationTransferParam"
+ },
+ "type": "array"
+ },
+ "applicationTransferStatus": {
+ "description": "Current status of transfer for this application. (Read-only)",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "id": {
- "type": "string",
- "description": "The transfer's ID (Read-only)."
+ "ApplicationTransferParam": {
+ "description": "Template for application transfer parameters.",
+ "id": "ApplicationTransferParam",
+ "properties": {
+ "key": {
+ "description": "The type of the transfer parameter. eg: 'PRIVACY_LEVEL'",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a DataTransfer request.",
- "default": "admin#datatransfer#DataTransfer"
+ "ApplicationsListResponse": {
+ "description": "Template for a collection of Applications.",
+ "id": "ApplicationsListResponse",
+ "properties": {
+ "applications": {
+ "description": "List of applications that support data transfer and are also installed for the customer.",
+ "items": {
+ "$ref": "Application"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#datatransfer#applicationsList",
+ "description": "Identifies the resource as a collection of Applications.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token which will be used to specify next page in list API.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "newOwnerUserId": {
- "type": "string",
- "description": "ID of the user to whom the data is being transfered."
+ "DataTransfer": {
+ "description": "The JSON template for a DataTransfer resource.",
+ "id": "DataTransfer",
+ "properties": {
+ "applicationDataTransfers": {
+ "description": "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.",
+ "items": {
+ "$ref": "ApplicationDataTransfer"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The transfer's ID (Read-only).",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#datatransfer#DataTransfer",
+ "description": "Identifies the resource as a DataTransfer request.",
+ "type": "string"
+ },
+ "newOwnerUserId": {
+ "description": "ID of the user to whom the data is being transfered.",
+ "type": "string"
+ },
+ "oldOwnerUserId": {
+ "description": "ID of the user whose data is being transfered.",
+ "type": "string"
+ },
+ "overallTransferStatusCode": {
+ "description": "Overall transfer status (Read-only).",
+ "type": "string"
+ },
+ "requestTime": {
+ "description": "The time at which the data transfer was requested (Read-only).",
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "oldOwnerUserId": {
- "type": "string",
- "description": "ID of the user whose data is being transfered."
- },
- "overallTransferStatusCode": {
- "type": "string",
- "description": "Overall transfer status (Read-only)."
- },
- "requestTime": {
- "type": "string",
- "description": "The time at which the data transfer was requested (Read-only).",
- "format": "date-time"
+ "DataTransfersListResponse": {
+ "description": "Template for a collection of DataTransfer resources.",
+ "id": "DataTransfersListResponse",
+ "properties": {
+ "dataTransfers": {
+ "description": "List of data transfer requests.",
+ "items": {
+ "$ref": "DataTransfer"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#datatransfer#dataTransfersList",
+ "description": "Identifies the resource as a collection of data transfer requests.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token which will be used to specify next page in list API.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "DataTransfersListResponse": {
- "id": "DataTransfersListResponse",
- "type": "object",
- "description": "Template for a collection of DataTransfer resources.",
- "properties": {
- "dataTransfers": {
- "type": "array",
- "description": "List of data transfer requests.",
- "items": {
- "$ref": "DataTransfer"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a collection of data transfer requests.",
- "default": "admin#datatransfer#dataTransfersList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token which will be used to specify next page in list API."
- }
- }
- }
- },
- "resources": {
- "applications": {
- "methods": {
- "get": {
- "id": "datatransfer.applications.get",
- "path": "applications/{applicationId}",
- "httpMethod": "GET",
- "description": "Retrieves information about an application for the given application ID.",
- "parameters": {
- "applicationId": {
- "type": "string",
- "description": "ID of the application resource to be retrieved.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "applicationId"
- ],
- "response": {
- "$ref": "Application"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- },
- "list": {
- "id": "datatransfer.applications.list",
- "path": "applications",
- "httpMethod": "GET",
- "description": "Lists the applications available for data transfer for a customer.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100.",
- "format": "int32",
- "minimum": "1",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ApplicationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- }
- }
- },
- "transfers": {
- "methods": {
- "get": {
- "id": "datatransfer.transfers.get",
- "path": "transfers/{dataTransferId}",
- "httpMethod": "GET",
- "description": "Retrieves a data transfer request by its resource ID.",
- "parameters": {
- "dataTransferId": {
- "type": "string",
- "description": "ID of the resource to be retrieved. This is returned in the response from the insert method.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "dataTransferId"
- ],
- "response": {
- "$ref": "DataTransfer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- },
- "insert": {
- "id": "datatransfer.transfers.insert",
- "path": "transfers",
- "httpMethod": "POST",
- "description": "Inserts a data transfer request.",
- "request": {
- "$ref": "DataTransfer"
- },
- "response": {
- "$ref": "DataTransfer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer"
- ]
- },
- "list": {
- "id": "datatransfer.transfers.list",
- "path": "transfers",
- "httpMethod": "GET",
- "description": "Lists the transfers for a customer by source user, destination user, or status.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100.",
- "format": "int32",
- "minimum": "1",
- "maximum": "500",
- "location": "query"
- },
- "newOwnerUserId": {
- "type": "string",
- "description": "Destination user's profile ID.",
- "location": "query"
- },
- "oldOwnerUserId": {
- "type": "string",
- "description": "Source user's profile ID.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify the next page in the list.",
- "location": "query"
- },
- "status": {
- "type": "string",
- "description": "Status of the transfer.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "DataTransfersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "admin/datatransfer/v1/",
+ "title": "Admin Data Transfer API",
+ "version": "datatransfer_v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/admin/directory/v1/admin-api.json b/vendor/google.golang.org/api/admin/directory/v1/admin-api.json
index 30ce72f34..85a4c746b 100644
--- a/vendor/google.golang.org/api/admin/directory/v1/admin-api.json
+++ b/vendor/google.golang.org/api/admin/directory/v1/admin-api.json
@@ -1,6713 +1,6742 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/FEIM1JSTcD4HhoBpMoEeP9vkMCQ\"",
- "discoveryVersion": "v1",
- "id": "admin:directory_v1",
- "name": "admin",
- "canonicalName": "directory",
- "version": "directory_v1",
- "revision": "20171212",
- "title": "Admin Directory API",
- "description": "The Admin SDK Directory API lets you view and manage enterprise resources such as users and groups, administrative notifications, security features, and more.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "packagePath": "admin",
- "icons": {
- "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
- "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/directory/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/admin/directory/v1/",
- "basePath": "/admin/directory/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "admin/directory/v1/",
- "batchPath": "batch/admin/directory_v1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/admin.directory.customer": {
- "description": "View and manage customer related information"
- },
- "https://www.googleapis.com/auth/admin.directory.customer.readonly": {
- "description": "View customer related information"
- },
- "https://www.googleapis.com/auth/admin.directory.device.chromeos": {
- "description": "View and manage your Chrome OS devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly": {
- "description": "View your Chrome OS devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.device.mobile": {
- "description": "View and manage your mobile devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.device.mobile.action": {
- "description": "Manage your mobile devices by performing administrative tasks"
- },
- "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly": {
- "description": "View your mobile devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.domain": {
- "description": "View and manage the provisioning of domains for your customers"
- },
- "https://www.googleapis.com/auth/admin.directory.domain.readonly": {
- "description": "View domains related to your customers"
- },
- "https://www.googleapis.com/auth/admin.directory.group": {
- "description": "View and manage the provisioning of groups on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.group.member": {
- "description": "View and manage group subscriptions on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.group.member.readonly": {
- "description": "View group subscriptions on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.group.readonly": {
- "description": "View groups on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.notifications": {
- "description": "View and manage notifications received on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.orgunit": {
- "description": "View and manage organization units on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.orgunit.readonly": {
- "description": "View organization units on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.resource.calendar": {
- "description": "View and manage the provisioning of calendar resources on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly": {
- "description": "View calendar resources on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.rolemanagement": {
- "description": "Manage delegated admin roles for your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly": {
- "description": "View delegated admin roles for your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user": {
- "description": "View and manage the provisioning of users on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.alias": {
- "description": "View and manage user aliases on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly": {
- "description": "View user aliases on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.readonly": {
- "description": "View users on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.security": {
- "description": "Manage data access permissions for users on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.userschema": {
- "description": "View and manage the provisioning of user schemas on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.userschema.readonly": {
- "description": "View user schemas on your domain"
- }
- }
- }
- },
- "schemas": {
- "Alias": {
- "id": "Alias",
- "type": "object",
- "description": "JSON template for Alias object in Directory API.",
- "properties": {
- "alias": {
- "type": "string",
- "description": "A alias email"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Unique id of the group (Read-only) Unique id of the user (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#alias"
- },
- "primaryEmail": {
- "type": "string",
- "description": "Group's primary email (Read-only) User's primary email (Read-only)"
- }
- }
- },
- "Aliases": {
- "id": "Aliases",
- "type": "object",
- "description": "JSON response template to list aliases in Directory API.",
- "properties": {
- "aliases": {
- "type": "array",
- "description": "List of alias objects.",
- "items": {
- "type": "any"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#aliases"
- }
- }
- },
- "AppAccessCollections": {
- "id": "AppAccessCollections",
- "type": "object",
- "description": "JSON template for App Access Collections Resource object in Directory API.",
- "properties": {
- "blockedApiAccessBuckets": {
- "type": "array",
- "description": "List of blocked api access buckets.",
- "items": {
- "type": "string"
- }
- },
- "enforceSettingsForAndroidDrive": {
- "type": "boolean",
- "description": "Boolean to indicate whether to enforce app access settings on Android Drive or not."
- },
- "errorMessage": {
- "type": "string",
- "description": "Error message provided by the Admin that will be shown to the user when an app is blocked."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as an app access collection. Value: admin#directory#appaccesscollection",
- "default": "admin#directory#appaccesscollection"
- },
- "resourceId": {
- "type": "string",
- "description": "Unique ID of app access collection. (Readonly)",
- "format": "int64"
- },
- "resourceName": {
- "type": "string",
- "description": "Resource name given by the customer while creating/updating. Should be unique under given customer."
- },
- "trustDomainOwnedApps": {
- "type": "boolean",
- "description": "Boolean that indicates whether to trust domain owned apps."
- }
- }
- },
- "Asp": {
- "id": "Asp",
- "type": "object",
- "description": "The template that returns individual ASP (Access Code) data.",
- "properties": {
- "codeId": {
- "type": "integer",
- "description": "The unique ID of the ASP.",
- "format": "int32"
- },
- "creationTime": {
- "type": "string",
- "description": "The time when the ASP was created. Expressed in Unix time format.",
- "format": "int64"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the ASP."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#asp.",
- "default": "admin#directory#asp"
- },
- "lastTimeUsed": {
- "type": "string",
- "description": "The time when the ASP was last used. Expressed in Unix time format.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "The name of the application that the user, represented by their userId, entered when the ASP was created."
- },
- "userKey": {
- "type": "string",
- "description": "The unique ID of the user who issued the ASP."
- }
- }
- },
- "Asps": {
- "id": "Asps",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of ASP resources.",
- "items": {
- "$ref": "Asp"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#aspList.",
- "default": "admin#directory#aspList"
- }
- }
- },
- "Building": {
- "id": "Building",
- "type": "object",
- "description": "JSON template for Building object in Directory API.",
- "properties": {
- "buildingId": {
- "type": "string",
- "description": "Unique identifier for the building. The maximum length is 100 characters."
- },
- "buildingName": {
- "type": "string",
- "description": "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."
- },
- "coordinates": {
- "$ref": "BuildingCoordinates",
- "description": "The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees."
- },
- "description": {
- "type": "string",
- "description": "A brief description of the building. For example, \"Chelsea Market\"."
- },
- "etags": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "floorNames": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#resources#buildings#Building"
- }
- }
- },
- "BuildingCoordinates": {
- "id": "BuildingCoordinates",
- "type": "object",
- "description": "JSON template for coordinates of a building in Directory API.",
- "properties": {
- "latitude": {
- "type": "number",
- "description": "Latitude in decimal degrees.",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "description": "Longitude in decimal degrees.",
- "format": "double"
- }
- }
- },
- "Buildings": {
- "id": "Buildings",
- "type": "object",
- "description": "JSON template for Building List Response object in Directory API.",
- "properties": {
- "buildings": {
- "type": "array",
- "description": "The Buildings in this page of results.",
- "items": {
- "$ref": "Building"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#resources#buildings#buildingsList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
- }
- }
- },
- "CalendarResource": {
- "id": "CalendarResource",
- "type": "object",
- "description": "JSON template for Calendar Resource object in Directory API.",
- "properties": {
- "buildingId": {
- "type": "string",
- "description": "Unique ID for the building a resource is located in."
- },
- "capacity": {
- "type": "integer",
- "description": "Capacity of a resource, number of seats in a room.",
- "format": "int32"
- },
- "etags": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "featureInstances": {
- "type": "any"
- },
- "floorName": {
- "type": "string",
- "description": "Name of the floor a resource is located on."
- },
- "floorSection": {
- "type": "string",
- "description": "Name of the section within a floor a resource is located in."
- },
- "generatedResourceName": {
- "type": "string",
- "description": "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)\"."
- },
- "kind": {
- "type": "string",
- "description": "The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.",
- "default": "admin#directory#resources#calendars#CalendarResource"
- },
- "resourceCategory": {
- "type": "string",
- "description": "The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN."
- },
- "resourceDescription": {
- "type": "string",
- "description": "Description of the resource, visible only to admins."
- },
- "resourceEmail": {
- "type": "string",
- "description": "The read-only email for the calendar resource. Generated as part of creating a new calendar resource."
- },
- "resourceId": {
- "type": "string",
- "description": "The unique ID for the calendar resource."
- },
- "resourceName": {
- "type": "string",
- "description": "The name of the calendar resource. For example, \"Training Room 1A\"."
- },
- "resourceType": {
- "type": "string",
- "description": "The type of the calendar resource, intended for non-room resources."
- },
- "userVisibleDescription": {
- "type": "string",
- "description": "Description of the resource, visible to users and admins."
- }
- }
- },
- "CalendarResources": {
- "id": "CalendarResources",
- "type": "object",
- "description": "JSON template for Calendar Resource List Response object in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "The CalendarResources in this page of results.",
- "items": {
- "$ref": "CalendarResource"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.",
- "default": "admin#directory#resources#calendars#calendarResourcesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
- }
- }
- },
- "Channel": {
- "id": "Channel",
- "type": "object",
- "description": "An notification channel used to watch for resource changes.",
- "properties": {
- "address": {
- "type": "string",
- "description": "The address where notifications are delivered for this channel."
- },
- "expiration": {
- "type": "string",
- "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "A UUID or similar unique string that identifies this channel."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
- "default": "api#channel"
- },
- "params": {
- "type": "object",
- "description": "Additional parameters controlling delivery channel behavior. Optional.",
- "additionalProperties": {
- "type": "string",
- "description": "Declares a new parameter by name."
- }
- },
- "payload": {
- "type": "boolean",
- "description": "A Boolean value to indicate whether payload is wanted. Optional."
- },
- "resourceId": {
- "type": "string",
- "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions."
- },
- "resourceUri": {
- "type": "string",
- "description": "A version-specific identifier for the watched resource."
- },
- "token": {
- "type": "string",
- "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional."
- },
- "type": {
- "type": "string",
- "description": "The type of delivery mechanism used for this channel."
- }
- }
- },
- "ChromeOsDevice": {
- "id": "ChromeOsDevice",
- "type": "object",
- "description": "JSON template for Chrome Os Device resource in Directory API.",
- "properties": {
- "activeTimeRanges": {
- "type": "array",
- "description": "List of active time ranges (Read-only)",
- "items": {
- "type": "object",
- "properties": {
- "activeTime": {
- "type": "integer",
- "description": "Duration in milliseconds",
- "format": "int32"
- },
- "date": {
- "type": "string",
- "description": "Date of usage",
- "format": "date"
- }
- }
- }
- },
- "annotatedAssetId": {
- "type": "string",
- "description": "AssetId specified during enrollment or through later annotation"
- },
- "annotatedLocation": {
- "type": "string",
- "description": "Address or location of the device as noted by the administrator"
- },
- "annotatedUser": {
- "type": "string",
- "description": "User of the device"
- },
- "bootMode": {
- "type": "string",
- "description": "Chromebook boot mode (Read-only)"
- },
- "deviceFiles": {
- "type": "array",
- "description": "List of device files to download (Read-only)",
- "items": {
- "type": "object",
- "properties": {
- "createTime": {
- "type": "string",
- "description": "Date and time the file was created",
- "format": "date-time"
- },
- "downloadUrl": {
- "type": "string",
- "description": "File downlod URL"
- },
- "name": {
- "type": "string",
- "description": "File name"
- },
- "type": {
- "type": "string",
- "description": "File type"
- }
- }
- }
- },
- "deviceId": {
- "type": "string",
- "description": "Unique identifier of Chrome OS Device (Read-only)"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "ethernetMacAddress": {
- "type": "string",
- "description": "Chromebook Mac Address on ethernet network interface (Read-only)"
- },
- "firmwareVersion": {
- "type": "string",
- "description": "Chromebook firmware version (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#chromeosdevice"
- },
- "lastEnrollmentTime": {
- "type": "string",
- "description": "Date and time the device was last enrolled (Read-only)",
- "format": "date-time"
- },
- "lastSync": {
- "type": "string",
- "description": "Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
- "format": "date-time"
- },
- "macAddress": {
- "type": "string",
- "description": "Chromebook Mac Address on wifi network interface (Read-only)"
- },
- "meid": {
- "type": "string",
- "description": "Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)"
- },
- "model": {
- "type": "string",
- "description": "Chromebook Model (Read-only)"
- },
- "notes": {
- "type": "string",
- "description": "Notes added by the administrator"
- },
- "orderNumber": {
- "type": "string",
- "description": "Chromebook order number (Read-only)"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "OrgUnit of the device"
- },
- "osVersion": {
- "type": "string",
- "description": "Chromebook Os Version (Read-only)"
- },
- "platformVersion": {
- "type": "string",
- "description": "Chromebook platform version (Read-only)"
- },
- "recentUsers": {
- "type": "array",
- "description": "List of recent device users, in descending order by last login time (Read-only)",
- "items": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the user. Present only if the user type is managed"
- },
- "type": {
- "type": "string",
- "description": "The type of the user"
- }
- }
- }
- },
- "serialNumber": {
- "type": "string",
- "description": "Chromebook serial number (Read-only)"
- },
- "status": {
- "type": "string",
- "description": "status of the device (Read-only)"
- },
- "supportEndDate": {
- "type": "string",
- "description": "Final date the device will be supported (Read-only)",
- "format": "date-time"
- },
- "tpmVersionInfo": {
- "type": "object",
- "properties": {
- "family": {
- "type": "string"
- },
- "firmwareVersion": {
- "type": "string"
- },
- "manufacturer": {
- "type": "string"
- },
- "specLevel": {
- "type": "string"
- },
- "tpmModel": {
- "type": "string"
- },
- "vendorSpecific": {
- "type": "string"
- }
- }
- },
- "willAutoRenew": {
- "type": "boolean",
- "description": "Will Chromebook auto renew after support end date (Read-only)"
- }
- }
- },
- "ChromeOsDeviceAction": {
- "id": "ChromeOsDeviceAction",
- "type": "object",
- "description": "JSON request template for firing actions on ChromeOs Device in Directory Devices API.",
- "properties": {
- "action": {
- "type": "string",
- "description": "Action to be taken on the ChromeOs Device",
- "annotations": {
- "required": [
- "directory.chromeosdevices.action"
- ]
- }
- },
- "deprovisionReason": {
- "type": "string"
- }
- }
- },
- "ChromeOsDevices": {
- "id": "ChromeOsDevices",
- "type": "object",
- "description": "JSON response template for List Chrome OS Devices operation in Directory API.",
- "properties": {
- "chromeosdevices": {
- "type": "array",
- "description": "List of Chrome OS Device objects.",
- "items": {
- "$ref": "ChromeOsDevice"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#chromeosdevices"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
- }
- }
- },
- "ChromeOsMoveDevicesToOu": {
- "id": "ChromeOsMoveDevicesToOu",
- "type": "object",
- "description": "JSON request template for moving ChromeOs Device to given OU in Directory Devices API.",
- "properties": {
- "deviceIds": {
- "type": "array",
- "description": "ChromeOs Devices to be moved to OU",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "directory.chromeosdevices.moveDevicesToOu"
- ]
- }
- }
- }
- },
- "Customer": {
- "id": "Customer",
- "type": "object",
- "description": "JSON template for Customer Resource object in Directory API.",
- "properties": {
- "alternateEmail": {
- "type": "string",
- "description": "The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain"
- },
- "customerCreationTime": {
- "type": "string",
- "description": "The customer's creation time (Readonly)",
- "format": "date-time"
- },
- "customerDomain": {
- "type": "string",
- "description": "The customer's primary domain name string. Do not include the www prefix when creating a new customer."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The unique ID for the customer's G Suite account. (Readonly)"
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a customer. Value: admin#directory#customer",
- "default": "admin#directory#customer"
- },
- "language": {
- "type": "string",
- "description": "The customer's ISO 639-2 language code. The default value is en-US"
- },
- "phoneNumber": {
- "type": "string",
- "description": "The customer's contact phone number in E.164 format."
- },
- "postalAddress": {
- "$ref": "CustomerPostalAddress",
- "description": "The customer's postal address information."
- }
- }
- },
- "CustomerPostalAddress": {
- "id": "CustomerPostalAddress",
- "type": "object",
- "description": "JSON template for postal address of a customer.",
- "properties": {
- "addressLine1": {
- "type": "string",
- "description": "A customer's physical address. The address can be composed of one to three lines."
- },
- "addressLine2": {
- "type": "string",
- "description": "Address line 2 of the address."
- },
- "addressLine3": {
- "type": "string",
- "description": "Address line 3 of the address."
- },
- "contactName": {
- "type": "string",
- "description": "The customer contact's name."
- },
- "countryCode": {
- "type": "string",
- "description": "This is a required property. For countryCode information see the ISO 3166 country code elements."
- },
- "locality": {
- "type": "string",
- "description": "Name of the locality. An example of a locality value is the city of San Francisco."
- },
- "organizationName": {
- "type": "string",
- "description": "The company or company division name."
- },
- "postalCode": {
- "type": "string",
- "description": "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."
- },
- "region": {
- "type": "string",
- "description": "Name of the region. An example of a region value is NY for the state of New York."
- }
- }
- },
- "DomainAlias": {
- "id": "DomainAlias",
- "type": "object",
- "description": "JSON template for Domain Alias object in Directory API.",
- "properties": {
- "creationTime": {
- "type": "string",
- "description": "The creation time of the domain alias. (Read-only).",
- "format": "int64"
- },
- "domainAliasName": {
- "type": "string",
- "description": "The domain alias name."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#domainAlias"
- },
- "parentDomainName": {
- "type": "string",
- "description": "The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.",
- "annotations": {
- "required": [
- "directory.domains.insert"
- ]
- }
- },
- "verified": {
- "type": "boolean",
- "description": "Indicates the verification state of a domain alias. (Read-only)"
- }
- }
- },
- "DomainAliases": {
- "id": "DomainAliases",
- "type": "object",
- "description": "JSON response template to list domain aliases in Directory API.",
- "properties": {
- "domainAliases": {
- "type": "array",
- "description": "List of domain alias objects.",
- "items": {
- "$ref": "DomainAlias"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#domainAliases"
- }
- }
- },
- "Domains": {
- "id": "Domains",
- "type": "object",
- "description": "JSON template for Domain object in Directory API.",
- "properties": {
- "creationTime": {
- "type": "string",
- "description": "Creation time of the domain. (Read-only).",
- "format": "int64"
- },
- "domainAliases": {
- "type": "array",
- "description": "List of domain alias objects. (Read-only)",
- "items": {
- "$ref": "DomainAlias"
- }
- },
- "domainName": {
- "type": "string",
- "description": "The domain name of the customer.",
- "annotations": {
- "required": [
- "directory.domains.insert"
- ]
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "isPrimary": {
- "type": "boolean",
- "description": "Indicates if the domain is a primary domain (Read-only)."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#domain"
- },
- "verified": {
- "type": "boolean",
- "description": "Indicates the verification state of a domain. (Read-only)."
- }
- }
- },
- "Domains2": {
- "id": "Domains2",
- "type": "object",
- "description": "JSON response template to list Domains in Directory API.",
- "properties": {
- "domains": {
- "type": "array",
- "description": "List of domain objects.",
- "items": {
- "$ref": "Domains"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#domains"
- }
- }
- },
- "Feature": {
- "id": "Feature",
- "type": "object",
- "description": "JSON template for Feature object in Directory API.",
- "properties": {
- "etags": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#resources#features#Feature"
- },
- "name": {
- "type": "string",
- "description": "The name of the feature.",
- "annotations": {
- "required": [
- "directory.resources.features.insert"
- ]
- }
- }
- }
- },
- "FeatureInstance": {
- "id": "FeatureInstance",
- "type": "object",
- "description": "JSON template for a \"feature instance\".",
- "properties": {
- "feature": {
- "$ref": "Feature"
- }
- }
- },
- "FeatureRename": {
- "id": "FeatureRename",
- "type": "object",
- "description": "JSON request template for renaming a feature.",
- "properties": {
- "newName": {
- "type": "string",
- "description": "New name of the feature.",
- "annotations": {
- "required": [
- "directory.resources.features.rename"
- ]
- }
- }
- }
- },
- "Features": {
- "id": "Features",
- "type": "object",
- "description": "JSON template for Feature List Response object in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "features": {
- "type": "array",
- "description": "The Features in this page of results.",
- "items": {
- "$ref": "Feature"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#resources#features#featuresList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
- }
- }
- },
- "Group": {
- "id": "Group",
- "type": "object",
- "description": "JSON template for Group resource in Directory API.",
- "properties": {
- "adminCreated": {
- "type": "boolean",
- "description": "Is the group created by admin (Read-only) *"
- },
- "aliases": {
- "type": "array",
- "description": "List of aliases (Read-only)",
- "items": {
- "type": "string"
- }
- },
- "description": {
- "type": "string",
- "description": "Description of the group"
- },
- "directMembersCount": {
- "type": "string",
- "description": "Group direct members count",
- "format": "int64"
- },
- "email": {
- "type": "string",
- "description": "Email of Group",
- "annotations": {
- "required": [
- "directory.groups.insert"
- ]
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of Group (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#group"
- },
- "name": {
- "type": "string",
- "description": "Group name"
- },
- "nonEditableAliases": {
- "type": "array",
- "description": "List of non editable aliases (Read-only)",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Groups": {
- "id": "Groups",
- "type": "object",
- "description": "JSON response template for List Groups operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "groups": {
- "type": "array",
- "description": "List of group objects.",
- "items": {
- "$ref": "Group"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#groups"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
- }
- }
- },
- "Member": {
- "id": "Member",
- "type": "object",
- "description": "JSON template for Member resource in Directory API.",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email of member (Read-only)"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#member"
- },
- "role": {
- "type": "string",
- "description": "Role of member"
- },
- "status": {
- "type": "string",
- "description": "Status of member (Immutable)"
- },
- "type": {
- "type": "string",
- "description": "Type of member (Immutable)"
- }
- }
- },
- "Members": {
- "id": "Members",
- "type": "object",
- "description": "JSON response template for List Members operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#members"
- },
- "members": {
- "type": "array",
- "description": "List of member objects.",
- "items": {
- "$ref": "Member"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
- }
- }
- },
- "MembersHasMember": {
- "id": "MembersHasMember",
- "type": "object",
- "description": "JSON template for Has Member response in Directory API.",
- "properties": {
- "isMember": {
- "type": "boolean",
- "description": "Identifies whether given user is a member or not.",
- "readOnly": true
- }
- }
- },
- "MobileDevice": {
- "id": "MobileDevice",
- "type": "object",
- "description": "JSON template for Mobile Device resource in Directory API.",
- "properties": {
- "adbStatus": {
- "type": "boolean",
- "description": "Adb (USB debugging) enabled or disabled on device (Read-only)"
- },
- "applications": {
- "type": "array",
- "description": "List of applications installed on Mobile Device",
- "items": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "Display name of application"
- },
- "packageName": {
- "type": "string",
- "description": "Package name of application"
- },
- "permission": {
- "type": "array",
- "description": "List of Permissions for application",
- "items": {
- "type": "string"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/admin.directory.customer": {
+ "description": "View and manage customer related information"
+ },
+ "https://www.googleapis.com/auth/admin.directory.customer.readonly": {
+ "description": "View customer related information"
+ },
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos": {
+ "description": "View and manage your Chrome OS devices' metadata"
+ },
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly": {
+ "description": "View your Chrome OS devices' metadata"
+ },
+ "https://www.googleapis.com/auth/admin.directory.device.mobile": {
+ "description": "View and manage your mobile devices' metadata"
+ },
+ "https://www.googleapis.com/auth/admin.directory.device.mobile.action": {
+ "description": "Manage your mobile devices by performing administrative tasks"
+ },
+ "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly": {
+ "description": "View your mobile devices' metadata"
+ },
+ "https://www.googleapis.com/auth/admin.directory.domain": {
+ "description": "View and manage the provisioning of domains for your customers"
+ },
+ "https://www.googleapis.com/auth/admin.directory.domain.readonly": {
+ "description": "View domains related to your customers"
+ },
+ "https://www.googleapis.com/auth/admin.directory.group": {
+ "description": "View and manage the provisioning of groups on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.group.member": {
+ "description": "View and manage group subscriptions on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.group.member.readonly": {
+ "description": "View group subscriptions on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.group.readonly": {
+ "description": "View groups on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.notifications": {
+ "description": "View and manage notifications received on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.orgunit": {
+ "description": "View and manage organization units on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.orgunit.readonly": {
+ "description": "View organization units on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar": {
+ "description": "View and manage the provisioning of calendar resources on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly": {
+ "description": "View calendar resources on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement": {
+ "description": "Manage delegated admin roles for your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly": {
+ "description": "View delegated admin roles for your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user": {
+ "description": "View and manage the provisioning of users on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user.alias": {
+ "description": "View and manage user aliases on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly": {
+ "description": "View user aliases on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user.readonly": {
+ "description": "View users on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.user.security": {
+ "description": "Manage data access permissions for users on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.userschema": {
+ "description": "View and manage the provisioning of user schemas on your domain"
+ },
+ "https://www.googleapis.com/auth/admin.directory.userschema.readonly": {
+ "description": "View user schemas on your domain"
}
- },
- "versionCode": {
- "type": "integer",
- "description": "Version code of application",
- "format": "int32"
- },
- "versionName": {
- "type": "string",
- "description": "Version name of application"
- }
}
- }
- },
- "basebandVersion": {
- "type": "string",
- "description": "Mobile Device Baseband version (Read-only)"
- },
- "bootloaderVersion": {
- "type": "string",
- "description": "Mobile Device Bootloader version (Read-only)"
- },
- "brand": {
- "type": "string",
- "description": "Mobile Device Brand (Read-only)"
- },
- "buildNumber": {
- "type": "string",
- "description": "Mobile Device Build number (Read-only)"
- },
- "defaultLanguage": {
- "type": "string",
- "description": "The default locale used on the Mobile Device (Read-only)"
- },
- "developerOptionsStatus": {
- "type": "boolean",
- "description": "Developer options enabled or disabled on device (Read-only)"
- },
- "deviceCompromisedStatus": {
- "type": "string",
- "description": "Mobile Device compromised status (Read-only)"
- },
- "deviceId": {
- "type": "string",
- "description": "Mobile Device serial number (Read-only)"
- },
- "devicePasswordStatus": {
- "type": "string",
- "description": "DevicePasswordStatus (Read-only)"
- },
- "email": {
- "type": "array",
- "description": "List of owner user's email addresses (Read-only)",
- "items": {
+ }
+ },
+ "basePath": "/admin/directory/v1/",
+ "baseUrl": "https://www.googleapis.com/admin/directory/v1/",
+ "batchPath": "batch/admin/directory_v1",
+ "canonicalName": "directory",
+ "description": "The Admin SDK Directory API lets you view and manage enterprise resources such as users and groups, administrative notifications, security features, and more.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/admin-sdk/directory/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/ny7NvsE3PzK3etgzPNk9J8KeI7k\"",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "id": "admin:directory_v1",
+ "kind": "discovery#restDescription",
+ "name": "admin",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "packagePath": "admin",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
- },
- "encryptionStatus": {
- "type": "string",
- "description": "Mobile Device Encryption Status (Read-only)"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "firstSync": {
- "type": "string",
- "description": "Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
- "format": "date-time"
- },
- "hardware": {
- "type": "string",
- "description": "Mobile Device Hardware (Read-only)"
- },
- "hardwareId": {
- "type": "string",
- "description": "Mobile Device Hardware Id (Read-only)"
- },
- "imei": {
- "type": "string",
- "description": "Mobile Device IMEI number (Read-only)"
- },
- "kernelVersion": {
- "type": "string",
- "description": "Mobile Device Kernel version (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#mobiledevice"
- },
- "lastSync": {
- "type": "string",
- "description": "Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
- "format": "date-time"
- },
- "managedAccountIsOnOwnerProfile": {
- "type": "boolean",
- "description": "Boolean indicating if this account is on owner/primary profile or not (Read-only)"
- },
- "manufacturer": {
- "type": "string",
- "description": "Mobile Device manufacturer (Read-only)"
- },
- "meid": {
- "type": "string",
- "description": "Mobile Device MEID number (Read-only)"
- },
- "model": {
- "type": "string",
- "description": "Name of the model of the device"
- },
- "name": {
- "type": "array",
- "description": "List of owner user's names (Read-only)",
- "items": {
- "type": "string"
- }
- },
- "networkOperator": {
- "type": "string",
- "description": "Mobile Device mobile or network operator (if available) (Read-only)"
- },
- "os": {
- "type": "string",
- "description": "Name of the mobile operating system"
- },
- "otherAccountsInfo": {
- "type": "array",
- "description": "List of accounts added on device (Read-only)",
- "items": {
- "type": "string"
- }
- },
- "privilege": {
- "type": "string",
- "description": "DMAgentPermission (Read-only)"
- },
- "releaseVersion": {
- "type": "string",
- "description": "Mobile Device release version version (Read-only)"
- },
- "resourceId": {
- "type": "string",
- "description": "Unique identifier of Mobile Device (Read-only)"
- },
- "securityPatchLevel": {
- "type": "string",
- "description": "Mobile Device Security patch level (Read-only)",
- "format": "int64"
- },
- "serialNumber": {
- "type": "string",
- "description": "Mobile Device SSN or Serial Number (Read-only)"
- },
- "status": {
- "type": "string",
- "description": "Status of the device (Read-only)"
- },
- "supportsWorkProfile": {
- "type": "boolean",
- "description": "Work profile supported on device (Read-only)"
- },
- "type": {
- "type": "string",
- "description": "The type of device (Read-only)"
- },
- "unknownSourcesStatus": {
- "type": "boolean",
- "description": "Unknown sources enabled or disabled on device (Read-only)"
- },
- "userAgent": {
- "type": "string",
- "description": "Mobile Device user agent"
- },
- "wifiMacAddress": {
- "type": "string",
- "description": "Mobile Device WiFi MAC address (Read-only)"
- }
- }
- },
- "MobileDeviceAction": {
- "id": "MobileDeviceAction",
- "type": "object",
- "description": "JSON request template for firing commands on Mobile Device in Directory Devices API.",
- "properties": {
- "action": {
- "type": "string",
- "description": "Action to be taken on the Mobile Device",
- "annotations": {
- "required": [
- "directory.mobiledevices.action"
- ]
- }
- }
- }
- },
- "MobileDevices": {
- "id": "MobileDevices",
- "type": "object",
- "description": "JSON response template for List Mobile Devices operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#mobiledevices"
- },
- "mobiledevices": {
- "type": "array",
- "description": "List of Mobile Device objects.",
- "items": {
- "$ref": "MobileDevice"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
- }
- }
- },
- "Notification": {
- "id": "Notification",
- "type": "object",
- "description": "Template for a notification resource.",
- "properties": {
- "body": {
- "type": "string",
- "description": "Body of the notification (Read-only)"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "fromAddress": {
- "type": "string",
- "description": "Address from which the notification is received (Read-only)"
- },
- "isUnread": {
- "type": "boolean",
- "description": "Boolean indicating whether the notification is unread or not.",
- "annotations": {
- "required": [
- "directory.notifications.patch",
- "directory.notifications.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the resource.",
- "default": "admin#directory#notification"
- },
- "notificationId": {
- "type": "string"
- },
- "sendTime": {
- "type": "string",
- "description": "Time at which notification was sent (Read-only)",
- "format": "date-time"
- },
- "subject": {
- "type": "string",
- "description": "Subject of the notification (Read-only)"
- }
- }
- },
- "Notifications": {
- "id": "Notifications",
- "type": "object",
- "description": "Template for notifications list response.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "List of notifications in this page.",
- "items": {
- "$ref": "Notification"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the resource.",
- "default": "admin#directory#notifications"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token for fetching the next page of notifications."
- },
- "unreadNotificationsCount": {
- "type": "integer",
- "description": "Number of unread notification for the domain.",
- "format": "int32"
- }
- }
- },
- "OrgUnit": {
- "id": "OrgUnit",
- "type": "object",
- "description": "JSON template for Org Unit resource in Directory API.",
- "properties": {
- "blockInheritance": {
- "type": "boolean",
- "description": "Should block inheritance"
- },
- "description": {
- "type": "string",
- "description": "Description of OrgUnit"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#orgUnit"
- },
- "name": {
- "type": "string",
- "description": "Name of OrgUnit",
- "annotations": {
- "required": [
- "directory.orgunits.insert"
- ]
- }
- },
- "orgUnitId": {
- "type": "string",
- "description": "Id of OrgUnit"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Path of OrgUnit"
- },
- "parentOrgUnitId": {
- "type": "string",
- "description": "Id of parent OrgUnit"
- },
- "parentOrgUnitPath": {
- "type": "string",
- "description": "Path of parent OrgUnit"
- }
- }
- },
- "OrgUnits": {
- "id": "OrgUnits",
- "type": "object",
- "description": "JSON response template for List Organization Units operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#orgUnits"
- },
- "organizationUnits": {
- "type": "array",
- "description": "List of user objects.",
- "items": {
- "$ref": "OrgUnit"
- }
- }
- }
- },
- "Privilege": {
- "id": "Privilege",
- "type": "object",
- "description": "JSON template for privilege resource in Directory API.",
- "properties": {
- "childPrivileges": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "Privilege"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "isOuScopable": {
- "type": "boolean",
- "description": "If the privilege can be restricted to an organization unit."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#privilege.",
- "default": "admin#directory#privilege"
- },
- "privilegeName": {
- "type": "string",
- "description": "The name of the privilege."
- },
- "serviceId": {
- "type": "string",
- "description": "The obfuscated ID of the service this privilege is for."
- },
- "serviceName": {
- "type": "string",
- "description": "The name of the service this privilege is for."
- }
- }
- },
- "Privileges": {
- "id": "Privileges",
- "type": "object",
- "description": "JSON response template for List privileges operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of Privilege resources.",
- "items": {
- "$ref": "Privilege"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#privileges.",
- "default": "admin#directory#privileges"
- }
- }
- },
- "Role": {
- "id": "Role",
- "type": "object",
- "description": "JSON template for role resource in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "isSuperAdminRole": {
- "type": "boolean",
- "description": "Returns true if the role is a super admin role."
- },
- "isSystemRole": {
- "type": "boolean",
- "description": "Returns true if this is a pre-defined system role."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#role.",
- "default": "admin#directory#role"
- },
- "roleDescription": {
- "type": "string",
- "description": "A short description of the role."
- },
- "roleId": {
- "type": "string",
- "description": "ID of the role.",
- "format": "int64"
- },
- "roleName": {
- "type": "string",
- "description": "Name of the role.",
- "annotations": {
- "required": [
- "directory.roles.insert"
- ]
- }
- },
- "rolePrivileges": {
- "type": "array",
- "description": "The set of privileges that are granted to this role.",
- "items": {
- "type": "object",
- "properties": {
- "privilegeName": {
- "type": "string",
- "description": "The name of the privilege."
- },
- "serviceId": {
- "type": "string",
- "description": "The obfuscated ID of the service this privilege is for."
- }
- }
- },
- "annotations": {
- "required": [
- "directory.roles.insert"
- ]
- }
- }
- }
- },
- "RoleAssignment": {
- "id": "RoleAssignment",
- "type": "object",
- "description": "JSON template for roleAssignment resource in Directory API.",
- "properties": {
- "assignedTo": {
- "type": "string",
- "description": "The unique ID of the user this role is assigned to."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#roleAssignment.",
- "default": "admin#directory#roleAssignment"
- },
- "orgUnitId": {
- "type": "string",
- "description": "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."
- },
- "roleAssignmentId": {
- "type": "string",
- "description": "ID of this roleAssignment.",
- "format": "int64"
- },
- "roleId": {
- "type": "string",
- "description": "The ID of the role that is assigned.",
- "format": "int64"
- },
- "scopeType": {
- "type": "string",
- "description": "The scope in which this role is assigned. Possible values are: \n- CUSTOMER\n- ORG_UNIT"
- }
- }
- },
- "RoleAssignments": {
- "id": "RoleAssignments",
- "type": "object",
- "description": "JSON response template for List roleAssignments operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of RoleAssignment resources.",
- "items": {
- "$ref": "RoleAssignment"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#roleAssignments.",
- "default": "admin#directory#roleAssignments"
- },
- "nextPageToken": {
- "type": "string"
- }
- }
- },
- "Roles": {
- "id": "Roles",
- "type": "object",
- "description": "JSON response template for List roles operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of Role resources.",
- "items": {
- "$ref": "Role"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#roles.",
- "default": "admin#directory#roles"
- },
- "nextPageToken": {
- "type": "string"
- }
- }
- },
- "Schema": {
- "id": "Schema",
- "type": "object",
- "description": "JSON template for Schema resource in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
},
"fields": {
- "type": "array",
- "description": "Fields of Schema",
- "items": {
- "$ref": "SchemaFieldSpec"
- },
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#schema"
- },
- "schemaId": {
- "type": "string",
- "description": "Unique identifier of Schema (Read-only)"
- },
- "schemaName": {
- "type": "string",
- "description": "Schema name",
- "annotations": {
- "required": [
- "directory.schemas.insert"
- ]
- }
- }
- }
- },
- "SchemaFieldSpec": {
- "id": "SchemaFieldSpec",
- "type": "object",
- "description": "JSON template for FieldSpec resource for Schemas in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "fieldId": {
- "type": "string",
- "description": "Unique identifier of Field (Read-only)"
- },
- "fieldName": {
- "type": "string",
- "description": "Name of the field.",
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- }
- },
- "fieldType": {
- "type": "string",
- "description": "Type of the field.",
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- }
- },
- "indexed": {
- "type": "boolean",
- "description": "Boolean specifying whether the field is indexed or not.",
- "default": "true"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#schema#fieldspec"
- },
- "multiValued": {
- "type": "boolean",
- "description": "Boolean specifying whether this is a multi-valued field or not."
- },
- "numericIndexingSpec": {
- "type": "object",
- "description": "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.",
- "properties": {
- "maxValue": {
- "type": "number",
- "description": "Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
- "format": "double"
- },
- "minValue": {
- "type": "number",
- "description": "Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
- "format": "double"
- }
- }
- },
- "readAccessType": {
- "type": "string",
- "description": "Read ACLs on the field specifying who can view values of this field. Valid values are \"ALL_DOMAIN_USERS\" and \"ADMINS_AND_SELF\".",
- "default": "ALL_DOMAIN_USERS"
- }
- }
- },
- "Schemas": {
- "id": "Schemas",
- "type": "object",
- "description": "JSON response template for List Schema operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#schemas"
- },
- "schemas": {
- "type": "array",
- "description": "List of UserSchema objects.",
- "items": {
- "$ref": "Schema"
- }
- }
- }
- },
- "Token": {
- "id": "Token",
- "type": "object",
- "description": "JSON template for token resource in Directory API.",
- "properties": {
- "anonymous": {
- "type": "boolean",
- "description": "Whether the application is registered with Google. The value is true if the application has an anonymous Client ID."
- },
- "clientId": {
- "type": "string",
- "description": "The Client ID of the application the token is issued to."
- },
- "displayText": {
- "type": "string",
- "description": "The displayable name of the application the token is issued to."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#token.",
- "default": "admin#directory#token"
- },
- "nativeApp": {
- "type": "boolean",
- "description": "Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device."
- },
- "scopes": {
- "type": "array",
- "description": "A list of authorization scopes the application is granted.",
- "items": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
- },
- "userKey": {
- "type": "string",
- "description": "The unique ID of the user that issued the token."
- }
- }
- },
- "Tokens": {
- "id": "Tokens",
- "type": "object",
- "description": "JSON response template for List tokens operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of Token resources.",
- "items": {
- "$ref": "Token"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#tokenList.",
- "default": "admin#directory#tokenList"
- }
- }
- },
- "TrustedAppId": {
- "id": "TrustedAppId",
- "type": "object",
- "description": "JSON template for Trusted App Ids Resource object in Directory API.",
- "properties": {
- "androidPackageName": {
- "type": "string",
- "description": "Android package name."
- },
- "certificateHashSHA1": {
- "type": "string",
- "description": "SHA1 signature of the app certificate."
- },
- "certificateHashSHA256": {
- "type": "string",
- "description": "SHA256 signature of the app certificate."
- },
- "etag": {
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a trusted AppId.",
- "default": "admin#directory#trustedappid"
- }
- }
- },
- "TrustedApps": {
- "id": "TrustedApps",
- "type": "object",
- "description": "JSON template for Trusted Apps response object of a user in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as trusted apps response.",
- "default": "admin#directory#trustedapplist"
- },
- "nextPageToken": {
- "type": "string"
- },
- "trustedApps": {
- "type": "array",
- "description": "Trusted Apps list.",
- "items": {
- "$ref": "TrustedAppId"
- }
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "JSON template for User object in Directory API.",
- "properties": {
- "addresses": {
- "type": "any"
- },
- "agreedToTerms": {
- "type": "boolean",
- "description": "Indicates if user has agreed to terms (Read-only)",
- "readOnly": true
- },
- "aliases": {
- "type": "array",
- "description": "List of aliases (Read-only)",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- },
- "changePasswordAtNextLogin": {
- "type": "boolean",
- "description": "Boolean indicating if the user should change password in next login"
- },
- "creationTime": {
- "type": "string",
- "description": "User's G Suite account creation time. (Read-only)",
- "format": "date-time",
- "readOnly": true
- },
- "customSchemas": {
- "type": "object",
- "description": "Custom fields of the user.",
- "additionalProperties": {
- "$ref": "UserCustomProperties"
- }
- },
- "customerId": {
- "type": "string",
- "description": "CustomerId of User (Read-only)",
- "readOnly": true
- },
- "deletionTime": {
- "type": "string",
- "format": "date-time",
- "readOnly": true
- },
- "emails": {
- "type": "any"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource.",
- "readOnly": true
- },
- "externalIds": {
- "type": "any"
- },
- "gender": {
- "type": "any"
- },
- "hashFunction": {
- "type": "string",
- "description": "Hash function name for password. Supported are MD5, SHA-1 and crypt"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of User (Read-only)"
- },
- "ims": {
- "type": "any"
- },
- "includeInGlobalAddressList": {
- "type": "boolean",
- "description": "Boolean indicating if user is included in Global Address List"
- },
- "ipWhitelisted": {
- "type": "boolean",
- "description": "Boolean indicating if ip is whitelisted"
- },
- "isAdmin": {
- "type": "boolean",
- "description": "Boolean indicating if the user is admin (Read-only)",
- "readOnly": true
- },
- "isDelegatedAdmin": {
- "type": "boolean",
- "description": "Boolean indicating if the user is delegated admin (Read-only)",
- "readOnly": true
- },
- "isEnforcedIn2Sv": {
- "type": "boolean",
- "description": "Is 2-step verification enforced (Read-only)",
- "readOnly": true
- },
- "isEnrolledIn2Sv": {
- "type": "boolean",
- "description": "Is enrolled in 2-step verification (Read-only)",
- "readOnly": true
- },
- "isMailboxSetup": {
- "type": "boolean",
- "description": "Is mailbox setup (Read-only)",
- "readOnly": true
- },
- "keywords": {
- "type": "any"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#user",
- "readOnly": true
- },
- "languages": {
- "type": "any"
- },
- "lastLoginTime": {
- "type": "string",
- "description": "User's last login time. (Read-only)",
- "format": "date-time",
- "readOnly": true
- },
- "locations": {
- "type": "any"
- },
- "name": {
- "$ref": "UserName",
- "description": "User's name",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- },
- "nonEditableAliases": {
- "type": "array",
- "description": "List of non editable aliases (Read-only)",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- },
- "notes": {
- "type": "any"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "OrgUnit of User"
- },
- "organizations": {
- "type": "any"
- },
- "password": {
- "type": "string",
- "description": "User's password",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- },
- "phones": {
- "type": "any"
- },
- "posixAccounts": {
- "type": "any"
- },
- "primaryEmail": {
- "type": "string",
- "description": "username of User",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- },
- "relations": {
- "type": "any"
- },
- "sshPublicKeys": {
- "type": "any"
- },
- "suspended": {
- "type": "boolean",
- "description": "Indicates if user is suspended"
- },
- "suspensionReason": {
- "type": "string",
- "description": "Suspension reason if user is suspended (Read-only)",
- "readOnly": true
- },
- "thumbnailPhotoEtag": {
- "type": "string",
- "description": "ETag of the user's photo (Read-only)",
- "readOnly": true
- },
- "thumbnailPhotoUrl": {
- "type": "string",
- "description": "Photo Url of the user (Read-only)",
- "readOnly": true
- },
- "websites": {
- "type": "any"
- }
- }
- },
- "UserAbout": {
- "id": "UserAbout",
- "type": "object",
- "description": "JSON template for About (notes) of a user in Directory API.",
- "properties": {
- "contentType": {
- "type": "string",
- "description": "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."
- },
- "value": {
- "type": "string",
- "description": "Actual value of notes."
- }
- }
- },
- "UserAddress": {
- "id": "UserAddress",
- "type": "object",
- "description": "JSON template for address.",
- "properties": {
- "country": {
- "type": "string",
- "description": "Country."
- },
- "countryCode": {
- "type": "string",
- "description": "Country code."
- },
- "customType": {
- "type": "string",
- "description": "Custom type."
- },
- "extendedAddress": {
- "type": "string",
- "description": "Extended Address."
- },
- "formatted": {
- "type": "string",
- "description": "Formatted address."
- },
- "locality": {
- "type": "string",
- "description": "Locality."
- },
- "poBox": {
- "type": "string",
- "description": "Other parts of address."
- },
- "postalCode": {
- "type": "string",
- "description": "Postal code."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary address. Only one entry could be marked as primary."
- },
- "region": {
- "type": "string",
- "description": "Region."
- },
- "sourceIsStructured": {
- "type": "boolean",
- "description": "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."
- },
- "streetAddress": {
- "type": "string",
- "description": "Street."
- },
- "type": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "UserCustomProperties": {
- "id": "UserCustomProperties",
- "type": "object",
- "description": "JSON template for a set of custom properties (i.e. all fields in a particular schema)",
- "additionalProperties": {
- "type": "any"
- }
- },
- "UserEmail": {
- "id": "UserEmail",
- "type": "object",
- "description": "JSON template for an email.",
- "properties": {
- "address": {
- "type": "string",
- "description": "Email id of the user."
- },
- "customType": {
- "type": "string",
- "description": "Custom Type."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary email. Only one entry could be marked as primary."
- },
- "type": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "UserExternalId": {
- "id": "UserExternalId",
- "type": "object",
- "description": "JSON template for an externalId entry.",
- "properties": {
- "customType": {
- "type": "string",
- "description": "Custom type."
- },
- "type": {
- "type": "string",
- "description": "The type of the Id."
- },
- "value": {
- "type": "string",
- "description": "The value of the id."
- }
- }
- },
- "UserGender": {
- "id": "UserGender",
- "type": "object",
- "properties": {
- "addressMeAs": {
- "type": "string",
- "description": "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\"."
- },
- "customGender": {
- "type": "string",
- "description": "Custom gender."
- },
- "type": {
- "type": "string",
- "description": "Gender."
- }
- }
- },
- "UserIm": {
- "id": "UserIm",
- "type": "object",
- "description": "JSON template for instant messenger of an user.",
- "properties": {
- "customProtocol": {
- "type": "string",
- "description": "Custom protocol."
- },
- "customType": {
- "type": "string",
- "description": "Custom type."
- },
- "im": {
- "type": "string",
- "description": "Instant messenger id."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary im. Only one entry could be marked as primary."
- },
- "protocol": {
- "type": "string",
- "description": "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."
- },
- "type": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "UserKeyword": {
- "id": "UserKeyword",
- "type": "object",
- "description": "JSON template for a keyword entry.",
- "properties": {
- "customType": {
- "type": "string",
- "description": "Custom Type."
- },
- "type": {
- "type": "string",
- "description": "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."
- },
- "value": {
- "type": "string",
- "description": "Keyword."
- }
- }
- },
- "UserLanguage": {
- "id": "UserLanguage",
- "type": "object",
- "description": "JSON template for a language entry.",
- "properties": {
- "customLanguage": {
- "type": "string",
- "description": "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"
- },
- "languageCode": {
- "type": "string",
- "description": "Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException."
- }
- }
- },
- "UserLocation": {
- "id": "UserLocation",
- "type": "object",
- "description": "JSON template for a location entry.",
- "properties": {
- "area": {
- "type": "string",
- "description": "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\"."
- },
- "buildingId": {
- "type": "string",
- "description": "Building Identifier."
- },
- "customType": {
- "type": "string",
- "description": "Custom Type."
- },
- "deskCode": {
- "type": "string",
- "description": "Most specific textual code of individual desk location."
- },
- "floorName": {
- "type": "string",
- "description": "Floor name/number."
- },
- "floorSection": {
- "type": "string",
- "description": "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."
- },
- "type": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "UserMakeAdmin": {
- "id": "UserMakeAdmin",
- "type": "object",
- "description": "JSON request template for setting/revoking admin status of a user in Directory API.",
- "properties": {
- "status": {
- "type": "boolean",
- "description": "Boolean indicating new admin status of the user",
- "annotations": {
- "required": [
- "directory.users.makeAdmin"
- ]
- }
- }
- }
- },
- "UserName": {
- "id": "UserName",
- "type": "object",
- "description": "JSON template for name of a user in Directory API.",
- "properties": {
- "familyName": {
- "type": "string",
- "description": "Last Name",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- },
- "fullName": {
- "type": "string",
- "description": "Full Name"
- },
- "givenName": {
- "type": "string",
- "description": "First Name",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- }
- }
- },
- "UserOrganization": {
- "id": "UserOrganization",
- "type": "object",
- "description": "JSON template for an organization entry.",
- "properties": {
- "costCenter": {
- "type": "string",
- "description": "The cost center of the users department."
- },
- "customType": {
- "type": "string",
- "description": "Custom type."
- },
- "department": {
- "type": "string",
- "description": "Department within the organization."
- },
- "description": {
- "type": "string",
- "description": "Description of the organization."
- },
- "domain": {
- "type": "string",
- "description": "The domain to which the organization belongs to."
- },
- "fullTimeEquivalent": {
- "type": "integer",
- "description": "The full-time equivalent percent within the organization (100000 = 100%).",
- "format": "int32"
- },
- "location": {
- "type": "string",
- "description": "Location of the organization. This need not be fully qualified address."
- },
- "name": {
- "type": "string",
- "description": "Name of the organization"
- },
- "primary": {
- "type": "boolean",
- "description": "If it user's primary organization."
- },
- "symbol": {
- "type": "string",
- "description": "Symbol of the organization."
- },
- "title": {
- "type": "string",
- "description": "Title (designation) of the user in the organization."
- },
- "type": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "UserPhone": {
- "id": "UserPhone",
- "type": "object",
- "description": "JSON template for a phone entry.",
- "properties": {
- "customType": {
- "type": "string",
- "description": "Custom Type."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary phone or not."
- },
- "type": {
- "type": "string",
- "description": "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."
- },
- "value": {
- "type": "string",
- "description": "Phone number."
- }
- }
- },
- "UserPhoto": {
- "id": "UserPhoto",
- "type": "object",
- "description": "JSON template for Photo object in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "height": {
- "type": "integer",
- "description": "Height in pixels of the photo",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of User (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#user#photo"
- },
- "mimeType": {
- "type": "string",
- "description": "Mime Type of the photo"
- },
- "photoData": {
- "type": "string",
- "description": "Base64 encoded photo data",
- "format": "byte",
- "annotations": {
- "required": [
- "directory.users.photos.update"
- ]
- }
- },
- "primaryEmail": {
- "type": "string",
- "description": "Primary email of User (Read-only)"
- },
- "width": {
- "type": "integer",
- "description": "Width in pixels of the photo",
- "format": "int32"
- }
- }
- },
- "UserPosixAccount": {
- "id": "UserPosixAccount",
- "type": "object",
- "description": "JSON template for a POSIX account entry. Description of the field family: go/fbs-posix.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "A POSIX account field identifier. (Read-only)",
- "readOnly": true
- },
- "gecos": {
- "type": "string",
- "description": "The GECOS (user information) for this account."
- },
- "gid": {
- "type": "string",
- "description": "The default group ID.",
- "format": "uint64"
- },
- "homeDirectory": {
- "type": "string",
- "description": "The path to the home directory for this account."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary account within the SystemId."
- },
- "shell": {
- "type": "string",
- "description": "The path to the login shell for this account."
- },
- "systemId": {
- "type": "string",
- "description": "System identifier for which account Username or Uid apply to."
- },
- "uid": {
- "type": "string",
- "description": "The POSIX compliant user ID.",
- "format": "uint64"
- },
- "username": {
- "type": "string",
- "description": "The username of the account."
- }
- }
- },
- "UserRelation": {
- "id": "UserRelation",
- "type": "object",
- "description": "JSON template for a relation entry.",
- "properties": {
- "customType": {
- "type": "string",
- "description": "Custom Type."
- },
- "type": {
- "type": "string",
- "description": "The relation of the user. Some of the possible values are mother, father, sister, brother, manager, assistant, partner."
- },
- "value": {
- "type": "string",
- "description": "The name of the relation."
- }
- }
- },
- "UserSshPublicKey": {
- "id": "UserSshPublicKey",
- "type": "object",
- "description": "JSON template for a POSIX account entry.",
- "properties": {
- "expirationTimeUsec": {
- "type": "string",
- "description": "An expiration time in microseconds since epoch.",
- "format": "int64"
- },
- "fingerprint": {
- "type": "string",
- "description": "A SHA-256 fingerprint of the SSH public key. (Read-only)",
- "readOnly": true
},
"key": {
- "type": "string",
- "description": "An SSH public key."
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "UserUndelete": {
- "id": "UserUndelete",
- "type": "object",
- "description": "JSON request template to undelete a user in Directory API.",
- "properties": {
- "orgUnitPath": {
- "type": "string",
- "description": "OrgUnit of User"
- }
- }
- },
- "UserWebsite": {
- "id": "UserWebsite",
- "type": "object",
- "description": "JSON template for a website entry.",
- "properties": {
- "customType": {
- "type": "string",
- "description": "Custom Type."
+ "protocol": "rest",
+ "resources": {
+ "asps": {
+ "methods": {
+ "delete": {
+ "description": "Delete an ASP issued by a user.",
+ "httpMethod": "DELETE",
+ "id": "directory.asps.delete",
+ "parameterOrder": [
+ "userKey",
+ "codeId"
+ ],
+ "parameters": {
+ "codeId": {
+ "description": "The unique ID of the ASP to be deleted.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/asps/{codeId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ },
+ "get": {
+ "description": "Get information about an ASP issued by a user.",
+ "httpMethod": "GET",
+ "id": "directory.asps.get",
+ "parameterOrder": [
+ "userKey",
+ "codeId"
+ ],
+ "parameters": {
+ "codeId": {
+ "description": "The unique ID of the ASP.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/asps/{codeId}",
+ "response": {
+ "$ref": "Asp"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ },
+ "list": {
+ "description": "List the ASPs issued by a user.",
+ "httpMethod": "GET",
+ "id": "directory.asps.list",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/asps",
+ "response": {
+ "$ref": "Asps"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ }
+ }
},
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary website or not."
+ "channels": {
+ "methods": {
+ "stop": {
+ "description": "Stop watching resources through this channel",
+ "httpMethod": "POST",
+ "id": "admin.channels.stop",
+ "path": "/admin/directory_v1/channels/stop",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.alias",
+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
+ ]
+ }
+ }
},
- "type": {
- "type": "string",
- "description": "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."
+ "chromeosdevices": {
+ "methods": {
+ "action": {
+ "description": "Take action on Chrome OS Device",
+ "httpMethod": "POST",
+ "id": "directory.chromeosdevices.action",
+ "parameterOrder": [
+ "customerId",
+ "resourceId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "Immutable ID of Chrome OS Device",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/chromeos/{resourceId}/action",
+ "request": {
+ "$ref": "ChromeOsDeviceAction"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos"
+ ]
+ },
+ "get": {
+ "description": "Retrieve Chrome OS Device",
+ "httpMethod": "GET",
+ "id": "directory.chromeosdevices.get",
+ "parameterOrder": [
+ "customerId",
+ "deviceId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Immutable ID of Chrome OS Device",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
+ "Includes all metadata fields"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/chromeos/{deviceId}",
+ "response": {
+ "$ref": "ChromeOsDevice"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos",
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
+ ]
+ },
+ "list": {
+ "description": "Retrieve all Chrome OS Devices of a customer (paginated)",
+ "httpMethod": "GET",
+ "id": "directory.chromeosdevices.list",
+ "parameterOrder": [
+ "customerId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 100",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Column to use for sorting results",
+ "enum": [
+ "annotatedLocation",
+ "annotatedUser",
+ "lastSync",
+ "notes",
+ "serialNumber",
+ "status",
+ "supportEndDate"
+ ],
+ "enumDescriptions": [
+ "Chromebook location as annotated by the administrator.",
+ "Chromebook user as annotated by administrator.",
+ "Chromebook last sync.",
+ "Chromebook notes as annotated by the administrator.",
+ "Chromebook Serial Number.",
+ "Chromebook status.",
+ "Chromebook support end date."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "description": "Full path of the organizational unit or its ID",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify next page in the list",
+ "location": "query",
+ "type": "string"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
+ "Includes all metadata fields"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "query": {
+ "description": "Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?hl=en\u0026answer=1698333",
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/chromeos",
+ "response": {
+ "$ref": "ChromeOsDevices"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos",
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
+ ]
+ },
+ "moveDevicesToOu": {
+ "description": "Move or insert multiple Chrome OS Devices to organizational unit",
+ "httpMethod": "POST",
+ "id": "directory.chromeosdevices.moveDevicesToOu",
+ "parameterOrder": [
+ "customerId",
+ "orgUnitPath"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "description": "Full path of the target organizational unit or its ID",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/chromeos/moveDevicesToOu",
+ "request": {
+ "$ref": "ChromeOsMoveDevicesToOu"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos"
+ ]
+ },
+ "patch": {
+ "description": "Update Chrome OS Device. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.chromeosdevices.patch",
+ "parameterOrder": [
+ "customerId",
+ "deviceId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Immutable ID of Chrome OS Device",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
+ "Includes all metadata fields"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/chromeos/{deviceId}",
+ "request": {
+ "$ref": "ChromeOsDevice"
+ },
+ "response": {
+ "$ref": "ChromeOsDevice"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos"
+ ]
+ },
+ "update": {
+ "description": "Update Chrome OS Device",
+ "httpMethod": "PUT",
+ "id": "directory.chromeosdevices.update",
+ "parameterOrder": [
+ "customerId",
+ "deviceId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Immutable ID of Chrome OS Device",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
+ "Includes all metadata fields"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/chromeos/{deviceId}",
+ "request": {
+ "$ref": "ChromeOsDevice"
+ },
+ "response": {
+ "$ref": "ChromeOsDevice"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.chromeos"
+ ]
+ }
+ }
},
- "value": {
- "type": "string",
- "description": "Website."
- }
- }
- },
- "Users": {
- "id": "Users",
- "type": "object",
- "description": "JSON response template for List Users operation in Apps Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
+ "customers": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a customer.",
+ "httpMethod": "GET",
+ "id": "directory.customers.get",
+ "parameterOrder": [
+ "customerKey"
+ ],
+ "parameters": {
+ "customerKey": {
+ "description": "Id of the customer to be retrieved",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customers/{customerKey}",
+ "response": {
+ "$ref": "Customer"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.customer",
+ "https://www.googleapis.com/auth/admin.directory.customer.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates a customer. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.customers.patch",
+ "parameterOrder": [
+ "customerKey"
+ ],
+ "parameters": {
+ "customerKey": {
+ "description": "Id of the customer to be updated",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customers/{customerKey}",
+ "request": {
+ "$ref": "Customer"
+ },
+ "response": {
+ "$ref": "Customer"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.customer"
+ ]
+ },
+ "update": {
+ "description": "Updates a customer.",
+ "httpMethod": "PUT",
+ "id": "directory.customers.update",
+ "parameterOrder": [
+ "customerKey"
+ ],
+ "parameters": {
+ "customerKey": {
+ "description": "Id of the customer to be updated",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customers/{customerKey}",
+ "request": {
+ "$ref": "Customer"
+ },
+ "response": {
+ "$ref": "Customer"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.customer"
+ ]
+ }
+ }
},
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#users"
+ "domainAliases": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a Domain Alias of the customer.",
+ "httpMethod": "DELETE",
+ "id": "directory.domainAliases.delete",
+ "parameterOrder": [
+ "customer",
+ "domainAliasName"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainAliasName": {
+ "description": "Name of domain alias to be retrieved.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/domainaliases/{domainAliasName}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.domain"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a domain alias of the customer.",
+ "httpMethod": "GET",
+ "id": "directory.domainAliases.get",
+ "parameterOrder": [
+ "customer",
+ "domainAliasName"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainAliasName": {
+ "description": "Name of domain alias to be retrieved.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/domainaliases/{domainAliasName}",
+ "response": {
+ "$ref": "DomainAlias"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.domain",
+ "https://www.googleapis.com/auth/admin.directory.domain.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a Domain alias of the customer.",
+ "httpMethod": "POST",
+ "id": "directory.domainAliases.insert",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/domainaliases",
+ "request": {
+ "$ref": "DomainAlias"
+ },
+ "response": {
+ "$ref": "DomainAlias"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.domain"
+ ]
+ },
+ "list": {
+ "description": "Lists the domain aliases of the customer.",
+ "httpMethod": "GET",
+ "id": "directory.domainAliases.list",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "parentDomainName": {
+ "description": "Name of the parent domain for which domain aliases are to be fetched.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/domainaliases",
+ "response": {
+ "$ref": "DomainAliases"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.domain",
+ "https://www.googleapis.com/auth/admin.directory.domain.readonly"
+ ]
+ }
+ }
},
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
+ "domains": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a domain of the customer.",
+ "httpMethod": "DELETE",
+ "id": "directory.domains.delete",
+ "parameterOrder": [
+ "customer",
+ "domainName"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainName": {
+ "description": "Name of domain to be deleted",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/domains/{domainName}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.domain"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a domain of the customer.",
+ "httpMethod": "GET",
+ "id": "directory.domains.get",
+ "parameterOrder": [
+ "customer",
+ "domainName"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainName": {
+ "description": "Name of domain to be retrieved",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/domains/{domainName}",
+ "response": {
+ "$ref": "Domains"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.domain",
+ "https://www.googleapis.com/auth/admin.directory.domain.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a domain of the customer.",
+ "httpMethod": "POST",
+ "id": "directory.domains.insert",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/domains",
+ "request": {
+ "$ref": "Domains"
+ },
+ "response": {
+ "$ref": "Domains"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.domain"
+ ]
+ },
+ "list": {
+ "description": "Lists the domains of the customer.",
+ "httpMethod": "GET",
+ "id": "directory.domains.list",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/domains",
+ "response": {
+ "$ref": "Domains2"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.domain",
+ "https://www.googleapis.com/auth/admin.directory.domain.readonly"
+ ]
+ }
+ }
},
- "trigger_event": {
- "type": "string",
- "description": "Event that triggered this response (only used in case of Push Response)"
+ "groups": {
+ "methods": {
+ "delete": {
+ "description": "Delete Group",
+ "httpMethod": "DELETE",
+ "id": "directory.groups.delete",
+ "parameterOrder": [
+ "groupKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group"
+ ]
+ },
+ "get": {
+ "description": "Retrieve Group",
+ "httpMethod": "GET",
+ "id": "directory.groups.get",
+ "parameterOrder": [
+ "groupKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}",
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create Group",
+ "httpMethod": "POST",
+ "id": "directory.groups.insert",
+ "path": "groups",
+ "request": {
+ "$ref": "Group"
+ },
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group"
+ ]
+ },
+ "list": {
+ "description": "Retrieve all groups in a domain (paginated)",
+ "httpMethod": "GET",
+ "id": "directory.groups.list",
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "domain": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 200",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify next page in the list",
+ "location": "query",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "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",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "groups",
+ "response": {
+ "$ref": "Groups"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Update Group. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.groups.patch",
+ "parameterOrder": [
+ "groupKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group. If ID, it should match with id of group object",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}",
+ "request": {
+ "$ref": "Group"
+ },
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group"
+ ]
+ },
+ "update": {
+ "description": "Update Group",
+ "httpMethod": "PUT",
+ "id": "directory.groups.update",
+ "parameterOrder": [
+ "groupKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group. If ID, it should match with id of group object",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}",
+ "request": {
+ "$ref": "Group"
+ },
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group"
+ ]
+ }
+ },
+ "resources": {
+ "aliases": {
+ "methods": {
+ "delete": {
+ "description": "Remove a alias for the group",
+ "httpMethod": "DELETE",
+ "id": "directory.groups.aliases.delete",
+ "parameterOrder": [
+ "groupKey",
+ "alias"
+ ],
+ "parameters": {
+ "alias": {
+ "description": "The alias to be removed",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "groupKey": {
+ "description": "Email or immutable ID of the group",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/aliases/{alias}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group"
+ ]
+ },
+ "insert": {
+ "description": "Add a alias for the group",
+ "httpMethod": "POST",
+ "id": "directory.groups.aliases.insert",
+ "parameterOrder": [
+ "groupKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/aliases",
+ "request": {
+ "$ref": "Alias"
+ },
+ "response": {
+ "$ref": "Alias"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group"
+ ]
+ },
+ "list": {
+ "description": "List all aliases for a group",
+ "httpMethod": "GET",
+ "id": "directory.groups.aliases.list",
+ "parameterOrder": [
+ "groupKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/aliases",
+ "response": {
+ "$ref": "Aliases"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
+ ],
+ "supportsSubscription": true
+ }
+ }
+ }
+ }
+ },
+ "members": {
+ "methods": {
+ "delete": {
+ "description": "Remove membership.",
+ "httpMethod": "DELETE",
+ "id": "directory.members.delete",
+ "parameterOrder": [
+ "groupKey",
+ "memberKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "memberKey": {
+ "description": "Email or immutable ID of the member",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/members/{memberKey}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.member"
+ ]
+ },
+ "get": {
+ "description": "Retrieve Group Member",
+ "httpMethod": "GET",
+ "id": "directory.members.get",
+ "parameterOrder": [
+ "groupKey",
+ "memberKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "memberKey": {
+ "description": "Email or immutable ID of the member",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/members/{memberKey}",
+ "response": {
+ "$ref": "Member"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.member",
+ "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
+ ]
+ },
+ "hasMember": {
+ "description": "Checks whether the given user is a member of the group. Membership can be direct or nested.",
+ "httpMethod": "GET",
+ "id": "directory.members.hasMember",
+ "parameterOrder": [
+ "groupKey",
+ "memberKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "memberKey": {
+ "description": "Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/hasMember/{memberKey}",
+ "response": {
+ "$ref": "MembersHasMember"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.member",
+ "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Add user to the specified group.",
+ "httpMethod": "POST",
+ "id": "directory.members.insert",
+ "parameterOrder": [
+ "groupKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/members",
+ "request": {
+ "$ref": "Member"
+ },
+ "response": {
+ "$ref": "Member"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.member"
+ ]
+ },
+ "list": {
+ "description": "Retrieve all members in a group (paginated)",
+ "httpMethod": "GET",
+ "id": "directory.members.list",
+ "parameterOrder": [
+ "groupKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 200",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify next page in the list",
+ "location": "query",
+ "type": "string"
+ },
+ "roles": {
+ "description": "Comma separated role values to filter list results on.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/members",
+ "response": {
+ "$ref": "Members"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.member",
+ "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Update membership of a user in the specified group. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.members.patch",
+ "parameterOrder": [
+ "groupKey",
+ "memberKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group. If ID, it should match with id of group object",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "memberKey": {
+ "description": "Email or immutable ID of the user. If ID, it should match with id of member object",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/members/{memberKey}",
+ "request": {
+ "$ref": "Member"
+ },
+ "response": {
+ "$ref": "Member"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.member"
+ ]
+ },
+ "update": {
+ "description": "Update membership of a user in the specified group.",
+ "httpMethod": "PUT",
+ "id": "directory.members.update",
+ "parameterOrder": [
+ "groupKey",
+ "memberKey"
+ ],
+ "parameters": {
+ "groupKey": {
+ "description": "Email or immutable ID of the group. If ID, it should match with id of group object",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "memberKey": {
+ "description": "Email or immutable ID of the user. If ID, it should match with id of member object",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "groups/{groupKey}/members/{memberKey}",
+ "request": {
+ "$ref": "Member"
+ },
+ "response": {
+ "$ref": "Member"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.group.member"
+ ]
+ }
+ }
+ },
+ "mobiledevices": {
+ "methods": {
+ "action": {
+ "description": "Take action on Mobile Device",
+ "httpMethod": "POST",
+ "id": "directory.mobiledevices.action",
+ "parameterOrder": [
+ "customerId",
+ "resourceId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "Immutable ID of Mobile Device",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/mobile/{resourceId}/action",
+ "request": {
+ "$ref": "MobileDeviceAction"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.mobile",
+ "https://www.googleapis.com/auth/admin.directory.device.mobile.action"
+ ]
+ },
+ "delete": {
+ "description": "Delete Mobile Device",
+ "httpMethod": "DELETE",
+ "id": "directory.mobiledevices.delete",
+ "parameterOrder": [
+ "customerId",
+ "resourceId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "Immutable ID of Mobile Device",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/mobile/{resourceId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.mobile"
+ ]
+ },
+ "get": {
+ "description": "Retrieve Mobile Device",
+ "httpMethod": "GET",
+ "id": "directory.mobiledevices.get",
+ "parameterOrder": [
+ "customerId",
+ "resourceId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
+ "Includes all metadata fields"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "Immutable ID of Mobile Device",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/mobile/{resourceId}",
+ "response": {
+ "$ref": "MobileDevice"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.mobile",
+ "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
+ "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
+ ]
+ },
+ "list": {
+ "description": "Retrieve all Mobile Devices of a customer (paginated)",
+ "httpMethod": "GET",
+ "id": "directory.mobiledevices.list",
+ "parameterOrder": [
+ "customerId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 100",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Column to use for sorting results",
+ "enum": [
+ "deviceId",
+ "email",
+ "lastSync",
+ "model",
+ "name",
+ "os",
+ "status",
+ "type"
+ ],
+ "enumDescriptions": [
+ "Mobile Device serial number.",
+ "Owner user email.",
+ "Last policy settings sync date time of the device.",
+ "Mobile Device model.",
+ "Owner user name.",
+ "Mobile operating system.",
+ "Status of the device.",
+ "Type of the device."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify next page in the list",
+ "location": "query",
+ "type": "string"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
+ "Includes all metadata fields"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "query": {
+ "description": "Search string in the format given at http://support.google.com/a/bin/answer.py?hl=en\u0026answer=1408863#search",
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/devices/mobile",
+ "response": {
+ "$ref": "MobileDevices"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.device.mobile",
+ "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
+ "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
+ ]
+ }
+ }
+ },
+ "notifications": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a notification",
+ "httpMethod": "DELETE",
+ "id": "directory.notifications.delete",
+ "parameterOrder": [
+ "customer",
+ "notificationId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "notificationId": {
+ "description": "The unique ID of the notification.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/notifications/{notificationId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.notifications"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a notification.",
+ "httpMethod": "GET",
+ "id": "directory.notifications.get",
+ "parameterOrder": [
+ "customer",
+ "notificationId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "notificationId": {
+ "description": "The unique ID of the notification.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/notifications/{notificationId}",
+ "response": {
+ "$ref": "Notification"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.notifications"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of notifications.",
+ "httpMethod": "GET",
+ "id": "directory.notifications.list",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "The unique ID for the customer's G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "The ISO 639-1 code of the language notifications are returned in. The default is English (en).",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of notifications to return per page. The default is 100.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The token to specify the page of results to retrieve.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/notifications",
+ "response": {
+ "$ref": "Notifications"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.notifications"
+ ]
+ },
+ "patch": {
+ "description": "Updates a notification. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.notifications.patch",
+ "parameterOrder": [
+ "customer",
+ "notificationId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "The unique ID for the customer's G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "notificationId": {
+ "description": "The unique ID of the notification.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/notifications/{notificationId}",
+ "request": {
+ "$ref": "Notification"
+ },
+ "response": {
+ "$ref": "Notification"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.notifications"
+ ]
+ },
+ "update": {
+ "description": "Updates a notification.",
+ "httpMethod": "PUT",
+ "id": "directory.notifications.update",
+ "parameterOrder": [
+ "customer",
+ "notificationId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "The unique ID for the customer's G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "notificationId": {
+ "description": "The unique ID of the notification.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/notifications/{notificationId}",
+ "request": {
+ "$ref": "Notification"
+ },
+ "response": {
+ "$ref": "Notification"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.notifications"
+ ]
+ }
+ }
+ },
+ "orgunits": {
+ "methods": {
+ "delete": {
+ "description": "Remove organizational unit",
+ "httpMethod": "DELETE",
+ "id": "directory.orgunits.delete",
+ "parameterOrder": [
+ "customerId",
+ "orgUnitPath"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "description": "Full path of the organizational unit or its ID",
+ "location": "path",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.orgunit"
+ ]
+ },
+ "get": {
+ "description": "Retrieve organizational unit",
+ "httpMethod": "GET",
+ "id": "directory.orgunits.get",
+ "parameterOrder": [
+ "customerId",
+ "orgUnitPath"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "description": "Full path of the organizational unit or its ID",
+ "location": "path",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
+ "response": {
+ "$ref": "OrgUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.orgunit",
+ "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Add organizational unit",
+ "httpMethod": "POST",
+ "id": "directory.orgunits.insert",
+ "parameterOrder": [
+ "customerId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/orgunits",
+ "request": {
+ "$ref": "OrgUnit"
+ },
+ "response": {
+ "$ref": "OrgUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.orgunit"
+ ]
+ },
+ "list": {
+ "description": "Retrieve all organizational units",
+ "httpMethod": "GET",
+ "id": "directory.orgunits.list",
+ "parameterOrder": [
+ "customerId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "default": "",
+ "description": "the URL-encoded organizational unit's path or its ID",
+ "location": "query",
+ "type": "string"
+ },
+ "type": {
+ "description": "Whether to return all sub-organizations or just immediate children",
+ "enum": [
+ "all",
+ "children"
+ ],
+ "enumDescriptions": [
+ "All sub-organizational units.",
+ "Immediate children only (default)."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/orgunits",
+ "response": {
+ "$ref": "OrgUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.orgunit",
+ "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Update organizational unit. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.orgunits.patch",
+ "parameterOrder": [
+ "customerId",
+ "orgUnitPath"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "description": "Full path of the organizational unit or its ID",
+ "location": "path",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
+ "request": {
+ "$ref": "OrgUnit"
+ },
+ "response": {
+ "$ref": "OrgUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.orgunit"
+ ]
+ },
+ "update": {
+ "description": "Update organizational unit",
+ "httpMethod": "PUT",
+ "id": "directory.orgunits.update",
+ "parameterOrder": [
+ "customerId",
+ "orgUnitPath"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "description": "Full path of the organizational unit or its ID",
+ "location": "path",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
+ "request": {
+ "$ref": "OrgUnit"
+ },
+ "response": {
+ "$ref": "OrgUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.orgunit"
+ ]
+ }
+ }
+ },
+ "privileges": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a paginated list of all privileges for a customer.",
+ "httpMethod": "GET",
+ "id": "directory.privileges.list",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roles/ALL/privileges",
+ "response": {
+ "$ref": "Privileges"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement",
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
+ ]
+ }
+ }
+ },
+ "resolvedAppAccessSettings": {
+ "methods": {
+ "GetSettings": {
+ "description": "Retrieves resolved app access settings of the logged in user.",
+ "httpMethod": "GET",
+ "id": "directory.resolvedAppAccessSettings.GetSettings",
+ "path": "resolvedappaccesssettings",
+ "response": {
+ "$ref": "AppAccessCollections"
+ }
+ },
+ "ListTrustedApps": {
+ "description": "Retrieves the list of apps trusted by the admin of the logged in user.",
+ "httpMethod": "GET",
+ "id": "directory.resolvedAppAccessSettings.ListTrustedApps",
+ "path": "trustedapps",
+ "response": {
+ "$ref": "TrustedApps"
+ }
+ }
+ }
+ },
+ "resources": {
+ "resources": {
+ "buildings": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a building.",
+ "httpMethod": "DELETE",
+ "id": "directory.resources.buildings.delete",
+ "parameterOrder": [
+ "customer",
+ "buildingId"
+ ],
+ "parameters": {
+ "buildingId": {
+ "description": "The ID of the building to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/buildings/{buildingId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a building.",
+ "httpMethod": "GET",
+ "id": "directory.resources.buildings.get",
+ "parameterOrder": [
+ "customer",
+ "buildingId"
+ ],
+ "parameters": {
+ "buildingId": {
+ "description": "The unique ID of the building to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/buildings/{buildingId}",
+ "response": {
+ "$ref": "Building"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar",
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a building.",
+ "httpMethod": "POST",
+ "id": "directory.resources.buildings.insert",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/buildings",
+ "request": {
+ "$ref": "Building"
+ },
+ "response": {
+ "$ref": "Building"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of buildings for an account.",
+ "httpMethod": "GET",
+ "id": "directory.resources.buildings.list",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "500",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify the next page in the list.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/buildings",
+ "response": {
+ "$ref": "Buildings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar",
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates a building. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.resources.buildings.patch",
+ "parameterOrder": [
+ "customer",
+ "buildingId"
+ ],
+ "parameters": {
+ "buildingId": {
+ "description": "The ID of the building to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/buildings/{buildingId}",
+ "request": {
+ "$ref": "Building"
+ },
+ "response": {
+ "$ref": "Building"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "update": {
+ "description": "Updates a building.",
+ "httpMethod": "PUT",
+ "id": "directory.resources.buildings.update",
+ "parameterOrder": [
+ "customer",
+ "buildingId"
+ ],
+ "parameters": {
+ "buildingId": {
+ "description": "The ID of the building to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/buildings/{buildingId}",
+ "request": {
+ "$ref": "Building"
+ },
+ "response": {
+ "$ref": "Building"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ }
+ }
+ },
+ "calendars": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a calendar resource.",
+ "httpMethod": "DELETE",
+ "id": "directory.resources.calendars.delete",
+ "parameterOrder": [
+ "customer",
+ "calendarResourceId"
+ ],
+ "parameters": {
+ "calendarResourceId": {
+ "description": "The unique ID of the calendar resource to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/calendars/{calendarResourceId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a calendar resource.",
+ "httpMethod": "GET",
+ "id": "directory.resources.calendars.get",
+ "parameterOrder": [
+ "customer",
+ "calendarResourceId"
+ ],
+ "parameters": {
+ "calendarResourceId": {
+ "description": "The unique ID of the calendar resource to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/calendars/{calendarResourceId}",
+ "response": {
+ "$ref": "CalendarResource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar",
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a calendar resource.",
+ "httpMethod": "POST",
+ "id": "directory.resources.calendars.insert",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/calendars",
+ "request": {
+ "$ref": "CalendarResource"
+ },
+ "response": {
+ "$ref": "CalendarResource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of calendar resources for an account.",
+ "httpMethod": "GET",
+ "id": "directory.resources.calendars.list",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "500",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify the next page in the list.",
+ "location": "query",
+ "type": "string"
+ },
+ "query": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/calendars",
+ "response": {
+ "$ref": "CalendarResources"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar",
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates a calendar resource.\n\nThis 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.",
+ "httpMethod": "PATCH",
+ "id": "directory.resources.calendars.patch",
+ "parameterOrder": [
+ "customer",
+ "calendarResourceId"
+ ],
+ "parameters": {
+ "calendarResourceId": {
+ "description": "The unique ID of the calendar resource to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/calendars/{calendarResourceId}",
+ "request": {
+ "$ref": "CalendarResource"
+ },
+ "response": {
+ "$ref": "CalendarResource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "update": {
+ "description": "Updates a calendar resource.\n\nThis 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.",
+ "httpMethod": "PUT",
+ "id": "directory.resources.calendars.update",
+ "parameterOrder": [
+ "customer",
+ "calendarResourceId"
+ ],
+ "parameters": {
+ "calendarResourceId": {
+ "description": "The unique ID of the calendar resource to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/calendars/{calendarResourceId}",
+ "request": {
+ "$ref": "CalendarResource"
+ },
+ "response": {
+ "$ref": "CalendarResource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ }
+ }
+ },
+ "features": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a feature.",
+ "httpMethod": "DELETE",
+ "id": "directory.resources.features.delete",
+ "parameterOrder": [
+ "customer",
+ "featureKey"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "featureKey": {
+ "description": "The unique ID of the feature to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/features/{featureKey}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a feature.",
+ "httpMethod": "GET",
+ "id": "directory.resources.features.get",
+ "parameterOrder": [
+ "customer",
+ "featureKey"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "featureKey": {
+ "description": "The unique ID of the feature to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/features/{featureKey}",
+ "response": {
+ "$ref": "Feature"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar",
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a feature.",
+ "httpMethod": "POST",
+ "id": "directory.resources.features.insert",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/features",
+ "request": {
+ "$ref": "Feature"
+ },
+ "response": {
+ "$ref": "Feature"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of features for an account.",
+ "httpMethod": "GET",
+ "id": "directory.resources.features.list",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "500",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify the next page in the list.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/features",
+ "response": {
+ "$ref": "Features"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar",
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates a feature. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.resources.features.patch",
+ "parameterOrder": [
+ "customer",
+ "featureKey"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "featureKey": {
+ "description": "The unique ID of the feature to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/features/{featureKey}",
+ "request": {
+ "$ref": "Feature"
+ },
+ "response": {
+ "$ref": "Feature"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "rename": {
+ "description": "Renames a feature.",
+ "httpMethod": "POST",
+ "id": "directory.resources.features.rename",
+ "parameterOrder": [
+ "customer",
+ "oldName"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "oldName": {
+ "description": "The unique ID of the feature to rename.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/features/{oldName}/rename",
+ "request": {
+ "$ref": "FeatureRename"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ },
+ "update": {
+ "description": "Updates a feature.",
+ "httpMethod": "PUT",
+ "id": "directory.resources.features.update",
+ "parameterOrder": [
+ "customer",
+ "featureKey"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "featureKey": {
+ "description": "The unique ID of the feature to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/resources/features/{featureKey}",
+ "request": {
+ "$ref": "Feature"
+ },
+ "response": {
+ "$ref": "Feature"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.resource.calendar"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "roleAssignments": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a role assignment.",
+ "httpMethod": "DELETE",
+ "id": "directory.roleAssignments.delete",
+ "parameterOrder": [
+ "customer",
+ "roleAssignmentId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "roleAssignmentId": {
+ "description": "Immutable ID of the role assignment.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roleassignments/{roleAssignmentId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement"
+ ]
+ },
+ "get": {
+ "description": "Retrieve a role assignment.",
+ "httpMethod": "GET",
+ "id": "directory.roleAssignments.get",
+ "parameterOrder": [
+ "customer",
+ "roleAssignmentId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "roleAssignmentId": {
+ "description": "Immutable ID of the role assignment.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roleassignments/{roleAssignmentId}",
+ "response": {
+ "$ref": "RoleAssignment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement",
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Creates a role assignment.",
+ "httpMethod": "POST",
+ "id": "directory.roleAssignments.insert",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roleassignments",
+ "request": {
+ "$ref": "RoleAssignment"
+ },
+ "response": {
+ "$ref": "RoleAssignment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a paginated list of all roleAssignments.",
+ "httpMethod": "GET",
+ "id": "directory.roleAssignments.list",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "200",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify the next page in the list.",
+ "location": "query",
+ "type": "string"
+ },
+ "roleId": {
+ "description": "Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roleassignments",
+ "response": {
+ "$ref": "RoleAssignments"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement",
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
+ ]
+ }
+ }
+ },
+ "roles": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a role.",
+ "httpMethod": "DELETE",
+ "id": "directory.roles.delete",
+ "parameterOrder": [
+ "customer",
+ "roleId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "roleId": {
+ "description": "Immutable ID of the role.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roles/{roleId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a role.",
+ "httpMethod": "GET",
+ "id": "directory.roles.get",
+ "parameterOrder": [
+ "customer",
+ "roleId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "roleId": {
+ "description": "Immutable ID of the role.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roles/{roleId}",
+ "response": {
+ "$ref": "Role"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement",
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Creates a role.",
+ "httpMethod": "POST",
+ "id": "directory.roles.insert",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roles",
+ "request": {
+ "$ref": "Role"
+ },
+ "response": {
+ "$ref": "Role"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a paginated list of all the roles in a domain.",
+ "httpMethod": "GET",
+ "id": "directory.roles.list",
+ "parameterOrder": [
+ "customer"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify the next page in the list.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roles",
+ "response": {
+ "$ref": "Roles"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement",
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates a role. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.roles.patch",
+ "parameterOrder": [
+ "customer",
+ "roleId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "roleId": {
+ "description": "Immutable ID of the role.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roles/{roleId}",
+ "request": {
+ "$ref": "Role"
+ },
+ "response": {
+ "$ref": "Role"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement"
+ ]
+ },
+ "update": {
+ "description": "Updates a role.",
+ "httpMethod": "PUT",
+ "id": "directory.roles.update",
+ "parameterOrder": [
+ "customer",
+ "roleId"
+ ],
+ "parameters": {
+ "customer": {
+ "description": "Immutable ID of the G Suite account.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "roleId": {
+ "description": "Immutable ID of the role.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customer}/roles/{roleId}",
+ "request": {
+ "$ref": "Role"
+ },
+ "response": {
+ "$ref": "Role"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.rolemanagement"
+ ]
+ }
+ }
+ },
+ "schemas": {
+ "methods": {
+ "delete": {
+ "description": "Delete schema",
+ "httpMethod": "DELETE",
+ "id": "directory.schemas.delete",
+ "parameterOrder": [
+ "customerId",
+ "schemaKey"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "schemaKey": {
+ "description": "Name or immutable ID of the schema",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/schemas/{schemaKey}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.userschema"
+ ]
+ },
+ "get": {
+ "description": "Retrieve schema",
+ "httpMethod": "GET",
+ "id": "directory.schemas.get",
+ "parameterOrder": [
+ "customerId",
+ "schemaKey"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "schemaKey": {
+ "description": "Name or immutable ID of the schema",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/schemas/{schemaKey}",
+ "response": {
+ "$ref": "Schema"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.userschema",
+ "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create schema.",
+ "httpMethod": "POST",
+ "id": "directory.schemas.insert",
+ "parameterOrder": [
+ "customerId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/schemas",
+ "request": {
+ "$ref": "Schema"
+ },
+ "response": {
+ "$ref": "Schema"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.userschema"
+ ]
+ },
+ "list": {
+ "description": "Retrieve all schemas for a customer",
+ "httpMethod": "GET",
+ "id": "directory.schemas.list",
+ "parameterOrder": [
+ "customerId"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/schemas",
+ "response": {
+ "$ref": "Schemas"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.userschema",
+ "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Update schema. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.schemas.patch",
+ "parameterOrder": [
+ "customerId",
+ "schemaKey"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "schemaKey": {
+ "description": "Name or immutable ID of the schema.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/schemas/{schemaKey}",
+ "request": {
+ "$ref": "Schema"
+ },
+ "response": {
+ "$ref": "Schema"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.userschema"
+ ]
+ },
+ "update": {
+ "description": "Update schema",
+ "httpMethod": "PUT",
+ "id": "directory.schemas.update",
+ "parameterOrder": [
+ "customerId",
+ "schemaKey"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Immutable ID of the G Suite account",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "schemaKey": {
+ "description": "Name or immutable ID of the schema.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "customer/{customerId}/schemas/{schemaKey}",
+ "request": {
+ "$ref": "Schema"
+ },
+ "response": {
+ "$ref": "Schema"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.userschema"
+ ]
+ }
+ }
+ },
+ "tokens": {
+ "methods": {
+ "delete": {
+ "description": "Delete all access tokens issued by a user for an application.",
+ "httpMethod": "DELETE",
+ "id": "directory.tokens.delete",
+ "parameterOrder": [
+ "userKey",
+ "clientId"
+ ],
+ "parameters": {
+ "clientId": {
+ "description": "The Client ID of the application the token is issued to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/tokens/{clientId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ },
+ "get": {
+ "description": "Get information about an access token issued by a user.",
+ "httpMethod": "GET",
+ "id": "directory.tokens.get",
+ "parameterOrder": [
+ "userKey",
+ "clientId"
+ ],
+ "parameters": {
+ "clientId": {
+ "description": "The Client ID of the application the token is issued to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/tokens/{clientId}",
+ "response": {
+ "$ref": "Token"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ },
+ "list": {
+ "description": "Returns the set of tokens specified user has issued to 3rd party applications.",
+ "httpMethod": "GET",
+ "id": "directory.tokens.list",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/tokens",
+ "response": {
+ "$ref": "Tokens"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ }
+ }
},
"users": {
- "type": "array",
- "description": "List of user objects.",
- "items": {
- "$ref": "User"
- }
+ "methods": {
+ "delete": {
+ "description": "Delete user",
+ "httpMethod": "DELETE",
+ "id": "directory.users.delete",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user"
+ ]
+ },
+ "get": {
+ "description": "retrieve user",
+ "httpMethod": "GET",
+ "id": "directory.users.get",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "customFieldMask": {
+ "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
+ "location": "query",
+ "type": "string"
+ },
+ "projection": {
+ "default": "basic",
+ "description": "What subset of fields to fetch for this user.",
+ "enum": [
+ "basic",
+ "custom",
+ "full"
+ ],
+ "enumDescriptions": [
+ "Do not include any custom fields for the user.",
+ "Include custom fields from schemas mentioned in customFieldMask.",
+ "Include all fields associated with this user."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "viewType": {
+ "default": "admin_view",
+ "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
+ "enum": [
+ "admin_view",
+ "domain_public"
+ ],
+ "enumDescriptions": [
+ "Fetches the ADMIN_VIEW of the user.",
+ "Fetches the DOMAIN_PUBLIC view of the user."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}",
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
+ ]
+ },
+ "insert": {
+ "description": "create user.",
+ "httpMethod": "POST",
+ "id": "directory.users.insert",
+ "path": "users",
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user"
+ ]
+ },
+ "list": {
+ "description": "Retrieve either deleted users or all users in a domain (paginated)",
+ "httpMethod": "GET",
+ "id": "directory.users.list",
+ "parameters": {
+ "customFieldMask": {
+ "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
+ "location": "query",
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "domain": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "event": {
+ "description": "Event on which subscription is intended (if subscribing)",
+ "enum": [
+ "add",
+ "delete",
+ "makeAdmin",
+ "undelete",
+ "update"
+ ],
+ "enumDescriptions": [
+ "User Created Event",
+ "User Deleted Event",
+ "User Admin Status Change Event",
+ "User Undeleted Event",
+ "User Updated Event"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
+ "format": "int32",
+ "location": "query",
+ "maximum": "500",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Column to use for sorting results",
+ "enum": [
+ "email",
+ "familyName",
+ "givenName"
+ ],
+ "enumDescriptions": [
+ "Primary email of the user.",
+ "User's family name.",
+ "User's given name."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify next page in the list",
+ "location": "query",
+ "type": "string"
+ },
+ "projection": {
+ "default": "basic",
+ "description": "What subset of fields to fetch for this user.",
+ "enum": [
+ "basic",
+ "custom",
+ "full"
+ ],
+ "enumDescriptions": [
+ "Do not include any custom fields for the user.",
+ "Include custom fields from schemas mentioned in customFieldMask.",
+ "Include all fields associated with this user."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "query": {
+ "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "If set to true retrieves the list of deleted users. Default is false",
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "description": "Whether to return results in ascending or descending order.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "viewType": {
+ "default": "admin_view",
+ "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
+ "enum": [
+ "admin_view",
+ "domain_public"
+ ],
+ "enumDescriptions": [
+ "Fetches the ADMIN_VIEW of the user.",
+ "Fetches the DOMAIN_PUBLIC view of the user."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "users",
+ "response": {
+ "$ref": "Users"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
+ ],
+ "supportsSubscription": true
+ },
+ "makeAdmin": {
+ "description": "change admin status of a user",
+ "httpMethod": "POST",
+ "id": "directory.users.makeAdmin",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user as admin",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/makeAdmin",
+ "request": {
+ "$ref": "UserMakeAdmin"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user"
+ ]
+ },
+ "patch": {
+ "description": "update user. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.users.patch",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user. If ID, it should match with id of user object",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}",
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user"
+ ]
+ },
+ "undelete": {
+ "description": "Undelete a deleted user",
+ "httpMethod": "POST",
+ "id": "directory.users.undelete",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "The immutable id of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/undelete",
+ "request": {
+ "$ref": "UserUndelete"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user"
+ ]
+ },
+ "update": {
+ "description": "update user",
+ "httpMethod": "PUT",
+ "id": "directory.users.update",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user. If ID, it should match with id of user object",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}",
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user"
+ ]
+ },
+ "watch": {
+ "description": "Watch for changes in users list",
+ "httpMethod": "POST",
+ "id": "directory.users.watch",
+ "parameters": {
+ "customFieldMask": {
+ "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
+ "location": "query",
+ "type": "string"
+ },
+ "customer": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "domain": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "event": {
+ "description": "Event on which subscription is intended (if subscribing)",
+ "enum": [
+ "add",
+ "delete",
+ "makeAdmin",
+ "undelete",
+ "update"
+ ],
+ "enumDescriptions": [
+ "User Created Event",
+ "User Deleted Event",
+ "User Admin Status Change Event",
+ "User Undeleted Event",
+ "User Updated Event"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
+ "format": "int32",
+ "location": "query",
+ "maximum": "500",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Column to use for sorting results",
+ "enum": [
+ "email",
+ "familyName",
+ "givenName"
+ ],
+ "enumDescriptions": [
+ "Primary email of the user.",
+ "User's family name.",
+ "User's given name."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify next page in the list",
+ "location": "query",
+ "type": "string"
+ },
+ "projection": {
+ "default": "basic",
+ "description": "What subset of fields to fetch for this user.",
+ "enum": [
+ "basic",
+ "custom",
+ "full"
+ ],
+ "enumDescriptions": [
+ "Do not include any custom fields for the user.",
+ "Include custom fields from schemas mentioned in customFieldMask.",
+ "Include all fields associated with this user."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "query": {
+ "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "If set to true retrieves the list of deleted users. Default is false",
+ "location": "query",
+ "type": "string"
+ },
+ "sortOrder": {
+ "description": "Whether to return results in ascending or descending order.",
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "Ascending order.",
+ "Descending order."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "viewType": {
+ "default": "admin_view",
+ "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
+ "enum": [
+ "admin_view",
+ "domain_public"
+ ],
+ "enumDescriptions": [
+ "Fetches the ADMIN_VIEW of the user.",
+ "Fetches the DOMAIN_PUBLIC view of the user."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "users/watch",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "response": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
+ ],
+ "supportsSubscription": true
+ }
+ },
+ "resources": {
+ "aliases": {
+ "methods": {
+ "delete": {
+ "description": "Remove a alias for the user",
+ "httpMethod": "DELETE",
+ "id": "directory.users.aliases.delete",
+ "parameterOrder": [
+ "userKey",
+ "alias"
+ ],
+ "parameters": {
+ "alias": {
+ "description": "The alias to be removed",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/aliases/{alias}",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.alias"
+ ]
+ },
+ "insert": {
+ "description": "Add a alias for the user",
+ "httpMethod": "POST",
+ "id": "directory.users.aliases.insert",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/aliases",
+ "request": {
+ "$ref": "Alias"
+ },
+ "response": {
+ "$ref": "Alias"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.alias"
+ ]
+ },
+ "list": {
+ "description": "List all aliases for a user",
+ "httpMethod": "GET",
+ "id": "directory.users.aliases.list",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "event": {
+ "description": "Event on which subscription is intended (if subscribing)",
+ "enum": [
+ "add",
+ "delete"
+ ],
+ "enumDescriptions": [
+ "Alias Created Event",
+ "Alias Deleted Event"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/aliases",
+ "response": {
+ "$ref": "Aliases"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.alias",
+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
+ ],
+ "supportsSubscription": true
+ },
+ "watch": {
+ "description": "Watch for changes in user aliases list",
+ "httpMethod": "POST",
+ "id": "directory.users.aliases.watch",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "event": {
+ "description": "Event on which subscription is intended (if subscribing)",
+ "enum": [
+ "add",
+ "delete"
+ ],
+ "enumDescriptions": [
+ "Alias Created Event",
+ "Alias Deleted Event"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/aliases/watch",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "response": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.alias",
+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
+ ],
+ "supportsSubscription": true
+ }
+ }
+ },
+ "photos": {
+ "methods": {
+ "delete": {
+ "description": "Remove photos for the user",
+ "httpMethod": "DELETE",
+ "id": "directory.users.photos.delete",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/photos/thumbnail",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user"
+ ]
+ },
+ "get": {
+ "description": "Retrieve photo of a user",
+ "httpMethod": "GET",
+ "id": "directory.users.photos.get",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/photos/thumbnail",
+ "response": {
+ "$ref": "UserPhoto"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Add a photo for the user. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "directory.users.photos.patch",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/photos/thumbnail",
+ "request": {
+ "$ref": "UserPhoto"
+ },
+ "response": {
+ "$ref": "UserPhoto"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user"
+ ]
+ },
+ "update": {
+ "description": "Add a photo for the user",
+ "httpMethod": "PUT",
+ "id": "directory.users.photos.update",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/photos/thumbnail",
+ "request": {
+ "$ref": "UserPhoto"
+ },
+ "response": {
+ "$ref": "UserPhoto"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "verificationCodes": {
+ "methods": {
+ "generate": {
+ "description": "Generate new backup verification codes for the user.",
+ "httpMethod": "POST",
+ "id": "directory.verificationCodes.generate",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/verificationCodes/generate",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ },
+ "invalidate": {
+ "description": "Invalidate the current backup verification codes for the user.",
+ "httpMethod": "POST",
+ "id": "directory.verificationCodes.invalidate",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Email or immutable ID of the user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/verificationCodes/invalidate",
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ },
+ "list": {
+ "description": "Returns the current set of valid backup verification codes for the specified user.",
+ "httpMethod": "GET",
+ "id": "directory.verificationCodes.list",
+ "parameterOrder": [
+ "userKey"
+ ],
+ "parameters": {
+ "userKey": {
+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userKey}/verificationCodes",
+ "response": {
+ "$ref": "VerificationCodes"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.directory.user.security"
+ ]
+ }
+ }
}
- }
- },
- "VerificationCode": {
- "id": "VerificationCode",
- "type": "object",
- "description": "JSON template for verification codes in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The type of the resource. This is always admin#directory#verificationCode.",
- "default": "admin#directory#verificationCode"
- },
- "userId": {
- "type": "string",
- "description": "The obfuscated unique ID of the user."
- },
- "verificationCode": {
- "type": "string",
- "description": "A current verification code for the user. Invalidated or used verification codes are not returned as part of the result."
- }
- }
- },
- "VerificationCodes": {
- "id": "VerificationCodes",
- "type": "object",
- "description": "JSON response template for List verification codes operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of verification code resources.",
- "items": {
- "$ref": "VerificationCode"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the resource. This is always admin#directory#verificationCodesList.",
- "default": "admin#directory#verificationCodesList"
- }
- }
- }
- },
- "resources": {
- "asps": {
- "methods": {
- "delete": {
- "id": "directory.asps.delete",
- "path": "users/{userKey}/asps/{codeId}",
- "httpMethod": "DELETE",
- "description": "Delete an ASP issued by a user.",
- "parameters": {
- "codeId": {
- "type": "integer",
- "description": "The unique ID of the ASP to be deleted.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "codeId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "get": {
- "id": "directory.asps.get",
- "path": "users/{userKey}/asps/{codeId}",
- "httpMethod": "GET",
- "description": "Get information about an ASP issued by a user.",
- "parameters": {
- "codeId": {
- "type": "integer",
- "description": "The unique ID of the ASP.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "codeId"
- ],
- "response": {
- "$ref": "Asp"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "list": {
- "id": "directory.asps.list",
- "path": "users/{userKey}/asps",
- "httpMethod": "GET",
- "description": "List the ASPs issued by a user.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "Asps"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- }
- }
- },
- "channels": {
- "methods": {
- "stop": {
- "id": "admin.channels.stop",
- "path": "/admin/directory_v1/channels/stop",
- "httpMethod": "POST",
- "description": "Stop watching resources through this channel",
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias",
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ]
- }
- }
- },
- "chromeosdevices": {
- "methods": {
- "action": {
- "id": "directory.chromeosdevices.action",
- "path": "customer/{customerId}/devices/chromeos/{resourceId}/action",
- "httpMethod": "POST",
- "description": "Take action on Chrome OS Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "resourceId": {
- "type": "string",
- "description": "Immutable ID of Chrome OS Device",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "resourceId"
- ],
- "request": {
- "$ref": "ChromeOsDeviceAction"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos"
- ]
- },
- "get": {
- "id": "directory.chromeosdevices.get",
- "path": "customer/{customerId}/devices/chromeos/{deviceId}",
- "httpMethod": "GET",
- "description": "Retrieve Chrome OS Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "deviceId": {
- "type": "string",
- "description": "Immutable ID of Chrome OS Device",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- "Includes all metadata fields"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId",
- "deviceId"
- ],
- "response": {
- "$ref": "ChromeOsDevice"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos",
- "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
- ]
- },
- "list": {
- "id": "directory.chromeosdevices.list",
- "path": "customer/{customerId}/devices/chromeos",
- "httpMethod": "GET",
- "description": "Retrieve all Chrome OS Devices of a customer (paginated)",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Column to use for sorting results",
- "enum": [
- "annotatedLocation",
- "annotatedUser",
- "lastSync",
- "notes",
- "serialNumber",
- "status",
- "supportEndDate"
- ],
- "enumDescriptions": [
- "Chromebook location as annotated by the administrator.",
- "Chromebook user as annotated by administrator.",
- "Chromebook last sync.",
- "Chromebook notes as annotated by the administrator.",
- "Chromebook Serial Number.",
- "Chromebook status.",
- "Chromebook support end date."
- ],
- "location": "query"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the organizational unit or its ID",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- "Includes all metadata fields"
- ],
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?hl=en&answer=1698333",
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "response": {
- "$ref": "ChromeOsDevices"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos",
- "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
- ]
- },
- "moveDevicesToOu": {
- "id": "directory.chromeosdevices.moveDevicesToOu",
- "path": "customer/{customerId}/devices/chromeos/moveDevicesToOu",
- "httpMethod": "POST",
- "description": "Move or insert multiple Chrome OS Devices to organizational unit",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the target organizational unit or its ID",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId",
- "orgUnitPath"
- ],
- "request": {
- "$ref": "ChromeOsMoveDevicesToOu"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos"
- ]
- },
- "patch": {
- "id": "directory.chromeosdevices.patch",
- "path": "customer/{customerId}/devices/chromeos/{deviceId}",
- "httpMethod": "PATCH",
- "description": "Update Chrome OS Device. This method supports patch semantics.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "deviceId": {
- "type": "string",
- "description": "Immutable ID of Chrome OS Device",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- "Includes all metadata fields"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId",
- "deviceId"
- ],
- "request": {
- "$ref": "ChromeOsDevice"
- },
- "response": {
- "$ref": "ChromeOsDevice"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos"
- ]
- },
- "update": {
- "id": "directory.chromeosdevices.update",
- "path": "customer/{customerId}/devices/chromeos/{deviceId}",
- "httpMethod": "PUT",
- "description": "Update Chrome OS Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "deviceId": {
- "type": "string",
- "description": "Immutable ID of Chrome OS Device",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- "Includes all metadata fields"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId",
- "deviceId"
- ],
- "request": {
- "$ref": "ChromeOsDevice"
- },
- "response": {
- "$ref": "ChromeOsDevice"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos"
- ]
- }
- }
- },
- "customers": {
- "methods": {
- "get": {
- "id": "directory.customers.get",
- "path": "customers/{customerKey}",
- "httpMethod": "GET",
- "description": "Retrieves a customer.",
- "parameters": {
- "customerKey": {
- "type": "string",
- "description": "Id of the customer to be retrieved",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerKey"
- ],
- "response": {
- "$ref": "Customer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.customer",
- "https://www.googleapis.com/auth/admin.directory.customer.readonly"
- ]
- },
- "patch": {
- "id": "directory.customers.patch",
- "path": "customers/{customerKey}",
- "httpMethod": "PATCH",
- "description": "Updates a customer. This method supports patch semantics.",
- "parameters": {
- "customerKey": {
- "type": "string",
- "description": "Id of the customer to be updated",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerKey"
- ],
- "request": {
- "$ref": "Customer"
- },
- "response": {
- "$ref": "Customer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.customer"
- ]
- },
- "update": {
- "id": "directory.customers.update",
- "path": "customers/{customerKey}",
- "httpMethod": "PUT",
- "description": "Updates a customer.",
- "parameters": {
- "customerKey": {
- "type": "string",
- "description": "Id of the customer to be updated",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerKey"
- ],
- "request": {
- "$ref": "Customer"
- },
- "response": {
- "$ref": "Customer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.customer"
- ]
- }
- }
- },
- "domainAliases": {
- "methods": {
- "delete": {
- "id": "directory.domainAliases.delete",
- "path": "customer/{customer}/domainaliases/{domainAliasName}",
- "httpMethod": "DELETE",
- "description": "Deletes a Domain Alias of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "domainAliasName": {
- "type": "string",
- "description": "Name of domain alias to be retrieved.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "domainAliasName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain"
- ]
- },
- "get": {
- "id": "directory.domainAliases.get",
- "path": "customer/{customer}/domainaliases/{domainAliasName}",
- "httpMethod": "GET",
- "description": "Retrieves a domain alias of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "domainAliasName": {
- "type": "string",
- "description": "Name of domain alias to be retrieved.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "domainAliasName"
- ],
- "response": {
- "$ref": "DomainAlias"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain",
- "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- ]
- },
- "insert": {
- "id": "directory.domainAliases.insert",
- "path": "customer/{customer}/domainaliases",
- "httpMethod": "POST",
- "description": "Inserts a Domain alias of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "DomainAlias"
- },
- "response": {
- "$ref": "DomainAlias"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain"
- ]
- },
- "list": {
- "id": "directory.domainAliases.list",
- "path": "customer/{customer}/domainaliases",
- "httpMethod": "GET",
- "description": "Lists the domain aliases of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "parentDomainName": {
- "type": "string",
- "description": "Name of the parent domain for which domain aliases are to be fetched.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "DomainAliases"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain",
- "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- ]
- }
- }
- },
- "domains": {
- "methods": {
- "delete": {
- "id": "directory.domains.delete",
- "path": "customer/{customer}/domains/{domainName}",
- "httpMethod": "DELETE",
- "description": "Deletes a domain of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "domainName": {
- "type": "string",
- "description": "Name of domain to be deleted",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "domainName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain"
- ]
- },
- "get": {
- "id": "directory.domains.get",
- "path": "customer/{customer}/domains/{domainName}",
- "httpMethod": "GET",
- "description": "Retrieves a domain of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "domainName": {
- "type": "string",
- "description": "Name of domain to be retrieved",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "domainName"
- ],
- "response": {
- "$ref": "Domains"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain",
- "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- ]
- },
- "insert": {
- "id": "directory.domains.insert",
- "path": "customer/{customer}/domains",
- "httpMethod": "POST",
- "description": "Inserts a domain of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "Domains"
- },
- "response": {
- "$ref": "Domains"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain"
- ]
- },
- "list": {
- "id": "directory.domains.list",
- "path": "customer/{customer}/domains",
- "httpMethod": "GET",
- "description": "Lists the domains of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Domains2"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain",
- "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- ]
- }
- }
- },
- "groups": {
- "methods": {
- "delete": {
- "id": "directory.groups.delete",
- "path": "groups/{groupKey}",
- "httpMethod": "DELETE",
- "description": "Delete Group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "get": {
- "id": "directory.groups.get",
- "path": "groups/{groupKey}",
- "httpMethod": "GET",
- "description": "Retrieve Group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ]
- },
- "insert": {
- "id": "directory.groups.insert",
- "path": "groups",
- "httpMethod": "POST",
- "description": "Create Group",
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "list": {
- "id": "directory.groups.list",
- "path": "groups",
- "httpMethod": "GET",
- "description": "Retrieve all groups in a domain (paginated)",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "domain": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 200",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "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",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Groups"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ]
- },
- "patch": {
- "id": "directory.groups.patch",
- "path": "groups/{groupKey}",
- "httpMethod": "PATCH",
- "description": "Update Group. This method supports patch semantics.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group. If ID, it should match with id of group object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "update": {
- "id": "directory.groups.update",
- "path": "groups/{groupKey}",
- "httpMethod": "PUT",
- "description": "Update Group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group. If ID, it should match with id of group object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- }
- },
- "resources": {
- "aliases": {
- "methods": {
- "delete": {
- "id": "directory.groups.aliases.delete",
- "path": "groups/{groupKey}/aliases/{alias}",
- "httpMethod": "DELETE",
- "description": "Remove a alias for the group",
- "parameters": {
- "alias": {
- "type": "string",
- "description": "The alias to be removed",
- "required": true,
- "location": "path"
- },
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "alias"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "insert": {
- "id": "directory.groups.aliases.insert",
- "path": "groups/{groupKey}/aliases",
- "httpMethod": "POST",
- "description": "Add a alias for the group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "request": {
- "$ref": "Alias"
- },
- "response": {
- "$ref": "Alias"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "list": {
- "id": "directory.groups.aliases.list",
- "path": "groups/{groupKey}/aliases",
- "httpMethod": "GET",
- "description": "List all aliases for a group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "response": {
- "$ref": "Aliases"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ],
- "supportsSubscription": true
- }
- }
- }
- }
- },
- "members": {
- "methods": {
- "delete": {
- "id": "directory.members.delete",
- "path": "groups/{groupKey}/members/{memberKey}",
- "httpMethod": "DELETE",
- "description": "Remove membership.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group",
- "required": true,
- "location": "path"
- },
- "memberKey": {
- "type": "string",
- "description": "Email or immutable ID of the member",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "memberKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member"
- ]
- },
- "get": {
- "id": "directory.members.get",
- "path": "groups/{groupKey}/members/{memberKey}",
- "httpMethod": "GET",
- "description": "Retrieve Group Member",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group",
- "required": true,
- "location": "path"
- },
- "memberKey": {
- "type": "string",
- "description": "Email or immutable ID of the member",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "memberKey"
- ],
- "response": {
- "$ref": "Member"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member",
- "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ]
- },
- "hasMember": {
- "id": "directory.members.hasMember",
- "path": "groups/{groupKey}/hasMember/{memberKey}",
- "httpMethod": "GET",
- "description": "Checks Membership of an user within a Group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- },
- "memberKey": {
- "type": "string",
- "description": "Email or immutable Id of the member",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "memberKey"
- ],
- "response": {
- "$ref": "MembersHasMember"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member",
- "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ]
- },
- "insert": {
- "id": "directory.members.insert",
- "path": "groups/{groupKey}/members",
- "httpMethod": "POST",
- "description": "Add user to the specified group.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "request": {
- "$ref": "Member"
- },
- "response": {
- "$ref": "Member"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member"
- ]
- },
- "list": {
- "id": "directory.members.list",
- "path": "groups/{groupKey}/members",
- "httpMethod": "GET",
- "description": "Retrieve all members in a group (paginated)",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 200",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "roles": {
- "type": "string",
- "description": "Comma separated role values to filter list results on.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "response": {
- "$ref": "Members"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member",
- "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ]
- },
- "patch": {
- "id": "directory.members.patch",
- "path": "groups/{groupKey}/members/{memberKey}",
- "httpMethod": "PATCH",
- "description": "Update membership of a user in the specified group. This method supports patch semantics.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group. If ID, it should match with id of group object",
- "required": true,
- "location": "path"
- },
- "memberKey": {
- "type": "string",
- "description": "Email or immutable ID of the user. If ID, it should match with id of member object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "memberKey"
- ],
- "request": {
- "$ref": "Member"
- },
- "response": {
- "$ref": "Member"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member"
- ]
- },
- "update": {
- "id": "directory.members.update",
- "path": "groups/{groupKey}/members/{memberKey}",
- "httpMethod": "PUT",
- "description": "Update membership of a user in the specified group.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable ID of the group. If ID, it should match with id of group object",
- "required": true,
- "location": "path"
- },
- "memberKey": {
- "type": "string",
- "description": "Email or immutable ID of the user. If ID, it should match with id of member object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "memberKey"
- ],
- "request": {
- "$ref": "Member"
- },
- "response": {
- "$ref": "Member"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member"
- ]
- }
- }
- },
- "mobiledevices": {
- "methods": {
- "action": {
- "id": "directory.mobiledevices.action",
- "path": "customer/{customerId}/devices/mobile/{resourceId}/action",
- "httpMethod": "POST",
- "description": "Take action on Mobile Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "resourceId": {
- "type": "string",
- "description": "Immutable ID of Mobile Device",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "resourceId"
- ],
- "request": {
- "$ref": "MobileDeviceAction"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.mobile",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.action"
- ]
- },
- "delete": {
- "id": "directory.mobiledevices.delete",
- "path": "customer/{customerId}/devices/mobile/{resourceId}",
- "httpMethod": "DELETE",
- "description": "Delete Mobile Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "resourceId": {
- "type": "string",
- "description": "Immutable ID of Mobile Device",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "resourceId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.mobile"
- ]
- },
- "get": {
- "id": "directory.mobiledevices.get",
- "path": "customer/{customerId}/devices/mobile/{resourceId}",
- "httpMethod": "GET",
- "description": "Retrieve Mobile Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
- "Includes all metadata fields"
- ],
- "location": "query"
- },
- "resourceId": {
- "type": "string",
- "description": "Immutable ID of Mobile Device",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "resourceId"
- ],
- "response": {
- "$ref": "MobileDevice"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.mobile",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
- ]
- },
- "list": {
- "id": "directory.mobiledevices.list",
- "path": "customer/{customerId}/devices/mobile",
- "httpMethod": "GET",
- "description": "Retrieve all Mobile Devices of a customer (paginated)",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Column to use for sorting results",
- "enum": [
- "deviceId",
- "email",
- "lastSync",
- "model",
- "name",
- "os",
- "status",
- "type"
- ],
- "enumDescriptions": [
- "Mobile Device serial number.",
- "Owner user email.",
- "Last policy settings sync date time of the device.",
- "Mobile Device model.",
- "Owner user name.",
- "Mobile operating system.",
- "Status of the device.",
- "Type of the device."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
- "Includes all metadata fields"
- ],
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "Search string in the format given at http://support.google.com/a/bin/answer.py?hl=en&answer=1408863#search",
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "response": {
- "$ref": "MobileDevices"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.mobile",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
- ]
- }
- }
- },
- "notifications": {
- "methods": {
- "delete": {
- "id": "directory.notifications.delete",
- "path": "customer/{customer}/notifications/{notificationId}",
- "httpMethod": "DELETE",
- "description": "Deletes a notification",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource.",
- "required": true,
- "location": "path"
- },
- "notificationId": {
- "type": "string",
- "description": "The unique ID of the notification.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "notificationId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- },
- "get": {
- "id": "directory.notifications.get",
- "path": "customer/{customer}/notifications/{notificationId}",
- "httpMethod": "GET",
- "description": "Retrieves a notification.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource.",
- "required": true,
- "location": "path"
- },
- "notificationId": {
- "type": "string",
- "description": "The unique ID of the notification.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "notificationId"
- ],
- "response": {
- "$ref": "Notification"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- },
- "list": {
- "id": "directory.notifications.list",
- "path": "customer/{customer}/notifications",
- "httpMethod": "GET",
- "description": "Retrieves a list of notifications.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's G Suite account.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The ISO 639-1 code of the language notifications are returned in. The default is English (en).",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of notifications to return per page. The default is 100.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The token to specify the page of results to retrieve.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Notifications"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- },
- "patch": {
- "id": "directory.notifications.patch",
- "path": "customer/{customer}/notifications/{notificationId}",
- "httpMethod": "PATCH",
- "description": "Updates a notification. This method supports patch semantics.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's G Suite account.",
- "required": true,
- "location": "path"
- },
- "notificationId": {
- "type": "string",
- "description": "The unique ID of the notification.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "notificationId"
- ],
- "request": {
- "$ref": "Notification"
- },
- "response": {
- "$ref": "Notification"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- },
- "update": {
- "id": "directory.notifications.update",
- "path": "customer/{customer}/notifications/{notificationId}",
- "httpMethod": "PUT",
- "description": "Updates a notification.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's G Suite account.",
- "required": true,
- "location": "path"
- },
- "notificationId": {
- "type": "string",
- "description": "The unique ID of the notification.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "notificationId"
- ],
- "request": {
- "$ref": "Notification"
- },
- "response": {
- "$ref": "Notification"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- }
- }
- },
- "orgunits": {
- "methods": {
- "delete": {
- "id": "directory.orgunits.delete",
- "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- "httpMethod": "DELETE",
- "description": "Remove organizational unit",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the organizational unit or its ID",
- "required": true,
- "repeated": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "orgUnitPath"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit"
- ]
- },
- "get": {
- "id": "directory.orgunits.get",
- "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- "httpMethod": "GET",
- "description": "Retrieve organizational unit",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the organizational unit or its ID",
- "required": true,
- "repeated": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "orgUnitPath"
- ],
- "response": {
- "$ref": "OrgUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit",
- "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
- ]
- },
- "insert": {
- "id": "directory.orgunits.insert",
- "path": "customer/{customerId}/orgunits",
- "httpMethod": "POST",
- "description": "Add organizational unit",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "request": {
- "$ref": "OrgUnit"
- },
- "response": {
- "$ref": "OrgUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit"
- ]
- },
- "list": {
- "id": "directory.orgunits.list",
- "path": "customer/{customerId}/orgunits",
- "httpMethod": "GET",
- "description": "Retrieve all organizational units",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "the URL-encoded organizational unit's path or its ID",
- "default": "",
- "location": "query"
- },
- "type": {
- "type": "string",
- "description": "Whether to return all sub-organizations or just immediate children",
- "enum": [
- "all",
- "children"
- ],
- "enumDescriptions": [
- "All sub-organizational units.",
- "Immediate children only (default)."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "response": {
- "$ref": "OrgUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit",
- "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
- ]
- },
- "patch": {
- "id": "directory.orgunits.patch",
- "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- "httpMethod": "PATCH",
- "description": "Update organizational unit. This method supports patch semantics.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the organizational unit or its ID",
- "required": true,
- "repeated": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "orgUnitPath"
- ],
- "request": {
- "$ref": "OrgUnit"
- },
- "response": {
- "$ref": "OrgUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit"
- ]
- },
- "update": {
- "id": "directory.orgunits.update",
- "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- "httpMethod": "PUT",
- "description": "Update organizational unit",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the organizational unit or its ID",
- "required": true,
- "repeated": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "orgUnitPath"
- ],
- "request": {
- "$ref": "OrgUnit"
- },
- "response": {
- "$ref": "OrgUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit"
- ]
- }
- }
- },
- "privileges": {
- "methods": {
- "list": {
- "id": "directory.privileges.list",
- "path": "customer/{customer}/roles/ALL/privileges",
- "httpMethod": "GET",
- "description": "Retrieves a paginated list of all privileges for a customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Privileges"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- }
- }
- },
- "resolvedAppAccessSettings": {
- "methods": {
- "GetSettings": {
- "id": "directory.resolvedAppAccessSettings.GetSettings",
- "path": "resolvedappaccesssettings",
- "httpMethod": "GET",
- "description": "Retrieves resolved app access settings of the logged in user.",
- "response": {
- "$ref": "AppAccessCollections"
- }
- },
- "ListTrustedApps": {
- "id": "directory.resolvedAppAccessSettings.ListTrustedApps",
- "path": "trustedapps",
- "httpMethod": "GET",
- "description": "Retrieves the list of apps trusted by the admin of the logged in user.",
- "response": {
- "$ref": "TrustedApps"
- }
- }
- }
- },
- "resources": {
- "resources": {
- "buildings": {
- "methods": {
- "delete": {
- "id": "directory.resources.buildings.delete",
- "path": "customer/{customer}/resources/buildings/{buildingId}",
- "httpMethod": "DELETE",
- "description": "Deletes a building.",
- "parameters": {
- "buildingId": {
- "type": "string",
- "description": "The ID of the building to delete.",
- "required": true,
- "location": "path"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "buildingId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "get": {
- "id": "directory.resources.buildings.get",
- "path": "customer/{customer}/resources/buildings/{buildingId}",
- "httpMethod": "GET",
- "description": "Retrieves a building.",
- "parameters": {
- "buildingId": {
- "type": "string",
- "description": "The unique ID of the building to retrieve.",
- "required": true,
- "location": "path"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "buildingId"
- ],
- "response": {
- "$ref": "Building"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar",
- "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
- ]
- },
- "insert": {
- "id": "directory.resources.buildings.insert",
- "path": "customer/{customer}/resources/buildings",
- "httpMethod": "POST",
- "description": "Inserts a building.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "Building"
- },
- "response": {
- "$ref": "Building"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "list": {
- "id": "directory.resources.buildings.list",
- "path": "customer/{customer}/resources/buildings",
- "httpMethod": "GET",
- "description": "Retrieves a list of buildings for an account.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Buildings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar",
- "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
- ]
- },
- "patch": {
- "id": "directory.resources.buildings.patch",
- "path": "customer/{customer}/resources/buildings/{buildingId}",
- "httpMethod": "PATCH",
- "description": "Updates a building. This method supports patch semantics.",
- "parameters": {
- "buildingId": {
- "type": "string",
- "description": "The ID of the building to update.",
- "required": true,
- "location": "path"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "buildingId"
- ],
- "request": {
- "$ref": "Building"
- },
- "response": {
- "$ref": "Building"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "update": {
- "id": "directory.resources.buildings.update",
- "path": "customer/{customer}/resources/buildings/{buildingId}",
- "httpMethod": "PUT",
- "description": "Updates a building.",
- "parameters": {
- "buildingId": {
- "type": "string",
- "description": "The ID of the building to update.",
- "required": true,
- "location": "path"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "buildingId"
- ],
- "request": {
- "$ref": "Building"
- },
- "response": {
- "$ref": "Building"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- }
- }
- },
- "calendars": {
- "methods": {
- "delete": {
- "id": "directory.resources.calendars.delete",
- "path": "customer/{customer}/resources/calendars/{calendarResourceId}",
- "httpMethod": "DELETE",
- "description": "Deletes a calendar resource.",
- "parameters": {
- "calendarResourceId": {
- "type": "string",
- "description": "The unique ID of the calendar resource to delete.",
- "required": true,
- "location": "path"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "calendarResourceId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "get": {
- "id": "directory.resources.calendars.get",
- "path": "customer/{customer}/resources/calendars/{calendarResourceId}",
- "httpMethod": "GET",
- "description": "Retrieves a calendar resource.",
- "parameters": {
- "calendarResourceId": {
- "type": "string",
- "description": "The unique ID of the calendar resource to retrieve.",
- "required": true,
- "location": "path"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "calendarResourceId"
- ],
- "response": {
- "$ref": "CalendarResource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar",
- "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
- ]
- },
- "insert": {
- "id": "directory.resources.calendars.insert",
- "path": "customer/{customer}/resources/calendars",
- "httpMethod": "POST",
- "description": "Inserts a calendar resource.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "CalendarResource"
- },
- "response": {
- "$ref": "CalendarResource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "list": {
- "id": "directory.resources.calendars.list",
- "path": "customer/{customer}/resources/calendars",
- "httpMethod": "GET",
- "description": "Retrieves a list of calendar resources for an account.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "1",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify the next page in the list.",
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "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 where applicable. For prefix match, the value should always be followed by a *.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "CalendarResources"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar",
- "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
- ]
- },
- "patch": {
- "id": "directory.resources.calendars.patch",
- "path": "customer/{customer}/resources/calendars/{calendarResourceId}",
- "httpMethod": "PATCH",
- "description": "Updates a calendar resource.\n\nThis 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.",
- "parameters": {
- "calendarResourceId": {
- "type": "string",
- "description": "The unique ID of the calendar resource to update.",
- "required": true,
- "location": "path"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "calendarResourceId"
- ],
- "request": {
- "$ref": "CalendarResource"
- },
- "response": {
- "$ref": "CalendarResource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "update": {
- "id": "directory.resources.calendars.update",
- "path": "customer/{customer}/resources/calendars/{calendarResourceId}",
- "httpMethod": "PUT",
- "description": "Updates a calendar resource.\n\nThis 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.",
- "parameters": {
- "calendarResourceId": {
- "type": "string",
- "description": "The unique ID of the calendar resource to update.",
- "required": true,
- "location": "path"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "calendarResourceId"
- ],
- "request": {
- "$ref": "CalendarResource"
- },
- "response": {
- "$ref": "CalendarResource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- }
- }
- },
- "features": {
- "methods": {
- "delete": {
- "id": "directory.resources.features.delete",
- "path": "customer/{customer}/resources/features/{featureKey}",
- "httpMethod": "DELETE",
- "description": "Deletes a feature.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "featureKey": {
- "type": "string",
- "description": "The unique ID of the feature to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "featureKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "get": {
- "id": "directory.resources.features.get",
- "path": "customer/{customer}/resources/features/{featureKey}",
- "httpMethod": "GET",
- "description": "Retrieves a feature.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "featureKey": {
- "type": "string",
- "description": "The unique ID of the feature to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "featureKey"
- ],
- "response": {
- "$ref": "Feature"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar",
- "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
- ]
- },
- "insert": {
- "id": "directory.resources.features.insert",
- "path": "customer/{customer}/resources/features",
- "httpMethod": "POST",
- "description": "Inserts a feature.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "Feature"
- },
- "response": {
- "$ref": "Feature"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "list": {
- "id": "directory.resources.features.list",
- "path": "customer/{customer}/resources/features",
- "httpMethod": "GET",
- "description": "Retrieves a list of features for an account.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify the next page in the list.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Features"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar",
- "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"
- ]
- },
- "patch": {
- "id": "directory.resources.features.patch",
- "path": "customer/{customer}/resources/features/{featureKey}",
- "httpMethod": "PATCH",
- "description": "Updates a feature. This method supports patch semantics.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "featureKey": {
- "type": "string",
- "description": "The unique ID of the feature to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "featureKey"
- ],
- "request": {
- "$ref": "Feature"
- },
- "response": {
- "$ref": "Feature"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "rename": {
- "id": "directory.resources.features.rename",
- "path": "customer/{customer}/resources/features/{oldName}/rename",
- "httpMethod": "POST",
- "description": "Renames a feature.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "oldName": {
- "type": "string",
- "description": "The unique ID of the feature to rename.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "oldName"
- ],
- "request": {
- "$ref": "FeatureRename"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- },
- "update": {
- "id": "directory.resources.features.update",
- "path": "customer/{customer}/resources/features/{featureKey}",
- "httpMethod": "PUT",
- "description": "Updates a feature.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "featureKey": {
- "type": "string",
- "description": "The unique ID of the feature to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "featureKey"
- ],
- "request": {
- "$ref": "Feature"
- },
- "response": {
- "$ref": "Feature"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.resource.calendar"
- ]
- }
- }
- }
- }
- },
- "roleAssignments": {
- "methods": {
- "delete": {
- "id": "directory.roleAssignments.delete",
- "path": "customer/{customer}/roleassignments/{roleAssignmentId}",
- "httpMethod": "DELETE",
- "description": "Deletes a role assignment.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "roleAssignmentId": {
- "type": "string",
- "description": "Immutable ID of the role assignment.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleAssignmentId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "get": {
- "id": "directory.roleAssignments.get",
- "path": "customer/{customer}/roleassignments/{roleAssignmentId}",
- "httpMethod": "GET",
- "description": "Retrieve a role assignment.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "roleAssignmentId": {
- "type": "string",
- "description": "Immutable ID of the role assignment.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleAssignmentId"
- ],
- "response": {
- "$ref": "RoleAssignment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- },
- "insert": {
- "id": "directory.roleAssignments.insert",
- "path": "customer/{customer}/roleassignments",
- "httpMethod": "POST",
- "description": "Creates a role assignment.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "RoleAssignment"
- },
- "response": {
- "$ref": "RoleAssignment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "list": {
- "id": "directory.roleAssignments.list",
- "path": "customer/{customer}/roleassignments",
- "httpMethod": "GET",
- "description": "Retrieves a paginated list of all roleAssignments.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "1",
- "maximum": "200",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify the next page in the list.",
- "location": "query"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "RoleAssignments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- }
- }
- },
- "roles": {
- "methods": {
- "delete": {
- "id": "directory.roles.delete",
- "path": "customer/{customer}/roles/{roleId}",
- "httpMethod": "DELETE",
- "description": "Deletes a role.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of the role.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "get": {
- "id": "directory.roles.get",
- "path": "customer/{customer}/roles/{roleId}",
- "httpMethod": "GET",
- "description": "Retrieves a role.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of the role.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleId"
- ],
- "response": {
- "$ref": "Role"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- },
- "insert": {
- "id": "directory.roles.insert",
- "path": "customer/{customer}/roles",
- "httpMethod": "POST",
- "description": "Creates a role.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "Role"
- },
- "response": {
- "$ref": "Role"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "list": {
- "id": "directory.roles.list",
- "path": "customer/{customer}/roles",
- "httpMethod": "GET",
- "description": "Retrieves a paginated list of all the roles in a domain.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "1",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify the next page in the list.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Roles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- },
- "patch": {
- "id": "directory.roles.patch",
- "path": "customer/{customer}/roles/{roleId}",
- "httpMethod": "PATCH",
- "description": "Updates a role. This method supports patch semantics.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of the role.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleId"
- ],
- "request": {
- "$ref": "Role"
- },
- "response": {
- "$ref": "Role"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "update": {
- "id": "directory.roles.update",
- "path": "customer/{customer}/roles/{roleId}",
- "httpMethod": "PUT",
- "description": "Updates a role.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the G Suite account.",
- "required": true,
- "location": "path"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of the role.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleId"
- ],
- "request": {
- "$ref": "Role"
- },
- "response": {
- "$ref": "Role"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- }
- }
},
+ "revision": "20180316",
+ "rootUrl": "https://www.googleapis.com/",
"schemas": {
- "methods": {
- "delete": {
- "id": "directory.schemas.delete",
- "path": "customer/{customerId}/schemas/{schemaKey}",
- "httpMethod": "DELETE",
- "description": "Delete schema",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "schemaKey": {
- "type": "string",
- "description": "Name or immutable ID of the schema",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "schemaKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema"
- ]
- },
- "get": {
- "id": "directory.schemas.get",
- "path": "customer/{customerId}/schemas/{schemaKey}",
- "httpMethod": "GET",
- "description": "Retrieve schema",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "schemaKey": {
- "type": "string",
- "description": "Name or immutable ID of the schema",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "schemaKey"
- ],
- "response": {
- "$ref": "Schema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema",
- "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
- ]
- },
- "insert": {
- "id": "directory.schemas.insert",
- "path": "customer/{customerId}/schemas",
- "httpMethod": "POST",
- "description": "Create schema.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "request": {
- "$ref": "Schema"
- },
- "response": {
- "$ref": "Schema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema"
- ]
- },
- "list": {
- "id": "directory.schemas.list",
- "path": "customer/{customerId}/schemas",
- "httpMethod": "GET",
- "description": "Retrieve all schemas for a customer",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "response": {
- "$ref": "Schemas"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema",
- "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
- ]
- },
- "patch": {
- "id": "directory.schemas.patch",
- "path": "customer/{customerId}/schemas/{schemaKey}",
- "httpMethod": "PATCH",
- "description": "Update schema. This method supports patch semantics.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "schemaKey": {
- "type": "string",
- "description": "Name or immutable ID of the schema.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "schemaKey"
- ],
- "request": {
- "$ref": "Schema"
- },
- "response": {
- "$ref": "Schema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema"
- ]
- },
- "update": {
- "id": "directory.schemas.update",
- "path": "customer/{customerId}/schemas/{schemaKey}",
- "httpMethod": "PUT",
- "description": "Update schema",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the G Suite account",
- "required": true,
- "location": "path"
- },
- "schemaKey": {
- "type": "string",
- "description": "Name or immutable ID of the schema.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "schemaKey"
- ],
- "request": {
- "$ref": "Schema"
- },
- "response": {
- "$ref": "Schema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema"
- ]
- }
- }
- },
- "tokens": {
- "methods": {
- "delete": {
- "id": "directory.tokens.delete",
- "path": "users/{userKey}/tokens/{clientId}",
- "httpMethod": "DELETE",
- "description": "Delete all access tokens issued by a user for an application.",
- "parameters": {
- "clientId": {
- "type": "string",
- "description": "The Client ID of the application the token is issued to.",
- "required": true,
- "location": "path"
- },
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "clientId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "get": {
- "id": "directory.tokens.get",
- "path": "users/{userKey}/tokens/{clientId}",
- "httpMethod": "GET",
- "description": "Get information about an access token issued by a user.",
- "parameters": {
- "clientId": {
- "type": "string",
- "description": "The Client ID of the application the token is issued to.",
- "required": true,
- "location": "path"
- },
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "clientId"
- ],
- "response": {
- "$ref": "Token"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "list": {
- "id": "directory.tokens.list",
- "path": "users/{userKey}/tokens",
- "httpMethod": "GET",
- "description": "Returns the set of tokens specified user has issued to 3rd party applications.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "Tokens"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "delete": {
- "id": "directory.users.delete",
- "path": "users/{userKey}",
- "httpMethod": "DELETE",
- "description": "Delete user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "get": {
- "id": "directory.users.get",
- "path": "users/{userKey}",
- "httpMethod": "GET",
- "description": "retrieve user",
- "parameters": {
- "customFieldMask": {
- "type": "string",
- "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "What subset of fields to fetch for this user.",
- "default": "basic",
- "enum": [
- "basic",
- "custom",
- "full"
- ],
- "enumDescriptions": [
- "Do not include any custom fields for the user.",
- "Include custom fields from schemas mentioned in customFieldMask.",
- "Include all fields associated with this user."
- ],
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
- },
- "viewType": {
- "type": "string",
- "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
- "default": "admin_view",
- "enum": [
- "admin_view",
- "domain_public"
- ],
- "enumDescriptions": [
- "Fetches the ADMIN_VIEW of the user.",
- "Fetches the DOMAIN_PUBLIC view of the user."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ]
- },
- "insert": {
- "id": "directory.users.insert",
- "path": "users",
- "httpMethod": "POST",
- "description": "create user.",
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "list": {
- "id": "directory.users.list",
- "path": "users",
- "httpMethod": "GET",
- "description": "Retrieve either deleted users or all users in a domain (paginated)",
- "parameters": {
- "customFieldMask": {
- "type": "string",
- "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
- "location": "query"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "domain": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "event": {
- "type": "string",
- "description": "Event on which subscription is intended (if subscribing)",
- "enum": [
- "add",
- "delete",
- "makeAdmin",
- "undelete",
- "update"
- ],
- "enumDescriptions": [
- "User Created Event",
- "User Deleted Event",
- "User Admin Status Change Event",
- "User Undeleted Event",
- "User Updated Event"
- ],
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
- "format": "int32",
- "minimum": "1",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Column to use for sorting results",
- "enum": [
- "email",
- "familyName",
- "givenName"
- ],
- "enumDescriptions": [
- "Primary email of the user.",
- "User's family name.",
- "User's given name."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "What subset of fields to fetch for this user.",
- "default": "basic",
- "enum": [
- "basic",
- "custom",
- "full"
- ],
- "enumDescriptions": [
- "Do not include any custom fields for the user.",
- "Include custom fields from schemas mentioned in customFieldMask.",
- "Include all fields associated with this user."
- ],
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
- "location": "query"
- },
- "showDeleted": {
- "type": "string",
- "description": "If set to true retrieves the list of deleted users. Default is false",
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Whether to return results in ascending or descending order.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- },
- "viewType": {
- "type": "string",
- "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
- "default": "admin_view",
- "enum": [
- "admin_view",
- "domain_public"
- ],
- "enumDescriptions": [
- "Fetches the ADMIN_VIEW of the user.",
- "Fetches the DOMAIN_PUBLIC view of the user."
- ],
- "location": "query"
- }
- },
- "response": {
- "$ref": "Users"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ],
- "supportsSubscription": true
- },
- "makeAdmin": {
- "id": "directory.users.makeAdmin",
- "path": "users/{userKey}/makeAdmin",
- "httpMethod": "POST",
- "description": "change admin status of a user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user as admin",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "UserMakeAdmin"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "patch": {
- "id": "directory.users.patch",
- "path": "users/{userKey}",
- "httpMethod": "PATCH",
- "description": "update user. This method supports patch semantics.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user. If ID, it should match with id of user object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "undelete": {
- "id": "directory.users.undelete",
- "path": "users/{userKey}/undelete",
- "httpMethod": "POST",
- "description": "Undelete a deleted user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "The immutable id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "UserUndelete"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "update": {
- "id": "directory.users.update",
- "path": "users/{userKey}",
- "httpMethod": "PUT",
- "description": "update user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user. If ID, it should match with id of user object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "watch": {
- "id": "directory.users.watch",
- "path": "users/watch",
- "httpMethod": "POST",
- "description": "Watch for changes in users list",
- "parameters": {
- "customFieldMask": {
- "type": "string",
- "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
- "location": "query"
- },
- "customer": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "domain": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "event": {
- "type": "string",
- "description": "Event on which subscription is intended (if subscribing)",
- "enum": [
- "add",
- "delete",
- "makeAdmin",
- "undelete",
- "update"
- ],
- "enumDescriptions": [
- "User Created Event",
- "User Deleted Event",
- "User Admin Status Change Event",
- "User Undeleted Event",
- "User Updated Event"
- ],
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
- "format": "int32",
- "minimum": "1",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Column to use for sorting results",
- "enum": [
- "email",
- "familyName",
- "givenName"
- ],
- "enumDescriptions": [
- "Primary email of the user.",
- "User's family name.",
- "User's given name."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "What subset of fields to fetch for this user.",
- "default": "basic",
- "enum": [
- "basic",
- "custom",
- "full"
- ],
- "enumDescriptions": [
- "Do not include any custom fields for the user.",
- "Include custom fields from schemas mentioned in customFieldMask.",
- "Include all fields associated with this user."
- ],
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
- "location": "query"
- },
- "showDeleted": {
- "type": "string",
- "description": "If set to true retrieves the list of deleted users. Default is false",
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Whether to return results in ascending or descending order.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- },
- "viewType": {
- "type": "string",
- "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
- "default": "admin_view",
- "enum": [
- "admin_view",
- "domain_public"
- ],
- "enumDescriptions": [
- "Fetches the ADMIN_VIEW of the user.",
- "Fetches the DOMAIN_PUBLIC view of the user."
- ],
- "location": "query"
- }
- },
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ],
- "supportsSubscription": true
- }
- },
- "resources": {
- "aliases": {
- "methods": {
- "delete": {
- "id": "directory.users.aliases.delete",
- "path": "users/{userKey}/aliases/{alias}",
- "httpMethod": "DELETE",
- "description": "Remove a alias for the user",
- "parameters": {
+ "Alias": {
+ "description": "JSON template for Alias object in Directory API.",
+ "id": "Alias",
+ "properties": {
"alias": {
- "type": "string",
- "description": "The alias to be removed",
- "required": true,
- "location": "path"
+ "description": "A alias email",
+ "type": "string"
},
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "alias"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias"
- ]
- },
- "insert": {
- "id": "directory.users.aliases.insert",
- "path": "users/{userKey}/aliases",
- "httpMethod": "POST",
- "description": "Add a alias for the user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "Alias"
- },
- "response": {
- "$ref": "Alias"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias"
- ]
- },
- "list": {
- "id": "directory.users.aliases.list",
- "path": "users/{userKey}/aliases",
- "httpMethod": "GET",
- "description": "List all aliases for a user",
- "parameters": {
- "event": {
- "type": "string",
- "description": "Event on which subscription is intended (if subscribing)",
- "enum": [
- "add",
- "delete"
- ],
- "enumDescriptions": [
- "Alias Created Event",
- "Alias Deleted Event"
- ],
- "location": "query"
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
},
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "Aliases"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias",
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ],
- "supportsSubscription": true
- },
- "watch": {
- "id": "directory.users.aliases.watch",
- "path": "users/{userKey}/aliases/watch",
- "httpMethod": "POST",
- "description": "Watch for changes in user aliases list",
- "parameters": {
- "event": {
- "type": "string",
- "description": "Event on which subscription is intended (if subscribing)",
- "enum": [
- "add",
- "delete"
- ],
- "enumDescriptions": [
- "Alias Created Event",
- "Alias Deleted Event"
- ],
- "location": "query"
+ "id": {
+ "description": "Unique id of the group (Read-only) Unique id of the user (Read-only)",
+ "type": "string"
},
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
+ "kind": {
+ "default": "admin#directory#alias",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "primaryEmail": {
+ "description": "Group's primary email (Read-only) User's primary email (Read-only)",
+ "type": "string"
}
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias",
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ],
- "supportsSubscription": true
- }
- }
+ },
+ "type": "object"
},
- "photos": {
- "methods": {
- "delete": {
- "id": "directory.users.photos.delete",
- "path": "users/{userKey}/photos/thumbnail",
- "httpMethod": "DELETE",
- "description": "Remove photos for the user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
+ "Aliases": {
+ "description": "JSON response template to list aliases in Directory API.",
+ "id": "Aliases",
+ "properties": {
+ "aliases": {
+ "description": "List of alias objects.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#aliases",
+ "description": "Kind of resource this is.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "userKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
},
- "get": {
- "id": "directory.users.photos.get",
- "path": "users/{userKey}/photos/thumbnail",
- "httpMethod": "GET",
- "description": "Retrieve photo of a user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
+ "type": "object"
+ },
+ "AppAccessCollections": {
+ "description": "JSON template for App Access Collections Resource object in Directory API.",
+ "id": "AppAccessCollections",
+ "properties": {
+ "blockedApiAccessBuckets": {
+ "description": "List of blocked api access buckets.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "enforceSettingsForAndroidDrive": {
+ "description": "Boolean to indicate whether to enforce app access settings on Android Drive or not.",
+ "type": "boolean"
+ },
+ "errorMessage": {
+ "description": "Error message provided by the Admin that will be shown to the user when an app is blocked.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#appaccesscollection",
+ "description": "Identifies the resource as an app access collection. Value: admin#directory#appaccesscollection",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "Unique ID of app access collection. (Readonly)",
+ "format": "int64",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Resource name given by the customer while creating/updating. Should be unique under given customer.",
+ "type": "string"
+ },
+ "trustDomainOwnedApps": {
+ "description": "Boolean that indicates whether to trust domain owned apps.",
+ "type": "boolean"
}
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "UserPhoto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ]
},
- "patch": {
- "id": "directory.users.photos.patch",
- "path": "users/{userKey}/photos/thumbnail",
- "httpMethod": "PATCH",
- "description": "Add a photo for the user. This method supports patch semantics.",
- "parameters": {
+ "type": "object"
+ },
+ "Asp": {
+ "description": "The template that returns individual ASP (Access Code) data.",
+ "id": "Asp",
+ "properties": {
+ "codeId": {
+ "description": "The unique ID of the ASP.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "creationTime": {
+ "description": "The time when the ASP was created. Expressed in Unix time format.",
+ "format": "int64",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the ASP.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#asp",
+ "description": "The type of the API resource. This is always admin#directory#asp.",
+ "type": "string"
+ },
+ "lastTimeUsed": {
+ "description": "The time when the ASP was last used. Expressed in Unix time format.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the application that the user, represented by their userId, entered when the ASP was created.",
+ "type": "string"
+ },
"userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
+ "description": "The unique ID of the user who issued the ASP.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "UserPhoto"
- },
- "response": {
- "$ref": "UserPhoto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
},
- "update": {
- "id": "directory.users.photos.update",
- "path": "users/{userKey}/photos/thumbnail",
- "httpMethod": "PUT",
- "description": "Add a photo for the user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
+ "type": "object"
+ },
+ "Asps": {
+ "id": "Asps",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of ASP resources.",
+ "items": {
+ "$ref": "Asp"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#aspList",
+ "description": "The type of the API resource. This is always admin#directory#aspList.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "UserPhoto"
- },
- "response": {
- "$ref": "UserPhoto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- }
- }
+ },
+ "type": "object"
+ },
+ "Building": {
+ "description": "JSON template for Building object in Directory API.",
+ "id": "Building",
+ "properties": {
+ "buildingId": {
+ "description": "Unique identifier for the building. The maximum length is 100 characters.",
+ "type": "string"
+ },
+ "buildingName": {
+ "description": "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.",
+ "type": "string"
+ },
+ "coordinates": {
+ "$ref": "BuildingCoordinates",
+ "description": "The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees."
+ },
+ "description": {
+ "description": "A brief description of the building. For example, \"Chelsea Market\".",
+ "type": "string"
+ },
+ "etags": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "floorNames": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#resources#buildings#Building",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BuildingCoordinates": {
+ "description": "JSON template for coordinates of a building in Directory API.",
+ "id": "BuildingCoordinates",
+ "properties": {
+ "latitude": {
+ "description": "Latitude in decimal degrees.",
+ "format": "double",
+ "type": "number"
+ },
+ "longitude": {
+ "description": "Longitude in decimal degrees.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "Buildings": {
+ "description": "JSON template for Building List Response object in Directory API.",
+ "id": "Buildings",
+ "properties": {
+ "buildings": {
+ "description": "The Buildings in this page of results.",
+ "items": {
+ "$ref": "Building"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#resources#buildings#buildingsList",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CalendarResource": {
+ "description": "JSON template for Calendar Resource object in Directory API.",
+ "id": "CalendarResource",
+ "properties": {
+ "buildingId": {
+ "description": "Unique ID for the building a resource is located in.",
+ "type": "string"
+ },
+ "capacity": {
+ "description": "Capacity of a resource, number of seats in a room.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "etags": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "featureInstances": {
+ "type": "any"
+ },
+ "floorName": {
+ "description": "Name of the floor a resource is located on.",
+ "type": "string"
+ },
+ "floorSection": {
+ "description": "Name of the section within a floor a resource is located in.",
+ "type": "string"
+ },
+ "generatedResourceName": {
+ "description": "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)\".",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#resources#calendars#CalendarResource",
+ "description": "The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.",
+ "type": "string"
+ },
+ "resourceCategory": {
+ "description": "The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.",
+ "type": "string"
+ },
+ "resourceDescription": {
+ "description": "Description of the resource, visible only to admins.",
+ "type": "string"
+ },
+ "resourceEmail": {
+ "description": "The read-only email for the calendar resource. Generated as part of creating a new calendar resource.",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "The unique ID for the calendar resource.",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "The name of the calendar resource. For example, \"Training Room 1A\".",
+ "type": "string"
+ },
+ "resourceType": {
+ "description": "The type of the calendar resource, intended for non-room resources.",
+ "type": "string"
+ },
+ "userVisibleDescription": {
+ "description": "Description of the resource, visible to users and admins.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CalendarResources": {
+ "description": "JSON template for Calendar Resource List Response object in Directory API.",
+ "id": "CalendarResources",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The CalendarResources in this page of results.",
+ "items": {
+ "$ref": "CalendarResource"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#resources#calendars#calendarResourcesList",
+ "description": "Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Channel": {
+ "description": "An notification channel used to watch for resource changes.",
+ "id": "Channel",
+ "properties": {
+ "address": {
+ "description": "The address where notifications are delivered for this channel.",
+ "type": "string"
+ },
+ "expiration": {
+ "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "A UUID or similar unique string that identifies this channel.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "api#channel",
+ "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "description": "Declares a new parameter by name.",
+ "type": "string"
+ },
+ "description": "Additional parameters controlling delivery channel behavior. Optional.",
+ "type": "object"
+ },
+ "payload": {
+ "description": "A Boolean value to indicate whether payload is wanted. Optional.",
+ "type": "boolean"
+ },
+ "resourceId": {
+ "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "A version-specific identifier for the watched resource.",
+ "type": "string"
+ },
+ "token": {
+ "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of delivery mechanism used for this channel.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChromeOsDevice": {
+ "description": "JSON template for Chrome Os Device resource in Directory API.",
+ "id": "ChromeOsDevice",
+ "properties": {
+ "activeTimeRanges": {
+ "description": "List of active time ranges (Read-only)",
+ "items": {
+ "properties": {
+ "activeTime": {
+ "description": "Duration in milliseconds",
+ "format": "int32",
+ "type": "integer"
+ },
+ "date": {
+ "description": "Date of usage",
+ "format": "date",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "annotatedAssetId": {
+ "description": "AssetId specified during enrollment or through later annotation",
+ "type": "string"
+ },
+ "annotatedLocation": {
+ "description": "Address or location of the device as noted by the administrator",
+ "type": "string"
+ },
+ "annotatedUser": {
+ "description": "User of the device",
+ "type": "string"
+ },
+ "bootMode": {
+ "description": "Chromebook boot mode (Read-only)",
+ "type": "string"
+ },
+ "deviceFiles": {
+ "description": "List of device files to download (Read-only)",
+ "items": {
+ "properties": {
+ "createTime": {
+ "description": "Date and time the file was created",
+ "format": "date-time",
+ "type": "string"
+ },
+ "downloadUrl": {
+ "description": "File download URL",
+ "type": "string"
+ },
+ "name": {
+ "description": "File name",
+ "type": "string"
+ },
+ "type": {
+ "description": "File type",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "deviceId": {
+ "description": "Unique identifier of Chrome OS Device (Read-only)",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "ethernetMacAddress": {
+ "description": "Chromebook Mac Address on ethernet network interface (Read-only)",
+ "type": "string"
+ },
+ "firmwareVersion": {
+ "description": "Chromebook firmware version (Read-only)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#chromeosdevice",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "lastEnrollmentTime": {
+ "description": "Date and time the device was last enrolled (Read-only)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "lastSync": {
+ "description": "Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "macAddress": {
+ "description": "Chromebook Mac Address on wifi network interface (Read-only)",
+ "type": "string"
+ },
+ "meid": {
+ "description": "Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)",
+ "type": "string"
+ },
+ "model": {
+ "description": "Chromebook Model (Read-only)",
+ "type": "string"
+ },
+ "notes": {
+ "description": "Notes added by the administrator",
+ "type": "string"
+ },
+ "orderNumber": {
+ "description": "Chromebook order number (Read-only)",
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "description": "OrgUnit of the device",
+ "type": "string"
+ },
+ "osVersion": {
+ "description": "Chromebook Os Version (Read-only)",
+ "type": "string"
+ },
+ "platformVersion": {
+ "description": "Chromebook platform version (Read-only)",
+ "type": "string"
+ },
+ "recentUsers": {
+ "description": "List of recent device users, in descending order by last login time (Read-only)",
+ "items": {
+ "properties": {
+ "email": {
+ "description": "Email address of the user. Present only if the user type is managed",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "serialNumber": {
+ "description": "Chromebook serial number (Read-only)",
+ "type": "string"
+ },
+ "status": {
+ "description": "status of the device (Read-only)",
+ "type": "string"
+ },
+ "supportEndDate": {
+ "description": "Final date the device will be supported (Read-only)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "tpmVersionInfo": {
+ "description": "Trusted Platform Module (TPM) (Read-only)",
+ "properties": {
+ "family": {
+ "description": "TPM family.",
+ "type": "string"
+ },
+ "firmwareVersion": {
+ "description": "TPM firmware version.",
+ "type": "string"
+ },
+ "manufacturer": {
+ "description": "TPM manufacturer code.",
+ "type": "string"
+ },
+ "specLevel": {
+ "description": "TPM specification level.",
+ "type": "string"
+ },
+ "tpmModel": {
+ "description": "TPM model number.",
+ "type": "string"
+ },
+ "vendorSpecific": {
+ "description": "Vendor-specific information such as Vendor ID.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "willAutoRenew": {
+ "description": "Will Chromebook auto renew after support end date (Read-only)",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ChromeOsDeviceAction": {
+ "description": "JSON request template for firing actions on ChromeOs Device in Directory Devices API.",
+ "id": "ChromeOsDeviceAction",
+ "properties": {
+ "action": {
+ "annotations": {
+ "required": [
+ "directory.chromeosdevices.action"
+ ]
+ },
+ "description": "Action to be taken on the ChromeOs Device",
+ "type": "string"
+ },
+ "deprovisionReason": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChromeOsDevices": {
+ "description": "JSON response template for List Chrome OS Devices operation in Directory API.",
+ "id": "ChromeOsDevices",
+ "properties": {
+ "chromeosdevices": {
+ "description": "List of Chrome OS Device objects.",
+ "items": {
+ "$ref": "ChromeOsDevice"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#chromeosdevices",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token used to access next page of this result.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChromeOsMoveDevicesToOu": {
+ "description": "JSON request template for moving ChromeOs Device to given OU in Directory Devices API.",
+ "id": "ChromeOsMoveDevicesToOu",
+ "properties": {
+ "deviceIds": {
+ "annotations": {
+ "required": [
+ "directory.chromeosdevices.moveDevicesToOu"
+ ]
+ },
+ "description": "ChromeOs Devices to be moved to OU",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Customer": {
+ "description": "JSON template for Customer Resource object in Directory API.",
+ "id": "Customer",
+ "properties": {
+ "alternateEmail": {
+ "description": "The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain",
+ "type": "string"
+ },
+ "customerCreationTime": {
+ "description": "The customer's creation time (Readonly)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "customerDomain": {
+ "description": "The customer's primary domain name string. Do not include the www prefix when creating a new customer.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID for the customer's G Suite account. (Readonly)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#customer",
+ "description": "Identifies the resource as a customer. Value: admin#directory#customer",
+ "type": "string"
+ },
+ "language": {
+ "description": "The customer's ISO 639-2 language code. The default value is en-US",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "The customer's contact phone number in E.164 format.",
+ "type": "string"
+ },
+ "postalAddress": {
+ "$ref": "CustomerPostalAddress",
+ "description": "The customer's postal address information."
+ }
+ },
+ "type": "object"
+ },
+ "CustomerPostalAddress": {
+ "description": "JSON template for postal address of a customer.",
+ "id": "CustomerPostalAddress",
+ "properties": {
+ "addressLine1": {
+ "description": "A customer's physical address. The address can be composed of one to three lines.",
+ "type": "string"
+ },
+ "addressLine2": {
+ "description": "Address line 2 of the address.",
+ "type": "string"
+ },
+ "addressLine3": {
+ "description": "Address line 3 of the address.",
+ "type": "string"
+ },
+ "contactName": {
+ "description": "The customer contact's name.",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "This is a required property. For countryCode information see the ISO 3166 country code elements.",
+ "type": "string"
+ },
+ "locality": {
+ "description": "Name of the locality. An example of a locality value is the city of San Francisco.",
+ "type": "string"
+ },
+ "organizationName": {
+ "description": "The company or company division name.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "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.",
+ "type": "string"
+ },
+ "region": {
+ "description": "Name of the region. An example of a region value is NY for the state of New York.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DomainAlias": {
+ "description": "JSON template for Domain Alias object in Directory API.",
+ "id": "DomainAlias",
+ "properties": {
+ "creationTime": {
+ "description": "The creation time of the domain alias. (Read-only).",
+ "format": "int64",
+ "type": "string"
+ },
+ "domainAliasName": {
+ "description": "The domain alias name.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#domainAlias",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "parentDomainName": {
+ "annotations": {
+ "required": [
+ "directory.domains.insert"
+ ]
+ },
+ "description": "The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.",
+ "type": "string"
+ },
+ "verified": {
+ "description": "Indicates the verification state of a domain alias. (Read-only)",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DomainAliases": {
+ "description": "JSON response template to list domain aliases in Directory API.",
+ "id": "DomainAliases",
+ "properties": {
+ "domainAliases": {
+ "description": "List of domain alias objects.",
+ "items": {
+ "$ref": "DomainAlias"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#domainAliases",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Domains": {
+ "description": "JSON template for Domain object in Directory API.",
+ "id": "Domains",
+ "properties": {
+ "creationTime": {
+ "description": "Creation time of the domain. (Read-only).",
+ "format": "int64",
+ "type": "string"
+ },
+ "domainAliases": {
+ "description": "List of domain alias objects. (Read-only)",
+ "items": {
+ "$ref": "DomainAlias"
+ },
+ "type": "array"
+ },
+ "domainName": {
+ "annotations": {
+ "required": [
+ "directory.domains.insert"
+ ]
+ },
+ "description": "The domain name of the customer.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "isPrimary": {
+ "description": "Indicates if the domain is a primary domain (Read-only).",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "admin#directory#domain",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "verified": {
+ "description": "Indicates the verification state of a domain. (Read-only).",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Domains2": {
+ "description": "JSON response template to list Domains in Directory API.",
+ "id": "Domains2",
+ "properties": {
+ "domains": {
+ "description": "List of domain objects.",
+ "items": {
+ "$ref": "Domains"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#domains",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Feature": {
+ "description": "JSON template for Feature object in Directory API.",
+ "id": "Feature",
+ "properties": {
+ "etags": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#resources#features#Feature",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "directory.resources.features.insert"
+ ]
+ },
+ "description": "The name of the feature.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FeatureInstance": {
+ "description": "JSON template for a \"feature instance\".",
+ "id": "FeatureInstance",
+ "properties": {
+ "feature": {
+ "$ref": "Feature",
+ "description": "The feature that this is an instance of. A calendar resource may have multiple instances of a feature."
+ }
+ },
+ "type": "object"
+ },
+ "FeatureRename": {
+ "description": "JSON request template for renaming a feature.",
+ "id": "FeatureRename",
+ "properties": {
+ "newName": {
+ "annotations": {
+ "required": [
+ "directory.resources.features.rename"
+ ]
+ },
+ "description": "New name of the feature.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Features": {
+ "description": "JSON template for Feature List Response object in Directory API.",
+ "id": "Features",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "features": {
+ "description": "The Features in this page of results.",
+ "items": {
+ "$ref": "Feature"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#resources#features#featuresList",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Group": {
+ "description": "JSON template for Group resource in Directory API.",
+ "id": "Group",
+ "properties": {
+ "adminCreated": {
+ "description": "Is the group created by admin (Read-only) *",
+ "type": "boolean"
+ },
+ "aliases": {
+ "description": "List of aliases (Read-only)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "Description of the group",
+ "type": "string"
+ },
+ "directMembersCount": {
+ "description": "Group direct members count",
+ "format": "int64",
+ "type": "string"
+ },
+ "email": {
+ "annotations": {
+ "required": [
+ "directory.groups.insert"
+ ]
+ },
+ "description": "Email of Group",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of Group (Read-only)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#group",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Group name",
+ "type": "string"
+ },
+ "nonEditableAliases": {
+ "description": "List of non editable aliases (Read-only)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Groups": {
+ "description": "JSON response template for List Groups operation in Directory API.",
+ "id": "Groups",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "groups": {
+ "description": "List of group objects.",
+ "items": {
+ "$ref": "Group"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#groups",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token used to access next page of this result.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Member": {
+ "description": "JSON template for Member resource in Directory API.",
+ "id": "Member",
+ "properties": {
+ "email": {
+ "description": "Email of member (Read-only)",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#member",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "role": {
+ "description": "Role of member",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of member (Immutable)",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of member (Immutable)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Members": {
+ "description": "JSON response template for List Members operation in Directory API.",
+ "id": "Members",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#members",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "members": {
+ "description": "List of member objects.",
+ "items": {
+ "$ref": "Member"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token used to access next page of this result.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MembersHasMember": {
+ "description": "JSON template for Has Member response in Directory API.",
+ "id": "MembersHasMember",
+ "properties": {
+ "isMember": {
+ "description": "Identifies whether the given user is a member of the group. Membership can be direct or nested.",
+ "readOnly": true,
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "MobileDevice": {
+ "description": "JSON template for Mobile Device resource in Directory API.",
+ "id": "MobileDevice",
+ "properties": {
+ "adbStatus": {
+ "description": "Adb (USB debugging) enabled or disabled on device (Read-only)",
+ "type": "boolean"
+ },
+ "applications": {
+ "description": "List of applications installed on Mobile Device",
+ "items": {
+ "properties": {
+ "displayName": {
+ "description": "Display name of application",
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Package name of application",
+ "type": "string"
+ },
+ "permission": {
+ "description": "List of Permissions for application",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "versionCode": {
+ "description": "Version code of application",
+ "format": "int32",
+ "type": "integer"
+ },
+ "versionName": {
+ "description": "Version name of application",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "basebandVersion": {
+ "description": "Mobile Device Baseband version (Read-only)",
+ "type": "string"
+ },
+ "bootloaderVersion": {
+ "description": "Mobile Device Bootloader version (Read-only)",
+ "type": "string"
+ },
+ "brand": {
+ "description": "Mobile Device Brand (Read-only)",
+ "type": "string"
+ },
+ "buildNumber": {
+ "description": "Mobile Device Build number (Read-only)",
+ "type": "string"
+ },
+ "defaultLanguage": {
+ "description": "The default locale used on the Mobile Device (Read-only)",
+ "type": "string"
+ },
+ "developerOptionsStatus": {
+ "description": "Developer options enabled or disabled on device (Read-only)",
+ "type": "boolean"
+ },
+ "deviceCompromisedStatus": {
+ "description": "Mobile Device compromised status (Read-only)",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Mobile Device serial number (Read-only)",
+ "type": "string"
+ },
+ "devicePasswordStatus": {
+ "description": "DevicePasswordStatus (Read-only)",
+ "type": "string"
+ },
+ "email": {
+ "description": "List of owner user's email addresses (Read-only)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "encryptionStatus": {
+ "description": "Mobile Device Encryption Status (Read-only)",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "firstSync": {
+ "description": "Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "hardware": {
+ "description": "Mobile Device Hardware (Read-only)",
+ "type": "string"
+ },
+ "hardwareId": {
+ "description": "Mobile Device Hardware Id (Read-only)",
+ "type": "string"
+ },
+ "imei": {
+ "description": "Mobile Device IMEI number (Read-only)",
+ "type": "string"
+ },
+ "kernelVersion": {
+ "description": "Mobile Device Kernel version (Read-only)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#mobiledevice",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "lastSync": {
+ "description": "Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "managedAccountIsOnOwnerProfile": {
+ "description": "Boolean indicating if this account is on owner/primary profile or not (Read-only)",
+ "type": "boolean"
+ },
+ "manufacturer": {
+ "description": "Mobile Device manufacturer (Read-only)",
+ "type": "string"
+ },
+ "meid": {
+ "description": "Mobile Device MEID number (Read-only)",
+ "type": "string"
+ },
+ "model": {
+ "description": "Name of the model of the device",
+ "type": "string"
+ },
+ "name": {
+ "description": "List of owner user's names (Read-only)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "networkOperator": {
+ "description": "Mobile Device mobile or network operator (if available) (Read-only)",
+ "type": "string"
+ },
+ "os": {
+ "description": "Name of the mobile operating system",
+ "type": "string"
+ },
+ "otherAccountsInfo": {
+ "description": "List of accounts added on device (Read-only)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "privilege": {
+ "description": "DMAgentPermission (Read-only)",
+ "type": "string"
+ },
+ "releaseVersion": {
+ "description": "Mobile Device release version version (Read-only)",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "Unique identifier of Mobile Device (Read-only)",
+ "type": "string"
+ },
+ "securityPatchLevel": {
+ "description": "Mobile Device Security patch level (Read-only)",
+ "format": "int64",
+ "type": "string"
+ },
+ "serialNumber": {
+ "description": "Mobile Device SSN or Serial Number (Read-only)",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the device (Read-only)",
+ "type": "string"
+ },
+ "supportsWorkProfile": {
+ "description": "Work profile supported on device (Read-only)",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "The type of device (Read-only)",
+ "type": "string"
+ },
+ "unknownSourcesStatus": {
+ "description": "Unknown sources enabled or disabled on device (Read-only)",
+ "type": "boolean"
+ },
+ "userAgent": {
+ "description": "Mobile Device user agent",
+ "type": "string"
+ },
+ "wifiMacAddress": {
+ "description": "Mobile Device WiFi MAC address (Read-only)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileDeviceAction": {
+ "description": "JSON request template for firing commands on Mobile Device in Directory Devices API.",
+ "id": "MobileDeviceAction",
+ "properties": {
+ "action": {
+ "annotations": {
+ "required": [
+ "directory.mobiledevices.action"
+ ]
+ },
+ "description": "Action to be taken on the Mobile Device",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MobileDevices": {
+ "description": "JSON response template for List Mobile Devices operation in Directory API.",
+ "id": "MobileDevices",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#mobiledevices",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "mobiledevices": {
+ "description": "List of Mobile Device objects.",
+ "items": {
+ "$ref": "MobileDevice"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token used to access next page of this result.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Notification": {
+ "description": "Template for a notification resource.",
+ "id": "Notification",
+ "properties": {
+ "body": {
+ "description": "Body of the notification (Read-only)",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "fromAddress": {
+ "description": "Address from which the notification is received (Read-only)",
+ "type": "string"
+ },
+ "isUnread": {
+ "annotations": {
+ "required": [
+ "directory.notifications.patch",
+ "directory.notifications.update"
+ ]
+ },
+ "description": "Boolean indicating whether the notification is unread or not.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "admin#directory#notification",
+ "description": "The type of the resource.",
+ "type": "string"
+ },
+ "notificationId": {
+ "type": "string"
+ },
+ "sendTime": {
+ "description": "Time at which notification was sent (Read-only)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "subject": {
+ "description": "Subject of the notification (Read-only)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Notifications": {
+ "description": "Template for notifications list response.",
+ "id": "Notifications",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "List of notifications in this page.",
+ "items": {
+ "$ref": "Notification"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#notifications",
+ "description": "The type of the resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token for fetching the next page of notifications.",
+ "type": "string"
+ },
+ "unreadNotificationsCount": {
+ "description": "Number of unread notification for the domain.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OrgUnit": {
+ "description": "JSON template for Org Unit resource in Directory API.",
+ "id": "OrgUnit",
+ "properties": {
+ "blockInheritance": {
+ "description": "Should block inheritance",
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of OrgUnit",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#orgUnit",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "directory.orgunits.insert"
+ ]
+ },
+ "description": "Name of OrgUnit",
+ "type": "string"
+ },
+ "orgUnitId": {
+ "description": "Id of OrgUnit",
+ "type": "string"
+ },
+ "orgUnitPath": {
+ "description": "Path of OrgUnit",
+ "type": "string"
+ },
+ "parentOrgUnitId": {
+ "description": "Id of parent OrgUnit",
+ "type": "string"
+ },
+ "parentOrgUnitPath": {
+ "description": "Path of parent OrgUnit",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrgUnits": {
+ "description": "JSON response template for List Organization Units operation in Directory API.",
+ "id": "OrgUnits",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#orgUnits",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "organizationUnits": {
+ "description": "List of user objects.",
+ "items": {
+ "$ref": "OrgUnit"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Privilege": {
+ "description": "JSON template for privilege resource in Directory API.",
+ "id": "Privilege",
+ "properties": {
+ "childPrivileges": {
+ "description": "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.",
+ "items": {
+ "$ref": "Privilege"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "isOuScopable": {
+ "description": "If the privilege can be restricted to an organization unit.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "admin#directory#privilege",
+ "description": "The type of the API resource. This is always admin#directory#privilege.",
+ "type": "string"
+ },
+ "privilegeName": {
+ "description": "The name of the privilege.",
+ "type": "string"
+ },
+ "serviceId": {
+ "description": "The obfuscated ID of the service this privilege is for.",
+ "type": "string"
+ },
+ "serviceName": {
+ "description": "The name of the service this privilege is for.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Privileges": {
+ "description": "JSON response template for List privileges operation in Directory API.",
+ "id": "Privileges",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of Privilege resources.",
+ "items": {
+ "$ref": "Privilege"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#privileges",
+ "description": "The type of the API resource. This is always admin#directory#privileges.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Role": {
+ "description": "JSON template for role resource in Directory API.",
+ "id": "Role",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "isSuperAdminRole": {
+ "description": "Returns true if the role is a super admin role.",
+ "type": "boolean"
+ },
+ "isSystemRole": {
+ "description": "Returns true if this is a pre-defined system role.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "admin#directory#role",
+ "description": "The type of the API resource. This is always admin#directory#role.",
+ "type": "string"
+ },
+ "roleDescription": {
+ "description": "A short description of the role.",
+ "type": "string"
+ },
+ "roleId": {
+ "description": "ID of the role.",
+ "format": "int64",
+ "type": "string"
+ },
+ "roleName": {
+ "annotations": {
+ "required": [
+ "directory.roles.insert"
+ ]
+ },
+ "description": "Name of the role.",
+ "type": "string"
+ },
+ "rolePrivileges": {
+ "annotations": {
+ "required": [
+ "directory.roles.insert"
+ ]
+ },
+ "description": "The set of privileges that are granted to this role.",
+ "items": {
+ "properties": {
+ "privilegeName": {
+ "description": "The name of the privilege.",
+ "type": "string"
+ },
+ "serviceId": {
+ "description": "The obfuscated ID of the service this privilege is for.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RoleAssignment": {
+ "description": "JSON template for roleAssignment resource in Directory API.",
+ "id": "RoleAssignment",
+ "properties": {
+ "assignedTo": {
+ "description": "The unique ID of the user this role is assigned to.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#roleAssignment",
+ "description": "The type of the API resource. This is always admin#directory#roleAssignment.",
+ "type": "string"
+ },
+ "orgUnitId": {
+ "description": "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.",
+ "type": "string"
+ },
+ "roleAssignmentId": {
+ "description": "ID of this roleAssignment.",
+ "format": "int64",
+ "type": "string"
+ },
+ "roleId": {
+ "description": "The ID of the role that is assigned.",
+ "format": "int64",
+ "type": "string"
+ },
+ "scopeType": {
+ "description": "The scope in which this role is assigned. Possible values are: \n- CUSTOMER\n- ORG_UNIT",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RoleAssignments": {
+ "description": "JSON response template for List roleAssignments operation in Directory API.",
+ "id": "RoleAssignments",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of RoleAssignment resources.",
+ "items": {
+ "$ref": "RoleAssignment"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#roleAssignments",
+ "description": "The type of the API resource. This is always admin#directory#roleAssignments.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Roles": {
+ "description": "JSON response template for List roles operation in Directory API.",
+ "id": "Roles",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of Role resources.",
+ "items": {
+ "$ref": "Role"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#roles",
+ "description": "The type of the API resource. This is always admin#directory#roles.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Schema": {
+ "description": "JSON template for Schema resource in Directory API.",
+ "id": "Schema",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "fields": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert",
+ "directory.schemas.update"
+ ]
+ },
+ "description": "Fields of Schema",
+ "items": {
+ "$ref": "SchemaFieldSpec"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#schema",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "schemaId": {
+ "description": "Unique identifier of Schema (Read-only)",
+ "type": "string"
+ },
+ "schemaName": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert"
+ ]
+ },
+ "description": "Schema name",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SchemaFieldSpec": {
+ "description": "JSON template for FieldSpec resource for Schemas in Directory API.",
+ "id": "SchemaFieldSpec",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "fieldId": {
+ "description": "Unique identifier of Field (Read-only)",
+ "type": "string"
+ },
+ "fieldName": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert",
+ "directory.schemas.update"
+ ]
+ },
+ "description": "Name of the field.",
+ "type": "string"
+ },
+ "fieldType": {
+ "annotations": {
+ "required": [
+ "directory.schemas.insert",
+ "directory.schemas.update"
+ ]
+ },
+ "description": "Type of the field.",
+ "type": "string"
+ },
+ "indexed": {
+ "default": "true",
+ "description": "Boolean specifying whether the field is indexed or not.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "admin#directory#schema#fieldspec",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "multiValued": {
+ "description": "Boolean specifying whether this is a multi-valued field or not.",
+ "type": "boolean"
+ },
+ "numericIndexingSpec": {
+ "description": "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.",
+ "properties": {
+ "maxValue": {
+ "description": "Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
+ "format": "double",
+ "type": "number"
+ },
+ "minValue": {
+ "description": "Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "readAccessType": {
+ "default": "ALL_DOMAIN_USERS",
+ "description": "Read ACLs on the field specifying who can view values of this field. Valid values are \"ALL_DOMAIN_USERS\" and \"ADMINS_AND_SELF\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Schemas": {
+ "description": "JSON response template for List Schema operation in Directory API.",
+ "id": "Schemas",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#schemas",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "schemas": {
+ "description": "List of UserSchema objects.",
+ "items": {
+ "$ref": "Schema"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Token": {
+ "description": "JSON template for token resource in Directory API.",
+ "id": "Token",
+ "properties": {
+ "anonymous": {
+ "description": "Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.",
+ "type": "boolean"
+ },
+ "clientId": {
+ "description": "The Client ID of the application the token is issued to.",
+ "type": "string"
+ },
+ "displayText": {
+ "description": "The displayable name of the application the token is issued to.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#token",
+ "description": "The type of the API resource. This is always admin#directory#token.",
+ "type": "string"
+ },
+ "nativeApp": {
+ "description": "Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device.",
+ "type": "boolean"
+ },
+ "scopes": {
+ "description": "A list of authorization scopes the application is granted.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "userKey": {
+ "description": "The unique ID of the user that issued the token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Tokens": {
+ "description": "JSON response template for List tokens operation in Directory API.",
+ "id": "Tokens",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of Token resources.",
+ "items": {
+ "$ref": "Token"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#tokenList",
+ "description": "The type of the API resource. This is always admin#directory#tokenList.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TrustedAppId": {
+ "description": "JSON template for Trusted App Ids Resource object in Directory API.",
+ "id": "TrustedAppId",
+ "properties": {
+ "androidPackageName": {
+ "description": "Android package name.",
+ "type": "string"
+ },
+ "certificateHashSHA1": {
+ "description": "SHA1 signature of the app certificate.",
+ "type": "string"
+ },
+ "certificateHashSHA256": {
+ "description": "SHA256 signature of the app certificate.",
+ "type": "string"
+ },
+ "etag": {
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#trustedappid",
+ "description": "Identifies the resource as a trusted AppId.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TrustedApps": {
+ "description": "JSON template for Trusted Apps response object of a user in Directory API.",
+ "id": "TrustedApps",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#trustedapplist",
+ "description": "Identifies the resource as trusted apps response.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string"
+ },
+ "trustedApps": {
+ "description": "Trusted Apps list.",
+ "items": {
+ "$ref": "TrustedAppId"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "User": {
+ "description": "JSON template for User object in Directory API.",
+ "id": "User",
+ "properties": {
+ "addresses": {
+ "type": "any"
+ },
+ "agreedToTerms": {
+ "description": "Indicates if user has agreed to terms (Read-only)",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "aliases": {
+ "description": "List of aliases (Read-only)",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "changePasswordAtNextLogin": {
+ "description": "Boolean indicating if the user should change password in next login",
+ "type": "boolean"
+ },
+ "creationTime": {
+ "description": "User's G Suite account creation time. (Read-only)",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "customSchemas": {
+ "additionalProperties": {
+ "$ref": "UserCustomProperties"
+ },
+ "description": "Custom fields of the user.",
+ "type": "object"
+ },
+ "customerId": {
+ "description": "CustomerId of User (Read-only)",
+ "readOnly": true,
+ "type": "string"
+ },
+ "deletionTime": {
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "emails": {
+ "type": "any"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "externalIds": {
+ "type": "any"
+ },
+ "gender": {
+ "type": "any"
+ },
+ "hashFunction": {
+ "description": "Hash function name for password. Supported are MD5, SHA-1 and crypt",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of User (Read-only)",
+ "type": "string"
+ },
+ "ims": {
+ "type": "any"
+ },
+ "includeInGlobalAddressList": {
+ "description": "Boolean indicating if user is included in Global Address List",
+ "type": "boolean"
+ },
+ "ipWhitelisted": {
+ "description": "Boolean indicating if ip is whitelisted",
+ "type": "boolean"
+ },
+ "isAdmin": {
+ "description": "Boolean indicating if the user is admin (Read-only)",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "isDelegatedAdmin": {
+ "description": "Boolean indicating if the user is delegated admin (Read-only)",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "isEnforcedIn2Sv": {
+ "description": "Is 2-step verification enforced (Read-only)",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "isEnrolledIn2Sv": {
+ "description": "Is enrolled in 2-step verification (Read-only)",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "isMailboxSetup": {
+ "description": "Is mailbox setup (Read-only)",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "keywords": {
+ "type": "any"
+ },
+ "kind": {
+ "default": "admin#directory#user",
+ "description": "Kind of resource this is.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "languages": {
+ "type": "any"
+ },
+ "lastLoginTime": {
+ "description": "User's last login time. (Read-only)",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "locations": {
+ "type": "any"
+ },
+ "name": {
+ "$ref": "UserName",
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "User's name"
+ },
+ "nonEditableAliases": {
+ "description": "List of non editable aliases (Read-only)",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "notes": {
+ "type": "any"
+ },
+ "orgUnitPath": {
+ "description": "OrgUnit of User",
+ "type": "string"
+ },
+ "organizations": {
+ "type": "any"
+ },
+ "password": {
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "User's password",
+ "type": "string"
+ },
+ "phones": {
+ "type": "any"
+ },
+ "posixAccounts": {
+ "type": "any"
+ },
+ "primaryEmail": {
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "username of User",
+ "type": "string"
+ },
+ "relations": {
+ "type": "any"
+ },
+ "sshPublicKeys": {
+ "type": "any"
+ },
+ "suspended": {
+ "description": "Indicates if user is suspended",
+ "type": "boolean"
+ },
+ "suspensionReason": {
+ "description": "Suspension reason if user is suspended (Read-only)",
+ "readOnly": true,
+ "type": "string"
+ },
+ "thumbnailPhotoEtag": {
+ "description": "ETag of the user's photo (Read-only)",
+ "readOnly": true,
+ "type": "string"
+ },
+ "thumbnailPhotoUrl": {
+ "description": "Photo Url of the user (Read-only)",
+ "readOnly": true,
+ "type": "string"
+ },
+ "websites": {
+ "type": "any"
+ }
+ },
+ "type": "object"
+ },
+ "UserAbout": {
+ "description": "JSON template for About (notes) of a user in Directory API.",
+ "id": "UserAbout",
+ "properties": {
+ "contentType": {
+ "description": "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.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Actual value of notes.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserAddress": {
+ "description": "JSON template for address.",
+ "id": "UserAddress",
+ "properties": {
+ "country": {
+ "description": "Country.",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country code.",
+ "type": "string"
+ },
+ "customType": {
+ "description": "Custom type.",
+ "type": "string"
+ },
+ "extendedAddress": {
+ "description": "Extended Address.",
+ "type": "string"
+ },
+ "formatted": {
+ "description": "Formatted address.",
+ "type": "string"
+ },
+ "locality": {
+ "description": "Locality.",
+ "type": "string"
+ },
+ "poBox": {
+ "description": "Other parts of address.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Postal code.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If this is user's primary address. Only one entry could be marked as primary.",
+ "type": "boolean"
+ },
+ "region": {
+ "description": "Region.",
+ "type": "string"
+ },
+ "sourceIsStructured": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "streetAddress": {
+ "description": "Street.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ }
+ },
+ "type": "object"
+ },
+ "UserCustomProperties": {
+ "additionalProperties": {
+ "type": "any"
+ },
+ "description": "JSON template for a set of custom properties (i.e. all fields in a particular schema)",
+ "id": "UserCustomProperties",
+ "type": "object"
+ },
+ "UserEmail": {
+ "description": "JSON template for an email.",
+ "id": "UserEmail",
+ "properties": {
+ "address": {
+ "description": "Email id of the user.",
+ "type": "string"
+ },
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If this is user's primary email. Only one entry could be marked as primary.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "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"
+ }
+ },
+ "type": "object"
+ },
+ "UserExternalId": {
+ "description": "JSON template for an externalId entry.",
+ "id": "UserExternalId",
+ "properties": {
+ "customType": {
+ "description": "Custom type.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the Id.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the id.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserGender": {
+ "id": "UserGender",
+ "properties": {
+ "addressMeAs": {
+ "description": "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\".",
+ "type": "string"
+ },
+ "customGender": {
+ "description": "Custom gender.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Gender.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserIm": {
+ "description": "JSON template for instant messenger of an user.",
+ "id": "UserIm",
+ "properties": {
+ "customProtocol": {
+ "description": "Custom protocol.",
+ "type": "string"
+ },
+ "customType": {
+ "description": "Custom type.",
+ "type": "string"
+ },
+ "im": {
+ "description": "Instant messenger id.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If this is user's primary im. Only one entry could be marked as primary.",
+ "type": "boolean"
+ },
+ "protocol": {
+ "description": "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.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ }
+ },
+ "type": "object"
+ },
+ "UserKeyword": {
+ "description": "JSON template for a keyword entry.",
+ "id": "UserKeyword",
+ "properties": {
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ },
+ "value": {
+ "description": "Keyword.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserLanguage": {
+ "description": "JSON template for a language entry.",
+ "id": "UserLanguage",
+ "properties": {
+ "customLanguage": {
+ "description": "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",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserLocation": {
+ "description": "JSON template for a location entry.",
+ "id": "UserLocation",
+ "properties": {
+ "area": {
+ "description": "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\".",
+ "type": "string"
+ },
+ "buildingId": {
+ "description": "Building Identifier.",
+ "type": "string"
+ },
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
+ },
+ "deskCode": {
+ "description": "Most specific textual code of individual desk location.",
+ "type": "string"
+ },
+ "floorName": {
+ "description": "Floor name/number.",
+ "type": "string"
+ },
+ "floorSection": {
+ "description": "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.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ }
+ },
+ "type": "object"
+ },
+ "UserMakeAdmin": {
+ "description": "JSON request template for setting/revoking admin status of a user in Directory API.",
+ "id": "UserMakeAdmin",
+ "properties": {
+ "status": {
+ "annotations": {
+ "required": [
+ "directory.users.makeAdmin"
+ ]
+ },
+ "description": "Boolean indicating new admin status of the user",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "UserName": {
+ "description": "JSON template for name of a user in Directory API.",
+ "id": "UserName",
+ "properties": {
+ "familyName": {
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "Last Name",
+ "type": "string"
+ },
+ "fullName": {
+ "description": "Full Name",
+ "type": "string"
+ },
+ "givenName": {
+ "annotations": {
+ "required": [
+ "directory.users.insert"
+ ]
+ },
+ "description": "First Name",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserOrganization": {
+ "description": "JSON template for an organization entry.",
+ "id": "UserOrganization",
+ "properties": {
+ "costCenter": {
+ "description": "The cost center of the users department.",
+ "type": "string"
+ },
+ "customType": {
+ "description": "Custom type.",
+ "type": "string"
+ },
+ "department": {
+ "description": "Department within the organization.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the organization.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "The domain to which the organization belongs to.",
+ "type": "string"
+ },
+ "fullTimeEquivalent": {
+ "description": "The full-time equivalent percent within the organization (100000 = 100%).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "location": {
+ "description": "Location of the organization. This need not be fully qualified address.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the organization",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If it user's primary organization.",
+ "type": "boolean"
+ },
+ "symbol": {
+ "description": "Symbol of the organization.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title (designation) of the user in the organization.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ }
+ },
+ "type": "object"
+ },
+ "UserPhone": {
+ "description": "JSON template for a phone entry.",
+ "id": "UserPhone",
+ "properties": {
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If this is user's primary phone or not.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "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"
+ },
+ "value": {
+ "description": "Phone number.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserPhoto": {
+ "description": "JSON template for Photo object in Directory API.",
+ "id": "UserPhoto",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "height": {
+ "description": "Height in pixels of the photo",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Unique identifier of User (Read-only)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#user#photo",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "Mime Type of the photo",
+ "type": "string"
+ },
+ "photoData": {
+ "annotations": {
+ "required": [
+ "directory.users.photos.update"
+ ]
+ },
+ "description": "Base64 encoded photo data",
+ "format": "byte",
+ "type": "string"
+ },
+ "primaryEmail": {
+ "description": "Primary email of User (Read-only)",
+ "type": "string"
+ },
+ "width": {
+ "description": "Width in pixels of the photo",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "UserPosixAccount": {
+ "description": "JSON template for a POSIX account entry. Description of the field family: go/fbs-posix.",
+ "id": "UserPosixAccount",
+ "properties": {
+ "accountId": {
+ "description": "A POSIX account field identifier. (Read-only)",
+ "readOnly": true,
+ "type": "string"
+ },
+ "gecos": {
+ "description": "The GECOS (user information) for this account.",
+ "type": "string"
+ },
+ "gid": {
+ "description": "The default group ID.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "homeDirectory": {
+ "description": "The path to the home directory for this account.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If this is user's primary account within the SystemId.",
+ "type": "boolean"
+ },
+ "shell": {
+ "description": "The path to the login shell for this account.",
+ "type": "string"
+ },
+ "systemId": {
+ "description": "System identifier for which account Username or Uid apply to.",
+ "type": "string"
+ },
+ "uid": {
+ "description": "The POSIX compliant user ID.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "username": {
+ "description": "The username of the account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserRelation": {
+ "description": "JSON template for a relation entry.",
+ "id": "UserRelation",
+ "properties": {
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The relation of the user. Some of the possible values are mother, father, sister, brother, manager, assistant, partner.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The name of the relation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserSshPublicKey": {
+ "description": "JSON template for a POSIX account entry.",
+ "id": "UserSshPublicKey",
+ "properties": {
+ "expirationTimeUsec": {
+ "description": "An expiration time in microseconds since epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "A SHA-256 fingerprint of the SSH public key. (Read-only)",
+ "readOnly": true,
+ "type": "string"
+ },
+ "key": {
+ "description": "An SSH public key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserUndelete": {
+ "description": "JSON request template to undelete a user in Directory API.",
+ "id": "UserUndelete",
+ "properties": {
+ "orgUnitPath": {
+ "description": "OrgUnit of User",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserWebsite": {
+ "description": "JSON template for a website entry.",
+ "id": "UserWebsite",
+ "properties": {
+ "customType": {
+ "description": "Custom Type.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "If this is user's primary website or not.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "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"
+ },
+ "value": {
+ "description": "Website.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Users": {
+ "description": "JSON response template for List Users operation in Apps Directory API.",
+ "id": "Users",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#users",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token used to access next page of this result.",
+ "type": "string"
+ },
+ "trigger_event": {
+ "description": "Event that triggered this response (only used in case of Push Response)",
+ "type": "string"
+ },
+ "users": {
+ "description": "List of user objects.",
+ "items": {
+ "$ref": "User"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VerificationCode": {
+ "description": "JSON template for verification codes in Directory API.",
+ "id": "VerificationCode",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#directory#verificationCode",
+ "description": "The type of the resource. This is always admin#directory#verificationCode.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "The obfuscated unique ID of the user.",
+ "type": "string"
+ },
+ "verificationCode": {
+ "description": "A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "VerificationCodes": {
+ "description": "JSON response template for List verification codes operation in Directory API.",
+ "id": "VerificationCodes",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of verification code resources.",
+ "items": {
+ "$ref": "VerificationCode"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#directory#verificationCodesList",
+ "description": "The type of the resource. This is always admin#directory#verificationCodesList.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "verificationCodes": {
- "methods": {
- "generate": {
- "id": "directory.verificationCodes.generate",
- "path": "users/{userKey}/verificationCodes/generate",
- "httpMethod": "POST",
- "description": "Generate new backup verification codes for the user.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "invalidate": {
- "id": "directory.verificationCodes.invalidate",
- "path": "users/{userKey}/verificationCodes/invalidate",
- "httpMethod": "POST",
- "description": "Invalidate the current backup verification codes for the user.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable ID of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "list": {
- "id": "directory.verificationCodes.list",
- "path": "users/{userKey}/verificationCodes",
- "httpMethod": "GET",
- "description": "Returns the current set of valid backup verification codes for the specified user.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "VerificationCodes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "admin/directory/v1/",
+ "title": "Admin Directory API",
+ "version": "directory_v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/admin/directory/v1/admin-gen.go b/vendor/google.golang.org/api/admin/directory/v1/admin-gen.go
index 28fa2d189..90fcc2848 100644
--- a/vendor/google.golang.org/api/admin/directory/v1/admin-gen.go
+++ b/vendor/google.golang.org/api/admin/directory/v1/admin-gen.go
@@ -1132,6 +1132,7 @@ type ChromeOsDevice struct {
// SupportEndDate: Final date the device will be supported (Read-only)
SupportEndDate string `json:"supportEndDate,omitempty"`
+ // TpmVersionInfo: Trusted Platform Module (TPM) (Read-only)
TpmVersionInfo *ChromeOsDeviceTpmVersionInfo `json:"tpmVersionInfo,omitempty"`
// WillAutoRenew: Will Chromebook auto renew after support end date
@@ -1200,7 +1201,7 @@ type ChromeOsDeviceDeviceFiles struct {
// CreateTime: Date and time the file was created
CreateTime string `json:"createTime,omitempty"`
- // DownloadUrl: File downlod URL
+ // DownloadUrl: File download URL
DownloadUrl string `json:"downloadUrl,omitempty"`
// Name: File name
@@ -1263,17 +1264,25 @@ func (s *ChromeOsDeviceRecentUsers) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// ChromeOsDeviceTpmVersionInfo: Trusted Platform Module (TPM)
+// (Read-only)
type ChromeOsDeviceTpmVersionInfo struct {
+ // Family: TPM family.
Family string `json:"family,omitempty"`
+ // FirmwareVersion: TPM firmware version.
FirmwareVersion string `json:"firmwareVersion,omitempty"`
+ // Manufacturer: TPM manufacturer code.
Manufacturer string `json:"manufacturer,omitempty"`
+ // SpecLevel: TPM specification level.
SpecLevel string `json:"specLevel,omitempty"`
+ // TpmModel: TPM model number.
TpmModel string `json:"tpmModel,omitempty"`
+ // VendorSpecific: Vendor-specific information such as Vendor ID.
VendorSpecific string `json:"vendorSpecific,omitempty"`
// ForceSendFields is a list of field names (e.g. "Family") to
@@ -1740,6 +1749,8 @@ func (s *Feature) MarshalJSON() ([]byte, error) {
// FeatureInstance: JSON template for a "feature instance".
type FeatureInstance struct {
+ // Feature: The feature that this is an instance of. A calendar resource
+ // may have multiple instances of a feature.
Feature *Feature `json:"feature,omitempty"`
// ForceSendFields is a list of field names (e.g. "Feature") to
@@ -2035,7 +2046,8 @@ func (s *Members) MarshalJSON() ([]byte, error) {
// MembersHasMember: JSON template for Has Member response in Directory
// API.
type MembersHasMember struct {
- // IsMember: Identifies whether given user is a member or not.
+ // IsMember: Identifies whether the given user is a member of the group.
+ // Membership can be direct or nested.
IsMember bool `json:"isMember,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -8766,7 +8778,8 @@ type MembersHasMemberCall struct {
header_ http.Header
}
-// HasMember: Checks Membership of an user within a Group
+// HasMember: Checks whether the given user is a member of the group.
+// Membership can be direct or nested.
func (r *MembersService) HasMember(groupKey string, memberKey string) *MembersHasMemberCall {
c := &MembersHasMemberCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.groupKey = groupKey
@@ -8869,7 +8882,7 @@ func (c *MembersHasMemberCall) Do(opts ...googleapi.CallOption) (*MembersHasMemb
}
return ret, nil
// {
- // "description": "Checks Membership of an user within a Group",
+ // "description": "Checks whether the given user is a member of the group. Membership can be direct or nested.",
// "httpMethod": "GET",
// "id": "directory.members.hasMember",
// "parameterOrder": [
@@ -8878,13 +8891,13 @@ func (c *MembersHasMemberCall) Do(opts ...googleapi.CallOption) (*MembersHasMemb
// ],
// "parameters": {
// "groupKey": {
- // "description": "Email or immutable Id of the group",
+ // "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "memberKey": {
- // "description": "Email or immutable Id of the member",
+ // "description": "Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.",
// "location": "path",
// "required": true,
// "type": "string"
@@ -12578,6 +12591,20 @@ func (r *ResourcesBuildingsService) List(customer string) *ResourcesBuildingsLis
return c
}
+// MaxResults sets the optional parameter "maxResults": Maximum number
+// of results to return.
+func (c *ResourcesBuildingsListCall) MaxResults(maxResults int64) *ResourcesBuildingsListCall {
+ c.urlParams_.Set("maxResults", fmt.Sprint(maxResults))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": Token to specify
+// the next page in the list.
+func (c *ResourcesBuildingsListCall) PageToken(pageToken string) *ResourcesBuildingsListCall {
+ c.urlParams_.Set("pageToken", pageToken)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -12684,6 +12711,19 @@ func (c *ResourcesBuildingsListCall) Do(opts ...googleapi.CallOption) (*Building
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "maxResults": {
+ // "description": "Maximum number of results to return.",
+ // "format": "int32",
+ // "location": "query",
+ // "maximum": "500",
+ // "minimum": "1",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "Token to specify the next page in the list.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "customer/{customer}/resources/buildings",
@@ -12698,6 +12738,27 @@ func (c *ResourcesBuildingsListCall) Do(opts ...googleapi.CallOption) (*Building
}
+// Pages invokes f for each page of results.
+// A non-nil error returned from f will halt the iteration.
+// The provided context supersedes any context provided to the Context method.
+func (c *ResourcesBuildingsListCall) Pages(ctx context.Context, f func(*Buildings) error) error {
+ c.ctx_ = ctx
+ defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point
+ for {
+ x, err := c.Do()
+ if err != nil {
+ return err
+ }
+ if err := f(x); err != nil {
+ return err
+ }
+ if x.NextPageToken == "" {
+ return nil
+ }
+ c.PageToken(x.NextPageToken)
+ }
+}
+
// method id "directory.resources.buildings.patch":
type ResourcesBuildingsPatchCall struct {
@@ -13418,8 +13479,11 @@ func (c *ResourcesCalendarsListCall) PageToken(pageToken string) *ResourcesCalen
// 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 where applicable. For prefix match, the value should
-// always be followed by a *.
+// 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.
func (c *ResourcesCalendarsListCall) Query(query string) *ResourcesCalendarsListCall {
c.urlParams_.Set("query", query)
return c
@@ -13551,7 +13615,7 @@ func (c *ResourcesCalendarsListCall) Do(opts ...googleapi.CallOption) (*Calendar
// "type": "string"
// },
// "query": {
- // "description": "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 where applicable. For prefix match, the value should always be followed by a *.",
+ // "description": "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.",
// "location": "query",
// "type": "string"
// }
@@ -14287,6 +14351,13 @@ func (r *ResourcesFeaturesService) List(customer string) *ResourcesFeaturesListC
return c
}
+// MaxResults sets the optional parameter "maxResults": Maximum number
+// of results to return.
+func (c *ResourcesFeaturesListCall) MaxResults(maxResults int64) *ResourcesFeaturesListCall {
+ c.urlParams_.Set("maxResults", fmt.Sprint(maxResults))
+ return c
+}
+
// PageToken sets the optional parameter "pageToken": Token to specify
// the next page in the list.
func (c *ResourcesFeaturesListCall) PageToken(pageToken string) *ResourcesFeaturesListCall {
@@ -14401,6 +14472,14 @@ func (c *ResourcesFeaturesListCall) Do(opts ...googleapi.CallOption) (*Features,
// "required": true,
// "type": "string"
// },
+ // "maxResults": {
+ // "description": "Maximum number of results to return.",
+ // "format": "int32",
+ // "location": "query",
+ // "maximum": "500",
+ // "minimum": "1",
+ // "type": "integer"
+ // },
// "pageToken": {
// "description": "Token to specify the next page in the list.",
// "location": "query",
diff --git a/vendor/google.golang.org/api/admin/reports/v1/admin-api.json b/vendor/google.golang.org/api/admin/reports/v1/admin-api.json
index e20f1d524..53fb5d642 100644
--- a/vendor/google.golang.org/api/admin/reports/v1/admin-api.json
+++ b/vendor/google.golang.org/api/admin/reports/v1/admin-api.json
@@ -1,822 +1,822 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/bw0JROoLapnynZnUYWv2Bypz6Uk\"",
- "discoveryVersion": "v1",
- "id": "admin:reports_v1",
- "name": "admin",
- "canonicalName": "reports",
- "version": "reports_v1",
- "revision": "20180110",
- "title": "Admin Reports API",
- "description": "Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "packagePath": "admin",
- "icons": {
- "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
- "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/reports/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/admin/reports/v1/",
- "basePath": "/admin/reports/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "admin/reports/v1/",
- "batchPath": "batch/admin/reports_v1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/admin.reports.audit.readonly": {
- "description": "View audit reports for your G Suite domain"
- },
- "https://www.googleapis.com/auth/admin.reports.usage.readonly": {
- "description": "View usage reports for your G Suite domain"
- }
- }
- }
- },
- "schemas": {
- "Activities": {
- "id": "Activities",
- "type": "object",
- "description": "JSON template for a collection of activites.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "Each record in read response.",
- "items": {
- "$ref": "Activity"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list response this is.",
- "default": "admin#reports#activities"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token for retrieving the next page"
- }
- }
- },
- "Activity": {
- "id": "Activity",
- "type": "object",
- "description": "JSON template for the activity resource.",
- "properties": {
- "actor": {
- "type": "object",
- "description": "User doing the action.",
- "properties": {
- "callerType": {
- "type": "string",
- "description": "User or OAuth 2LO request."
- },
- "email": {
- "type": "string",
- "description": "Email address of the user."
- },
- "key": {
- "type": "string",
- "description": "For OAuth 2LO API requests, consumer_key of the requestor."
- },
- "profileId": {
- "type": "string",
- "description": "Obfuscated user id of the user."
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/admin.reports.audit.readonly": {
+ "description": "View audit reports for your G Suite domain"
+ },
+ "https://www.googleapis.com/auth/admin.reports.usage.readonly": {
+ "description": "View usage reports for your G Suite domain"
+ }
}
- }
+ }
+ },
+ "basePath": "/admin/reports/v1/",
+ "baseUrl": "https://www.googleapis.com/admin/reports/v1/",
+ "batchPath": "batch/admin/reports_v1",
+ "canonicalName": "reports",
+ "description": "Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/admin-sdk/reports/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/bw0JROoLapnynZnUYWv2Bypz6Uk\"",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "id": "admin:reports_v1",
+ "kind": "discovery#restDescription",
+ "name": "admin",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "packagePath": "admin",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "etag": {
- "type": "string",
- "description": "ETag of the entry."
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
},
- "events": {
- "type": "array",
- "description": "Activity events.",
- "items": {
- "type": "object",
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "activities": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of activities for a specific customer and application.",
+ "httpMethod": "GET",
+ "id": "reports.activities.list",
+ "parameterOrder": [
+ "userKey",
+ "applicationName"
+ ],
+ "parameters": {
+ "actorIpAddress": {
+ "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
+ "location": "query",
+ "type": "string"
+ },
+ "applicationName": {
+ "description": "Application name for which the events are to be retrieved.",
+ "location": "path",
+ "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)",
+ "required": true,
+ "type": "string"
+ },
+ "customerId": {
+ "description": "Represents the customer for which the data is to be fetched.",
+ "location": "query",
+ "pattern": "C.+",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Return events which occurred at or before this time.",
+ "location": "query",
+ "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
+ "type": "string"
+ },
+ "eventName": {
+ "description": "Name of the event being queried.",
+ "location": "query",
+ "type": "string"
+ },
+ "filters": {
+ "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
+ "location": "query",
+ "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Number of activity records to be shown in each page.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify next page.",
+ "location": "query",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Return events which occurred at or after this time.",
+ "location": "query",
+ "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "activity/users/{userKey}/applications/{applicationName}",
+ "response": {
+ "$ref": "Activities"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.audit.readonly"
+ ],
+ "supportsSubscription": true
+ },
+ "watch": {
+ "description": "Push changes to activities",
+ "httpMethod": "POST",
+ "id": "reports.activities.watch",
+ "parameterOrder": [
+ "userKey",
+ "applicationName"
+ ],
+ "parameters": {
+ "actorIpAddress": {
+ "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
+ "location": "query",
+ "type": "string"
+ },
+ "applicationName": {
+ "description": "Application name for which the events are to be retrieved.",
+ "location": "path",
+ "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)",
+ "required": true,
+ "type": "string"
+ },
+ "customerId": {
+ "description": "Represents the customer for which the data is to be fetched.",
+ "location": "query",
+ "pattern": "C.+",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Return events which occurred at or before this time.",
+ "location": "query",
+ "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
+ "type": "string"
+ },
+ "eventName": {
+ "description": "Name of the event being queried.",
+ "location": "query",
+ "type": "string"
+ },
+ "filters": {
+ "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
+ "location": "query",
+ "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Number of activity records to be shown in each page.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1000",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify next page.",
+ "location": "query",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Return events which occurred at or after this time.",
+ "location": "query",
+ "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "activity/users/{userKey}/applications/{applicationName}/watch",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "response": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.audit.readonly"
+ ],
+ "supportsSubscription": true
+ }
+ }
+ },
+ "channels": {
+ "methods": {
+ "stop": {
+ "description": "Stop watching resources through this channel",
+ "httpMethod": "POST",
+ "id": "admin.channels.stop",
+ "path": "/admin/reports_v1/channels/stop",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.audit.readonly"
+ ]
+ }
+ }
+ },
+ "customerUsageReports": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report which is a collection of properties / statistics for a specific customer.",
+ "httpMethod": "GET",
+ "id": "reports.customerUsageReports.get",
+ "parameterOrder": [
+ "date"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Represents the customer for which the data is to be fetched.",
+ "location": "query",
+ "pattern": "C.+",
+ "type": "string"
+ },
+ "date": {
+ "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
+ "location": "path",
+ "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token to specify next page.",
+ "location": "query",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
+ "location": "query",
+ "pattern": "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)",
+ "type": "string"
+ }
+ },
+ "path": "usage/dates/{date}",
+ "response": {
+ "$ref": "UsageReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.usage.readonly"
+ ]
+ }
+ }
+ },
+ "entityUsageReports": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report which is a collection of properties / statistics for a set of objects.",
+ "httpMethod": "GET",
+ "id": "reports.entityUsageReports.get",
+ "parameterOrder": [
+ "entityType",
+ "entityKey",
+ "date"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Represents the customer for which the data is to be fetched.",
+ "location": "query",
+ "pattern": "C.+",
+ "type": "string"
+ },
+ "date": {
+ "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
+ "location": "path",
+ "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
+ "required": true,
+ "type": "string"
+ },
+ "entityKey": {
+ "description": "Represents the key of object for which the data should be filtered.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "entityType": {
+ "description": "Type of object. Should be one of - gplus_communities.",
+ "location": "path",
+ "pattern": "(gplus_communities)",
+ "required": true,
+ "type": "string"
+ },
+ "filters": {
+ "description": "Represents the set of filters including parameter operator value.",
+ "location": "query",
+ "pattern": "(((gplus)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+,)*(((gplus)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+)",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Maximum allowed is 1000",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify next page.",
+ "location": "query",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
+ "location": "query",
+ "pattern": "(((gplus)):[^,]+,)*(((gplus)):[^,]+)",
+ "type": "string"
+ }
+ },
+ "path": "usage/{entityType}/{entityKey}/dates/{date}",
+ "response": {
+ "$ref": "UsageReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.usage.readonly"
+ ]
+ }
+ }
+ },
+ "userUsageReport": {
+ "methods": {
+ "get": {
+ "description": "Retrieves a report which is a collection of properties / statistics for a set of users.",
+ "httpMethod": "GET",
+ "id": "reports.userUsageReport.get",
+ "parameterOrder": [
+ "userKey",
+ "date"
+ ],
+ "parameters": {
+ "customerId": {
+ "description": "Represents the customer for which the data is to be fetched.",
+ "location": "query",
+ "pattern": "C.+",
+ "type": "string"
+ },
+ "date": {
+ "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
+ "location": "path",
+ "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
+ "required": true,
+ "type": "string"
+ },
+ "filters": {
+ "description": "Represents the set of filters including parameter operator value.",
+ "location": "query",
+ "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+)",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return. Maximum allowed is 1000",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "1000",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to specify next page.",
+ "location": "query",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
+ "location": "query",
+ "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)",
+ "type": "string"
+ },
+ "userKey": {
+ "description": "Represents the profile id or the user email for which the data should be filtered.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "usage/users/{userKey}/dates/{date}",
+ "response": {
+ "$ref": "UsageReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/admin.reports.usage.readonly"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180110",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Activities": {
+ "description": "JSON template for a collection of activites.",
+ "id": "Activities",
"properties": {
- "name": {
- "type": "string",
- "description": "Name of event."
- },
- "parameters": {
- "type": "array",
- "description": "Parameter value pairs for various applications.",
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
"items": {
- "type": "object",
- "properties": {
- "boolValue": {
- "type": "boolean",
- "description": "Boolean value of the parameter."
+ "description": "Each record in read response.",
+ "items": {
+ "$ref": "Activity"
},
- "intValue": {
- "type": "string",
- "description": "Integral value of the parameter.",
- "format": "int64"
+ "type": "array"
+ },
+ "kind": {
+ "default": "admin#reports#activities",
+ "description": "Kind of list response this is.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token for retrieving the next page",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Activity": {
+ "description": "JSON template for the activity resource.",
+ "id": "Activity",
+ "properties": {
+ "actor": {
+ "description": "User doing the action.",
+ "properties": {
+ "callerType": {
+ "description": "User or OAuth 2LO request.",
+ "type": "string"
+ },
+ "email": {
+ "description": "Email address of the user.",
+ "type": "string"
+ },
+ "key": {
+ "description": "For OAuth 2LO API requests, consumer_key of the requestor.",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "Obfuscated user id of the user.",
+ "type": "string"
+ }
},
- "multiIntValue": {
- "type": "array",
- "description": "Multi-int value of the parameter.",
- "items": {
- "type": "string",
- "format": "int64"
- }
+ "type": "object"
+ },
+ "etag": {
+ "description": "ETag of the entry.",
+ "type": "string"
+ },
+ "events": {
+ "description": "Activity events.",
+ "items": {
+ "properties": {
+ "name": {
+ "description": "Name of event.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Parameter value pairs for various applications.",
+ "items": {
+ "properties": {
+ "boolValue": {
+ "description": "Boolean value of the parameter.",
+ "type": "boolean"
+ },
+ "intValue": {
+ "description": "Integral value of the parameter.",
+ "format": "int64",
+ "type": "string"
+ },
+ "multiIntValue": {
+ "description": "Multi-int value of the parameter.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "multiValue": {
+ "description": "Multi-string value of the parameter.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the parameter.",
+ "type": "string"
+ },
+ "value": {
+ "description": "String value of the parameter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "Type of event.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "multiValue": {
- "type": "array",
- "description": "Multi-string value of the parameter.",
- "items": {
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for each activity record.",
+ "properties": {
+ "applicationName": {
+ "description": "Application name to which the event belongs.",
+ "type": "string"
+ },
+ "customerId": {
+ "description": "Obfuscated customer ID of the source customer.",
+ "type": "string"
+ },
+ "time": {
+ "description": "Time of occurrence of the activity.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "uniqueQualifier": {
+ "description": "Unique qualifier if multiple events have the same time.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ipAddress": {
+ "description": "IP Address of the user doing the action.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#reports#activity",
+ "description": "Kind of resource this is.",
+ "type": "string"
+ },
+ "ownerDomain": {
+ "description": "Domain of source customer.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Channel": {
+ "description": "An notification channel used to watch for resource changes.",
+ "id": "Channel",
+ "properties": {
+ "address": {
+ "description": "The address where notifications are delivered for this channel.",
+ "type": "string"
+ },
+ "expiration": {
+ "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "A UUID or similar unique string that identifies this channel.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "api#channel",
+ "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "description": "Declares a new parameter by name.",
"type": "string"
- }
},
- "name": {
- "type": "string",
- "description": "The name of the parameter."
- },
- "value": {
- "type": "string",
- "description": "String value of the parameter."
- }
- }
+ "description": "Additional parameters controlling delivery channel behavior. Optional.",
+ "type": "object"
+ },
+ "payload": {
+ "description": "A Boolean value to indicate whether payload is wanted. Optional.",
+ "type": "boolean"
+ },
+ "resourceId": {
+ "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "A version-specific identifier for the watched resource.",
+ "type": "string"
+ },
+ "token": {
+ "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of delivery mechanism used for this channel.",
+ "type": "string"
}
- },
- "type": {
- "type": "string",
- "description": "Type of event."
- }
- }
- }
- },
- "id": {
- "type": "object",
- "description": "Unique identifier for each activity record.",
- "properties": {
- "applicationName": {
- "type": "string",
- "description": "Application name to which the event belongs."
},
- "customerId": {
- "type": "string",
- "description": "Obfuscated customer ID of the source customer."
- },
- "time": {
- "type": "string",
- "description": "Time of occurrence of the activity.",
- "format": "date-time"
- },
- "uniqueQualifier": {
- "type": "string",
- "description": "Unique qualifier if multiple events have the same time.",
- "format": "int64"
- }
- }
+ "type": "object"
},
- "ipAddress": {
- "type": "string",
- "description": "IP Address of the user doing the action."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#reports#activity"
- },
- "ownerDomain": {
- "type": "string",
- "description": "Domain of source customer."
- }
- }
- },
- "Channel": {
- "id": "Channel",
- "type": "object",
- "description": "An notification channel used to watch for resource changes.",
- "properties": {
- "address": {
- "type": "string",
- "description": "The address where notifications are delivered for this channel."
- },
- "expiration": {
- "type": "string",
- "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "A UUID or similar unique string that identifies this channel."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
- "default": "api#channel"
- },
- "params": {
- "type": "object",
- "description": "Additional parameters controlling delivery channel behavior. Optional.",
- "additionalProperties": {
- "type": "string",
- "description": "Declares a new parameter by name."
- }
- },
- "payload": {
- "type": "boolean",
- "description": "A Boolean value to indicate whether payload is wanted. Optional."
- },
- "resourceId": {
- "type": "string",
- "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions."
- },
- "resourceUri": {
- "type": "string",
- "description": "A version-specific identifier for the watched resource."
- },
- "token": {
- "type": "string",
- "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional."
- },
- "type": {
- "type": "string",
- "description": "The type of delivery mechanism used for this channel."
- }
- }
- },
- "UsageReport": {
- "id": "UsageReport",
- "type": "object",
- "description": "JSON template for a usage report.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date to which the record belongs.",
- "readOnly": true
- },
- "entity": {
- "type": "object",
- "description": "Information about the type of the item.",
- "readOnly": true,
- "properties": {
- "customerId": {
- "type": "string",
- "description": "Obfuscated customer id for the record.",
- "readOnly": true
- },
- "entityId": {
- "type": "string",
- "description": "Object key. Only relevant if entity.type = \"OBJECT\" Note: external-facing name of report is \"Entities\" rather than \"Objects\".",
- "readOnly": true
- },
- "profileId": {
- "type": "string",
- "description": "Obfuscated user id for the record.",
- "readOnly": true
- },
- "type": {
- "type": "string",
- "description": "The type of item, can be customer, user, or entity (aka. object).",
- "readOnly": true
- },
- "userEmail": {
- "type": "string",
- "description": "user's email. Only relevant if entity.type = \"USER\"",
- "readOnly": true
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The kind of object.",
- "default": "admin#reports#usageReport"
- },
- "parameters": {
- "type": "array",
- "description": "Parameter value pairs for various applications.",
- "readOnly": true,
- "items": {
- "type": "object",
+ "UsageReport": {
+ "description": "JSON template for a usage report.",
+ "id": "UsageReport",
"properties": {
- "boolValue": {
- "type": "boolean",
- "description": "Boolean value of the parameter.",
- "readOnly": true
- },
- "datetimeValue": {
- "type": "string",
- "description": "RFC 3339 formatted value of the parameter.",
- "format": "date-time",
- "readOnly": true
- },
- "intValue": {
- "type": "string",
- "description": "Integral value of the parameter.",
- "format": "int64",
- "readOnly": true
- },
- "msgValue": {
- "type": "array",
- "description": "Nested message value of the parameter.",
- "readOnly": true,
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any"
- }
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the parameter."
- },
- "stringValue": {
- "type": "string",
- "description": "String value of the parameter.",
- "readOnly": true
- }
- }
- }
- }
- }
- },
- "UsageReports": {
- "id": "UsageReports",
- "type": "object",
- "description": "JSON template for a collection of usage reports.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The kind of object.",
- "default": "admin#reports#usageReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token for retrieving the next page"
- },
- "usageReports": {
- "type": "array",
- "description": "Various application parameter records.",
- "items": {
- "$ref": "UsageReport"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Warnings if any.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Machine readable code / warning type."
- },
- "data": {
- "type": "array",
- "description": "Key-Value pairs to give detailed information on the warning.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "Key associated with a key-value pair to give detailed information on the warning."
+ "date": {
+ "description": "The date to which the record belongs.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "entity": {
+ "description": "Information about the type of the item.",
+ "properties": {
+ "customerId": {
+ "description": "Obfuscated customer id for the record.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "entityId": {
+ "description": "Object key. Only relevant if entity.type = \"OBJECT\" Note: external-facing name of report is \"Entities\" rather than \"Objects\".",
+ "readOnly": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "Obfuscated user id for the record.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of item, can be customer, user, or entity (aka. object).",
+ "readOnly": true,
+ "type": "string"
+ },
+ "userEmail": {
+ "description": "user's email. Only relevant if entity.type = \"USER\"",
+ "readOnly": true,
+ "type": "string"
+ }
},
- "value": {
- "type": "string",
- "description": "Value associated with a key-value pair to give detailed information on the warning."
- }
- }
+ "readOnly": true,
+ "type": "object"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#reports#usageReport",
+ "description": "The kind of object.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Parameter value pairs for various applications.",
+ "items": {
+ "properties": {
+ "boolValue": {
+ "description": "Boolean value of the parameter.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "datetimeValue": {
+ "description": "RFC 3339 formatted value of the parameter.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "intValue": {
+ "description": "Integral value of the parameter.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "msgValue": {
+ "description": "Nested message value of the parameter.",
+ "items": {
+ "additionalProperties": {
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the parameter.",
+ "type": "string"
+ },
+ "stringValue": {
+ "description": "String value of the parameter.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "readOnly": true,
+ "type": "array"
}
- },
- "message": {
- "type": "string",
- "description": "Human readable message for the warning."
- }
- }
- }
- }
- }
- }
- },
- "resources": {
- "activities": {
- "methods": {
- "list": {
- "id": "reports.activities.list",
- "path": "activity/users/{userKey}/applications/{applicationName}",
- "httpMethod": "GET",
- "description": "Retrieves a list of activities for a specific customer and application.",
- "parameters": {
- "actorIpAddress": {
- "type": "string",
- "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
- "location": "query"
},
- "applicationName": {
- "type": "string",
- "description": "Application name for which the events are to be retrieved.",
- "required": true,
- "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)",
- "location": "path"
- },
- "customerId": {
- "type": "string",
- "description": "Represents the customer for which the data is to be fetched.",
- "pattern": "C.+",
- "location": "query"
- },
- "endTime": {
- "type": "string",
- "description": "Return events which occurred at or before this time.",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "location": "query"
- },
- "eventName": {
- "type": "string",
- "description": "Name of the event being queried.",
- "location": "query"
- },
- "filters": {
- "type": "string",
- "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
- "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Number of activity records to be shown in each page.",
- "format": "int32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page.",
- "location": "query"
- },
- "startTime": {
- "type": "string",
- "description": "Return events which occurred at or after this time.",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "applicationName"
- ],
- "response": {
- "$ref": "Activities"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- ],
- "supportsSubscription": true
+ "type": "object"
},
- "watch": {
- "id": "reports.activities.watch",
- "path": "activity/users/{userKey}/applications/{applicationName}/watch",
- "httpMethod": "POST",
- "description": "Push changes to activities",
- "parameters": {
- "actorIpAddress": {
- "type": "string",
- "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
- "location": "query"
+ "UsageReports": {
+ "description": "JSON template for a collection of usage reports.",
+ "id": "UsageReports",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "admin#reports#usageReports",
+ "description": "The kind of object.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token for retrieving the next page",
+ "type": "string"
+ },
+ "usageReports": {
+ "description": "Various application parameter records.",
+ "items": {
+ "$ref": "UsageReport"
+ },
+ "type": "array"
+ },
+ "warnings": {
+ "description": "Warnings if any.",
+ "items": {
+ "properties": {
+ "code": {
+ "description": "Machine readable code / warning type.",
+ "type": "string"
+ },
+ "data": {
+ "description": "Key-Value pairs to give detailed information on the warning.",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "Key associated with a key-value pair to give detailed information on the warning.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value associated with a key-value pair to give detailed information on the warning.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "Human readable message for the warning.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
},
- "applicationName": {
- "type": "string",
- "description": "Application name for which the events are to be retrieved.",
- "required": true,
- "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)",
- "location": "path"
- },
- "customerId": {
- "type": "string",
- "description": "Represents the customer for which the data is to be fetched.",
- "pattern": "C.+",
- "location": "query"
- },
- "endTime": {
- "type": "string",
- "description": "Return events which occurred at or before this time.",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "location": "query"
- },
- "eventName": {
- "type": "string",
- "description": "Name of the event being queried.",
- "location": "query"
- },
- "filters": {
- "type": "string",
- "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
- "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Number of activity records to be shown in each page.",
- "format": "int32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page.",
- "location": "query"
- },
- "startTime": {
- "type": "string",
- "description": "Return events which occurred at or after this time.",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "applicationName"
- ],
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- ],
- "supportsSubscription": true
+ "type": "object"
}
- }
},
- "channels": {
- "methods": {
- "stop": {
- "id": "admin.channels.stop",
- "path": "/admin/reports_v1/channels/stop",
- "httpMethod": "POST",
- "description": "Stop watching resources through this channel",
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- ]
- }
- }
- },
- "customerUsageReports": {
- "methods": {
- "get": {
- "id": "reports.customerUsageReports.get",
- "path": "usage/dates/{date}",
- "httpMethod": "GET",
- "description": "Retrieves a report which is a collection of properties / statistics for a specific customer.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Represents the customer for which the data is to be fetched.",
- "pattern": "C.+",
- "location": "query"
- },
- "date": {
- "type": "string",
- "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
- "required": true,
- "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page.",
- "location": "query"
- },
- "parameters": {
- "type": "string",
- "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
- "pattern": "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)",
- "location": "query"
- }
- },
- "parameterOrder": [
- "date"
- ],
- "response": {
- "$ref": "UsageReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- ]
- }
- }
- },
- "entityUsageReports": {
- "methods": {
- "get": {
- "id": "reports.entityUsageReports.get",
- "path": "usage/{entityType}/{entityKey}/dates/{date}",
- "httpMethod": "GET",
- "description": "Retrieves a report which is a collection of properties / statistics for a set of objects.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Represents the customer for which the data is to be fetched.",
- "pattern": "C.+",
- "location": "query"
- },
- "date": {
- "type": "string",
- "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
- "required": true,
- "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- "location": "path"
- },
- "entityKey": {
- "type": "string",
- "description": "Represents the key of object for which the data should be filtered.",
- "required": true,
- "location": "path"
- },
- "entityType": {
- "type": "string",
- "description": "Type of object. Should be one of - gplus_communities.",
- "required": true,
- "pattern": "(gplus_communities)",
- "location": "path"
- },
- "filters": {
- "type": "string",
- "description": "Represents the set of filters including parameter operator value.",
- "pattern": "(((gplus)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+,)*(((gplus)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+)",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Maximum allowed is 1000",
- "format": "uint32",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page.",
- "location": "query"
- },
- "parameters": {
- "type": "string",
- "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
- "pattern": "(((gplus)):[^,]+,)*(((gplus)):[^,]+)",
- "location": "query"
- }
- },
- "parameterOrder": [
- "entityType",
- "entityKey",
- "date"
- ],
- "response": {
- "$ref": "UsageReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- ]
- }
- }
- },
- "userUsageReport": {
- "methods": {
- "get": {
- "id": "reports.userUsageReport.get",
- "path": "usage/users/{userKey}/dates/{date}",
- "httpMethod": "GET",
- "description": "Retrieves a report which is a collection of properties / statistics for a set of users.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Represents the customer for which the data is to be fetched.",
- "pattern": "C.+",
- "location": "query"
- },
- "date": {
- "type": "string",
- "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
- "required": true,
- "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- "location": "path"
- },
- "filters": {
- "type": "string",
- "description": "Represents the set of filters including parameter operator value.",
- "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+)",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Maximum allowed is 1000",
- "format": "uint32",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page.",
- "location": "query"
- },
- "parameters": {
- "type": "string",
- "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
- "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "Represents the profile id or the user email for which the data should be filtered.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "date"
- ],
- "response": {
- "$ref": "UsageReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "admin/reports/v1/",
+ "title": "Admin Reports API",
+ "version": "reports_v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adsense/v1.3/adsense-gen.go b/vendor/google.golang.org/api/adsense/v1.3/adsense-gen.go
index 4ec72e147..24317041b 100644
--- a/vendor/google.golang.org/api/adsense/v1.3/adsense-gen.go
+++ b/vendor/google.golang.org/api/adsense/v1.3/adsense-gen.go
@@ -401,8 +401,8 @@ type Account struct {
}
func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
+ type NoMethod Account
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -443,8 +443,8 @@ type Accounts struct {
}
func (s *Accounts) MarshalJSON() ([]byte, error) {
- type noMethod Accounts
- raw := noMethod(*s)
+ type NoMethod Accounts
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -483,8 +483,8 @@ type AdClient struct {
}
func (s *AdClient) MarshalJSON() ([]byte, error) {
- type noMethod AdClient
- raw := noMethod(*s)
+ type NoMethod AdClient
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -525,8 +525,8 @@ type AdClients struct {
}
func (s *AdClients) MarshalJSON() ([]byte, error) {
- type noMethod AdClients
- raw := noMethod(*s)
+ type NoMethod AdClients
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -559,8 +559,8 @@ type AdCode struct {
}
func (s *AdCode) MarshalJSON() ([]byte, error) {
- type noMethod AdCode
- raw := noMethod(*s)
+ type NoMethod AdCode
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -598,8 +598,8 @@ type AdStyle struct {
}
func (s *AdStyle) MarshalJSON() ([]byte, error) {
- type noMethod AdStyle
- raw := noMethod(*s)
+ type NoMethod AdStyle
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -640,8 +640,8 @@ type AdStyleColors struct {
}
func (s *AdStyleColors) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleColors
- raw := noMethod(*s)
+ type NoMethod AdStyleColors
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -671,8 +671,8 @@ type AdStyleFont struct {
}
func (s *AdStyleFont) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleFont
- raw := noMethod(*s)
+ type NoMethod AdStyleFont
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -743,8 +743,8 @@ type AdUnit struct {
}
func (s *AdUnit) MarshalJSON() ([]byte, error) {
- type noMethod AdUnit
- raw := noMethod(*s)
+ type NoMethod AdUnit
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -779,8 +779,8 @@ type AdUnitContentAdsSettings struct {
}
func (s *AdUnitContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettings
- raw := noMethod(*s)
+ type NoMethod AdUnitContentAdsSettings
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -815,8 +815,8 @@ type AdUnitContentAdsSettingsBackupOption struct {
}
func (s *AdUnitContentAdsSettingsBackupOption) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettingsBackupOption
- raw := noMethod(*s)
+ type NoMethod AdUnitContentAdsSettingsBackupOption
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -855,8 +855,8 @@ type AdUnitFeedAdsSettings struct {
}
func (s *AdUnitFeedAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitFeedAdsSettings
- raw := noMethod(*s)
+ type NoMethod AdUnitFeedAdsSettings
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -894,8 +894,8 @@ type AdUnitMobileContentAdsSettings struct {
}
func (s *AdUnitMobileContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitMobileContentAdsSettings
- raw := noMethod(*s)
+ type NoMethod AdUnitMobileContentAdsSettings
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -936,8 +936,8 @@ type AdUnits struct {
}
func (s *AdUnits) MarshalJSON() ([]byte, error) {
- type noMethod AdUnits
- raw := noMethod(*s)
+ type NoMethod AdUnits
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -996,8 +996,8 @@ type AdsenseReportsGenerateResponse struct {
}
func (s *AdsenseReportsGenerateResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdsenseReportsGenerateResponse
- raw := noMethod(*s)
+ type NoMethod AdsenseReportsGenerateResponse
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1031,8 +1031,8 @@ type AdsenseReportsGenerateResponseHeaders struct {
}
func (s *AdsenseReportsGenerateResponseHeaders) MarshalJSON() ([]byte, error) {
- type noMethod AdsenseReportsGenerateResponseHeaders
- raw := noMethod(*s)
+ type NoMethod AdsenseReportsGenerateResponseHeaders
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1076,8 +1076,8 @@ type Alert struct {
}
func (s *Alert) MarshalJSON() ([]byte, error) {
- type noMethod Alert
- raw := noMethod(*s)
+ type NoMethod Alert
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1110,8 +1110,8 @@ type Alerts struct {
}
func (s *Alerts) MarshalJSON() ([]byte, error) {
- type noMethod Alerts
- raw := noMethod(*s)
+ type NoMethod Alerts
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1157,8 +1157,8 @@ type CustomChannel struct {
}
func (s *CustomChannel) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannel
- raw := noMethod(*s)
+ type NoMethod CustomChannel
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1200,8 +1200,8 @@ type CustomChannelTargetingInfo struct {
}
func (s *CustomChannelTargetingInfo) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannelTargetingInfo
- raw := noMethod(*s)
+ type NoMethod CustomChannelTargetingInfo
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1242,8 +1242,8 @@ type CustomChannels struct {
}
func (s *CustomChannels) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannels
- raw := noMethod(*s)
+ type NoMethod CustomChannels
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1275,8 +1275,8 @@ type Metadata struct {
}
func (s *Metadata) MarshalJSON() ([]byte, error) {
- type noMethod Metadata
- raw := noMethod(*s)
+ type NoMethod Metadata
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1336,8 +1336,8 @@ type ReportingMetadataEntry struct {
}
func (s *ReportingMetadataEntry) MarshalJSON() ([]byte, error) {
- type noMethod ReportingMetadataEntry
- raw := noMethod(*s)
+ type NoMethod ReportingMetadataEntry
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1378,8 +1378,8 @@ type SavedAdStyle struct {
}
func (s *SavedAdStyle) MarshalJSON() ([]byte, error) {
- type noMethod SavedAdStyle
- raw := noMethod(*s)
+ type NoMethod SavedAdStyle
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1420,8 +1420,8 @@ type SavedAdStyles struct {
}
func (s *SavedAdStyles) MarshalJSON() ([]byte, error) {
- type noMethod SavedAdStyles
- raw := noMethod(*s)
+ type NoMethod SavedAdStyles
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1453,8 +1453,8 @@ type SavedReport struct {
}
func (s *SavedReport) MarshalJSON() ([]byte, error) {
- type noMethod SavedReport
- raw := noMethod(*s)
+ type NoMethod SavedReport
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1495,8 +1495,8 @@ type SavedReports struct {
}
func (s *SavedReports) MarshalJSON() ([]byte, error) {
- type noMethod SavedReports
- raw := noMethod(*s)
+ type NoMethod SavedReports
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1531,8 +1531,8 @@ type UrlChannel struct {
}
func (s *UrlChannel) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannel
- raw := noMethod(*s)
+ type NoMethod UrlChannel
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1573,8 +1573,8 @@ type UrlChannels struct {
}
func (s *UrlChannels) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannels
- raw := noMethod(*s)
+ type NoMethod UrlChannels
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1692,7 +1692,7 @@ func (c *AccountsGetCall) Do(opts ...googleapi.CallOption) (*Account, error) {
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -1846,7 +1846,7 @@ func (c *AccountsListCall) Do(opts ...googleapi.CallOption) (*Accounts, error) {
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -2025,7 +2025,7 @@ func (c *AccountsAdclientsListCall) Do(opts ...googleapi.CallOption) (*AdClients
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -2204,7 +2204,7 @@ func (c *AccountsAdunitsGetCall) Do(opts ...googleapi.CallOption) (*AdUnit, erro
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -2362,7 +2362,7 @@ func (c *AccountsAdunitsGetAdCodeCall) Do(opts ...googleapi.CallOption) (*AdCode
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -2541,7 +2541,7 @@ func (c *AccountsAdunitsListCall) Do(opts ...googleapi.CallOption) (*AdUnits, er
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -2749,7 +2749,7 @@ func (c *AccountsAdunitsCustomchannelsListCall) Do(opts ...googleapi.CallOption)
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -2944,7 +2944,7 @@ func (c *AccountsAlertsListCall) Do(opts ...googleapi.CallOption) (*Alerts, erro
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -3094,7 +3094,7 @@ func (c *AccountsCustomchannelsGetCall) Do(opts ...googleapi.CallOption) (*Custo
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -3267,7 +3267,7 @@ func (c *AccountsCustomchannelsListCall) Do(opts ...googleapi.CallOption) (*Cust
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -3475,7 +3475,7 @@ func (c *AccountsCustomchannelsAdunitsListCall) Do(opts ...googleapi.CallOption)
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -3755,7 +3755,7 @@ func (c *AccountsReportsGenerateCall) Do(opts ...googleapi.CallOption) (*Adsense
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -3997,7 +3997,7 @@ func (c *AccountsReportsSavedGenerateCall) Do(opts ...googleapi.CallOption) (*Ad
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -4180,7 +4180,7 @@ func (c *AccountsReportsSavedListCall) Do(opts ...googleapi.CallOption) (*SavedR
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -4355,7 +4355,7 @@ func (c *AccountsSavedadstylesGetCall) Do(opts ...googleapi.CallOption) (*SavedA
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -4517,7 +4517,7 @@ func (c *AccountsSavedadstylesListCall) Do(opts ...googleapi.CallOption) (*Saved
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -4709,7 +4709,7 @@ func (c *AccountsUrlchannelsListCall) Do(opts ...googleapi.CallOption) (*UrlChan
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -4899,7 +4899,7 @@ func (c *AdclientsListCall) Do(opts ...googleapi.CallOption) (*AdClients, error)
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -5065,7 +5065,7 @@ func (c *AdunitsGetCall) Do(opts ...googleapi.CallOption) (*AdUnit, error) {
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -5213,7 +5213,7 @@ func (c *AdunitsGetAdCodeCall) Do(opts ...googleapi.CallOption) (*AdCode, error)
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -5382,7 +5382,7 @@ func (c *AdunitsListCall) Do(opts ...googleapi.CallOption) (*AdUnits, error) {
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -5580,7 +5580,7 @@ func (c *AdunitsCustomchannelsListCall) Do(opts ...googleapi.CallOption) (*Custo
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -5763,7 +5763,7 @@ func (c *AlertsListCall) Do(opts ...googleapi.CallOption) (*Alerts, error) {
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -5900,7 +5900,7 @@ func (c *CustomchannelsGetCall) Do(opts ...googleapi.CallOption) (*CustomChannel
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -6063,7 +6063,7 @@ func (c *CustomchannelsListCall) Do(opts ...googleapi.CallOption) (*CustomChanne
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -6261,7 +6261,7 @@ func (c *CustomchannelsAdunitsListCall) Do(opts ...googleapi.CallOption) (*AdUni
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -6441,7 +6441,7 @@ func (c *MetadataDimensionsListCall) Do(opts ...googleapi.CallOption) (*Metadata
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -6564,7 +6564,7 @@ func (c *MetadataMetricsListCall) Do(opts ...googleapi.CallOption) (*Metadata, e
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -6782,7 +6782,7 @@ func (c *ReportsGenerateCall) Do(opts ...googleapi.CallOption) (*AdsenseReportsG
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -7020,7 +7020,7 @@ func (c *ReportsSavedGenerateCall) Do(opts ...googleapi.CallOption) (*AdsenseRep
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -7191,7 +7191,7 @@ func (c *ReportsSavedListCall) Do(opts ...googleapi.CallOption) (*SavedReports,
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -7354,7 +7354,7 @@ func (c *SavedadstylesGetCall) Do(opts ...googleapi.CallOption) (*SavedAdStyle,
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -7504,7 +7504,7 @@ func (c *SavedadstylesListCall) Do(opts ...googleapi.CallOption) (*SavedAdStyles
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -7684,7 +7684,7 @@ func (c *UrlchannelsListCall) Do(opts ...googleapi.CallOption) (*UrlChannels, er
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
diff --git a/vendor/google.golang.org/api/adsense/v1.4/adsense-api.json b/vendor/google.golang.org/api/adsense/v1.4/adsense-api.json
index fa96a60bc..bd9159ef2 100644
--- a/vendor/google.golang.org/api/adsense/v1.4/adsense-api.json
+++ b/vendor/google.golang.org/api/adsense/v1.4/adsense-api.json
@@ -1,2407 +1,2407 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/5dfOA4TQ4h1l0_SNvBmZicECrgQ\"",
- "discoveryVersion": "v1",
- "id": "adsense:v1.4",
- "name": "adsense",
- "canonicalName": "AdSense",
- "version": "v1.4",
- "revision": "20170912",
- "title": "AdSense Management API",
- "description": "Accesses AdSense publishers' inventory and generates performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/management/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adsense/v1.4/",
- "basePath": "/adsense/v1.4/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adsense/v1.4/",
- "batchPath": "batch/adsense/v1.4",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adsense": {
- "description": "View and manage your AdSense data"
- },
- "https://www.googleapis.com/auth/adsense.readonly": {
- "description": "View your AdSense data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "creation_time": {
- "type": "string",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#account.",
- "default": "adsense#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- },
- "premium": {
- "type": "boolean",
- "description": "Whether this account is premium."
- },
- "subAccounts": {
- "type": "array",
- "description": "Sub accounts of the this account.",
- "items": {
- "$ref": "Account"
- }
- },
- "timezone": {
- "type": "string",
- "description": "AdSense timezone of this account."
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The accounts returned in this list response.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#accounts.",
- "default": "adsense#accounts"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#adClient.",
- "default": "adsense#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#adClients.",
- "default": "adsense#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdCode": {
- "id": "AdCode",
- "type": "object",
- "properties": {
- "adCode": {
- "type": "string",
- "description": "The ad code snippet."
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#adCode.",
- "default": "adsense#adCode"
- }
- }
- },
- "AdStyle": {
- "id": "AdStyle",
- "type": "object",
- "properties": {
- "colors": {
- "type": "object",
- "description": "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.",
- "properties": {
- "background": {
- "type": "string",
- "description": "The color of the ad background."
- },
- "border": {
- "type": "string",
- "description": "The color of the ad border."
- },
- "text": {
- "type": "string",
- "description": "The color of the ad text."
- },
- "title": {
- "type": "string",
- "description": "The color of the ad title."
- },
- "url": {
- "type": "string",
- "description": "The color of the ad url."
- }
- }
- },
- "corners": {
- "type": "string",
- "description": "The style of the corners in the ad (deprecated: never populated, ignored)."
- },
- "font": {
- "type": "object",
- "description": "The font which is included in the style.",
- "properties": {
- "family": {
- "type": "string",
- "description": "The family of the font."
- },
- "size": {
- "type": "string",
- "description": "The size of the font."
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#adStyle.",
- "default": "adsense#adStyle"
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "contentAdsSettings": {
- "type": "object",
- "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).",
- "properties": {
- "backupOption": {
- "type": "object",
- "description": "The backup option to be used in instances where no ad is available.",
- "properties": {
- "color": {
- "type": "string",
- "description": "Color to use when type is set to COLOR."
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adsense": {
+ "description": "View and manage your AdSense data"
},
- "type": {
- "type": "string",
- "description": "Type of the backup option. Possible values are BLANK, COLOR and URL."
- },
- "url": {
- "type": "string",
- "description": "URL to use when type is set to URL."
+ "https://www.googleapis.com/auth/adsense.readonly": {
+ "description": "View your AdSense data"
}
- }
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
}
- }
+ }
+ },
+ "basePath": "/adsense/v1.4/",
+ "baseUrl": "https://www.googleapis.com/adsense/v1.4/",
+ "batchPath": "batch/adsense/v1.4",
+ "canonicalName": "AdSense",
+ "description": "Accesses AdSense publishers' inventory and generates performance reports.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/adsense/management/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/8_GH3r5fzMK8tmgovIuz_n7J2kU\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/adsense-16.png",
+ "x32": "https://www.google.com/images/icons/product/adsense-32.png"
+ },
+ "id": "adsense:v1.4",
+ "kind": "discovery#restDescription",
+ "name": "adsense",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "csv",
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of text/csv",
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "customStyle": {
- "$ref": "AdStyle",
- "description": "Custom style information specific to this ad unit."
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
},
- "feedAdsSettings": {
- "type": "object",
- "description": "Settings specific to feed ads (AFF) - deprecated.",
- "properties": {
- "adPosition": {
- "type": "string",
- "description": "The position of the ads relative to the feed entries."
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Get information about the selected AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.get",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to get information about.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "tree": {
+ "description": "Whether the tree of sub accounts should be returned.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "accounts/{accountId}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all accounts available to this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of accounts to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts",
+ "response": {
+ "$ref": "Accounts"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
},
- "frequency": {
- "type": "integer",
- "description": "The frequency at which ads should appear in the feed (i.e. every N entries).",
- "format": "int32"
- },
- "minimumWordCount": {
- "type": "integer",
- "description": "The minimum length an entry should be in order to have attached ads.",
- "format": "int32"
- },
- "type": {
- "type": "string",
- "description": "The type of ads which should appear."
+ "resources": {
+ "adclients": {
+ "methods": {
+ "list": {
+ "description": "List all ad clients in the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.adclients.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account for which to list ad clients.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ },
+ "adunits": {
+ "methods": {
+ "get": {
+ "description": "Gets the specified ad unit in the specified ad client for the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.adunits.get",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to get the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
+ "$ref": "AdUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "getAdCode": {
+ "description": "Get ad code for the specified ad unit.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.adunits.getAdCode",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad client.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client with contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to get the code for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
+ "response": {
+ "$ref": "AdCode"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all ad units in the specified ad client for the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.adunits.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "customchannels": {
+ "methods": {
+ "list": {
+ "description": "List all custom channels which the specified ad unit belongs to.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.adunits.customchannels.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client which contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "alerts": {
+ "methods": {
+ "delete": {
+ "description": "Dismiss (delete) the specified alert from the specified publisher AdSense account.",
+ "httpMethod": "DELETE",
+ "id": "adsense.accounts.alerts.delete",
+ "parameterOrder": [
+ "accountId",
+ "alertId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "alertId": {
+ "description": "Alert to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/alerts/{alertId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense"
+ ]
+ },
+ "list": {
+ "description": "List the alerts for the specified AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.alerts.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account for which to retrieve the alerts.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/alerts",
+ "response": {
+ "$ref": "Alerts"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ },
+ "customchannels": {
+ "methods": {
+ "get": {
+ "description": "Get the specified custom channel from the specified ad client for the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.customchannels.get",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all custom channels in the specified ad client for the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.customchannels.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "adunits": {
+ "methods": {
+ "list": {
+ "description": "List all ad units in the specified custom channel.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.customchannels.adunits.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "payments": {
+ "methods": {
+ "list": {
+ "description": "List the payments for the specified AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.payments.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account for which to retrieve the payments.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/payments",
+ "response": {
+ "$ref": "Payments"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "generate": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.reports.generate",
+ "parameterOrder": [
+ "accountId",
+ "startDate",
+ "endDate"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account upon which to report.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "currency": {
+ "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
+ "location": "query",
+ "pattern": "[a-zA-Z]+",
+ "type": "string"
+ },
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters to be run on the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "useTimezoneReporting": {
+ "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "accounts/{accountId}/reports",
+ "response": {
+ "$ref": "AdsenseReportsGenerateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ],
+ "supportsMediaDownload": true
+ }
+ },
+ "resources": {
+ "saved": {
+ "methods": {
+ "generate": {
+ "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.reports.saved.generate",
+ "parameterOrder": [
+ "accountId",
+ "savedReportId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the saved reports belong.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "savedReportId": {
+ "description": "The saved report to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{accountId}/reports/{savedReportId}",
+ "response": {
+ "$ref": "AdsenseReportsGenerateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all saved reports in the specified AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.reports.saved.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the saved reports belong.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of saved reports to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/reports/saved",
+ "response": {
+ "$ref": "SavedReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "savedadstyles": {
+ "methods": {
+ "get": {
+ "description": "List a specific saved ad style for the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.savedadstyles.get",
+ "parameterOrder": [
+ "accountId",
+ "savedAdStyleId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account for which to get the saved ad style.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "savedAdStyleId": {
+ "description": "Saved ad style to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
+ "response": {
+ "$ref": "SavedAdStyle"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all saved ad styles in the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.savedadstyles.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account for which to list saved ad styles.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of saved ad styles to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/savedadstyles",
+ "response": {
+ "$ref": "SavedAdStyles"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ },
+ "urlchannels": {
+ "methods": {
+ "list": {
+ "description": "List all URL channels in the specified ad client for the specified account.",
+ "httpMethod": "GET",
+ "id": "adsense.accounts.urlchannels.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to which the ad client belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to list URL channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
+ "response": {
+ "$ref": "UrlChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ }
}
- }
},
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#adUnit.",
- "default": "adsense#adUnit"
- },
- "mobileContentAdsSettings": {
- "type": "object",
- "description": "Settings specific to WAP mobile content ads (AFMC) - deprecated.",
- "properties": {
- "markupLanguage": {
- "type": "string",
- "description": "The markup language to use for this ad unit."
- },
- "scriptingLanguage": {
- "type": "string",
- "description": "The scripting language to use for this ad unit."
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- }
- }
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "savedStyleId": {
- "type": "string",
- "description": "ID of the saved ad style which holds this ad unit's style information."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- }
- }
- },
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#adUnits.",
- "default": "adsense#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdsenseReportsGenerateResponse": {
- "id": "AdsenseReportsGenerateResponse",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "endDate": {
- "type": "string",
- "description": "The requested end date in yyyy-mm-dd format."
- },
- "headers": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#report.",
- "default": "adsense#report"
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "startDate": {
- "type": "string",
- "description": "The requested start date in yyyy-mm-dd format."
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Alert": {
- "id": "Alert",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "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."
- },
- "isDismissible": {
- "type": "boolean",
- "description": "Whether this alert can be dismissed."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#alert.",
- "default": "adsense#alert"
- },
- "message": {
- "type": "string",
- "description": "The localized alert message."
- },
- "severity": {
- "type": "string",
- "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE."
- },
- "type": {
- "type": "string",
- "description": "Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD."
- }
- }
- },
- "Alerts": {
- "id": "Alerts",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The alerts returned in this list response.",
- "items": {
- "$ref": "Alert"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#alerts.",
- "default": "adsense#alerts"
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#customChannel.",
- "default": "adsense#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
- }
- }
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#customChannels.",
- "default": "adsense#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "ReportingMetadataEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#metadata.",
- "default": "adsense#metadata"
- }
- }
- },
- "Payment": {
- "id": "Payment",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this Payment."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#payment.",
- "default": "adsense#payment"
- },
- "paymentAmount": {
- "type": "string",
- "description": "The amount to be paid."
- },
- "paymentAmountCurrencyCode": {
- "type": "string",
- "description": "The currency code for the amount to be paid."
- },
- "paymentDate": {
- "type": "string",
- "description": "The date this payment was/will be credited to the user, or none if the payment threshold has not been met."
- }
- }
- },
- "Payments": {
- "id": "Payments",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "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": {
- "$ref": "Payment"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#payments.",
- "default": "adsense#payments"
- }
- }
- },
- "ReportingMetadataEntry": {
- "id": "ReportingMetadataEntry",
- "type": "object",
- "properties": {
- "compatibleDimensions": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "compatibleMetrics": {
- "type": "array",
- "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#reportingMetadataEntry.",
- "default": "adsense#reportingMetadataEntry"
- },
- "requiredDimensions": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "requiredMetrics": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "supportedProducts": {
- "type": "array",
- "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SavedAdStyle": {
- "id": "SavedAdStyle",
- "type": "object",
- "properties": {
- "adStyle": {
- "$ref": "AdStyle",
- "description": "The AdStyle itself."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#savedAdStyle.",
- "default": "adsense#savedAdStyle"
- },
- "name": {
- "type": "string",
- "description": "The user selected name of this SavedAdStyle."
- }
- }
- },
- "SavedAdStyles": {
- "id": "SavedAdStyles",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved ad styles returned in this list response.",
- "items": {
- "$ref": "SavedAdStyle"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#savedAdStyles.",
- "default": "adsense#savedAdStyles"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#savedReport.",
- "default": "adsense#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#savedReports.",
- "default": "adsense#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#urlChannel.",
- "default": "adsense#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#urlChannels.",
- "default": "adsense#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adsense.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about.",
- "required": true,
- "location": "path"
- },
- "tree": {
- "type": "boolean",
- "description": "Whether the tree of sub accounts should be returned.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "List all accounts available to this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of accounts to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
"adclients": {
- "methods": {
- "list": {
- "id": "adsense.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list ad clients.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "methods": {
+ "list": {
+ "description": "List all ad clients in this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.adclients.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
}
- }
},
"adunits": {
- "methods": {
- "get": {
- "id": "adsense.accounts.adunits.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
+ "methods": {
+ "get": {
+ "description": "Gets the specified ad unit in the specified ad client.",
+ "httpMethod": "GET",
+ "id": "adsense.adunits.get",
+ "parameterOrder": [
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to get the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
+ "$ref": "AdUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
},
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
+ "getAdCode": {
+ "description": "Get ad code for the specified ad unit.",
+ "httpMethod": "GET",
+ "id": "adsense.adunits.getAdCode",
+ "parameterOrder": [
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client with contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to get the code for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/adunits/{adUnitId}/adcode",
+ "response": {
+ "$ref": "AdCode"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
},
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "getAdCode": {
- "id": "adsense.accounts.adunits.getAdCode",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "httpMethod": "GET",
- "description": "Get ad code for the specified ad unit.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client with contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get the code for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
"list": {
- "id": "adsense.accounts.adunits.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
+ "description": "List all ad units in the specified ad client for this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.adunits.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
},
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
+ "path": "adclients/{adClientId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
},
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "customchannels": {
+ "methods": {
+ "list": {
+ "description": "List all custom channels which the specified ad unit belongs to.",
+ "httpMethod": "GET",
+ "id": "adsense.adunits.customchannels.list",
+ "parameterOrder": [
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
}
- }
}
- }
},
"alerts": {
- "methods": {
- "delete": {
- "id": "adsense.accounts.alerts.delete",
- "path": "accounts/{accountId}/alerts/{alertId}",
- "httpMethod": "DELETE",
- "description": "Dismiss (delete) the specified alert from the specified publisher AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad unit.",
- "required": true,
- "location": "path"
+ "methods": {
+ "delete": {
+ "description": "Dismiss (delete) the specified alert from the publisher's AdSense account.",
+ "httpMethod": "DELETE",
+ "id": "adsense.alerts.delete",
+ "parameterOrder": [
+ "alertId"
+ ],
+ "parameters": {
+ "alertId": {
+ "description": "Alert to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "alerts/{alertId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense"
+ ]
},
- "alertId": {
- "type": "string",
- "description": "Alert to delete.",
- "required": true,
- "location": "path"
+ "list": {
+ "description": "List the alerts for this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.alerts.list",
+ "parameters": {
+ "locale": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "alerts",
+ "response": {
+ "$ref": "Alerts"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
- },
- "parameterOrder": [
- "accountId",
- "alertId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adsense"
- ]
- },
- "list": {
- "id": "adsense.accounts.alerts.list",
- "path": "accounts/{accountId}/alerts",
- "httpMethod": "GET",
- "description": "List the alerts for the specified AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to retrieve the alerts.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
}
- }
},
"customchannels": {
- "methods": {
- "get": {
- "id": "adsense.accounts.customchannels.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
+ "methods": {
+ "get": {
+ "description": "Get the specified custom channel from the specified ad client.",
+ "httpMethod": "GET",
+ "id": "adsense.customchannels.get",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}",
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
},
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
"list": {
- "id": "adsense.accounts.customchannels.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
+ "description": "List all custom channels in the specified ad client for this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.customchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
},
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
+ "path": "adclients/{adClientId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
},
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "adunits": {
+ "methods": {
+ "list": {
+ "description": "List all ad units in the specified custom channel.",
+ "httpMethod": "GET",
+ "id": "adsense.customchannels.adunits.list",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client which contains the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "metadata": {
+ "resources": {
+ "dimensions": {
+ "methods": {
+ "list": {
+ "description": "List the metadata for the dimensions available to this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.metadata.dimensions.list",
+ "path": "metadata/dimensions",
+ "response": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "list": {
+ "description": "List the metadata for the metrics available to this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.metadata.metrics.list",
+ "path": "metadata/metrics",
+ "response": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
}
- }
}
- }
},
"payments": {
- "methods": {
- "list": {
- "id": "adsense.accounts.payments.list",
- "path": "accounts/{accountId}/payments",
- "httpMethod": "GET",
- "description": "List the payments for the specified AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to retrieve the payments.",
- "required": true,
- "location": "path"
+ "methods": {
+ "list": {
+ "description": "List the payments for this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.payments.list",
+ "path": "payments",
+ "response": {
+ "$ref": "Payments"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Payments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
}
- }
},
"reports": {
- "methods": {
- "generate": {
- "id": "adsense.accounts.reports.generate",
- "path": "accounts/{accountId}/reports",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account upon which to report.",
- "required": true,
- "location": "path"
- },
- "currency": {
- "type": "string",
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- "pattern": "[a-zA-Z]+",
- "location": "query"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "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.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- },
- "useTimezoneReporting": {
- "type": "boolean",
- "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
+ "methods": {
"generate": {
- "id": "adsense.accounts.reports.saved.generate",
- "path": "accounts/{accountId}/reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the saved reports belong.",
- "required": true,
- "location": "path"
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "adsense.reports.generate",
+ "parameterOrder": [
+ "startDate",
+ "endDate"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Accounts upon which to report.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "currency": {
+ "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
+ "location": "query",
+ "pattern": "[a-zA-Z]+",
+ "type": "string"
+ },
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters to be run on the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "useTimezoneReporting": {
+ "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
+ "location": "query",
+ "type": "boolean"
+ }
},
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
+ "path": "reports",
+ "response": {
+ "$ref": "AdsenseReportsGenerateResponse"
},
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "savedReportId"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.reports.saved.list",
- "path": "accounts/{accountId}/reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in the specified AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the saved reports belong.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ],
+ "supportsMediaDownload": true
+ }
+ },
+ "resources": {
+ "saved": {
+ "methods": {
+ "generate": {
+ "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
+ "httpMethod": "GET",
+ "id": "adsense.reports.saved.generate",
+ "parameterOrder": [
+ "savedReportId"
+ ],
+ "parameters": {
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "savedReportId": {
+ "description": "The saved report to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "reports/{savedReportId}",
+ "response": {
+ "$ref": "AdsenseReportsGenerateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ },
+ "list": {
+ "description": "List all saved reports in this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.reports.saved.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of saved reports to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "reports/saved",
+ "response": {
+ "$ref": "SavedReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
+ }
+ }
}
- }
}
- }
},
"savedadstyles": {
- "methods": {
- "get": {
- "id": "adsense.accounts.savedadstyles.get",
- "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
- "httpMethod": "GET",
- "description": "List a specific saved ad style for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to get the saved ad style.",
- "required": true,
- "location": "path"
+ "methods": {
+ "get": {
+ "description": "Get a specific saved ad style from the user's account.",
+ "httpMethod": "GET",
+ "id": "adsense.savedadstyles.get",
+ "parameterOrder": [
+ "savedAdStyleId"
+ ],
+ "parameters": {
+ "savedAdStyleId": {
+ "description": "Saved ad style to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "savedadstyles/{savedAdStyleId}",
+ "response": {
+ "$ref": "SavedAdStyle"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
},
- "savedAdStyleId": {
- "type": "string",
- "description": "Saved ad style to retrieve.",
- "required": true,
- "location": "path"
+ "list": {
+ "description": "List all saved ad styles in the user's account.",
+ "httpMethod": "GET",
+ "id": "adsense.savedadstyles.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of saved ad styles to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "savedadstyles",
+ "response": {
+ "$ref": "SavedAdStyles"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
- },
- "parameterOrder": [
- "accountId",
- "savedAdStyleId"
- ],
- "response": {
- "$ref": "SavedAdStyle"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.savedadstyles.list",
- "path": "accounts/{accountId}/savedadstyles",
- "httpMethod": "GET",
- "description": "List all saved ad styles in the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list saved ad styles.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedAdStyles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
}
- }
},
"urlchannels": {
- "methods": {
- "list": {
- "id": "adsense.accounts.urlchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "methods": {
+ "list": {
+ "description": "List all URL channels in the specified ad client for this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsense.urlchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list URL channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/urlchannels",
+ "response": {
+ "$ref": "UrlChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsense",
+ "https://www.googleapis.com/auth/adsense.readonly"
+ ]
}
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
}
- }
}
- }
},
- "adclients": {
- "methods": {
- "list": {
- "id": "adsense.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adsense.adunits.get",
- "path": "adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "getAdCode": {
- "id": "adsense.adunits.getAdCode",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "httpMethod": "GET",
- "description": "Get ad code for the specified ad unit.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client with contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get the code for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.adunits.list",
- "path": "adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adsense.adunits.customchannels.list",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
+ "revision": "20180204",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "id": "Account",
+ "properties": {
+ "creation_time": {
+ "format": "int64",
+ "type": "string"
},
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
+ "id": {
+ "description": "Unique identifier of this account.",
+ "type": "string"
},
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
+ "kind": {
+ "default": "adsense#account",
+ "description": "Kind of resource this is, in this case adsense#account.",
+ "type": "string"
},
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "name": {
+ "description": "Name of this account.",
+ "type": "string"
+ },
+ "premium": {
+ "description": "Whether this account is premium.",
+ "type": "boolean"
+ },
+ "subAccounts": {
+ "description": "Sub accounts of the this account.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "timezone": {
+ "description": "AdSense timezone of this account.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "alerts": {
- "methods": {
- "delete": {
- "id": "adsense.alerts.delete",
- "path": "alerts/{alertId}",
- "httpMethod": "DELETE",
- "description": "Dismiss (delete) the specified alert from the publisher's AdSense account.",
- "parameters": {
- "alertId": {
- "type": "string",
- "description": "Alert to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "alertId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adsense"
- ]
+ },
+ "type": "object"
},
- "list": {
- "id": "adsense.alerts.list",
- "path": "alerts",
- "httpMethod": "GET",
- "description": "List the alerts for this AdSense account.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adsense.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
- "list": {
- "id": "adsense.customchannels.adunits.list",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
+ "Accounts": {
+ "id": "Accounts",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
},
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
+ "items": {
+ "description": "The accounts returned in this list response.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
},
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
+ "kind": {
+ "default": "adsense#accounts",
+ "description": "Kind of list this is, in this case adsense#accounts.",
+ "type": "string"
},
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "nextPageToken": {
+ "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "metadata": {
- "resources": {
- "dimensions": {
- "methods": {
- "list": {
- "id": "adsense.metadata.dimensions.list",
- "path": "metadata/dimensions",
- "httpMethod": "GET",
- "description": "List the metadata for the dimensions available to this AdSense account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
+ },
+ "type": "object"
},
- "metrics": {
- "methods": {
- "list": {
- "id": "adsense.metadata.metrics.list",
- "path": "metadata/metrics",
- "httpMethod": "GET",
- "description": "List the metadata for the metrics available to this AdSense account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "payments": {
- "methods": {
- "list": {
- "id": "adsense.payments.list",
- "path": "payments",
- "httpMethod": "GET",
- "description": "List the payments for this AdSense account.",
- "response": {
- "$ref": "Payments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsense.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Accounts upon which to report.",
- "repeated": true,
- "location": "query"
- },
- "currency": {
- "type": "string",
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- "pattern": "[a-zA-Z]+",
- "location": "query"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "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.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- },
- "useTimezoneReporting": {
- "type": "boolean",
- "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adsense.reports.saved.generate",
- "path": "reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
+ "AdClient": {
+ "id": "AdClient",
+ "properties": {
+ "arcOptIn": {
+ "description": "Whether this ad client is opted in to ARC.",
+ "type": "boolean"
},
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
+ "id": {
+ "description": "Unique identifier of this ad client.",
+ "type": "string"
},
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
+ "kind": {
+ "default": "adsense#adClient",
+ "description": "Kind of resource this is, in this case adsense#adClient.",
+ "type": "string"
},
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
+ "productCode": {
+ "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.",
+ "type": "string"
+ },
+ "supportsReporting": {
+ "description": "Whether this ad client supports being reported on.",
+ "type": "boolean"
}
- },
- "parameterOrder": [
- "savedReportId"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
},
- "list": {
- "id": "adsense.reports.saved.list",
- "path": "reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "savedadstyles": {
- "methods": {
- "get": {
- "id": "adsense.savedadstyles.get",
- "path": "savedadstyles/{savedAdStyleId}",
- "httpMethod": "GET",
- "description": "Get a specific saved ad style from the user's account.",
- "parameters": {
- "savedAdStyleId": {
- "type": "string",
- "description": "Saved ad style to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "savedAdStyleId"
- ],
- "response": {
- "$ref": "SavedAdStyle"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
+ "type": "object"
},
- "list": {
- "id": "adsense.savedadstyles.list",
- "path": "savedadstyles",
- "httpMethod": "GET",
- "description": "List all saved ad styles in the user's account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
+ "AdClients": {
+ "id": "AdClients",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The ad clients returned in this list response.",
+ "items": {
+ "$ref": "AdClient"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#adClients",
+ "description": "Kind of list this is, in this case adsense#adClients.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
},
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedAdStyles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
+ "type": "object"
+ },
+ "AdCode": {
+ "id": "AdCode",
+ "properties": {
+ "adCode": {
+ "description": "The ad code snippet.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#adCode",
+ "description": "Kind this is, in this case adsense#adCode.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdStyle": {
+ "id": "AdStyle",
+ "properties": {
+ "colors": {
+ "description": "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.",
+ "properties": {
+ "background": {
+ "description": "The color of the ad background.",
+ "type": "string"
+ },
+ "border": {
+ "description": "The color of the ad border.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The color of the ad text.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The color of the ad title.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The color of the ad url.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "corners": {
+ "description": "The style of the corners in the ad (deprecated: never populated, ignored).",
+ "type": "string"
+ },
+ "font": {
+ "description": "The font which is included in the style.",
+ "properties": {
+ "family": {
+ "description": "The family of the font.",
+ "type": "string"
+ },
+ "size": {
+ "description": "The size of the font.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "kind": {
+ "default": "adsense#adStyle",
+ "description": "Kind this is, in this case adsense#adStyle.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdUnit": {
+ "id": "AdUnit",
+ "properties": {
+ "code": {
+ "description": "Identity code of this ad unit, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "contentAdsSettings": {
+ "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).",
+ "properties": {
+ "backupOption": {
+ "description": "The backup option to be used in instances where no ad is available.",
+ "properties": {
+ "color": {
+ "description": "Color to use when type is set to COLOR.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the backup option. Possible values are BLANK, COLOR and URL.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to use when type is set to URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "size": {
+ "description": "Size of this ad unit.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this ad unit.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "customStyle": {
+ "$ref": "AdStyle",
+ "description": "Custom style information specific to this ad unit."
+ },
+ "feedAdsSettings": {
+ "description": "Settings specific to feed ads (AFF) - deprecated.",
+ "properties": {
+ "adPosition": {
+ "description": "The position of the ads relative to the feed entries.",
+ "type": "string"
+ },
+ "frequency": {
+ "description": "The frequency at which ads should appear in the feed (i.e. every N entries).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minimumWordCount": {
+ "description": "The minimum length an entry should be in order to have attached ads.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": {
+ "description": "The type of ads which should appear.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#adUnit",
+ "description": "Kind of resource this is, in this case adsense#adUnit.",
+ "type": "string"
+ },
+ "mobileContentAdsSettings": {
+ "description": "Settings specific to WAP mobile content ads (AFMC) - deprecated.",
+ "properties": {
+ "markupLanguage": {
+ "description": "The markup language to use for this ad unit.",
+ "type": "string"
+ },
+ "scriptingLanguage": {
+ "description": "The scripting language to use for this ad unit.",
+ "type": "string"
+ },
+ "size": {
+ "description": "Size of this ad unit.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this ad unit.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "name": {
+ "description": "Name of this ad unit.",
+ "type": "string"
+ },
+ "savedStyleId": {
+ "description": "ID of the saved ad style which holds this ad unit's style information.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdUnits": {
+ "id": "AdUnits",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The ad units returned in this list response.",
+ "items": {
+ "$ref": "AdUnit"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#adUnits",
+ "description": "Kind of list this is, in this case adsense#adUnits.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdsenseReportsGenerateResponse": {
+ "id": "AdsenseReportsGenerateResponse",
+ "properties": {
+ "averages": {
+ "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "endDate": {
+ "description": "The requested end date in yyyy-mm-dd format.",
+ "type": "string"
+ },
+ "headers": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "currency": {
+ "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#report",
+ "description": "Kind this is, in this case adsense#report.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "startDate": {
+ "description": "The requested start date in yyyy-mm-dd format.",
+ "type": "string"
+ },
+ "totalMatchedRows": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totals": {
+ "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "warnings": {
+ "description": "Any warnings associated with generation of the report.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Alert": {
+ "id": "Alert",
+ "properties": {
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "isDismissible": {
+ "description": "Whether this alert can be dismissed.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "adsense#alert",
+ "description": "Kind of resource this is, in this case adsense#alert.",
+ "type": "string"
+ },
+ "message": {
+ "description": "The localized alert message.",
+ "type": "string"
+ },
+ "severity": {
+ "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ }
+ },
+ "type": "object"
+ },
+ "Alerts": {
+ "id": "Alerts",
+ "properties": {
+ "items": {
+ "description": "The alerts returned in this list response.",
+ "items": {
+ "$ref": "Alert"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#alerts",
+ "description": "Kind of list this is, in this case adsense#alerts.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannel": {
+ "id": "CustomChannel",
+ "properties": {
+ "code": {
+ "description": "Code of this custom channel, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#customChannel",
+ "description": "Kind of resource this is, in this case adsense#customChannel.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this custom channel.",
+ "type": "string"
+ },
+ "targetingInfo": {
+ "description": "The targeting information of this custom channel, if activated.",
+ "properties": {
+ "adsAppearOn": {
+ "description": "The name used to describe this channel externally.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The external description of the channel.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.",
+ "type": "string"
+ },
+ "siteLanguage": {
+ "description": "The language of the sites ads will be displayed on.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannels": {
+ "id": "CustomChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The custom channels returned in this list response.",
+ "items": {
+ "$ref": "CustomChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#customChannels",
+ "description": "Kind of list this is, in this case adsense#customChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Metadata": {
+ "id": "Metadata",
+ "properties": {
+ "items": {
+ "items": {
+ "$ref": "ReportingMetadataEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#metadata",
+ "description": "Kind of list this is, in this case adsense#metadata.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Payment": {
+ "id": "Payment",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of this Payment.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#payment",
+ "description": "Kind of resource this is, in this case adsense#payment.",
+ "type": "string"
+ },
+ "paymentAmount": {
+ "description": "The amount to be paid.",
+ "type": "string"
+ },
+ "paymentAmountCurrencyCode": {
+ "description": "The currency code for the amount to be paid.",
+ "type": "string"
+ },
+ "paymentDate": {
+ "description": "The date this payment was/will be credited to the user, or none if the payment threshold has not been met.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Payments": {
+ "id": "Payments",
+ "properties": {
+ "items": {
+ "description": "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": {
+ "$ref": "Payment"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#payments",
+ "description": "Kind of list this is, in this case adsense#payments.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportingMetadataEntry": {
+ "id": "ReportingMetadataEntry",
+ "properties": {
+ "compatibleDimensions": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "compatibleMetrics": {
+ "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#reportingMetadataEntry",
+ "description": "Kind of resource this is, in this case adsense#reportingMetadataEntry.",
+ "type": "string"
+ },
+ "requiredDimensions": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "requiredMetrics": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportedProducts": {
+ "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SavedAdStyle": {
+ "id": "SavedAdStyle",
+ "properties": {
+ "adStyle": {
+ "$ref": "AdStyle",
+ "description": "The AdStyle itself."
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#savedAdStyle",
+ "description": "Kind of resource this is, in this case adsense#savedAdStyle.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The user selected name of this SavedAdStyle.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SavedAdStyles": {
+ "id": "SavedAdStyles",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The saved ad styles returned in this list response.",
+ "items": {
+ "$ref": "SavedAdStyle"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#savedAdStyles",
+ "description": "Kind of list this is, in this case adsense#savedAdStyles.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SavedReport": {
+ "id": "SavedReport",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of this saved report.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#savedReport",
+ "description": "Kind of resource this is, in this case adsense#savedReport.",
+ "type": "string"
+ },
+ "name": {
+ "description": "This saved report's name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SavedReports": {
+ "id": "SavedReports",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The saved reports returned in this list response.",
+ "items": {
+ "$ref": "SavedReport"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#savedReports",
+ "description": "Kind of list this is, in this case adsense#savedReports.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannel": {
+ "id": "UrlChannel",
+ "properties": {
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsense#urlChannel",
+ "description": "Kind of resource this is, in this case adsense#urlChannel.",
+ "type": "string"
+ },
+ "urlPattern": {
+ "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannels": {
+ "id": "UrlChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The URL channels returned in this list response.",
+ "items": {
+ "$ref": "UrlChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsense#urlChannels",
+ "description": "Kind of list this is, in this case adsense#urlChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adsense.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "adsense/v1.4/",
+ "title": "AdSense Management API",
+ "version": "v1.4"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-api.json b/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-api.json
index b87fc9d18..aff7f974c 100644
--- a/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-api.json
+++ b/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-api.json
@@ -1,1569 +1,1569 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/HzRIN4Gi3jUuNGWAsKKaxu4tH4k\"",
- "discoveryVersion": "v1",
- "id": "adsensehost:v4.1",
- "name": "adsensehost",
- "canonicalName": "AdSense Host",
- "version": "v4.1",
- "revision": "20170912",
- "title": "AdSense Host API",
- "description": "Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/host/",
- "labels": [
- "limited_availability"
- ],
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adsensehost/v4.1/",
- "basePath": "/adsensehost/v4.1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adsensehost/v4.1/",
- "batchPath": "batch/adsensehost/v4.1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adsensehost": {
- "description": "View and manage your AdSense host data and associated accounts"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#account.",
- "default": "adsensehost#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- },
- "status": {
- "type": "string",
- "description": "Approval status of this account. One of: PENDING, APPROVED, DISABLED."
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The accounts returned in this list response.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#accounts.",
- "default": "adsensehost#accounts"
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#adClient.",
- "default": "adsensehost#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#adClients.",
- "default": "adsensehost#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdCode": {
- "id": "AdCode",
- "type": "object",
- "properties": {
- "adCode": {
- "type": "string",
- "description": "The ad code snippet."
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsensehost#adCode.",
- "default": "adsensehost#adCode"
- }
- }
- },
- "AdStyle": {
- "id": "AdStyle",
- "type": "object",
- "properties": {
- "colors": {
- "type": "object",
- "description": "The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
- "properties": {
- "background": {
- "type": "string",
- "description": "The color of the ad background."
- },
- "border": {
- "type": "string",
- "description": "The color of the ad border."
- },
- "text": {
- "type": "string",
- "description": "The color of the ad text."
- },
- "title": {
- "type": "string",
- "description": "The color of the ad title."
- },
- "url": {
- "type": "string",
- "description": "The color of the ad url."
- }
- }
- },
- "corners": {
- "type": "string",
- "description": "The style of the corners in the ad (deprecated: never populated, ignored)."
- },
- "font": {
- "type": "object",
- "description": "The font which is included in the style.",
- "properties": {
- "family": {
- "type": "string",
- "description": "The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA."
- },
- "size": {
- "type": "string",
- "description": "The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE."
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsensehost#adStyle.",
- "default": "adsensehost#adStyle"
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "contentAdsSettings": {
- "type": "object",
- "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).",
- "properties": {
- "backupOption": {
- "type": "object",
- "description": "The backup option to be used in instances where no ad is available.",
- "properties": {
- "color": {
- "type": "string",
- "description": "Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash."
- },
- "type": {
- "type": "string",
- "description": "Type of the backup option. Possible values are BLANK, COLOR and URL."
- },
- "url": {
- "type": "string",
- "description": "URL to use when type is set to URL."
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adsensehost": {
+ "description": "View and manage your AdSense host data and associated accounts"
}
- }
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit. Size values are in the form SIZE_{width}_{height}."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK."
}
- }
- },
- "customStyle": {
- "$ref": "AdStyle",
- "description": "Custom style information specific to this ad unit."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#adUnit.",
- "default": "adsensehost#adUnit"
- },
- "mobileContentAdsSettings": {
- "type": "object",
- "description": "Settings specific to WAP mobile content ads (AFMC - deprecated).",
- "properties": {
- "markupLanguage": {
- "type": "string",
- "description": "The markup language to use for this ad unit."
- },
- "scriptingLanguage": {
- "type": "string",
- "description": "The scripting language to use for this ad unit."
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- }
- }
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
}
- }
},
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#adUnits.",
- "default": "adsensehost#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
+ "basePath": "/adsensehost/v4.1/",
+ "baseUrl": "https://www.googleapis.com/adsensehost/v4.1/",
+ "batchPath": "batch/adsensehost/v4.1",
+ "canonicalName": "AdSense Host",
+ "description": "Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/adsense/host/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/GgWkCMn0Gu9PJFDrmlIZU1uRxE0\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/adsense-16.png",
+ "x32": "https://www.google.com/images/icons/product/adsense-32.png"
},
- "AssociationSession": {
- "id": "AssociationSession",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Hosted account id of the associated publisher after association. Present if status is ACCEPTED."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this association session."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#associationSession.",
- "default": "adsensehost#associationSession"
- },
- "productCodes": {
- "type": "array",
- "description": "The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated)",
- "items": {
+ "id": "adsensehost:v4.1",
+ "kind": "discovery#restDescription",
+ "labels": [
+ "limited_availability"
+ ],
+ "name": "adsensehost",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "csv",
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of text/csv",
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
},
- "redirectUrl": {
- "type": "string",
- "description": "Redirect URL of this association session. Used to redirect users into the AdSense association flow."
- },
- "status": {
- "type": "string",
- "description": "Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR."
- },
- "userLocale": {
- "type": "string",
- "description": "The preferred locale of the user themselves when going through the AdSense association flow."
- },
- "websiteLocale": {
- "type": "string",
- "description": "The locale of the user's hosted website."
- },
- "websiteUrl": {
- "type": "string",
- "description": "The URL of the user's hosted website."
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#customChannel.",
- "default": "adsensehost#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#customChannels.",
- "default": "adsensehost#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
},
- "headers": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsensehost#report.",
- "default": "adsensehost#report"
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
+ "key": {
+ "description": "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.",
+ "location": "query",
"type": "string"
- }
},
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
"type": "string"
- }
}
- }
},
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#urlChannel.",
- "default": "adsensehost#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#urlChannels.",
- "default": "adsensehost#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adsensehost.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected associated AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about.",
- "required": true,
- "location": "path"
+ "protocol": "rest",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "get": {
+ "description": "Get information about the selected associated AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.get",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account to get information about.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}",
+ "response": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "list": {
+ "description": "List hosted accounts associated with this AdSense account by ad client id.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.list",
+ "parameterOrder": [
+ "filterAdClientId"
+ ],
+ "parameters": {
+ "filterAdClientId": {
+ "description": "Ad clients to list accounts for.",
+ "location": "query",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts",
+ "response": {
+ "$ref": "Accounts"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ },
+ "resources": {
+ "adclients": {
+ "methods": {
+ "get": {
+ "description": "Get information about one of the ad clients in the specified publisher's AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.adclients.get",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad client.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}",
+ "response": {
+ "$ref": "AdClient"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "list": {
+ "description": "List all hosted ad clients in the specified hosted account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.adclients.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account for which to list ad clients.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
+ },
+ "adunits": {
+ "methods": {
+ "delete": {
+ "description": "Delete the specified ad unit from the specified publisher AdSense account.",
+ "httpMethod": "DELETE",
+ "id": "adsensehost.accounts.adunits.delete",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to get ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
+ "$ref": "AdUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "get": {
+ "description": "Get the specified host ad unit in this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.adunits.get",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to get ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
+ "response": {
+ "$ref": "AdUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "getAdCode": {
+ "description": "Get ad code for the specified ad unit, attaching the specified host custom channels.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.adunits.getAdCode",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad client.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client with contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to get the code for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "hostCustomChannelId": {
+ "description": "Host custom channel to attach to the ad code.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
+ "response": {
+ "$ref": "AdCode"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "insert": {
+ "description": "Insert the supplied ad unit into the specified publisher AdSense account.",
+ "httpMethod": "POST",
+ "id": "adsensehost.accounts.adunits.insert",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which will contain the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client into which to insert the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
+ "request": {
+ "$ref": "AdUnit"
+ },
+ "response": {
+ "$ref": "AdUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "list": {
+ "description": "List all ad units in the specified publisher's AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.adunits.list",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad client.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client for which to list ad units.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "Whether to include inactive ad units. Default: true.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of ad units to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
+ "response": {
+ "$ref": "AdUnits"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "patch": {
+ "description": "Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adsensehost.accounts.adunits.patch",
+ "parameterOrder": [
+ "accountId",
+ "adClientId",
+ "adUnitId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad client.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client which contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adUnitId": {
+ "description": "Ad unit to get.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
+ "request": {
+ "$ref": "AdUnit"
+ },
+ "response": {
+ "$ref": "AdUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "update": {
+ "description": "Update the supplied ad unit in the specified publisher AdSense account.",
+ "httpMethod": "PUT",
+ "id": "adsensehost.accounts.adunits.update",
+ "parameterOrder": [
+ "accountId",
+ "adClientId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account which contains the ad client.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "adClientId": {
+ "description": "Ad client which contains the ad unit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
+ "request": {
+ "$ref": "AdUnit"
+ },
+ "response": {
+ "$ref": "AdUnit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "generate": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "adsensehost.accounts.reports.generate",
+ "parameterOrder": [
+ "accountId",
+ "startDate",
+ "endDate"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Hosted account upon which to report.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters to be run on the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "accounts/{accountId}/reports",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
+ }
}
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
},
- "list": {
- "id": "adsensehost.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "List hosted accounts associated with this AdSense account by ad client id.",
- "parameters": {
- "filterAdClientId": {
- "type": "string",
- "description": "Ad clients to list accounts for.",
- "required": true,
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "filterAdClientId"
- ],
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- },
- "resources": {
"adclients": {
- "methods": {
- "get": {
- "id": "adsensehost.accounts.adclients.get",
- "path": "accounts/{accountId}/adclients/{adClientId}",
- "httpMethod": "GET",
- "description": "Get information about one of the ad clients in the specified publisher's AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
+ "methods": {
+ "get": {
+ "description": "Get information about one of the ad clients in the Host AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.adclients.get",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}",
+ "response": {
+ "$ref": "AdClient"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
},
- "adClientId": {
- "type": "string",
- "description": "Ad client to get.",
- "required": true,
- "location": "path"
+ "list": {
+ "description": "List all host ad clients in this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.adclients.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of ad clients to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients",
+ "response": {
+ "$ref": "AdClients"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
}
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "AdClient"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
- "httpMethod": "GET",
- "description": "List all hosted ad clients in the specified hosted account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list ad clients.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
}
- }
},
- "adunits": {
- "methods": {
- "delete": {
- "id": "adsensehost.accounts.adunits.delete",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "DELETE",
- "description": "Delete the specified ad unit from the specified publisher AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad unit.",
- "required": true,
- "location": "path"
+ "associationsessions": {
+ "methods": {
+ "start": {
+ "description": "Create an association session for initiating an association with an AdSense user.",
+ "httpMethod": "GET",
+ "id": "adsensehost.associationsessions.start",
+ "parameterOrder": [
+ "productCode",
+ "websiteUrl"
+ ],
+ "parameters": {
+ "productCode": {
+ "description": "Products to associate with the user.",
+ "enum": [
+ "AFC",
+ "AFG",
+ "AFMC",
+ "AFS",
+ "AFV"
+ ],
+ "enumDescriptions": [
+ "AdSense For Content",
+ "AdSense For Games",
+ "AdSense For Mobile Content - deprecated",
+ "AdSense For Search - deprecated",
+ "AdSense For Video"
+ ],
+ "location": "query",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ },
+ "userLocale": {
+ "description": "The preferred locale of the user.",
+ "location": "query",
+ "type": "string"
+ },
+ "websiteLocale": {
+ "description": "The locale of the user's hosted website.",
+ "location": "query",
+ "type": "string"
+ },
+ "websiteUrl": {
+ "description": "The URL of the user's hosted website.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "associationsessions/start",
+ "response": {
+ "$ref": "AssociationSession"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
},
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to delete.",
- "required": true,
- "location": "path"
+ "verify": {
+ "description": "Verify an association session after the association callback returns from AdSense signup.",
+ "httpMethod": "GET",
+ "id": "adsensehost.associationsessions.verify",
+ "parameterOrder": [
+ "token"
+ ],
+ "parameters": {
+ "token": {
+ "description": "The token returned to the association callback URL.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "associationsessions/verify",
+ "response": {
+ "$ref": "AssociationSession"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
+ },
+ "customchannels": {
+ "methods": {
+ "delete": {
+ "description": "Delete a specific custom channel from the host AdSense account.",
+ "httpMethod": "DELETE",
+ "id": "adsensehost.customchannels.delete",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client from which to delete the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}",
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "get": {
+ "description": "Get a specific custom channel from the host AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.customchannels.get",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client from which to get the custom channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels/{customChannelId}",
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "insert": {
+ "description": "Add a new custom channel to the host AdSense account.",
+ "httpMethod": "POST",
+ "id": "adsensehost.customchannels.insert",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client to which the new custom channel will be added.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels",
+ "request": {
+ "$ref": "CustomChannel"
+ },
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "list": {
+ "description": "List all host custom channels in this AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.customchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list custom channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of custom channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels",
+ "response": {
+ "$ref": "CustomChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "patch": {
+ "description": "Update a custom channel in the host AdSense account. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "adsensehost.customchannels.patch",
+ "parameterOrder": [
+ "adClientId",
+ "customChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client in which the custom channel will be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customChannelId": {
+ "description": "Custom channel to get.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels",
+ "request": {
+ "$ref": "CustomChannel"
+ },
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "update": {
+ "description": "Update a custom channel in the host AdSense account.",
+ "httpMethod": "PUT",
+ "id": "adsensehost.customchannels.update",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client in which the custom channel will be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/customchannels",
+ "request": {
+ "$ref": "CustomChannel"
+ },
+ "response": {
+ "$ref": "CustomChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
}
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "get": {
- "id": "adsensehost.accounts.adunits.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Get the specified host ad unit in this AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "getAdCode": {
- "id": "adsensehost.accounts.adunits.getAdCode",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "httpMethod": "GET",
- "description": "Get ad code for the specified ad unit, attaching the specified host custom channels.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client with contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get the code for.",
- "required": true,
- "location": "path"
- },
- "hostCustomChannelId": {
- "type": "string",
- "description": "Host custom channel to attach to the ad code.",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "insert": {
- "id": "adsensehost.accounts.adunits.insert",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "POST",
- "description": "Insert the supplied ad unit into the specified publisher AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which will contain the ad unit.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client into which to insert the ad unit.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "request": {
- "$ref": "AdUnit"
- },
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.accounts.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified publisher's AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "patch": {
- "id": "adsensehost.accounts.adunits.patch",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "PATCH",
- "description": "Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "request": {
- "$ref": "AdUnit"
- },
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "update": {
- "id": "adsensehost.accounts.adunits.update",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "PUT",
- "description": "Update the supplied ad unit in the specified publisher AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "request": {
- "$ref": "AdUnit"
- },
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
}
- }
},
"reports": {
- "methods": {
- "generate": {
- "id": "adsensehost.accounts.reports.generate",
- "path": "accounts/{accountId}/reports",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Hosted account upon which to report.",
- "required": true,
- "location": "path"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "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.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
+ "methods": {
+ "generate": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "adsensehost.reports.generate",
+ "parameterOrder": [
+ "startDate",
+ "endDate"
+ ],
+ "parameters": {
+ "dimension": {
+ "description": "Dimensions to base the report on.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters to be run on the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+(==|=@).+",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of rows of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "50000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "metric": {
+ "description": "Numeric columns to include in the report.",
+ "location": "query",
+ "pattern": "[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "(\\+|-)?[a-zA-Z_]+",
+ "repeated": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
+ "location": "query",
+ "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first row of report data to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "5000",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "reports",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ }
+ }
+ },
+ "urlchannels": {
+ "methods": {
+ "delete": {
+ "description": "Delete a URL channel from the host AdSense account.",
+ "httpMethod": "DELETE",
+ "id": "adsensehost.urlchannels.delete",
+ "parameterOrder": [
+ "adClientId",
+ "urlChannelId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client from which to delete the URL channel.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "urlChannelId": {
+ "description": "URL channel to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/urlchannels/{urlChannelId}",
+ "response": {
+ "$ref": "UrlChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "insert": {
+ "description": "Add a new URL channel to the host AdSense account.",
+ "httpMethod": "POST",
+ "id": "adsensehost.urlchannels.insert",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client to which the new URL channel will be added.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/urlchannels",
+ "request": {
+ "$ref": "UrlChannel"
+ },
+ "response": {
+ "$ref": "UrlChannel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
+ },
+ "list": {
+ "description": "List all host URL channels in the host AdSense account.",
+ "httpMethod": "GET",
+ "id": "adsensehost.urlchannels.list",
+ "parameterOrder": [
+ "adClientId"
+ ],
+ "parameters": {
+ "adClientId": {
+ "description": "Ad client for which to list URL channels.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of URL channels to include in the response, used for paging.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "10000",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "adclients/{adClientId}/urlchannels",
+ "response": {
+ "$ref": "UrlChannels"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adsensehost"
+ ]
}
- },
- "parameterOrder": [
- "accountId",
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
}
- }
}
- }
},
- "adclients": {
- "methods": {
- "get": {
- "id": "adsensehost.adclients.get",
- "path": "adclients/{adClientId}",
- "httpMethod": "GET",
- "description": "Get information about one of the ad clients in the Host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdClient"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all host ad clients in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
+ "revision": "20180204",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "id": "Account",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of this account.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsensehost#account",
+ "description": "Kind of resource this is, in this case adsensehost#account.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this account.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Approval status of this account. One of: PENDING, APPROVED, DISABLED.",
+ "type": "string"
+ }
},
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
+ "type": "object"
+ },
+ "Accounts": {
+ "id": "Accounts",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The accounts returned in this list response.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsensehost#accounts",
+ "description": "Kind of list this is, in this case adsensehost#accounts.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdClient": {
+ "id": "AdClient",
+ "properties": {
+ "arcOptIn": {
+ "description": "Whether this ad client is opted in to ARC.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Unique identifier of this ad client.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsensehost#adClient",
+ "description": "Kind of resource this is, in this case adsensehost#adClient.",
+ "type": "string"
+ },
+ "productCode": {
+ "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.",
+ "type": "string"
+ },
+ "supportsReporting": {
+ "description": "Whether this ad client supports being reported on.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AdClients": {
+ "id": "AdClients",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The ad clients returned in this list response.",
+ "items": {
+ "$ref": "AdClient"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsensehost#adClients",
+ "description": "Kind of list this is, in this case adsensehost#adClients.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdCode": {
+ "id": "AdCode",
+ "properties": {
+ "adCode": {
+ "description": "The ad code snippet.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsensehost#adCode",
+ "description": "Kind this is, in this case adsensehost#adCode.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdStyle": {
+ "id": "AdStyle",
+ "properties": {
+ "colors": {
+ "description": "The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
+ "properties": {
+ "background": {
+ "description": "The color of the ad background.",
+ "type": "string"
+ },
+ "border": {
+ "description": "The color of the ad border.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The color of the ad text.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The color of the ad title.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The color of the ad url.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "corners": {
+ "description": "The style of the corners in the ad (deprecated: never populated, ignored).",
+ "type": "string"
+ },
+ "font": {
+ "description": "The font which is included in the style.",
+ "properties": {
+ "family": {
+ "description": "The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.",
+ "type": "string"
+ },
+ "size": {
+ "description": "The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "kind": {
+ "default": "adsensehost#adStyle",
+ "description": "Kind this is, in this case adsensehost#adStyle.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdUnit": {
+ "id": "AdUnit",
+ "properties": {
+ "code": {
+ "description": "Identity code of this ad unit, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "contentAdsSettings": {
+ "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).",
+ "properties": {
+ "backupOption": {
+ "description": "The backup option to be used in instances where no ad is available.",
+ "properties": {
+ "color": {
+ "description": "Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the backup option. Possible values are BLANK, COLOR and URL.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to use when type is set to URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "size": {
+ "description": "Size of this ad unit. Size values are in the form SIZE_{width}_{height}.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "customStyle": {
+ "$ref": "AdStyle",
+ "description": "Custom style information specific to this ad unit."
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsensehost#adUnit",
+ "description": "Kind of resource this is, in this case adsensehost#adUnit.",
+ "type": "string"
+ },
+ "mobileContentAdsSettings": {
+ "description": "Settings specific to WAP mobile content ads (AFMC - deprecated).",
+ "properties": {
+ "markupLanguage": {
+ "description": "The markup language to use for this ad unit.",
+ "type": "string"
+ },
+ "scriptingLanguage": {
+ "description": "The scripting language to use for this ad unit.",
+ "type": "string"
+ },
+ "size": {
+ "description": "Size of this ad unit.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this ad unit.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "name": {
+ "description": "Name of this ad unit.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdUnits": {
+ "id": "AdUnits",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The ad units returned in this list response.",
+ "items": {
+ "$ref": "AdUnit"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsensehost#adUnits",
+ "description": "Kind of list this is, in this case adsensehost#adUnits.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AssociationSession": {
+ "id": "AssociationSession",
+ "properties": {
+ "accountId": {
+ "description": "Hosted account id of the associated publisher after association. Present if status is ACCEPTED.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of this association session.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsensehost#associationSession",
+ "description": "Kind of resource this is, in this case adsensehost#associationSession.",
+ "type": "string"
+ },
+ "productCodes": {
+ "description": "The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "redirectUrl": {
+ "description": "Redirect URL of this association session. Used to redirect users into the AdSense association flow.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.",
+ "type": "string"
+ },
+ "userLocale": {
+ "description": "The preferred locale of the user themselves when going through the AdSense association flow.",
+ "type": "string"
+ },
+ "websiteLocale": {
+ "description": "The locale of the user's hosted website.",
+ "type": "string"
+ },
+ "websiteUrl": {
+ "description": "The URL of the user's hosted website.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannel": {
+ "id": "CustomChannel",
+ "properties": {
+ "code": {
+ "description": "Code of this custom channel, not necessarily unique across ad clients.",
+ "type": "string"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsensehost#customChannel",
+ "description": "Kind of resource this is, in this case adsensehost#customChannel.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this custom channel.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomChannels": {
+ "id": "CustomChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The custom channels returned in this list response.",
+ "items": {
+ "$ref": "CustomChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsensehost#customChannels",
+ "description": "Kind of list this is, in this case adsensehost#customChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "id": "Report",
+ "properties": {
+ "averages": {
+ "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "currency": {
+ "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsensehost#report",
+ "description": "Kind this is, in this case adsensehost#report.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "totalMatchedRows": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totals": {
+ "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "warnings": {
+ "description": "Any warnings associated with generation of the report.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannel": {
+ "id": "UrlChannel",
+ "properties": {
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "adsensehost#urlChannel",
+ "description": "Kind of resource this is, in this case adsensehost#urlChannel.",
+ "type": "string"
+ },
+ "urlPattern": {
+ "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlChannels": {
+ "id": "UrlChannels",
+ "properties": {
+ "etag": {
+ "description": "ETag of this response for caching purposes.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The URL channels returned in this list response.",
+ "items": {
+ "$ref": "UrlChannel"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "adsensehost#urlChannels",
+ "description": "Kind of list this is, in this case adsensehost#urlChannels.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "associationsessions": {
- "methods": {
- "start": {
- "id": "adsensehost.associationsessions.start",
- "path": "associationsessions/start",
- "httpMethod": "GET",
- "description": "Create an association session for initiating an association with an AdSense user.",
- "parameters": {
- "productCode": {
- "type": "string",
- "description": "Products to associate with the user.",
- "required": true,
- "enum": [
- "AFC",
- "AFG",
- "AFMC",
- "AFS",
- "AFV"
- ],
- "enumDescriptions": [
- "AdSense For Content",
- "AdSense For Games",
- "AdSense For Mobile Content - deprecated",
- "AdSense For Search - deprecated",
- "AdSense For Video"
- ],
- "repeated": true,
- "location": "query"
- },
- "userLocale": {
- "type": "string",
- "description": "The preferred locale of the user.",
- "location": "query"
- },
- "websiteLocale": {
- "type": "string",
- "description": "The locale of the user's hosted website.",
- "location": "query"
- },
- "websiteUrl": {
- "type": "string",
- "description": "The URL of the user's hosted website.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "productCode",
- "websiteUrl"
- ],
- "response": {
- "$ref": "AssociationSession"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "verify": {
- "id": "adsensehost.associationsessions.verify",
- "path": "associationsessions/verify",
- "httpMethod": "GET",
- "description": "Verify an association session after the association callback returns from AdSense signup.",
- "parameters": {
- "token": {
- "type": "string",
- "description": "The token returned to the association callback URL.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "token"
- ],
- "response": {
- "$ref": "AssociationSession"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "delete": {
- "id": "adsensehost.customchannels.delete",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "DELETE",
- "description": "Delete a specific custom channel from the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client from which to delete the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "get": {
- "id": "adsensehost.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get a specific custom channel from the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client from which to get the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "insert": {
- "id": "adsensehost.customchannels.insert",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "POST",
- "description": "Add a new custom channel to the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client to which the new custom channel will be added.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "request": {
- "$ref": "CustomChannel"
- },
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all host custom channels in this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "patch": {
- "id": "adsensehost.customchannels.patch",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "PATCH",
- "description": "Update a custom channel in the host AdSense account. This method supports patch semantics.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client in which the custom channel will be updated.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to get.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "request": {
- "$ref": "CustomChannel"
- },
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "update": {
- "id": "adsensehost.customchannels.update",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "PUT",
- "description": "Update a custom channel in the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client in which the custom channel will be updated.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "request": {
- "$ref": "CustomChannel"
- },
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsensehost.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "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.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- },
- "urlchannels": {
- "methods": {
- "delete": {
- "id": "adsensehost.urlchannels.delete",
- "path": "adclients/{adClientId}/urlchannels/{urlChannelId}",
- "httpMethod": "DELETE",
- "description": "Delete a URL channel from the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client from which to delete the URL channel.",
- "required": true,
- "location": "path"
- },
- "urlChannelId": {
- "type": "string",
- "description": "URL channel to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "urlChannelId"
- ],
- "response": {
- "$ref": "UrlChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "insert": {
- "id": "adsensehost.urlchannels.insert",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "POST",
- "description": "Add a new URL channel to the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client to which the new URL channel will be added.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "request": {
- "$ref": "UrlChannel"
- },
- "response": {
- "$ref": "UrlChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all host URL channels in the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "adsensehost/v4.1/",
+ "title": "AdSense Host API",
+ "version": "v4.1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/analytics/v2.4/analytics-api.json b/vendor/google.golang.org/api/analytics/v2.4/analytics-api.json
index 92506614d..8ec28ce55 100644
--- a/vendor/google.golang.org/api/analytics/v2.4/analytics-api.json
+++ b/vendor/google.golang.org/api/analytics/v2.4/analytics-api.json
@@ -1,366 +1,366 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/kYN47VW3boRYzE7pkj4HK3FyEC0\"",
- "discoveryVersion": "v1",
- "id": "analytics:v2.4",
- "name": "analytics",
- "version": "v2.4",
- "revision": "20170807",
- "title": "Google Analytics API",
- "description": "Views and manages your Google Analytics data.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/analytics-16.png",
- "x32": "https://www.google.com/images/icons/product/analytics-32.png"
- },
- "documentationLink": "https://developers.google.com/analytics/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/analytics/v2.4/",
- "basePath": "/analytics/v2.4/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "analytics/v2.4/",
- "batchPath": "batch/analytics/v2.4",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "atom",
- "enum": [
- "atom"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/atom+xml"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "false",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/analytics": {
- "description": "View and manage your Google Analytics data"
- },
- "https://www.googleapis.com/auth/analytics.readonly": {
- "description": "View your Google Analytics data"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/analytics": {
+ "description": "View and manage your Google Analytics data"
+ },
+ "https://www.googleapis.com/auth/analytics.readonly": {
+ "description": "View your Google Analytics data"
+ }
+ }
}
- }
- }
- },
- "resources": {
- "data": {
- "methods": {
- "get": {
- "id": "analytics.data.get",
- "path": "data",
- "httpMethod": "GET",
- "description": "Returns Analytics report data for a view (profile).",
- "parameters": {
- "dimensions": {
- "type": "string",
- "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
- "pattern": "(ga:.+)?",
- "location": "query"
- },
- "end-date": {
- "type": "string",
- "description": "End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
- "location": "query"
- },
- "filters": {
- "type": "string",
- "description": "A comma-separated list of dimension or metric filters to be applied to the report data.",
- "pattern": "ga:.+",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- "required": true,
- "pattern": "ga:[0-9]+",
- "location": "query"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of entries to include in this feed.",
- "format": "int32",
- "location": "query"
- },
- "metrics": {
- "type": "string",
- "description": "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.",
- "required": true,
- "pattern": "ga:.+",
- "location": "query"
- },
- "segment": {
- "type": "string",
- "description": "An Analytics advanced segment to be applied to the report data.",
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "A comma-separated list of dimensions or metrics that determine the sort order for the report data.",
- "pattern": "(-)?ga:.+",
- "location": "query"
- },
- "start-date": {
- "type": "string",
- "description": "Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "ids",
- "start-date",
- "end-date",
- "metrics"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
},
- "management": {
- "resources": {
- "accounts": {
- "methods": {
- "list": {
- "id": "analytics.management.accounts.list",
- "path": "management/accounts",
- "httpMethod": "GET",
- "description": "Lists all accounts to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of accounts to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ "basePath": "/analytics/v2.4/",
+ "baseUrl": "https://www.googleapis.com/analytics/v2.4/",
+ "batchPath": "batch/analytics/v2.4",
+ "description": "Views and manages your Google Analytics data.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/analytics/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/ulqmidM-fMam4LKTNGEvE0WurA4\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/analytics-16.png",
+ "x32": "https://www.google.com/images/icons/product/analytics-32.png"
+ },
+ "id": "analytics:v2.4",
+ "kind": "discovery#restDescription",
+ "name": "analytics",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "atom",
+ "description": "Data format for the response.",
+ "enum": [
+ "atom"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/atom+xml"
+ ],
+ "location": "query",
+ "type": "string"
},
- "goals": {
- "methods": {
- "list": {
- "id": "analytics.management.goals.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
- "httpMethod": "GET",
- "description": "Lists goals to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of goals to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
},
- "profiles": {
- "methods": {
- "list": {
- "id": "analytics.management.profiles.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
- "httpMethod": "GET",
- "description": "Lists views (profiles) to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of views (profiles) to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
},
- "segments": {
- "methods": {
- "list": {
- "id": "analytics.management.segments.list",
- "path": "management/segments",
- "httpMethod": "GET",
- "description": "Lists advanced segments to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of advanced segments to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "webproperties": {
- "methods": {
- "list": {
- "id": "analytics.management.webproperties.list",
- "path": "management/accounts/{accountId}/webproperties",
- "httpMethod": "GET",
- "description": "Lists web properties to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of web properties to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ "prettyPrint": {
+ "default": "false",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
- }
- }
-}
+ },
+ "protocol": "rest",
+ "resources": {
+ "data": {
+ "methods": {
+ "get": {
+ "description": "Returns Analytics report data for a view (profile).",
+ "httpMethod": "GET",
+ "id": "analytics.data.get",
+ "parameterOrder": [
+ "ids",
+ "start-date",
+ "end-date",
+ "metrics"
+ ],
+ "parameters": {
+ "dimensions": {
+ "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
+ "location": "query",
+ "pattern": "(ga:.+)?",
+ "type": "string"
+ },
+ "end-date": {
+ "description": "End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.",
+ "location": "query",
+ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
+ "required": true,
+ "type": "string"
+ },
+ "filters": {
+ "description": "A comma-separated list of dimension or metric filters to be applied to the report data.",
+ "location": "query",
+ "pattern": "ga:.+",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
+ "location": "query",
+ "pattern": "ga:[0-9]+",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of entries to include in this feed.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "ga:.+",
+ "required": true,
+ "type": "string"
+ },
+ "segment": {
+ "description": "An Analytics advanced segment to be applied to the report data.",
+ "location": "query",
+ "type": "string"
+ },
+ "sort": {
+ "description": "A comma-separated list of dimensions or metrics that determine the sort order for the report data.",
+ "location": "query",
+ "pattern": "(-)?ga:.+",
+ "type": "string"
+ },
+ "start-date": {
+ "description": "Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.",
+ "location": "query",
+ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
+ "required": true,
+ "type": "string"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "data",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "management": {
+ "resources": {
+ "accounts": {
+ "methods": {
+ "list": {
+ "description": "Lists all accounts to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.accounts.list",
+ "parameters": {
+ "max-results": {
+ "description": "The maximum number of accounts to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "management/accounts",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "goals": {
+ "methods": {
+ "list": {
+ "description": "Lists goals to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.goals.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of goals to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "profileId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "start-index": {
+ "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "profiles": {
+ "methods": {
+ "list": {
+ "description": "Lists views (profiles) to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.profiles.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of views (profiles) to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "segments": {
+ "methods": {
+ "list": {
+ "description": "Lists advanced segments to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.segments.list",
+ "parameters": {
+ "max-results": {
+ "description": "The maximum number of advanced segments to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "management/segments",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "webproperties": {
+ "methods": {
+ "list": {
+ "description": "Lists web properties to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.webproperties.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of web properties to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20171211",
+ "rootUrl": "https://www.googleapis.com/",
+ "servicePath": "analytics/v2.4/",
+ "title": "Google Analytics API",
+ "version": "v2.4"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/analytics/v3/analytics-api.json b/vendor/google.golang.org/api/analytics/v3/analytics-api.json
index b6b69e000..03d575dac 100644
--- a/vendor/google.golang.org/api/analytics/v3/analytics-api.json
+++ b/vendor/google.golang.org/api/analytics/v3/analytics-api.json
@@ -1,7370 +1,7370 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/o3DGRejYlQONYxz9qTIt_cgX6AA\"",
- "discoveryVersion": "v1",
- "id": "analytics:v3",
- "name": "analytics",
- "version": "v3",
- "revision": "20171211",
- "title": "Google Analytics API",
- "description": "Views and manages your Google Analytics data.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/analytics-16.png",
- "x32": "https://www.google.com/images/icons/product/analytics-32.png"
- },
- "documentationLink": "https://developers.google.com/analytics/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/analytics/v3/",
- "basePath": "/analytics/v3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "analytics/v3/",
- "batchPath": "batch/analytics/v3",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "false",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/analytics": {
- "description": "View and manage your Google Analytics data"
- },
- "https://www.googleapis.com/auth/analytics.edit": {
- "description": "Edit Google Analytics management entities"
- },
- "https://www.googleapis.com/auth/analytics.manage.users": {
- "description": "Manage Google Analytics Account users by email address"
- },
- "https://www.googleapis.com/auth/analytics.manage.users.readonly": {
- "description": "View Google Analytics user permissions"
- },
- "https://www.googleapis.com/auth/analytics.provision": {
- "description": "Create a new Google Analytics account along with its default property and view"
- },
- "https://www.googleapis.com/auth/analytics.readonly": {
- "description": "View your Google Analytics data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "JSON template for Analytics account entry.",
- "properties": {
- "childLink": {
- "type": "object",
- "description": "Child link for an account entry. Points to the list of web properties for this account.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the list of web properties for this account."
- },
- "type": {
- "type": "string",
- "description": "Type of the child link. Its value is \"analytics#webproperties\".",
- "default": "analytics#webproperties"
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Time the account was created.",
- "format": "date-time"
- },
- "id": {
- "type": "string",
- "description": "Account ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics account.",
- "default": "analytics#account"
- },
- "name": {
- "type": "string",
- "description": "Account name."
- },
- "permissions": {
- "type": "object",
- "description": "Permissions the user has for this account.",
- "properties": {
- "effective": {
- "type": "array",
- "description": "All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this account."
- },
- "starred": {
- "type": "boolean",
- "description": "Indicates whether this account is starred or not."
- },
- "updated": {
- "type": "string",
- "description": "Time the account was last modified.",
- "format": "date-time"
- }
- }
- },
- "AccountRef": {
- "id": "AccountRef",
- "type": "object",
- "description": "JSON template for a linked account.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link for this account."
- },
- "id": {
- "type": "string",
- "description": "Account ID."
- },
- "kind": {
- "type": "string",
- "description": "Analytics account reference.",
- "default": "analytics#accountRef"
- },
- "name": {
- "type": "string",
- "description": "Account name."
- }
- }
- },
- "AccountSummaries": {
- "id": "AccountSummaries",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of AccountSummaries.",
- "items": {
- "$ref": "AccountSummary"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#accountSummaries"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this AccountSummary collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this AccountSummary collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "AccountSummary": {
- "id": "AccountSummary",
- "type": "object",
- "description": "JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Account ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics AccountSummary.",
- "default": "analytics#accountSummary"
- },
- "name": {
- "type": "string",
- "description": "Account name."
- },
- "starred": {
- "type": "boolean",
- "description": "Indicates whether this account is starred or not."
- },
- "webProperties": {
- "type": "array",
- "description": "List of web properties under this account.",
- "items": {
- "$ref": "WebPropertySummary"
- }
- }
- }
- },
- "AccountTicket": {
- "id": "AccountTicket",
- "type": "object",
- "description": "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.",
- "properties": {
- "account": {
- "$ref": "Account",
- "description": "Account for this ticket."
- },
- "id": {
- "type": "string",
- "description": "Account ticket ID used to access the account ticket."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for account ticket.",
- "default": "analytics#accountTicket"
- },
- "profile": {
- "$ref": "Profile",
- "description": "View (Profile) for the account."
- },
- "redirectUri": {
- "type": "string",
- "description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL."
- },
- "webproperty": {
- "$ref": "Webproperty",
- "description": "Web property for the account."
- }
- }
- },
- "AccountTreeRequest": {
- "id": "AccountTreeRequest",
- "type": "object",
- "description": "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.",
- "properties": {
- "accountName": {
- "type": "string",
- "annotations": {
- "required": [
- "analytics.provisioning.createAccountTree"
- ]
- }
- },
- "accountSettings": {
- "type": "object",
- "properties": {
- "admobReporting": {
- "type": "boolean"
- },
- "sharingWithGoogleAnySales": {
- "type": "boolean"
- },
- "sharingWithGoogleProducts": {
- "type": "boolean"
- },
- "sharingWithGoogleSales": {
- "type": "boolean"
- },
- "sharingWithGoogleSupport": {
- "type": "boolean"
- },
- "sharingWithOthers": {
- "type": "boolean"
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type for account ticket.",
- "default": "analytics#accountTreeRequest"
- },
- "profileName": {
- "type": "string",
- "annotations": {
- "required": [
- "analytics.provisioning.createAccountTree"
- ]
- }
- },
- "timezone": {
- "type": "string",
- "annotations": {
- "required": [
- "analytics.provisioning.createAccountTree"
- ]
- }
- },
- "webpropertyName": {
- "type": "string",
- "annotations": {
- "required": [
- "analytics.provisioning.createAccountTree"
- ]
- }
- },
- "websiteUrl": {
- "type": "string",
- "annotations": {
- "required": [
- "analytics.provisioning.createAccountTree"
- ]
- }
- }
- }
- },
- "AccountTreeResponse": {
- "id": "AccountTreeResponse",
- "type": "object",
- "description": "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).",
- "properties": {
- "account": {
- "$ref": "Account",
- "description": "The account created."
- },
- "accountSettings": {
- "type": "object",
- "properties": {
- "admobReporting": {
- "type": "boolean"
- },
- "sharingWithGoogleAnySales": {
- "type": "boolean"
- },
- "sharingWithGoogleProducts": {
- "type": "boolean"
- },
- "sharingWithGoogleSales": {
- "type": "boolean"
- },
- "sharingWithGoogleSupport": {
- "type": "boolean"
- },
- "sharingWithOthers": {
- "type": "boolean"
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type for account ticket.",
- "default": "analytics#accountTreeResponse"
- },
- "profile": {
- "$ref": "Profile",
- "description": "View (Profile) for the account."
- },
- "webproperty": {
- "$ref": "Webproperty",
- "description": "Web property for the account."
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#accounts"
- },
- "nextLink": {
- "type": "string",
- "description": "Next link for this account collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Previous link for this account collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "AdWordsAccount": {
- "id": "AdWordsAccount",
- "type": "object",
- "description": "JSON template for an AdWords account.",
- "properties": {
- "autoTaggingEnabled": {
- "type": "boolean",
- "description": "True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation."
- },
- "customerId": {
- "type": "string",
- "description": "Customer ID. This field is required when creating an AdWords link.",
- "annotations": {
- "required": [
- "analytics.management.webPropertyAdWordsLinks.insert",
- "analytics.management.webPropertyAdWordsLinks.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type for AdWords account.",
- "default": "analytics#adWordsAccount"
- }
- }
- },
- "AnalyticsDataimportDeleteUploadDataRequest": {
- "id": "AnalyticsDataimportDeleteUploadDataRequest",
- "type": "object",
- "description": "Request template for the delete upload data request.",
- "properties": {
- "customDataImportUids": {
- "type": "array",
- "description": "A list of upload UIDs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Column": {
- "id": "Column",
- "type": "object",
- "description": "JSON template for a metadata column.",
- "properties": {
- "attributes": {
- "type": "object",
- "description": "Map of attribute name and value for this column.",
- "additionalProperties": {
- "type": "string",
- "description": "The name of the attribute."
- }
- },
- "id": {
- "type": "string",
- "description": "Column id."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics column.",
- "default": "analytics#column"
- }
- }
- },
- "Columns": {
- "id": "Columns",
- "type": "object",
- "description": "Lists columns (dimensions and metrics) for a particular report type.",
- "properties": {
- "attributeNames": {
- "type": "array",
- "description": "List of attributes names returned by columns.",
- "items": {
- "type": "string"
- }
- },
- "etag": {
- "type": "string",
- "description": "Etag of collection. This etag can be compared with the last response etag to check if response has changed."
- },
- "items": {
- "type": "array",
- "description": "List of columns for a report type.",
- "items": {
- "$ref": "Column"
- }
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#columns"
- },
- "totalResults": {
- "type": "integer",
- "description": "Total number of columns returned in the response.",
- "format": "int32"
- }
- }
- },
- "CustomDataSource": {
- "id": "CustomDataSource",
- "type": "object",
- "description": "JSON template for an Analytics custom data source.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this custom data source belongs."
- },
- "childLink": {
- "type": "object",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#dailyUploads\". Value is \"analytics#uploads\"."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Time this custom data source was created.",
- "format": "date-time"
- },
- "description": {
- "type": "string",
- "description": "Description of custom data source."
- },
- "id": {
- "type": "string",
- "description": "Custom data source ID."
- },
- "importBehavior": {
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics custom data source.",
- "default": "analytics#customDataSource"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom data source."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for this custom data source. Points to the web property to which this custom data source belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the web property to which this custom data source belongs."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#webproperty\".",
- "default": "analytics#webproperty"
- }
- }
- },
- "profilesLinked": {
- "type": "array",
- "description": "IDs of views (profiles) linked to the custom data source.",
- "items": {
- "type": "string"
- }
- },
- "schema": {
- "type": "array",
- "description": "Collection of schema headers of the custom data source.",
- "items": {
- "type": "string"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this Analytics custom data source."
- },
- "type": {
- "type": "string",
- "description": "Type of the custom data source."
- },
- "updated": {
- "type": "string",
- "description": "Time this custom data source was last modified.",
- "format": "date-time"
- },
- "uploadType": {
- "type": "string",
- "description": "Upload type of the custom data source."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY to which this custom data source belongs."
- }
- }
- },
- "CustomDataSources": {
- "id": "CustomDataSources",
- "type": "object",
- "description": "Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Collection of custom data sources.",
- "items": {
- "$ref": "CustomDataSource"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#customDataSources"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this custom data source collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this custom data source collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "CustomDimension": {
- "id": "CustomDimension",
- "type": "object",
- "description": "JSON template for Analytics Custom Dimension.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID."
- },
- "active": {
- "type": "boolean",
- "description": "Boolean indicating whether the custom dimension is active."
- },
- "created": {
- "type": "string",
- "description": "Time the custom dimension was created.",
- "format": "date-time",
- "readOnly": true
- },
- "id": {
- "type": "string",
- "description": "Custom dimension ID."
- },
- "index": {
- "type": "integer",
- "description": "Index of the custom dimension.",
- "format": "int32",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Kind value for a custom dimension. Set to \"analytics#customDimension\". It is a read-only field.",
- "default": "analytics#customDimension",
- "readOnly": true
- },
- "name": {
- "type": "string",
- "description": "Name of the custom dimension."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for the custom dimension. Points to the property to which the custom dimension belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the property to which the custom dimension belongs."
- },
- "type": {
- "type": "string",
- "description": "Type of the parent link. Set to \"analytics#webproperty\".",
- "default": "analytics#webproperty"
- }
- }
- },
- "scope": {
- "type": "string",
- "description": "Scope of the custom dimension: HIT, SESSION, USER or PRODUCT."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for the custom dimension",
- "readOnly": true
- },
- "updated": {
- "type": "string",
- "description": "Time the custom dimension was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "webPropertyId": {
- "type": "string",
- "description": "Property ID."
- }
- }
- },
- "CustomDimensions": {
- "id": "CustomDimensions",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Collection of custom dimensions.",
- "items": {
- "$ref": "CustomDimension"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#customDimensions"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this custom dimension collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this custom dimension collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "CustomMetric": {
- "id": "CustomMetric",
- "type": "object",
- "description": "JSON template for Analytics Custom Metric.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID."
- },
- "active": {
- "type": "boolean",
- "description": "Boolean indicating whether the custom metric is active."
- },
- "created": {
- "type": "string",
- "description": "Time the custom metric was created.",
- "format": "date-time",
- "readOnly": true
- },
- "id": {
- "type": "string",
- "description": "Custom metric ID."
- },
- "index": {
- "type": "integer",
- "description": "Index of the custom metric.",
- "format": "int32",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Kind value for a custom metric. Set to \"analytics#customMetric\". It is a read-only field.",
- "default": "analytics#customMetric",
- "readOnly": true
- },
- "max_value": {
- "type": "string",
- "description": "Max value of custom metric."
- },
- "min_value": {
- "type": "string",
- "description": "Min value of custom metric."
- },
- "name": {
- "type": "string",
- "description": "Name of the custom metric."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for the custom metric. Points to the property to which the custom metric belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the property to which the custom metric belongs."
- },
- "type": {
- "type": "string",
- "description": "Type of the parent link. Set to \"analytics#webproperty\".",
- "default": "analytics#webproperty"
- }
- }
- },
- "scope": {
- "type": "string",
- "description": "Scope of the custom metric: HIT or PRODUCT."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for the custom metric",
- "readOnly": true
- },
- "type": {
- "type": "string",
- "description": "Data type of custom metric."
- },
- "updated": {
- "type": "string",
- "description": "Time the custom metric was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "webPropertyId": {
- "type": "string",
- "description": "Property ID."
- }
- }
- },
- "CustomMetrics": {
- "id": "CustomMetrics",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Collection of custom metrics.",
- "items": {
- "$ref": "CustomMetric"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#customMetrics"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this custom metric collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this custom metric collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "EntityAdWordsLink": {
- "id": "EntityAdWordsLink",
- "type": "object",
- "description": "JSON template for Analytics Entity AdWords Link.",
- "properties": {
- "adWordsAccounts": {
- "type": "array",
- "description": "A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.",
- "items": {
- "$ref": "AdWordsAccount"
- },
- "annotations": {
- "required": [
- "analytics.management.webPropertyAdWordsLinks.insert",
- "analytics.management.webPropertyAdWordsLinks.update"
- ]
- }
- },
- "entity": {
- "type": "object",
- "description": "Web property being linked.",
- "properties": {
- "webPropertyRef": {
- "$ref": "WebPropertyRef"
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Entity AdWords link ID"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for entity AdWords link.",
- "default": "analytics#entityAdWordsLink"
- },
- "name": {
- "type": "string",
- "description": "Name of the link. This field is required when creating an AdWords link.",
- "annotations": {
- "required": [
- "analytics.management.webPropertyAdWordsLinks.insert",
- "analytics.management.webPropertyAdWordsLinks.update"
- ]
- }
- },
- "profileIds": {
- "type": "array",
- "description": "IDs of linked Views (Profiles) represented as strings.",
- "items": {
- "type": "string"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "URL link for this Google Analytics - Google AdWords link."
- }
- }
- },
- "EntityAdWordsLinks": {
- "id": "EntityAdWordsLinks",
- "type": "object",
- "description": "An entity AdWords link collection provides a list of GA-AdWords links Each resource in this collection corresponds to a single link.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of entity AdWords links.",
- "items": {
- "$ref": "EntityAdWordsLink"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#entityAdWordsLinks"
- },
- "nextLink": {
- "type": "string",
- "description": "Next link for this AdWords link collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Previous link for this AdWords link collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- }
- }
- },
- "EntityUserLink": {
- "id": "EntityUserLink",
- "type": "object",
- "description": "JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.",
- "properties": {
- "entity": {
- "type": "object",
- "description": "Entity for this link. It can be an account, a web property, or a view (profile).",
- "properties": {
- "accountRef": {
- "$ref": "AccountRef",
- "description": "Account for this link."
- },
- "profileRef": {
- "$ref": "ProfileRef",
- "description": "View (Profile) for this link."
- },
- "webPropertyRef": {
- "$ref": "WebPropertyRef",
- "description": "Web property for this link."
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Entity user link ID"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for entity user link.",
- "default": "analytics#entityUserLink"
- },
- "permissions": {
- "type": "object",
- "description": "Permissions the user has for this entity.",
- "properties": {
- "effective": {
- "type": "array",
- "description": "Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- },
- "local": {
- "type": "array",
- "description": "Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Self link for this resource."
- },
- "userRef": {
- "$ref": "UserRef",
- "description": "User reference."
- }
- }
- },
- "EntityUserLinks": {
- "id": "EntityUserLinks",
- "type": "object",
- "description": "An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of entity user links.",
- "items": {
- "$ref": "EntityUserLink"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#entityUserLinks"
- },
- "nextLink": {
- "type": "string",
- "description": "Next link for this account collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Previous link for this account collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- }
- }
- },
- "Experiment": {
- "id": "Experiment",
- "type": "object",
- "description": "JSON template for Analytics experiment resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this experiment belongs. This field is read-only."
- },
- "created": {
- "type": "string",
- "description": "Time the experiment was created. This field is read-only.",
- "format": "date-time"
- },
- "description": {
- "type": "string",
- "description": "Notes about this experiment."
- },
- "editableInGaUi": {
- "type": "boolean",
- "description": "If true, the end user will be able to edit the experiment via the Google Analytics user interface."
- },
- "endTime": {
- "type": "string",
- "description": "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.",
- "format": "date-time"
- },
- "equalWeighting": {
- "type": "boolean",
- "description": "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."
- },
- "id": {
- "type": "string",
- "description": "Experiment ID. Required for patch and update. Disallowed for create.",
- "annotations": {
- "required": [
- "analytics.management.experiments.patch",
- "analytics.management.experiments.update"
- ]
- }
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this experiment belongs. This field is read-only."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for an Analytics experiment. This field is read-only.",
- "default": "analytics#experiment"
- },
- "minimumExperimentLengthInDays": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "name": {
- "type": "string",
- "description": "Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.",
- "annotations": {
- "required": [
- "analytics.management.experiments.insert",
- "analytics.management.experiments.update"
- ]
- }
- },
- "objectiveMetric": {
- "type": "string",
- "description": "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\"."
- },
- "optimizationType": {
- "type": "string",
- "description": "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\"."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for an experiment. Points to the view (profile) to which this experiment belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the view (profile) to which this experiment belongs. This field is read-only."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#profile\". This field is read-only.",
- "default": "analytics#profile"
- }
- }
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to which this experiment belongs. This field is read-only."
- },
- "reasonExperimentEnded": {
- "type": "string",
- "description": "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."
- },
- "rewriteVariationUrlsAsOriginal": {
- "type": "boolean",
- "description": "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."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this experiment. This field is read-only."
- },
- "servingFramework": {
- "type": "string",
- "description": "The framework used to serve the experiment variations and evaluate the results. One of: \n- REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.\n- API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.\n- 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."
- },
- "snippet": {
- "type": "string",
- "description": "The snippet of code to include on the control page(s). This field is read-only."
- },
- "startTime": {
- "type": "string",
- "description": "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.",
- "format": "date-time"
- },
- "status": {
- "type": "string",
- "description": "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.",
- "annotations": {
- "required": [
- "analytics.management.experiments.insert",
- "analytics.management.experiments.update"
- ]
- }
- },
- "trafficCoverage": {
- "type": "number",
- "description": "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.",
- "format": "double"
- },
- "updated": {
- "type": "string",
- "description": "Time the experiment was last modified. This field is read-only.",
- "format": "date-time"
- },
- "variations": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.",
- "annotations": {
- "required": [
- "analytics.management.experiments.insert",
- "analytics.management.experiments.update"
- ]
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/analytics": {
+ "description": "View and manage your Google Analytics data"
+ },
+ "https://www.googleapis.com/auth/analytics.edit": {
+ "description": "Edit Google Analytics management entities"
+ },
+ "https://www.googleapis.com/auth/analytics.manage.users": {
+ "description": "Manage Google Analytics Account users by email address"
+ },
+ "https://www.googleapis.com/auth/analytics.manage.users.readonly": {
+ "description": "View Google Analytics user permissions"
+ },
+ "https://www.googleapis.com/auth/analytics.provision": {
+ "description": "Create a new Google Analytics account along with its default property and view"
+ },
+ "https://www.googleapis.com/auth/analytics.readonly": {
+ "description": "View your Google Analytics data"
}
- },
- "status": {
- "type": "string",
- "description": "Status of the variation. Possible values: \"ACTIVE\", \"INACTIVE\". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED."
- },
- "url": {
- "type": "string",
- "description": "The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED."
- },
- "weight": {
- "type": "number",
- "description": "Weight that this variation should receive. Only present if the experiment is running. This field is read-only.",
- "format": "double"
- },
- "won": {
- "type": "boolean",
- "description": "True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only."
- }
}
- }
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only."
- },
- "winnerConfidenceLevel": {
- "type": "number",
- "description": "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.",
- "format": "double"
- },
- "winnerFound": {
- "type": "boolean",
- "description": "Boolean specifying whether a winner has been found for this experiment. This field is read-only."
}
- }
},
- "Experiments": {
- "id": "Experiments",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of experiments.",
- "items": {
- "$ref": "Experiment"
- }
+ "basePath": "/analytics/v3/",
+ "baseUrl": "https://www.googleapis.com/analytics/v3/",
+ "batchPath": "batch/analytics/v3",
+ "description": "Views and manages your Google Analytics data.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/analytics/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/pZyXISvfodVzorQpGHmIl5L61w8\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/analytics-16.png",
+ "x32": "https://www.google.com/images/icons/product/analytics-32.png"
+ },
+ "id": "analytics:v3",
+ "kind": "discovery#restDescription",
+ "name": "analytics",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
},
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#experiments"
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
},
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this experiment collection."
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this experiment collection."
+ "prettyPrint": {
+ "default": "false",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
},
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
},
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of resources in the result.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "Filter": {
- "id": "Filter",
- "type": "object",
- "description": "JSON template for an Analytics account filter.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this filter belongs."
- },
- "advancedDetails": {
- "type": "object",
- "description": "Details for the filter of the type ADVANCED.",
- "properties": {
- "caseSensitive": {
- "type": "boolean",
- "description": "Indicates if the filter expressions are case sensitive."
- },
- "extractA": {
- "type": "string",
- "description": "Expression to extract from field A."
- },
- "extractB": {
- "type": "string",
- "description": "Expression to extract from field B."
- },
- "fieldA": {
- "type": "string",
- "description": "Field A."
- },
- "fieldAIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "fieldARequired": {
- "type": "boolean",
- "description": "Indicates if field A is required to match."
- },
- "fieldB": {
- "type": "string",
- "description": "Field B."
- },
- "fieldBIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "fieldBRequired": {
- "type": "boolean",
- "description": "Indicates if field B is required to match."
- },
- "outputConstructor": {
- "type": "string",
- "description": "Expression used to construct the output value."
- },
- "outputToField": {
- "type": "string",
- "description": "Output field."
- },
- "outputToFieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "overrideOutputField": {
- "type": "boolean",
- "description": "Indicates if the existing value of the output field, if any, should be overridden by the output expression."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Time this filter was created.",
- "format": "date-time",
- "readOnly": true
- },
- "excludeDetails": {
- "$ref": "FilterExpression",
- "description": "Details for the filter of the type EXCLUDE."
- },
- "id": {
- "type": "string",
- "description": "Filter ID."
- },
- "includeDetails": {
- "$ref": "FilterExpression",
- "description": "Details for the filter of the type INCLUDE."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics filter.",
- "default": "analytics#filter",
- "readOnly": true
- },
- "lowercaseDetails": {
- "type": "object",
- "description": "Details for the filter of the type LOWER.",
- "properties": {
- "field": {
- "type": "string",
- "description": "Field to use in the filter."
- },
- "fieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- }
- }
- },
- "name": {
- "type": "string",
- "description": "Name of this filter.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.filters.update"
- ]
- }
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for this filter. Points to the account to which this filter belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the account to which this filter belongs."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#account\".",
- "default": "analytics#account"
- }
- }
- },
- "searchAndReplaceDetails": {
- "type": "object",
- "description": "Details for the filter of the type SEARCH_AND_REPLACE.",
- "properties": {
- "caseSensitive": {
- "type": "boolean",
- "description": "Determines if the filter is case sensitive."
- },
- "field": {
- "type": "string",
- "description": "Field to use in the filter."
- },
- "fieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "replaceString": {
- "type": "string",
- "description": "Term to replace the search term with."
- },
- "searchString": {
- "type": "string",
- "description": "Term to search."
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this filter.",
- "readOnly": true
- },
- "type": {
- "type": "string",
- "description": "Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.filters.update"
- ]
- }
- },
- "updated": {
- "type": "string",
- "description": "Time this filter was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "uppercaseDetails": {
- "type": "object",
- "description": "Details for the filter of the type UPPER.",
- "properties": {
- "field": {
- "type": "string",
- "description": "Field to use in the filter."
- },
- "fieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- }
- }
- }
- }
- },
- "FilterExpression": {
- "id": "FilterExpression",
- "type": "object",
- "description": "JSON template for an Analytics filter expression.",
- "properties": {
- "caseSensitive": {
- "type": "boolean",
- "description": "Determines if the filter is case sensitive."
- },
- "expressionValue": {
- "type": "string",
- "description": "Filter expression value"
- },
- "field": {
- "type": "string",
- "description": "Field to filter. Possible values: \n- Content and Traffic \n- PAGE_REQUEST_URI, \n- PAGE_HOSTNAME, \n- PAGE_TITLE, \n- REFERRAL, \n- COST_DATA_URI (Campaign target URL), \n- HIT_TYPE, \n- INTERNAL_SEARCH_TERM, \n- INTERNAL_SEARCH_TYPE, \n- SOURCE_PROPERTY_TRACKING_ID, \n- Campaign or AdGroup \n- CAMPAIGN_SOURCE, \n- CAMPAIGN_MEDIUM, \n- CAMPAIGN_NAME, \n- CAMPAIGN_AD_GROUP, \n- CAMPAIGN_TERM, \n- CAMPAIGN_CONTENT, \n- CAMPAIGN_CODE, \n- CAMPAIGN_REFERRAL_PATH, \n- E-Commerce \n- TRANSACTION_COUNTRY, \n- TRANSACTION_REGION, \n- TRANSACTION_CITY, \n- TRANSACTION_AFFILIATION (Store or order location), \n- ITEM_NAME, \n- ITEM_CODE, \n- ITEM_VARIATION, \n- TRANSACTION_ID, \n- TRANSACTION_CURRENCY_CODE, \n- PRODUCT_ACTION_TYPE, \n- Audience/Users \n- BROWSER, \n- BROWSER_VERSION, \n- BROWSER_SIZE, \n- PLATFORM, \n- PLATFORM_VERSION, \n- LANGUAGE, \n- SCREEN_RESOLUTION, \n- SCREEN_COLORS, \n- JAVA_ENABLED (Boolean Field), \n- FLASH_VERSION, \n- GEO_SPEED (Connection speed), \n- VISITOR_TYPE, \n- GEO_ORGANIZATION (ISP organization), \n- GEO_DOMAIN, \n- GEO_IP_ADDRESS, \n- GEO_IP_VERSION, \n- Location \n- GEO_COUNTRY, \n- GEO_REGION, \n- GEO_CITY, \n- Event \n- EVENT_CATEGORY, \n- EVENT_ACTION, \n- EVENT_LABEL, \n- Other \n- CUSTOM_FIELD_1, \n- CUSTOM_FIELD_2, \n- USER_DEFINED_VALUE, \n- Application \n- APP_ID, \n- APP_INSTALLER_ID, \n- APP_NAME, \n- APP_VERSION, \n- SCREEN, \n- IS_APP (Boolean Field), \n- IS_FATAL_EXCEPTION (Boolean Field), \n- EXCEPTION_DESCRIPTION, \n- Mobile device \n- IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), \n- IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), \n- DEVICE_CATEGORY, \n- MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), \n- MOBILE_HAS_NFC_SUPPORT (Boolean Field), \n- MOBILE_HAS_CELLULAR_RADIO (Boolean Field), \n- MOBILE_HAS_WIFI_SUPPORT (Boolean Field), \n- MOBILE_BRAND_NAME, \n- MOBILE_MODEL_NAME, \n- MOBILE_MARKETING_NAME, \n- MOBILE_POINTING_METHOD, \n- Social \n- SOCIAL_NETWORK, \n- SOCIAL_ACTION, \n- SOCIAL_ACTION_TARGET, \n- Custom dimension \n- CUSTOM_DIMENSION (See accompanying field index),"
- },
- "fieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Kind value for filter expression",
- "default": "analytics#filterExpression"
- },
- "matchType": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "FilterRef": {
- "id": "FilterRef",
- "type": "object",
- "description": "JSON template for a profile filter link.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this filter belongs.",
- "readOnly": true
- },
- "href": {
- "type": "string",
- "description": "Link for this filter."
- },
- "id": {
- "type": "string",
- "description": "Filter ID.",
- "annotations": {
- "required": [
- "analytics.management.profileFilterLinks.insert"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind value for filter reference.",
- "default": "analytics#filterRef"
- },
- "name": {
- "type": "string",
- "description": "Name of this filter.",
- "readOnly": true
- }
- }
- },
- "Filters": {
- "id": "Filters",
- "type": "object",
- "description": "A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of filters.",
- "items": {
- "$ref": "Filter"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#filters"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this filter collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this filter collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "GaData": {
- "id": "GaData",
- "type": "object",
- "description": "Analytics data for a given view (profile).",
- "properties": {
- "columnHeaders": {
- "type": "array",
- "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
- "items": {
- "type": "object",
- "properties": {
- "columnType": {
- "type": "string",
- "description": "Column Type. Either DIMENSION or METRIC."
- },
- "dataType": {
- "type": "string",
- "description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc."
- },
- "name": {
- "type": "string",
- "description": "Column name."
- }
- }
- }
- },
- "containsSampledData": {
- "type": "boolean",
- "description": "Determines if Analytics data contains samples."
- },
- "dataLastRefreshed": {
- "type": "string",
- "description": "The last refreshed time in seconds for Analytics data.",
- "format": "int64"
- },
- "dataTable": {
- "type": "object",
- "properties": {
- "cols": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "label": {
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- }
- }
- },
- "rows": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "c": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "v": {
- "type": "string"
+ "protocol": "rest",
+ "resources": {
+ "data": {
+ "resources": {
+ "ga": {
+ "methods": {
+ "get": {
+ "description": "Returns Analytics data for a view (profile).",
+ "httpMethod": "GET",
+ "id": "analytics.data.ga.get",
+ "parameterOrder": [
+ "ids",
+ "start-date",
+ "end-date",
+ "metrics"
+ ],
+ "parameters": {
+ "dimensions": {
+ "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
+ "location": "query",
+ "pattern": "(ga:.+)?",
+ "type": "string"
+ },
+ "end-date": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
+ "required": true,
+ "type": "string"
+ },
+ "filters": {
+ "description": "A comma-separated list of dimension or metric filters to be applied to Analytics data.",
+ "location": "query",
+ "pattern": "ga:.+",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
+ "location": "query",
+ "pattern": "ga:[0-9]+",
+ "required": true,
+ "type": "string"
+ },
+ "include-empty-rows": {
+ "description": "The response will include empty rows if this parameter is set to true, the default is true",
+ "location": "query",
+ "type": "boolean"
+ },
+ "max-results": {
+ "description": "The maximum number of entries to include in this feed.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.",
+ "location": "query",
+ "pattern": "ga:.+",
+ "required": true,
+ "type": "string"
+ },
+ "output": {
+ "description": "The selected format for the response. Default format is JSON.",
+ "enum": [
+ "dataTable",
+ "json"
+ ],
+ "enumDescriptions": [
+ "Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.",
+ "Returns the response in standard JSON format."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "samplingLevel": {
+ "description": "The desired sampling level.",
+ "enum": [
+ "DEFAULT",
+ "FASTER",
+ "HIGHER_PRECISION"
+ ],
+ "enumDescriptions": [
+ "Returns response with a sample size that balances speed and accuracy.",
+ "Returns a fast response with a smaller sample size.",
+ "Returns a more accurate response using a large sample size, but this may result in the response being slower."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "segment": {
+ "description": "An Analytics segment to be applied to data.",
+ "location": "query",
+ "type": "string"
+ },
+ "sort": {
+ "description": "A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.",
+ "location": "query",
+ "pattern": "(-)?ga:.+",
+ "type": "string"
+ },
+ "start-date": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
+ "required": true,
+ "type": "string"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "data/ga",
+ "response": {
+ "$ref": "GaData"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "mcf": {
+ "methods": {
+ "get": {
+ "description": "Returns Analytics Multi-Channel Funnels data for a view (profile).",
+ "httpMethod": "GET",
+ "id": "analytics.data.mcf.get",
+ "parameterOrder": [
+ "ids",
+ "start-date",
+ "end-date",
+ "metrics"
+ ],
+ "parameters": {
+ "dimensions": {
+ "description": "A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.",
+ "location": "query",
+ "pattern": "(mcf:.+)?",
+ "type": "string"
+ },
+ "end-date": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
+ "required": true,
+ "type": "string"
+ },
+ "filters": {
+ "description": "A comma-separated list of dimension or metric filters to be applied to the Analytics data.",
+ "location": "query",
+ "pattern": "mcf:.+",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
+ "location": "query",
+ "pattern": "ga:[0-9]+",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of entries to include in this feed.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.",
+ "location": "query",
+ "pattern": "mcf:.+",
+ "required": true,
+ "type": "string"
+ },
+ "samplingLevel": {
+ "description": "The desired sampling level.",
+ "enum": [
+ "DEFAULT",
+ "FASTER",
+ "HIGHER_PRECISION"
+ ],
+ "enumDescriptions": [
+ "Returns response with a sample size that balances speed and accuracy.",
+ "Returns a fast response with a smaller sample size.",
+ "Returns a more accurate response using a large sample size, but this may result in the response being slower."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "sort": {
+ "description": "A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.",
+ "location": "query",
+ "pattern": "(-)?mcf:.+",
+ "type": "string"
+ },
+ "start-date": {
+ "description": "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.",
+ "location": "query",
+ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
+ "required": true,
+ "type": "string"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "data/mcf",
+ "response": {
+ "$ref": "McfData"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "realtime": {
+ "methods": {
+ "get": {
+ "description": "Returns real time data for a view (profile).",
+ "httpMethod": "GET",
+ "id": "analytics.data.realtime.get",
+ "parameterOrder": [
+ "ids",
+ "metrics"
+ ],
+ "parameters": {
+ "dimensions": {
+ "description": "A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.",
+ "location": "query",
+ "pattern": "(ga:.+)|(rt:.+)",
+ "type": "string"
+ },
+ "filters": {
+ "description": "A comma-separated list of dimension or metric filters to be applied to real time data.",
+ "location": "query",
+ "pattern": "(ga:.+)|(rt:.+)",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
+ "location": "query",
+ "pattern": "ga:[0-9]+",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of entries to include in this feed.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.",
+ "location": "query",
+ "pattern": "(ga:.+)|(rt:.+)",
+ "required": true,
+ "type": "string"
+ },
+ "sort": {
+ "description": "A comma-separated list of dimensions or metrics that determine the sort order for real time data.",
+ "location": "query",
+ "pattern": "(-)?((ga:.+)|(rt:.+))",
+ "type": "string"
+ }
+ },
+ "path": "data/realtime",
+ "response": {
+ "$ref": "RealtimeData"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
}
- }
}
- }
}
- }
}
- }
},
- "id": {
- "type": "string",
- "description": "Unique ID for this data response."
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "analytics#gaData"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this Analytics data query."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this Analytics data query."
- },
- "profileInfo": {
- "type": "object",
- "description": "Information for the view (profile), for which the Analytics data was requested.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs."
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "profileName": {
- "type": "string",
- "description": "View (Profile) name."
- },
- "tableId": {
- "type": "string",
- "description": "Table ID for view (profile)."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to which this view (profile) belongs."
- }
- }
- },
- "query": {
- "type": "object",
- "description": "Analytics data request query parameters.",
- "properties": {
- "dimensions": {
- "type": "string",
- "description": "List of analytics dimensions."
- },
- "end-date": {
- "type": "string",
- "description": "End date."
- },
- "filters": {
- "type": "string",
- "description": "Comma-separated list of dimension or metric filters."
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID."
- },
- "max-results": {
- "type": "integer",
- "description": "Maximum results per page.",
- "format": "int32"
- },
- "metrics": {
- "type": "array",
- "description": "List of analytics metrics.",
- "items": {
- "type": "string"
- }
- },
- "samplingLevel": {
- "type": "string",
- "description": "Desired sampling level"
- },
- "segment": {
- "type": "string",
- "description": "Analytics advanced segment."
- },
- "sort": {
- "type": "array",
- "description": "List of dimensions or metrics based on which Analytics data is sorted.",
- "items": {
- "type": "string"
- }
- },
- "start-date": {
- "type": "string",
- "description": "Start date."
- },
- "start-index": {
- "type": "integer",
- "description": "Start index.",
- "format": "int32"
- }
- }
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "sampleSize": {
- "type": "string",
- "description": "The number of samples used to calculate the result.",
- "format": "int64"
- },
- "sampleSpace": {
- "type": "string",
- "description": "Total size of the sample space from which the samples were selected.",
- "format": "int64"
- },
- "selfLink": {
- "type": "string",
- "description": "Link to this page."
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of rows for the query, regardless of the number of rows in the response.",
- "format": "int32"
- },
- "totalsForAllResults": {
- "type": "object",
- "description": "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.",
- "additionalProperties": {
- "type": "string",
- "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric."
- }
- }
- }
- },
- "Goal": {
- "id": "Goal",
- "type": "object",
- "description": "JSON template for Analytics goal resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this goal belongs."
- },
- "active": {
- "type": "boolean",
- "description": "Determines whether this goal is active."
- },
- "created": {
- "type": "string",
- "description": "Time this goal was created.",
- "format": "date-time"
- },
- "eventDetails": {
- "type": "object",
- "description": "Details for the goal of the type EVENT.",
- "properties": {
- "eventConditions": {
- "type": "array",
- "description": "List of event conditions.",
- "items": {
- "type": "object",
- "properties": {
- "comparisonType": {
- "type": "string",
- "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL."
- },
- "comparisonValue": {
- "type": "string",
- "description": "Value used for this comparison.",
- "format": "int64"
- },
- "expression": {
- "type": "string",
- "description": "Expression used for this match."
- },
- "matchType": {
- "type": "string",
- "description": "Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT."
- },
- "type": {
- "type": "string",
- "description": "Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE."
- }
+ "management": {
+ "resources": {
+ "accountSummaries": {
+ "methods": {
+ "list": {
+ "description": "Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.accountSummaries.list",
+ "parameters": {
+ "max-results": {
+ "description": "The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "management/accountSummaries",
+ "response": {
+ "$ref": "AccountSummaries"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "accountUserLinks": {
+ "methods": {
+ "delete": {
+ "description": "Removes a user from the given account.",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.accountUserLinks.delete",
+ "parameterOrder": [
+ "accountId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to delete the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "Link ID to delete the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users"
+ ]
+ },
+ "insert": {
+ "description": "Adds a new user to the given account.",
+ "httpMethod": "POST",
+ "id": "analytics.management.accountUserLinks.insert",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/entityUserLinks",
+ "request": {
+ "$ref": "EntityUserLink"
+ },
+ "response": {
+ "$ref": "EntityUserLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users"
+ ]
+ },
+ "list": {
+ "description": "Lists account-user links for a given account.",
+ "httpMethod": "GET",
+ "id": "analytics.management.accountUserLinks.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve the user links for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of account-user links to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "management/accounts/{accountId}/entityUserLinks",
+ "response": {
+ "$ref": "EntityUserLinks"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users",
+ "https://www.googleapis.com/auth/analytics.manage.users.readonly"
+ ]
+ },
+ "update": {
+ "description": "Updates permissions for an existing user on the given account.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.accountUserLinks.update",
+ "parameterOrder": [
+ "accountId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to update the account-user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "Link ID to update the account-user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
+ "request": {
+ "$ref": "EntityUserLink"
+ },
+ "response": {
+ "$ref": "EntityUserLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users"
+ ]
+ }
+ }
+ },
+ "accounts": {
+ "methods": {
+ "list": {
+ "description": "Lists all accounts to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.accounts.list",
+ "parameters": {
+ "max-results": {
+ "description": "The maximum number of accounts to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "management/accounts",
+ "response": {
+ "$ref": "Accounts"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "customDataSources": {
+ "methods": {
+ "list": {
+ "description": "List custom data sources to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.customDataSources.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account Id for the custom data sources to retrieve.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of custom data sources to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "Web property Id for the custom data sources to retrieve.",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources",
+ "response": {
+ "$ref": "CustomDataSources"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "customDimensions": {
+ "methods": {
+ "get": {
+ "description": "Get a custom dimension to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.customDimensions.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customDimensionId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom dimension to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customDimensionId": {
+ "description": "The ID of the custom dimension to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom dimension to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
+ "response": {
+ "$ref": "CustomDimension"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create a new custom dimension.",
+ "httpMethod": "POST",
+ "id": "analytics.management.customDimensions.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom dimension to create.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom dimension to create.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
+ "request": {
+ "$ref": "CustomDimension"
+ },
+ "response": {
+ "$ref": "CustomDimension"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists custom dimensions to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.customDimensions.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom dimensions to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of custom dimensions to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom dimensions to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
+ "response": {
+ "$ref": "CustomDimensions"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing custom dimension. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.customDimensions.patch",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customDimensionId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom dimension to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customDimensionId": {
+ "description": "Custom dimension ID for the custom dimension to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ignoreCustomDataSourceLinks": {
+ "default": "false",
+ "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom dimension to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
+ "request": {
+ "$ref": "CustomDimension"
+ },
+ "response": {
+ "$ref": "CustomDimension"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing custom dimension.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.customDimensions.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customDimensionId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom dimension to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customDimensionId": {
+ "description": "Custom dimension ID for the custom dimension to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ignoreCustomDataSourceLinks": {
+ "default": "false",
+ "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom dimension to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
+ "request": {
+ "$ref": "CustomDimension"
+ },
+ "response": {
+ "$ref": "CustomDimension"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "customMetrics": {
+ "methods": {
+ "get": {
+ "description": "Get a custom metric to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.customMetrics.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customMetricId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom metric to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customMetricId": {
+ "description": "The ID of the custom metric to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom metric to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
+ "response": {
+ "$ref": "CustomMetric"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create a new custom metric.",
+ "httpMethod": "POST",
+ "id": "analytics.management.customMetrics.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom metric to create.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom dimension to create.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
+ "request": {
+ "$ref": "CustomMetric"
+ },
+ "response": {
+ "$ref": "CustomMetric"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists custom metrics to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.customMetrics.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom metrics to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of custom metrics to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom metrics to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
+ "response": {
+ "$ref": "CustomMetrics"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing custom metric. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.customMetrics.patch",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customMetricId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom metric to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customMetricId": {
+ "description": "Custom metric ID for the custom metric to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ignoreCustomDataSourceLinks": {
+ "default": "false",
+ "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom metric to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
+ "request": {
+ "$ref": "CustomMetric"
+ },
+ "response": {
+ "$ref": "CustomMetric"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing custom metric.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.customMetrics.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customMetricId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID for the custom metric to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "customMetricId": {
+ "description": "Custom metric ID for the custom metric to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ignoreCustomDataSourceLinks": {
+ "default": "false",
+ "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for the custom metric to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
+ "request": {
+ "$ref": "CustomMetric"
+ },
+ "response": {
+ "$ref": "CustomMetric"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "experiments": {
+ "methods": {
+ "delete": {
+ "description": "Delete an experiment.",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.experiments.delete",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "experimentId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which the experiment belongs",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "experimentId": {
+ "description": "ID of the experiment to delete",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to which the experiment belongs",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to which the experiment belongs",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "get": {
+ "description": "Returns an experiment to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.experiments.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "experimentId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve the experiment for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "experimentId": {
+ "description": "Experiment ID to retrieve the experiment for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to retrieve the experiment for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve the experiment for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
+ "response": {
+ "$ref": "Experiment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create a new experiment.",
+ "httpMethod": "POST",
+ "id": "analytics.management.experiments.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create the experiment for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to create the experiment for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to create the experiment for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
+ "request": {
+ "$ref": "Experiment"
+ },
+ "response": {
+ "$ref": "Experiment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists experiments to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.experiments.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve experiments for.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of experiments to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to retrieve experiments for.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "start-index": {
+ "description": "An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve experiments for.",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
+ "response": {
+ "$ref": "Experiments"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Update an existing experiment. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.experiments.patch",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "experimentId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID of the experiment to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "experimentId": {
+ "description": "Experiment ID of the experiment to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID of the experiment to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID of the experiment to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
+ "request": {
+ "$ref": "Experiment"
+ },
+ "response": {
+ "$ref": "Experiment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Update an existing experiment.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.experiments.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "experimentId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID of the experiment to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "experimentId": {
+ "description": "Experiment ID of the experiment to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID of the experiment to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID of the experiment to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
+ "request": {
+ "$ref": "Experiment"
+ },
+ "response": {
+ "$ref": "Experiment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "filters": {
+ "methods": {
+ "delete": {
+ "description": "Delete a filter.",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.filters.delete",
+ "parameterOrder": [
+ "accountId",
+ "filterId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to delete the filter for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterId": {
+ "description": "ID of the filter to be deleted.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/filters/{filterId}",
+ "response": {
+ "$ref": "Filter"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "get": {
+ "description": "Returns a filters to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.filters.get",
+ "parameterOrder": [
+ "accountId",
+ "filterId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve filters for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterId": {
+ "description": "Filter ID to retrieve filters for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/filters/{filterId}",
+ "response": {
+ "$ref": "Filter"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create a new filter.",
+ "httpMethod": "POST",
+ "id": "analytics.management.filters.insert",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create filter for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/filters",
+ "request": {
+ "$ref": "Filter"
+ },
+ "response": {
+ "$ref": "Filter"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists all filters for an account",
+ "httpMethod": "GET",
+ "id": "analytics.management.filters.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve filters for.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of filters to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "management/accounts/{accountId}/filters",
+ "response": {
+ "$ref": "Filters"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing filter. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.filters.patch",
+ "parameterOrder": [
+ "accountId",
+ "filterId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which the filter belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterId": {
+ "description": "ID of the filter to be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/filters/{filterId}",
+ "request": {
+ "$ref": "Filter"
+ },
+ "response": {
+ "$ref": "Filter"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing filter.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.filters.update",
+ "parameterOrder": [
+ "accountId",
+ "filterId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which the filter belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterId": {
+ "description": "ID of the filter to be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/filters/{filterId}",
+ "request": {
+ "$ref": "Filter"
+ },
+ "response": {
+ "$ref": "Filter"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "goals": {
+ "methods": {
+ "get": {
+ "description": "Gets a goal to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.goals.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "goalId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve the goal for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "goalId": {
+ "description": "Goal ID to retrieve the goal for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to retrieve the goal for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve the goal for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
+ "response": {
+ "$ref": "Goal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create a new goal.",
+ "httpMethod": "POST",
+ "id": "analytics.management.goals.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create the goal for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to create the goal for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to create the goal for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
+ "request": {
+ "$ref": "Goal"
+ },
+ "response": {
+ "$ref": "Goal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists goals to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.goals.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of goals to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "profileId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "start-index": {
+ "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
+ "response": {
+ "$ref": "Goals"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing goal. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.goals.patch",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "goalId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to update the goal.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "goalId": {
+ "description": "Index of the goal to be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to update the goal.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to update the goal.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
+ "request": {
+ "$ref": "Goal"
+ },
+ "response": {
+ "$ref": "Goal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing goal.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.goals.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "goalId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to update the goal.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "goalId": {
+ "description": "Index of the goal to be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to update the goal.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to update the goal.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
+ "request": {
+ "$ref": "Goal"
+ },
+ "response": {
+ "$ref": "Goal"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "profileFilterLinks": {
+ "methods": {
+ "delete": {
+ "description": "Delete a profile filter link.",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.profileFilterLinks.delete",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which the profile filter link belongs.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "ID of the profile filter link to delete.",
+ "location": "path",
+ "pattern": "\\d+:\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "Profile ID to which the filter link belongs.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property Id to which the profile filter link belongs.",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "get": {
+ "description": "Returns a single profile filter link.",
+ "httpMethod": "GET",
+ "id": "analytics.management.profileFilterLinks.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve profile filter link for.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "ID of the profile filter link.",
+ "location": "path",
+ "pattern": "\\d+:\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "Profile ID to retrieve filter link for.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property Id to retrieve profile filter link for.",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
+ "response": {
+ "$ref": "ProfileFilterLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create a new profile filter link.",
+ "httpMethod": "POST",
+ "id": "analytics.management.profileFilterLinks.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create profile filter link for.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "Profile ID to create filter link for.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property Id to create profile filter link for.",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
+ "request": {
+ "$ref": "ProfileFilterLink"
+ },
+ "response": {
+ "$ref": "ProfileFilterLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists all profile filter links for a profile.",
+ "httpMethod": "GET",
+ "id": "analytics.management.profileFilterLinks.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve profile filter links for.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of profile filter links to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "profileId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
+ "response": {
+ "$ref": "ProfileFilterLinks"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Update an existing profile filter link. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.profileFilterLinks.patch",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which profile filter link belongs.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "ID of the profile filter link to be updated.",
+ "location": "path",
+ "pattern": "\\d+:\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "Profile ID to which filter link belongs",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property Id to which profile filter link belongs",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
+ "request": {
+ "$ref": "ProfileFilterLink"
+ },
+ "response": {
+ "$ref": "ProfileFilterLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Update an existing profile filter link.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.profileFilterLinks.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which profile filter link belongs.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "ID of the profile filter link to be updated.",
+ "location": "path",
+ "pattern": "\\d+:\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "Profile ID to which filter link belongs",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property Id to which profile filter link belongs",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
+ "request": {
+ "$ref": "ProfileFilterLink"
+ },
+ "response": {
+ "$ref": "ProfileFilterLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "profileUserLinks": {
+ "methods": {
+ "delete": {
+ "description": "Removes a user from the given view (profile).",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.profileUserLinks.delete",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to delete the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "Link ID to delete the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to delete the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web Property ID to delete the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users"
+ ]
+ },
+ "insert": {
+ "description": "Adds a new user to the given view (profile).",
+ "httpMethod": "POST",
+ "id": "analytics.management.profileUserLinks.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to create the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web Property ID to create the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
+ "request": {
+ "$ref": "EntityUserLink"
+ },
+ "response": {
+ "$ref": "EntityUserLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users"
+ ]
+ },
+ "list": {
+ "description": "Lists profile-user links for a given view (profile).",
+ "httpMethod": "GET",
+ "id": "analytics.management.profileUserLinks.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID which the given view (profile) belongs to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of profile-user links to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "profileId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "start-index": {
+ "description": "An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
+ "response": {
+ "$ref": "EntityUserLinks"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users",
+ "https://www.googleapis.com/auth/analytics.manage.users.readonly"
+ ]
+ },
+ "update": {
+ "description": "Updates permissions for an existing user on the given view (profile).",
+ "httpMethod": "PUT",
+ "id": "analytics.management.profileUserLinks.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to update the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "Link ID to update the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile ID) to update the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web Property ID to update the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
+ "request": {
+ "$ref": "EntityUserLink"
+ },
+ "response": {
+ "$ref": "EntityUserLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users"
+ ]
+ }
+ }
+ },
+ "profiles": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a view (profile).",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.profiles.delete",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to delete the view (profile) for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "ID of the view (profile) to be deleted.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to delete the view (profile) for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "get": {
+ "description": "Gets a view (profile) to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.profiles.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve the view (profile) for.",
+ "location": "path",
+ "pattern": "[0-9]+",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to retrieve the view (profile) for.",
+ "location": "path",
+ "pattern": "[0-9]+",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve the view (profile) for.",
+ "location": "path",
+ "pattern": "UA-[0-9]+-[0-9]+",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
+ "response": {
+ "$ref": "Profile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create a new view (profile).",
+ "httpMethod": "POST",
+ "id": "analytics.management.profiles.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create the view (profile) for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to create the view (profile) for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
+ "request": {
+ "$ref": "Profile"
+ },
+ "response": {
+ "$ref": "Profile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists views (profiles) to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.profiles.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of views (profiles) to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
+ "response": {
+ "$ref": "Profiles"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing view (profile). This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.profiles.patch",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which the view (profile) belongs",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "ID of the view (profile) to be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to which the view (profile) belongs",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
+ "request": {
+ "$ref": "Profile"
+ },
+ "response": {
+ "$ref": "Profile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing view (profile).",
+ "httpMethod": "PUT",
+ "id": "analytics.management.profiles.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which the view (profile) belongs",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "ID of the view (profile) to be updated.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to which the view (profile) belongs",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
+ "request": {
+ "$ref": "Profile"
+ },
+ "response": {
+ "$ref": "Profile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "remarketingAudience": {
+ "methods": {
+ "delete": {
+ "description": "Delete a remarketing audience.",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.remarketingAudience.delete",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "remarketingAudienceId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which the remarketing audience belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingAudienceId": {
+ "description": "The ID of the remarketing audience to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to which the remarketing audience belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "get": {
+ "description": "Gets a remarketing audience to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.remarketingAudience.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "remarketingAudienceId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account ID of the remarketing audience to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingAudienceId": {
+ "description": "The ID of the remarketing audience to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "The web property ID of the remarketing audience to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
+ "response": {
+ "$ref": "RemarketingAudience"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Creates a new remarketing audience.",
+ "httpMethod": "POST",
+ "id": "analytics.management.remarketingAudience.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account ID for which to create the remarketing audience.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID for which to create the remarketing audience.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences",
+ "request": {
+ "$ref": "RemarketingAudience"
+ },
+ "response": {
+ "$ref": "RemarketingAudience"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists remarketing audiences to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.remarketingAudience.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account ID of the remarketing audiences to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of remarketing audiences to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "type": {
+ "default": "all",
+ "location": "query",
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "The web property ID of the remarketing audiences to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences",
+ "response": {
+ "$ref": "RemarketingAudiences"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing remarketing audience. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.remarketingAudience.patch",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "remarketingAudienceId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account ID of the remarketing audience to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingAudienceId": {
+ "description": "The ID of the remarketing audience to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "The web property ID of the remarketing audience to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
+ "request": {
+ "$ref": "RemarketingAudience"
+ },
+ "response": {
+ "$ref": "RemarketingAudience"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing remarketing audience.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.remarketingAudience.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "remarketingAudienceId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account ID of the remarketing audience to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "remarketingAudienceId": {
+ "description": "The ID of the remarketing audience to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "The web property ID of the remarketing audience to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
+ "request": {
+ "$ref": "RemarketingAudience"
+ },
+ "response": {
+ "$ref": "RemarketingAudience"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "segments": {
+ "methods": {
+ "list": {
+ "description": "Lists segments to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.segments.list",
+ "parameters": {
+ "max-results": {
+ "description": "The maximum number of segments to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "management/segments",
+ "response": {
+ "$ref": "Segments"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "unsampledReports": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an unsampled report.",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.unsampledReports.delete",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "unsampledReportId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to delete the unsampled report for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to delete the unsampled report for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "unsampledReportId": {
+ "description": "ID of the unsampled report to be deleted.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to delete the unsampled reports for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "get": {
+ "description": "Returns a single unsampled report.",
+ "httpMethod": "GET",
+ "id": "analytics.management.unsampledReports.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId",
+ "unsampledReportId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve unsampled report for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to retrieve unsampled report for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "unsampledReportId": {
+ "description": "ID of the unsampled report to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve unsampled reports for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}",
+ "response": {
+ "$ref": "UnsampledReport"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Create a new unsampled report.",
+ "httpMethod": "POST",
+ "id": "analytics.management.unsampledReports.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create the unsampled report for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to create the unsampled report for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to create the unsampled report for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
+ "request": {
+ "$ref": "UnsampledReport"
+ },
+ "response": {
+ "$ref": "UnsampledReport"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists unsampled reports to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.unsampledReports.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "profileId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of unsampled reports to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "start-index": {
+ "description": "An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
+ "response": {
+ "$ref": "UnsampledReports"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ },
+ "uploads": {
+ "methods": {
+ "deleteUploadData": {
+ "description": "Delete data associated with a previous upload.",
+ "httpMethod": "POST",
+ "id": "analytics.management.uploads.deleteUploadData",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customDataSourceId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account Id for the uploads to be deleted.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "customDataSourceId": {
+ "description": "Custom data source Id for the uploads to be deleted.",
+ "location": "path",
+ "pattern": ".{22}",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property Id for the uploads to be deleted.",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData",
+ "request": {
+ "$ref": "AnalyticsDataimportDeleteUploadDataRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "get": {
+ "description": "List uploads to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.uploads.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customDataSourceId",
+ "uploadId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account Id for the upload to retrieve.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "customDataSourceId": {
+ "description": "Custom data source Id for upload to retrieve.",
+ "location": "path",
+ "pattern": ".{22}",
+ "required": true,
+ "type": "string"
+ },
+ "uploadId": {
+ "description": "Upload Id to retrieve.",
+ "location": "path",
+ "pattern": ".{22}",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property Id for the upload to retrieve.",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}",
+ "response": {
+ "$ref": "Upload"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "list": {
+ "description": "List uploads to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.uploads.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customDataSourceId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account Id for the uploads to retrieve.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "customDataSourceId": {
+ "description": "Custom data source Id for uploads to retrieve.",
+ "location": "path",
+ "pattern": ".{22}",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of uploads to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "Web property Id for the uploads to retrieve.",
+ "location": "path",
+ "pattern": "UA-(\\d+)-(\\d+)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
+ "response": {
+ "$ref": "Uploads"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "uploadData": {
+ "description": "Upload data for a custom data source.",
+ "httpMethod": "POST",
+ "id": "analytics.management.uploads.uploadData",
+ "mediaUpload": {
+ "accept": [
+ "application/octet-stream"
+ ],
+ "maxSize": "1GB",
+ "protocols": {
+ "resumable": {
+ "multipart": true,
+ "path": "/resumable/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads"
+ },
+ "simple": {
+ "multipart": true,
+ "path": "/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads"
+ }
+ }
+ },
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "customDataSourceId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account Id associated with the upload.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "customDataSourceId": {
+ "description": "Custom data source Id to which the data being uploaded belongs.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property UA-string associated with the upload.",
+ "location": "path",
+ "pattern": "UA-\\d+-\\d+",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
+ "response": {
+ "$ref": "Upload"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit"
+ ],
+ "supportsMediaUpload": true
+ }
+ }
+ },
+ "webPropertyAdWordsLinks": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a web property-AdWords link.",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.webPropertyAdWordsLinks.delete",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "webPropertyAdWordsLinkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "ID of the account which the given web property belongs to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyAdWordsLinkId": {
+ "description": "Web property AdWords link ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to delete the AdWords link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "get": {
+ "description": "Returns a web property-AdWords link to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.webPropertyAdWordsLinks.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "webPropertyAdWordsLinkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "ID of the account which the given web property belongs to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyAdWordsLinkId": {
+ "description": "Web property-AdWords link ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve the AdWords link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
+ "response": {
+ "$ref": "EntityAdWordsLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Creates a webProperty-AdWords link.",
+ "httpMethod": "POST",
+ "id": "analytics.management.webPropertyAdWordsLinks.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "ID of the Google Analytics account to create the link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to create the link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
+ "request": {
+ "$ref": "EntityAdWordsLink"
+ },
+ "response": {
+ "$ref": "EntityAdWordsLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists webProperty-AdWords links for a given web property.",
+ "httpMethod": "GET",
+ "id": "analytics.management.webPropertyAdWordsLinks.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "ID of the account which the given web property belongs to.",
+ "location": "path",
+ "pattern": "\\d+",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of webProperty-AdWords links to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first webProperty-AdWords link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve the AdWords links for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
+ "response": {
+ "$ref": "EntityAdWordsLinks"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing webProperty-AdWords link. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.webPropertyAdWordsLinks.patch",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "webPropertyAdWordsLinkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "ID of the account which the given web property belongs to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyAdWordsLinkId": {
+ "description": "Web property-AdWords link ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve the AdWords link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
+ "request": {
+ "$ref": "EntityAdWordsLink"
+ },
+ "response": {
+ "$ref": "EntityAdWordsLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing webProperty-AdWords link.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.webPropertyAdWordsLinks.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "webPropertyAdWordsLinkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "ID of the account which the given web property belongs to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyAdWordsLinkId": {
+ "description": "Web property-AdWords link ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to retrieve the AdWords link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
+ "request": {
+ "$ref": "EntityAdWordsLink"
+ },
+ "response": {
+ "$ref": "EntityAdWordsLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "webproperties": {
+ "methods": {
+ "get": {
+ "description": "Gets a web property to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.webproperties.get",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to retrieve the web property for.",
+ "location": "path",
+ "pattern": "[0-9]+",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "ID to retrieve the web property for.",
+ "location": "path",
+ "pattern": "UA-[0-9]+-[0-9]+",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
+ "response": {
+ "$ref": "Webproperty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "insert": {
+ "description": "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.",
+ "httpMethod": "POST",
+ "id": "analytics.management.webproperties.insert",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create the web property for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties",
+ "request": {
+ "$ref": "Webproperty"
+ },
+ "response": {
+ "$ref": "Webproperty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "list": {
+ "description": "Lists web properties to which the user has access.",
+ "httpMethod": "GET",
+ "id": "analytics.management.webproperties.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of web properties to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties",
+ "response": {
+ "$ref": "Webproperties"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing web property. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "analytics.management.webproperties.patch",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which the web property belongs",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
+ "request": {
+ "$ref": "Webproperty"
+ },
+ "response": {
+ "$ref": "Webproperty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing web property.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.webproperties.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to which the web property belongs",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
+ "request": {
+ "$ref": "Webproperty"
+ },
+ "response": {
+ "$ref": "Webproperty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.edit"
+ ]
+ }
+ }
+ },
+ "webpropertyUserLinks": {
+ "methods": {
+ "delete": {
+ "description": "Removes a user from the given web property.",
+ "httpMethod": "DELETE",
+ "id": "analytics.management.webpropertyUserLinks.delete",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to delete the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "Link ID to delete the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web Property ID to delete the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users"
+ ]
+ },
+ "insert": {
+ "description": "Adds a new user to the given web property.",
+ "httpMethod": "POST",
+ "id": "analytics.management.webpropertyUserLinks.insert",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to create the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web Property ID to create the user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
+ "request": {
+ "$ref": "EntityUserLink"
+ },
+ "response": {
+ "$ref": "EntityUserLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users"
+ ]
+ },
+ "list": {
+ "description": "Lists webProperty-user links for a given web property.",
+ "httpMethod": "GET",
+ "id": "analytics.management.webpropertyUserLinks.list",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID which the given web property belongs to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "max-results": {
+ "description": "The maximum number of webProperty-user Links to include in this response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "start-index": {
+ "description": "An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "webPropertyId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
+ "response": {
+ "$ref": "EntityUserLinks"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users",
+ "https://www.googleapis.com/auth/analytics.manage.users.readonly"
+ ]
+ },
+ "update": {
+ "description": "Updates permissions for an existing user on the given web property.",
+ "httpMethod": "PUT",
+ "id": "analytics.management.webpropertyUserLinks.update",
+ "parameterOrder": [
+ "accountId",
+ "webPropertyId",
+ "linkId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID to update the account-user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "linkId": {
+ "description": "Link ID to update the account-user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to update the account-user link for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
+ "request": {
+ "$ref": "EntityUserLink"
+ },
+ "response": {
+ "$ref": "EntityUserLink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.manage.users"
+ ]
+ }
+ }
}
- }
- },
- "useEventValue": {
- "type": "boolean",
- "description": "Determines if the event value should be used as the value for this goal."
}
- }
},
- "id": {
- "type": "string",
- "description": "Goal ID."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this goal belongs."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for an Analytics goal.",
- "default": "analytics#goal"
- },
- "name": {
- "type": "string",
- "description": "Goal name."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for a goal. Points to the view (profile) to which this goal belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the view (profile) to which this goal belongs."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#profile\".",
- "default": "analytics#profile"
- }
- }
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to which this goal belongs."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this goal."
- },
- "type": {
- "type": "string",
- "description": "Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT."
- },
- "updated": {
- "type": "string",
- "description": "Time this goal was last modified.",
- "format": "date-time"
- },
- "urlDestinationDetails": {
- "type": "object",
- "description": "Details for the goal of the type URL_DESTINATION.",
- "properties": {
- "caseSensitive": {
- "type": "boolean",
- "description": "Determines if the goal URL must exactly match the capitalization of visited URLs."
- },
- "firstStepRequired": {
- "type": "boolean",
- "description": "Determines if the first step in this goal is required."
- },
- "matchType": {
- "type": "string",
- "description": "Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX."
- },
- "steps": {
- "type": "array",
- "description": "List of steps configured for this goal funnel.",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Step name."
- },
- "number": {
- "type": "integer",
- "description": "Step number.",
- "format": "int32"
- },
- "url": {
- "type": "string",
- "description": "URL for this step."
- }
+ "metadata": {
+ "resources": {
+ "columns": {
+ "methods": {
+ "list": {
+ "description": "Lists all columns for a report type",
+ "httpMethod": "GET",
+ "id": "analytics.metadata.columns.list",
+ "parameterOrder": [
+ "reportType"
+ ],
+ "parameters": {
+ "reportType": {
+ "description": "Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API",
+ "location": "path",
+ "pattern": "ga",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "metadata/{reportType}/columns",
+ "response": {
+ "$ref": "Columns"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.edit",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
}
- }
- },
- "url": {
- "type": "string",
- "description": "URL for this goal."
}
- }
},
- "value": {
- "type": "number",
- "description": "Goal value.",
- "format": "float"
- },
- "visitNumPagesDetails": {
- "type": "object",
- "description": "Details for the goal of the type VISIT_NUM_PAGES.",
- "properties": {
- "comparisonType": {
- "type": "string",
- "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL."
- },
- "comparisonValue": {
- "type": "string",
- "description": "Value used for this comparison.",
- "format": "int64"
+ "provisioning": {
+ "methods": {
+ "createAccountTicket": {
+ "description": "Creates an account ticket.",
+ "httpMethod": "POST",
+ "id": "analytics.provisioning.createAccountTicket",
+ "path": "provisioning/createAccountTicket",
+ "request": {
+ "$ref": "AccountTicket"
+ },
+ "response": {
+ "$ref": "AccountTicket"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.provision"
+ ]
+ },
+ "createAccountTree": {
+ "description": "Provision account.",
+ "httpMethod": "POST",
+ "id": "analytics.provisioning.createAccountTree",
+ "path": "provisioning/createAccountTree",
+ "request": {
+ "$ref": "AccountTreeRequest"
+ },
+ "response": {
+ "$ref": "AccountTreeResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics.provision"
+ ]
+ }
}
- }
- },
- "visitTimeOnSiteDetails": {
- "type": "object",
- "description": "Details for the goal of the type VISIT_TIME_ON_SITE.",
- "properties": {
- "comparisonType": {
- "type": "string",
- "description": "Type of comparison. Possible values are LESS_THAN or GREATER_THAN."
- },
- "comparisonValue": {
- "type": "string",
- "description": "Value used for this comparison.",
- "format": "int64"
- }
- }
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY."
}
- }
},
- "Goals": {
- "id": "Goals",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of goals.",
- "items": {
- "$ref": "Goal"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#goals"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this goal collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this goal collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of resources in the result.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "IncludeConditions": {
- "id": "IncludeConditions",
- "type": "object",
- "description": "JSON template for an Analytics Remarketing Include Conditions.",
- "properties": {
- "daysToLookBack": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "isSmartList": {
- "type": "boolean",
- "description": "Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for include conditions.",
- "default": "analytics#includeConditions"
- },
- "membershipDurationDays": {
- "type": "integer",
- "description": "Number of days (in the range 1 to 540) a user remains in the audience.",
- "format": "int32"
- },
- "segment": {
- "type": "string",
- "description": "The segment condition that will cause a user to be added to an audience."
- }
- }
- },
- "LinkedForeignAccount": {
- "id": "LinkedForeignAccount",
- "type": "object",
- "description": "JSON template for an Analytics Remarketing Audience Foreign Link.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this linked foreign account belongs."
- },
- "eligibleForSearch": {
- "type": "boolean",
- "description": "Boolean indicating whether this is eligible for search.",
- "readOnly": true
- },
- "id": {
- "type": "string",
- "description": "Entity ad account link ID."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this linked foreign account belongs.",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Resource type for linked foreign account.",
- "default": "analytics#linkedForeignAccount"
- },
- "linkedAccountId": {
- "type": "string",
- "description": "The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX."
- },
- "remarketingAudienceId": {
- "type": "string",
- "description": "Remarketing audience ID to which this linked foreign account belongs."
- },
- "status": {
- "type": "string",
- "description": "The status of this foreign account link."
- },
- "type": {
- "type": "string",
- "description": "The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs."
- }
- }
- },
- "McfData": {
- "id": "McfData",
- "type": "object",
- "description": "Multi-Channel Funnels data for a given view (profile).",
- "properties": {
- "columnHeaders": {
- "type": "array",
- "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
- "items": {
- "type": "object",
+ "revision": "20180309",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Account": {
+ "description": "JSON template for Analytics account entry.",
+ "id": "Account",
"properties": {
- "columnType": {
- "type": "string",
- "description": "Column Type. Either DIMENSION or METRIC."
- },
- "dataType": {
- "type": "string",
- "description": "Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc."
- },
- "name": {
- "type": "string",
- "description": "Column name."
- }
- }
- }
- },
- "containsSampledData": {
- "type": "boolean",
- "description": "Determines if the Analytics data contains sampled data."
- },
- "id": {
- "type": "string",
- "description": "Unique ID for this data response."
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "analytics#mcfData"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this Analytics data query."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this Analytics data query."
- },
- "profileInfo": {
- "type": "object",
- "description": "Information for the view (profile), for which the Analytics data was requested.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs."
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "profileName": {
- "type": "string",
- "description": "View (Profile) name."
- },
- "tableId": {
- "type": "string",
- "description": "Table ID for view (profile)."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to which this view (profile) belongs."
- }
- }
- },
- "query": {
- "type": "object",
- "description": "Analytics data request query parameters.",
- "properties": {
- "dimensions": {
- "type": "string",
- "description": "List of analytics dimensions."
- },
- "end-date": {
- "type": "string",
- "description": "End date."
- },
- "filters": {
- "type": "string",
- "description": "Comma-separated list of dimension or metric filters."
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID."
- },
- "max-results": {
- "type": "integer",
- "description": "Maximum results per page.",
- "format": "int32"
- },
- "metrics": {
- "type": "array",
- "description": "List of analytics metrics.",
- "items": {
- "type": "string"
- }
- },
- "samplingLevel": {
- "type": "string",
- "description": "Desired sampling level"
- },
- "segment": {
- "type": "string",
- "description": "Analytics advanced segment."
- },
- "sort": {
- "type": "array",
- "description": "List of dimensions or metrics based on which Analytics data is sorted.",
- "items": {
- "type": "string"
- }
- },
- "start-date": {
- "type": "string",
- "description": "Start date."
- },
- "start-index": {
- "type": "integer",
- "description": "Start index.",
- "format": "int32"
- }
- }
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "description": "A union object representing a dimension or metric value. Only one of \"primitiveValue\" or \"conversionPathValue\" attribute will be populated.",
- "properties": {
- "conversionPathValue": {
- "type": "array",
- "description": "A conversion path dimension value, containing a list of interactions with their attributes.",
- "items": {
- "type": "object",
+ "childLink": {
+ "description": "Child link for an account entry. Points to the list of web properties for this account.",
"properties": {
- "interactionType": {
- "type": "string",
- "description": "Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc."
- },
- "nodeValue": {
- "type": "string",
- "description": "Node value of an interaction on conversion path. Such as source, medium etc."
- }
- }
- }
+ "href": {
+ "description": "Link to the list of web properties for this account.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#webproperties",
+ "description": "Type of the child link. Its value is \"analytics#webproperties\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "primitiveValue": {
- "type": "string",
- "description": "A primitive dimension value. A primitive metric value."
+ "created": {
+ "description": "Time the account was created.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "id": {
+ "description": "Account ID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#account",
+ "description": "Resource type for Analytics account.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Account name.",
+ "type": "string"
+ },
+ "permissions": {
+ "description": "Permissions the user has for this account.",
+ "properties": {
+ "effective": {
+ "description": "All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "Link for this account.",
+ "type": "string"
+ },
+ "starred": {
+ "description": "Indicates whether this account is starred or not.",
+ "type": "boolean"
+ },
+ "updated": {
+ "description": "Time the account was last modified.",
+ "format": "date-time",
+ "type": "string"
}
- }
- }
- }
- },
- "sampleSize": {
- "type": "string",
- "description": "The number of samples used to calculate the result.",
- "format": "int64"
- },
- "sampleSpace": {
- "type": "string",
- "description": "Total size of the sample space from which the samples were selected.",
- "format": "int64"
- },
- "selfLink": {
- "type": "string",
- "description": "Link to this page."
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of rows for the query, regardless of the number of rows in the response.",
- "format": "int32"
- },
- "totalsForAllResults": {
- "type": "object",
- "description": "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.",
- "additionalProperties": {
- "type": "string",
- "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric."
- }
- }
- }
- },
- "Profile": {
- "id": "Profile",
- "type": "object",
- "description": "JSON template for an Analytics view (profile).",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "botFilteringEnabled": {
- "type": "boolean",
- "description": "Indicates whether bot filtering is enabled for this view (profile)."
- },
- "childLink": {
- "type": "object",
- "description": "Child link for this view (profile). Points to the list of goals for this view (profile).",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the list of goals for this view (profile)."
},
- "type": {
- "type": "string",
- "description": "Value is \"analytics#goals\".",
- "default": "analytics#goals"
- }
- }
+ "type": "object"
},
- "created": {
- "type": "string",
- "description": "Time this view (profile) was created.",
- "format": "date-time",
- "readOnly": true
- },
- "currency": {
- "type": "string",
- "description": "The currency type associated with this view (profile), defaults to USD. The supported values are:\nUSD, 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"
- },
- "defaultPage": {
- "type": "string",
- "description": "Default page for this view (profile)."
- },
- "eCommerceTracking": {
- "type": "boolean",
- "description": "Indicates whether ecommerce tracking is enabled for this view (profile)."
- },
- "enhancedECommerceTracking": {
- "type": "boolean",
- "description": "Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled."
- },
- "excludeQueryParameters": {
- "type": "string",
- "description": "The query parameters that are excluded from this view (profile)."
- },
- "id": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs.",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics view (profile).",
- "default": "analytics#profile",
- "readOnly": true
- },
- "name": {
- "type": "string",
- "description": "Name of this view (profile)."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for this view (profile). Points to the web property to which this view (profile) belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the web property to which this view (profile) belongs."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#webproperty\".",
- "default": "analytics#webproperty"
- }
- }
- },
- "permissions": {
- "type": "object",
- "description": "Permissions the user has for this view (profile).",
- "properties": {
- "effective": {
- "type": "array",
- "description": "All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this view (profile).",
- "readOnly": true
- },
- "siteSearchCategoryParameters": {
- "type": "string",
- "description": "Site search category parameters for this view (profile)."
- },
- "siteSearchQueryParameters": {
- "type": "string",
- "description": "The site search query parameters for this view (profile)."
- },
- "starred": {
- "type": "boolean",
- "description": "Indicates whether this view (profile) is starred or not."
- },
- "stripSiteSearchCategoryParameters": {
- "type": "boolean",
- "description": "Whether or not Analytics will strip search category parameters from the URLs in your reports."
- },
- "stripSiteSearchQueryParameters": {
- "type": "boolean",
- "description": "Whether or not Analytics will strip search query parameters from the URLs in your reports."
- },
- "timezone": {
- "type": "string",
- "description": "Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database."
- },
- "type": {
- "type": "string",
- "description": "View (Profile) type. Supported types: WEB or APP."
- },
- "updated": {
- "type": "string",
- "description": "Time this view (profile) was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.",
- "readOnly": true
- },
- "websiteUrl": {
- "type": "string",
- "description": "Website URL for this view (profile)."
- }
- }
- },
- "ProfileFilterLink": {
- "id": "ProfileFilterLink",
- "type": "object",
- "description": "JSON template for an Analytics profile filter link.",
- "properties": {
- "filterRef": {
- "$ref": "FilterRef",
- "description": "Filter for this link."
- },
- "id": {
- "type": "string",
- "description": "Profile filter link ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics filter.",
- "default": "analytics#profileFilterLink",
- "readOnly": true
- },
- "profileRef": {
- "$ref": "ProfileRef",
- "description": "View (Profile) for this link."
- },
- "rank": {
- "type": "integer",
- "description": "The rank of this profile filter link relative to the other filters linked to the same profile.\nFor readonly (i.e., list and get) operations, the rank always starts at 1.\nFor 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.",
- "format": "int32"
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this profile filter link.",
- "readOnly": true
- }
- }
- },
- "ProfileFilterLinks": {
- "id": "ProfileFilterLinks",
- "type": "object",
- "description": "A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of profile filter links.",
- "items": {
- "$ref": "ProfileFilterLink"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#profileFilterLinks"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this profile filter link collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this profile filter link collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "ProfileRef": {
- "id": "ProfileRef",
- "type": "object",
- "description": "JSON template for a linked view (profile).",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "href": {
- "type": "string",
- "description": "Link for this view (profile)."
- },
- "id": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs."
- },
- "kind": {
- "type": "string",
- "description": "Analytics view (profile) reference.",
- "default": "analytics#profileRef"
- },
- "name": {
- "type": "string",
- "description": "Name of this view (profile)."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs."
- }
- }
- },
- "ProfileSummary": {
- "id": "ProfileSummary",
- "type": "object",
- "description": "JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.",
- "properties": {
- "id": {
- "type": "string",
- "description": "View (profile) ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics ProfileSummary.",
- "default": "analytics#profileSummary"
- },
- "name": {
- "type": "string",
- "description": "View (profile) name."
- },
- "starred": {
- "type": "boolean",
- "description": "Indicates whether this view (profile) is starred or not."
- },
- "type": {
- "type": "string",
- "description": "View (Profile) type. Supported types: WEB or APP."
- }
- }
- },
- "Profiles": {
- "id": "Profiles",
- "type": "object",
- "description": "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).",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of views (profiles).",
- "items": {
- "$ref": "Profile"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#profiles"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this view (profile) collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this view (profile) collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "RealtimeData": {
- "id": "RealtimeData",
- "type": "object",
- "description": "Real time data for a given view (profile).",
- "properties": {
- "columnHeaders": {
- "type": "array",
- "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
- "items": {
- "type": "object",
+ "AccountRef": {
+ "description": "JSON template for a linked account.",
+ "id": "AccountRef",
"properties": {
- "columnType": {
- "type": "string",
- "description": "Column Type. Either DIMENSION or METRIC."
- },
- "dataType": {
- "type": "string",
- "description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc."
- },
- "name": {
- "type": "string",
- "description": "Column name."
- }
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Unique ID for this data response."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "analytics#realtimeData"
- },
- "profileInfo": {
- "type": "object",
- "description": "Information for the view (profile), for which the real time data was requested.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs."
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "profileName": {
- "type": "string",
- "description": "View (Profile) name."
- },
- "tableId": {
- "type": "string",
- "description": "Table ID for view (profile)."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to which this view (profile) belongs."
- }
- }
- },
- "query": {
- "type": "object",
- "description": "Real time data request query parameters.",
- "properties": {
- "dimensions": {
- "type": "string",
- "description": "List of real time dimensions."
- },
- "filters": {
- "type": "string",
- "description": "Comma-separated list of dimension or metric filters."
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID."
- },
- "max-results": {
- "type": "integer",
- "description": "Maximum results per page.",
- "format": "int32"
- },
- "metrics": {
- "type": "array",
- "description": "List of real time metrics.",
- "items": {
- "type": "string"
- }
- },
- "sort": {
- "type": "array",
- "description": "List of dimensions or metrics based on which real time data is sorted.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link to this page."
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of rows for the query, regardless of the number of rows in the response.",
- "format": "int32"
- },
- "totalsForAllResults": {
- "type": "object",
- "description": "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.",
- "additionalProperties": {
- "type": "string",
- "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric."
- }
- }
- }
- },
- "RemarketingAudience": {
- "id": "RemarketingAudience",
- "type": "object",
- "description": "JSON template for an Analytics remarketing audience.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this remarketing audience belongs."
- },
- "audienceDefinition": {
- "type": "object",
- "description": "The simple audience definition that will cause a user to be added to an audience.",
- "properties": {
- "includeConditions": {
- "$ref": "IncludeConditions",
- "description": "Defines the conditions to include users to the audience."
- }
- }
- },
- "audienceType": {
- "type": "string",
- "description": "The type of audience, either SIMPLE or STATE_BASED."
- },
- "created": {
- "type": "string",
- "description": "Time this remarketing audience was created.",
- "format": "date-time",
- "readOnly": true
- },
- "description": {
- "type": "string",
- "description": "The description of this remarketing audience.",
- "readOnly": true
- },
- "id": {
- "type": "string",
- "description": "Remarketing Audience ID."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this remarketing audience belongs.",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#remarketingAudience"
- },
- "linkedAdAccounts": {
- "type": "array",
- "description": "The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.",
- "items": {
- "$ref": "LinkedForeignAccount"
- }
- },
- "linkedViews": {
- "type": "array",
- "description": "The views (profiles) that this remarketing audience is linked to.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of this remarketing audience."
- },
- "stateBasedAudienceDefinition": {
- "type": "object",
- "description": "A state based audience definition that will cause a user to be added or removed from an audience.",
- "properties": {
- "excludeConditions": {
- "type": "object",
- "description": "Defines the conditions to exclude users from the audience.",
- "properties": {
- "exclusionDuration": {
- "type": "string",
- "description": "Whether to make the exclusion TEMPORARY or PERMANENT."
+ "href": {
+ "description": "Link for this account.",
+ "type": "string"
},
- "segment": {
- "type": "string",
- "description": "The segment condition that will cause a user to be removed from an audience."
+ "id": {
+ "description": "Account ID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#accountRef",
+ "description": "Analytics account reference.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Account name.",
+ "type": "string"
}
- }
},
- "includeConditions": {
- "$ref": "IncludeConditions",
- "description": "Defines the conditions to include users to the audience."
- }
- }
+ "type": "object"
},
- "updated": {
- "type": "string",
- "description": "Time this remarketing audience was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs."
- }
- }
- },
- "RemarketingAudiences": {
- "id": "RemarketingAudiences",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of remarketing audiences.",
- "items": {
- "$ref": "RemarketingAudience"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#remarketingAudiences"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this remarketing audience collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this view (profile) collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "Segment": {
- "id": "Segment",
- "type": "object",
- "description": "JSON template for an Analytics segment.",
- "properties": {
- "created": {
- "type": "string",
- "description": "Time the segment was created.",
- "format": "date-time"
- },
- "definition": {
- "type": "string",
- "description": "Segment definition."
- },
- "id": {
- "type": "string",
- "description": "Segment ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics segment.",
- "default": "analytics#segment"
- },
- "name": {
- "type": "string",
- "description": "Segment name."
- },
- "segmentId": {
- "type": "string",
- "description": "Segment ID. Can be used with the 'segment' parameter in Core Reporting API."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this segment."
- },
- "type": {
- "type": "string",
- "description": "Type for a segment. Possible values are \"BUILT_IN\" or \"CUSTOM\"."
- },
- "updated": {
- "type": "string",
- "description": "Time the segment was last modified.",
- "format": "date-time"
- }
- }
- },
- "Segments": {
- "id": "Segments",
- "type": "object",
- "description": "An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of segments.",
- "items": {
- "$ref": "Segment"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type for segments.",
- "default": "analytics#segments"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this segment collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this segment collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "UnsampledReport": {
- "id": "UnsampledReport",
- "type": "object",
- "description": "JSON template for Analytics unsampled report resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this unsampled report belongs."
- },
- "cloudStorageDownloadDetails": {
- "type": "object",
- "description": "Download details for a file stored in Google Cloud Storage.",
- "readOnly": true,
- "properties": {
- "bucketId": {
- "type": "string",
- "description": "Id of the bucket the file object is stored in."
+ "AccountSummaries": {
+ "description": "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.",
+ "id": "AccountSummaries",
+ "properties": {
+ "items": {
+ "description": "A list of AccountSummaries.",
+ "items": {
+ "$ref": "AccountSummary"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#accountSummaries",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this AccountSummary collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this AccountSummary collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
},
- "objectId": {
- "type": "string",
- "description": "Id of the file object containing the report data."
- }
- }
+ "type": "object"
},
- "created": {
- "type": "string",
- "description": "Time this unsampled report was created.",
- "format": "date-time",
- "readOnly": true
- },
- "dimensions": {
- "type": "string",
- "description": "The dimensions for the unsampled report."
- },
- "downloadType": {
- "type": "string",
- "description": "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.",
- "readOnly": true
- },
- "driveDownloadDetails": {
- "type": "object",
- "description": "Download details for a file stored in Google Drive.",
- "readOnly": true,
- "properties": {
- "documentId": {
- "type": "string",
- "description": "Id of the document/file containing the report data."
- }
- }
- },
- "end-date": {
- "type": "string",
- "description": "The end date for the unsampled report.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.unsampledReports.insert"
- ]
- }
- },
- "filters": {
- "type": "string",
- "description": "The filters for the unsampled report."
- },
- "id": {
- "type": "string",
- "description": "Unsampled report ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for an Analytics unsampled report.",
- "default": "analytics#unsampledReport",
- "readOnly": true
- },
- "metrics": {
- "type": "string",
- "description": "The metrics for the unsampled report.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.unsampledReports.insert"
- ]
- }
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to which this unsampled report belongs."
- },
- "segment": {
- "type": "string",
- "description": "The segment for the unsampled report."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this unsampled report.",
- "readOnly": true
- },
- "start-date": {
- "type": "string",
- "description": "The start date for the unsampled report.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.unsampledReports.insert"
- ]
- }
- },
- "status": {
- "type": "string",
- "description": "Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.",
- "readOnly": true
- },
- "title": {
- "type": "string",
- "description": "Title of the unsampled report.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.unsampledReports.insert"
- ]
- }
- },
- "updated": {
- "type": "string",
- "description": "Time this unsampled report was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY."
- }
- }
- },
- "UnsampledReports": {
- "id": "UnsampledReports",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of unsampled reports.",
- "items": {
- "$ref": "UnsampledReport"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#unsampledReports"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this unsampled report collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this unsampled report collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of resources in the result.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "Upload": {
- "id": "Upload",
- "type": "object",
- "description": "Metadata returned for an upload operation.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account Id to which this upload belongs.",
- "format": "int64"
- },
- "customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id to which this data import belongs."
- },
- "errors": {
- "type": "array",
- "description": "Data import errors collection.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "A unique ID for this upload."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics upload.",
- "default": "analytics#upload"
- },
- "status": {
- "type": "string",
- "description": "Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED."
- },
- "uploadTime": {
- "type": "string",
- "description": "Time this file is uploaded.",
- "format": "date-time"
- }
- }
- },
- "Uploads": {
- "id": "Uploads",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of uploads.",
- "items": {
- "$ref": "Upload"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#uploads"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this upload collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this upload collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of resources in the result.",
- "format": "int32"
- }
- }
- },
- "UserRef": {
- "id": "UserRef",
- "type": "object",
- "description": "JSON template for a user reference.",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email ID of this user."
- },
- "id": {
- "type": "string",
- "description": "User ID."
- },
- "kind": {
- "type": "string",
- "default": "analytics#userRef"
- }
- }
- },
- "WebPropertyRef": {
- "id": "WebPropertyRef",
- "type": "object",
- "description": "JSON template for a web property reference.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this web property belongs."
- },
- "href": {
- "type": "string",
- "description": "Link for this web property."
- },
- "id": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for this web property."
- },
- "kind": {
- "type": "string",
- "description": "Analytics web property reference.",
- "default": "analytics#webPropertyRef"
- },
- "name": {
- "type": "string",
- "description": "Name of this web property."
- }
- }
- },
- "WebPropertySummary": {
- "id": "WebPropertySummary",
- "type": "object",
- "description": "JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for this web property."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics WebPropertySummary.",
- "default": "analytics#webPropertySummary"
- },
- "level": {
- "type": "string",
- "description": "Level for this web property. Possible values are STANDARD or PREMIUM."
- },
- "name": {
- "type": "string",
- "description": "Web property name."
- },
- "profiles": {
- "type": "array",
- "description": "List of profiles under this web property.",
- "items": {
- "$ref": "ProfileSummary"
- }
- },
- "starred": {
- "type": "boolean",
- "description": "Indicates whether this web property is starred or not."
- },
- "websiteUrl": {
- "type": "string",
- "description": "Website url for this web property."
- }
- }
- },
- "Webproperties": {
- "id": "Webproperties",
- "type": "object",
- "description": "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.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of web properties.",
- "items": {
- "$ref": "Webproperty"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "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.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#webproperties"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this web property collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this web property collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "Webproperty": {
- "id": "Webproperty",
- "type": "object",
- "description": "JSON template for an Analytics web property.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this web property belongs."
- },
- "childLink": {
- "type": "object",
- "description": "Child link for this web property. Points to the list of views (profiles) for this web property.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the list of views (profiles) for this web property."
+ "AccountSummary": {
+ "description": "JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.",
+ "id": "AccountSummary",
+ "properties": {
+ "id": {
+ "description": "Account ID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#accountSummary",
+ "description": "Resource type for Analytics AccountSummary.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Account name.",
+ "type": "string"
+ },
+ "starred": {
+ "description": "Indicates whether this account is starred or not.",
+ "type": "boolean"
+ },
+ "webProperties": {
+ "description": "List of web properties under this account.",
+ "items": {
+ "$ref": "WebPropertySummary"
+ },
+ "type": "array"
+ }
},
- "type": {
- "type": "string",
- "description": "Type of the parent link. Its value is \"analytics#profiles\".",
- "default": "analytics#profiles"
- }
- }
+ "type": "object"
},
- "created": {
- "type": "string",
- "description": "Time this web property was created.",
- "format": "date-time",
- "readOnly": true
- },
- "defaultProfileId": {
- "type": "string",
- "description": "Default view (profile) ID.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY."
- },
- "industryVertical": {
- "type": "string",
- "description": "The industry vertical/category selected for this web property."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for this web property.",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics WebProperty.",
- "default": "analytics#webproperty",
- "readOnly": true
- },
- "level": {
- "type": "string",
- "description": "Level for this web property. Possible values are STANDARD or PREMIUM.",
- "readOnly": true
- },
- "name": {
- "type": "string",
- "description": "Name of this web property."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for this web property. Points to the account to which this web property belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the account for this web property."
+ "AccountTicket": {
+ "description": "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.",
+ "id": "AccountTicket",
+ "properties": {
+ "account": {
+ "$ref": "Account",
+ "description": "Account for this ticket."
+ },
+ "id": {
+ "description": "Account ticket ID used to access the account ticket.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#accountTicket",
+ "description": "Resource type for account ticket.",
+ "type": "string"
+ },
+ "profile": {
+ "$ref": "Profile",
+ "description": "View (Profile) for the account."
+ },
+ "redirectUri": {
+ "description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.",
+ "type": "string"
+ },
+ "webproperty": {
+ "$ref": "Webproperty",
+ "description": "Web property for the account."
+ }
},
- "type": {
- "type": "string",
- "description": "Type of the parent link. Its value is \"analytics#account\".",
- "default": "analytics#account"
- }
- }
+ "type": "object"
},
- "permissions": {
- "type": "object",
- "description": "Permissions the user has for this web property.",
- "properties": {
- "effective": {
- "type": "array",
- "description": "All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- }
- }
- },
- "profileCount": {
- "type": "integer",
- "description": "View (Profile) count for this web property.",
- "format": "int32",
- "readOnly": true
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this web property.",
- "readOnly": true
- },
- "starred": {
- "type": "boolean",
- "description": "Indicates whether this web property is starred or not."
- },
- "updated": {
- "type": "string",
- "description": "Time this web property was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "websiteUrl": {
- "type": "string",
- "description": "Website url for this web property."
- }
- }
- }
- },
- "resources": {
- "data": {
- "resources": {
- "ga": {
- "methods": {
- "get": {
- "id": "analytics.data.ga.get",
- "path": "data/ga",
- "httpMethod": "GET",
- "description": "Returns Analytics data for a view (profile).",
- "parameters": {
- "dimensions": {
- "type": "string",
- "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
- "pattern": "(ga:.+)?",
- "location": "query"
+ "AccountTreeRequest": {
+ "description": "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.",
+ "id": "AccountTreeRequest",
+ "properties": {
+ "accountName": {
+ "annotations": {
+ "required": [
+ "analytics.provisioning.createAccountTree"
+ ]
+ },
+ "type": "string"
},
- "end-date": {
- "type": "string",
- "description": "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.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- "location": "query"
+ "accountSettings": {
+ "properties": {
+ "admobReporting": {
+ "type": "boolean"
+ },
+ "sharingWithGoogleAnySales": {
+ "type": "boolean"
+ },
+ "sharingWithGoogleProducts": {
+ "type": "boolean"
+ },
+ "sharingWithGoogleSales": {
+ "type": "boolean"
+ },
+ "sharingWithGoogleSupport": {
+ "type": "boolean"
+ },
+ "sharingWithOthers": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
},
- "filters": {
- "type": "string",
- "description": "A comma-separated list of dimension or metric filters to be applied to Analytics data.",
- "pattern": "ga:.+",
- "location": "query"
+ "kind": {
+ "default": "analytics#accountTreeRequest",
+ "description": "Resource type for account ticket.",
+ "type": "string"
},
- "ids": {
- "type": "string",
- "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- "required": true,
- "pattern": "ga:[0-9]+",
- "location": "query"
+ "profileName": {
+ "annotations": {
+ "required": [
+ "analytics.provisioning.createAccountTree"
+ ]
+ },
+ "type": "string"
},
- "include-empty-rows": {
- "type": "boolean",
- "description": "The response will include empty rows if this parameter is set to true, the default is true",
- "location": "query"
+ "timezone": {
+ "annotations": {
+ "required": [
+ "analytics.provisioning.createAccountTree"
+ ]
+ },
+ "type": "string"
},
- "max-results": {
- "type": "integer",
- "description": "The maximum number of entries to include in this feed.",
- "format": "int32",
- "location": "query"
+ "webpropertyName": {
+ "annotations": {
+ "required": [
+ "analytics.provisioning.createAccountTree"
+ ]
+ },
+ "type": "string"
},
- "metrics": {
- "type": "string",
- "description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.",
- "required": true,
- "pattern": "ga:.+",
- "location": "query"
- },
- "output": {
- "type": "string",
- "description": "The selected format for the response. Default format is JSON.",
- "enum": [
- "dataTable",
- "json"
- ],
- "enumDescriptions": [
- "Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.",
- "Returns the response in standard JSON format."
- ],
- "location": "query"
- },
- "samplingLevel": {
- "type": "string",
- "description": "The desired sampling level.",
- "enum": [
- "DEFAULT",
- "FASTER",
- "HIGHER_PRECISION"
- ],
- "enumDescriptions": [
- "Returns response with a sample size that balances speed and accuracy.",
- "Returns a fast response with a smaller sample size.",
- "Returns a more accurate response using a large sample size, but this may result in the response being slower."
- ],
- "location": "query"
- },
- "segment": {
- "type": "string",
- "description": "An Analytics segment to be applied to data.",
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.",
- "pattern": "(-)?ga:.+",
- "location": "query"
- },
- "start-date": {
- "type": "string",
- "description": "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.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
+ "websiteUrl": {
+ "annotations": {
+ "required": [
+ "analytics.provisioning.createAccountTree"
+ ]
+ },
+ "type": "string"
}
- },
- "parameterOrder": [
- "ids",
- "start-date",
- "end-date",
- "metrics"
- ],
- "response": {
- "$ref": "GaData"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ },
+ "type": "object"
},
- "mcf": {
- "methods": {
- "get": {
- "id": "analytics.data.mcf.get",
- "path": "data/mcf",
- "httpMethod": "GET",
- "description": "Returns Analytics Multi-Channel Funnels data for a view (profile).",
- "parameters": {
- "dimensions": {
- "type": "string",
- "description": "A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.",
- "pattern": "(mcf:.+)?",
- "location": "query"
+ "AccountTreeResponse": {
+ "description": "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).",
+ "id": "AccountTreeResponse",
+ "properties": {
+ "account": {
+ "$ref": "Account",
+ "description": "The account created."
},
- "end-date": {
- "type": "string",
- "description": "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.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- "location": "query"
+ "accountSettings": {
+ "properties": {
+ "admobReporting": {
+ "type": "boolean"
+ },
+ "sharingWithGoogleAnySales": {
+ "type": "boolean"
+ },
+ "sharingWithGoogleProducts": {
+ "type": "boolean"
+ },
+ "sharingWithGoogleSales": {
+ "type": "boolean"
+ },
+ "sharingWithGoogleSupport": {
+ "type": "boolean"
+ },
+ "sharingWithOthers": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
},
- "filters": {
- "type": "string",
- "description": "A comma-separated list of dimension or metric filters to be applied to the Analytics data.",
- "pattern": "mcf:.+",
- "location": "query"
+ "kind": {
+ "default": "analytics#accountTreeResponse",
+ "description": "Resource type for account ticket.",
+ "type": "string"
},
- "ids": {
- "type": "string",
- "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- "required": true,
- "pattern": "ga:[0-9]+",
- "location": "query"
+ "profile": {
+ "$ref": "Profile",
+ "description": "View (Profile) for the account."
},
- "max-results": {
- "type": "integer",
- "description": "The maximum number of entries to include in this feed.",
- "format": "int32",
- "location": "query"
- },
- "metrics": {
- "type": "string",
- "description": "A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.",
- "required": true,
- "pattern": "mcf:.+",
- "location": "query"
- },
- "samplingLevel": {
- "type": "string",
- "description": "The desired sampling level.",
- "enum": [
- "DEFAULT",
- "FASTER",
- "HIGHER_PRECISION"
- ],
- "enumDescriptions": [
- "Returns response with a sample size that balances speed and accuracy.",
- "Returns a fast response with a smaller sample size.",
- "Returns a more accurate response using a large sample size, but this may result in the response being slower."
- ],
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.",
- "pattern": "(-)?mcf:.+",
- "location": "query"
- },
- "start-date": {
- "type": "string",
- "description": "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.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
+ "webproperty": {
+ "$ref": "Webproperty",
+ "description": "Web property for the account."
}
- },
- "parameterOrder": [
- "ids",
- "start-date",
- "end-date",
- "metrics"
- ],
- "response": {
- "$ref": "McfData"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ },
+ "type": "object"
},
- "realtime": {
- "methods": {
- "get": {
- "id": "analytics.data.realtime.get",
- "path": "data/realtime",
- "httpMethod": "GET",
- "description": "Returns real time data for a view (profile).",
- "parameters": {
- "dimensions": {
- "type": "string",
- "description": "A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.",
- "pattern": "(ga:.+)|(rt:.+)",
- "location": "query"
+ "Accounts": {
+ "description": "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.",
+ "id": "Accounts",
+ "properties": {
+ "items": {
+ "description": "A list of accounts.",
+ "items": {
+ "$ref": "Account"
+ },
+ "type": "array"
},
- "filters": {
- "type": "string",
- "description": "A comma-separated list of dimension or metric filters to be applied to real time data.",
- "pattern": "(ga:.+)|(rt:.+)",
- "location": "query"
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
},
- "ids": {
- "type": "string",
- "description": "Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- "required": true,
- "pattern": "ga:[0-9]+",
- "location": "query"
+ "kind": {
+ "default": "analytics#accounts",
+ "description": "Collection type.",
+ "type": "string"
},
- "max-results": {
- "type": "integer",
- "description": "The maximum number of entries to include in this feed.",
- "format": "int32",
- "location": "query"
+ "nextLink": {
+ "description": "Next link for this account collection.",
+ "type": "string"
},
- "metrics": {
- "type": "string",
- "description": "A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.",
- "required": true,
- "pattern": "(ga:.+)|(rt:.+)",
- "location": "query"
+ "previousLink": {
+ "description": "Previous link for this account collection.",
+ "type": "string"
},
- "sort": {
- "type": "string",
- "description": "A comma-separated list of dimensions or metrics that determine the sort order for real time data.",
- "pattern": "(-)?((ga:.+)|(rt:.+))",
- "location": "query"
+ "startIndex": {
+ "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
}
- },
- "parameterOrder": [
- "ids",
- "metrics"
- ],
- "response": {
- "$ref": "RealtimeData"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- }
- }
- },
- "management": {
- "resources": {
- "accountSummaries": {
- "methods": {
- "list": {
- "id": "analytics.management.accountSummaries.list",
- "path": "management/accountSummaries",
- "httpMethod": "GET",
- "description": "Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AccountSummaries"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ },
+ "type": "object"
},
- "accountUserLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.accountUserLinks.delete",
- "path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
- "httpMethod": "DELETE",
- "description": "Removes a user from the given account.",
- "parameters": {
+ "AdWordsAccount": {
+ "description": "JSON template for an AdWords account.",
+ "id": "AdWordsAccount",
+ "properties": {
+ "autoTaggingEnabled": {
+ "description": "True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation.",
+ "type": "boolean"
+ },
+ "customerId": {
+ "annotations": {
+ "required": [
+ "analytics.management.webPropertyAdWordsLinks.insert",
+ "analytics.management.webPropertyAdWordsLinks.update"
+ ]
+ },
+ "description": "Customer ID. This field is required when creating an AdWords link.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#adWordsAccount",
+ "description": "Resource type for AdWords account.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AnalyticsDataimportDeleteUploadDataRequest": {
+ "description": "Request template for the delete upload data request.",
+ "id": "AnalyticsDataimportDeleteUploadDataRequest",
+ "properties": {
+ "customDataImportUids": {
+ "description": "A list of upload UIDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Column": {
+ "description": "JSON template for a metadata column.",
+ "id": "Column",
+ "properties": {
+ "attributes": {
+ "additionalProperties": {
+ "description": "The name of the attribute.",
+ "type": "string"
+ },
+ "description": "Map of attribute name and value for this column.",
+ "type": "object"
+ },
+ "id": {
+ "description": "Column id.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#column",
+ "description": "Resource type for Analytics column.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Columns": {
+ "description": "Lists columns (dimensions and metrics) for a particular report type.",
+ "id": "Columns",
+ "properties": {
+ "attributeNames": {
+ "description": "List of attributes names returned by columns.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "Etag of collection. This etag can be compared with the last response etag to check if response has changed.",
+ "type": "string"
+ },
+ "items": {
+ "description": "List of columns for a report type.",
+ "items": {
+ "$ref": "Column"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "analytics#columns",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "totalResults": {
+ "description": "Total number of columns returned in the response.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CustomDataSource": {
+ "description": "JSON template for an Analytics custom data source.",
+ "id": "CustomDataSource",
+ "properties": {
"accountId": {
- "type": "string",
- "description": "Account ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to delete the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "linkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "insert": {
- "id": "analytics.management.accountUserLinks.insert",
- "path": "management/accounts/{accountId}/entityUserLinks",
- "httpMethod": "POST",
- "description": "Adds a new user to the given account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "list": {
- "id": "analytics.management.accountUserLinks.list",
- "path": "management/accounts/{accountId}/entityUserLinks",
- "httpMethod": "GET",
- "description": "Lists account-user links for a given account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the user links for.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of account-user links to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "EntityUserLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users",
- "https://www.googleapis.com/auth/analytics.manage.users.readonly"
- ]
- },
- "update": {
- "id": "analytics.management.accountUserLinks.update",
- "path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
- "httpMethod": "PUT",
- "description": "Updates permissions for an existing user on the given account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to update the account-user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to update the account-user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "linkId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- }
- }
- },
- "accounts": {
- "methods": {
- "list": {
- "id": "analytics.management.accounts.list",
- "path": "management/accounts",
- "httpMethod": "GET",
- "description": "Lists all accounts to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of accounts to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "customDataSources": {
- "methods": {
- "list": {
- "id": "analytics.management.customDataSources.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources",
- "httpMethod": "GET",
- "description": "List custom data sources to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account Id for the custom data sources to retrieve.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of custom data sources to include in this response.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id for the custom data sources to retrieve.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "CustomDataSources"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "customDimensions": {
- "methods": {
- "get": {
- "id": "analytics.management.customDimensions.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
- "httpMethod": "GET",
- "description": "Get a custom dimension to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimension to retrieve.",
- "required": true,
- "location": "path"
- },
- "customDimensionId": {
- "type": "string",
- "description": "The ID of the custom dimension to retrieve.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDimensionId"
- ],
- "response": {
- "$ref": "CustomDimension"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.customDimensions.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
- "httpMethod": "POST",
- "description": "Create a new custom dimension.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimension to create.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to create.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "CustomDimension"
- },
- "response": {
- "$ref": "CustomDimension"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.customDimensions.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
- "httpMethod": "GET",
- "description": "Lists custom dimensions to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimensions to retrieve.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of custom dimensions to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimensions to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "CustomDimensions"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.customDimensions.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing custom dimension. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- },
- "customDimensionId": {
- "type": "string",
- "description": "Custom dimension ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- },
- "ignoreCustomDataSourceLinks": {
- "type": "boolean",
- "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
- "default": "false",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDimensionId"
- ],
- "request": {
- "$ref": "CustomDimension"
- },
- "response": {
- "$ref": "CustomDimension"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.customDimensions.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
- "httpMethod": "PUT",
- "description": "Updates an existing custom dimension.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- },
- "customDimensionId": {
- "type": "string",
- "description": "Custom dimension ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- },
- "ignoreCustomDataSourceLinks": {
- "type": "boolean",
- "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
- "default": "false",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDimensionId"
- ],
- "request": {
- "$ref": "CustomDimension"
- },
- "response": {
- "$ref": "CustomDimension"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "customMetrics": {
- "methods": {
- "get": {
- "id": "analytics.management.customMetrics.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
- "httpMethod": "GET",
- "description": "Get a custom metric to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metric to retrieve.",
- "required": true,
- "location": "path"
- },
- "customMetricId": {
- "type": "string",
- "description": "The ID of the custom metric to retrieve.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom metric to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customMetricId"
- ],
- "response": {
- "$ref": "CustomMetric"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.customMetrics.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
- "httpMethod": "POST",
- "description": "Create a new custom metric.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metric to create.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to create.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "CustomMetric"
- },
- "response": {
- "$ref": "CustomMetric"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.customMetrics.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
- "httpMethod": "GET",
- "description": "Lists custom metrics to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metrics to retrieve.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of custom metrics to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom metrics to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "CustomMetrics"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.customMetrics.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing custom metric. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metric to update.",
- "required": true,
- "location": "path"
- },
- "customMetricId": {
- "type": "string",
- "description": "Custom metric ID for the custom metric to update.",
- "required": true,
- "location": "path"
- },
- "ignoreCustomDataSourceLinks": {
- "type": "boolean",
- "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
- "default": "false",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom metric to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customMetricId"
- ],
- "request": {
- "$ref": "CustomMetric"
- },
- "response": {
- "$ref": "CustomMetric"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.customMetrics.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
- "httpMethod": "PUT",
- "description": "Updates an existing custom metric.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metric to update.",
- "required": true,
- "location": "path"
- },
- "customMetricId": {
- "type": "string",
- "description": "Custom metric ID for the custom metric to update.",
- "required": true,
- "location": "path"
- },
- "ignoreCustomDataSourceLinks": {
- "type": "boolean",
- "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
- "default": "false",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom metric to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customMetricId"
- ],
- "request": {
- "$ref": "CustomMetric"
- },
- "response": {
- "$ref": "CustomMetric"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "experiments": {
- "methods": {
- "delete": {
- "id": "analytics.management.experiments.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- "httpMethod": "DELETE",
- "description": "Delete an experiment.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the experiment belongs",
- "required": true,
- "location": "path"
- },
- "experimentId": {
- "type": "string",
- "description": "ID of the experiment to delete",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to which the experiment belongs",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which the experiment belongs",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "experimentId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.experiments.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- "httpMethod": "GET",
- "description": "Returns an experiment to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the experiment for.",
- "required": true,
- "location": "path"
- },
- "experimentId": {
- "type": "string",
- "description": "Experiment ID to retrieve the experiment for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve the experiment for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the experiment for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "experimentId"
- ],
- "response": {
- "$ref": "Experiment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.experiments.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
- "httpMethod": "POST",
- "description": "Create a new experiment.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the experiment for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to create the experiment for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the experiment for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "Experiment"
- },
- "response": {
- "$ref": "Experiment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.experiments.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
- "httpMethod": "GET",
- "description": "Lists experiments to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve experiments for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of experiments to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve experiments for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve experiments for.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "Experiments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.experiments.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- "httpMethod": "PATCH",
- "description": "Update an existing experiment. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "experimentId": {
- "type": "string",
- "description": "Experiment ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the experiment to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "experimentId"
- ],
- "request": {
- "$ref": "Experiment"
- },
- "response": {
- "$ref": "Experiment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.experiments.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- "httpMethod": "PUT",
- "description": "Update an existing experiment.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "experimentId": {
- "type": "string",
- "description": "Experiment ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the experiment to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "experimentId"
- ],
- "request": {
- "$ref": "Experiment"
- },
- "response": {
- "$ref": "Experiment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "filters": {
- "methods": {
- "delete": {
- "id": "analytics.management.filters.delete",
- "path": "management/accounts/{accountId}/filters/{filterId}",
- "httpMethod": "DELETE",
- "description": "Delete a filter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to delete the filter for.",
- "required": true,
- "location": "path"
- },
- "filterId": {
- "type": "string",
- "description": "ID of the filter to be deleted.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "filterId"
- ],
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.filters.get",
- "path": "management/accounts/{accountId}/filters/{filterId}",
- "httpMethod": "GET",
- "description": "Returns a filters to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve filters for.",
- "required": true,
- "location": "path"
- },
- "filterId": {
- "type": "string",
- "description": "Filter ID to retrieve filters for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "filterId"
- ],
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.filters.insert",
- "path": "management/accounts/{accountId}/filters",
- "httpMethod": "POST",
- "description": "Create a new filter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create filter for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "Filter"
- },
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.filters.list",
- "path": "management/accounts/{accountId}/filters",
- "httpMethod": "GET",
- "description": "Lists all filters for an account",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve filters for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of filters to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Filters"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.filters.patch",
- "path": "management/accounts/{accountId}/filters/{filterId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing filter. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the filter belongs.",
- "required": true,
- "location": "path"
- },
- "filterId": {
- "type": "string",
- "description": "ID of the filter to be updated.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "filterId"
- ],
- "request": {
- "$ref": "Filter"
- },
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.filters.update",
- "path": "management/accounts/{accountId}/filters/{filterId}",
- "httpMethod": "PUT",
- "description": "Updates an existing filter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the filter belongs.",
- "required": true,
- "location": "path"
- },
- "filterId": {
- "type": "string",
- "description": "ID of the filter to be updated.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "filterId"
- ],
- "request": {
- "$ref": "Filter"
- },
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "goals": {
- "methods": {
- "get": {
- "id": "analytics.management.goals.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
- "httpMethod": "GET",
- "description": "Gets a goal to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the goal for.",
- "required": true,
- "location": "path"
- },
- "goalId": {
- "type": "string",
- "description": "Goal ID to retrieve the goal for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve the goal for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the goal for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "goalId"
- ],
- "response": {
- "$ref": "Goal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.goals.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
- "httpMethod": "POST",
- "description": "Create a new goal.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the goal for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to create the goal for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the goal for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "Goal"
- },
- "response": {
- "$ref": "Goal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.goals.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
- "httpMethod": "GET",
- "description": "Lists goals to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of goals to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "Goals"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.goals.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing goal. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to update the goal.",
- "required": true,
- "location": "path"
- },
- "goalId": {
- "type": "string",
- "description": "Index of the goal to be updated.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to update the goal.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to update the goal.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "goalId"
- ],
- "request": {
- "$ref": "Goal"
- },
- "response": {
- "$ref": "Goal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.goals.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
- "httpMethod": "PUT",
- "description": "Updates an existing goal.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to update the goal.",
- "required": true,
- "location": "path"
- },
- "goalId": {
- "type": "string",
- "description": "Index of the goal to be updated.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to update the goal.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to update the goal.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "goalId"
- ],
- "request": {
- "$ref": "Goal"
- },
- "response": {
- "$ref": "Goal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "profileFilterLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.profileFilterLinks.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- "httpMethod": "DELETE",
- "description": "Delete a profile filter link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the profile filter link belongs.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "ID of the profile filter link to delete.",
- "required": true,
- "pattern": "\\d+:\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to which the filter link belongs.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to which the profile filter link belongs.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.profileFilterLinks.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- "httpMethod": "GET",
- "description": "Returns a single profile filter link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve profile filter link for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "ID of the profile filter link.",
- "required": true,
- "pattern": "\\d+:\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to retrieve filter link for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to retrieve profile filter link for.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "response": {
- "$ref": "ProfileFilterLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.profileFilterLinks.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
- "httpMethod": "POST",
- "description": "Create a new profile filter link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create profile filter link for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to create filter link for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to create profile filter link for.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "ProfileFilterLink"
- },
- "response": {
- "$ref": "ProfileFilterLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.profileFilterLinks.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
- "httpMethod": "GET",
- "description": "Lists all profile filter links for a profile.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve profile filter links for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of profile filter links to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "ProfileFilterLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.profileFilterLinks.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- "httpMethod": "PATCH",
- "description": "Update an existing profile filter link. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which profile filter link belongs.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "ID of the profile filter link to be updated.",
- "required": true,
- "pattern": "\\d+:\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to which filter link belongs",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to which profile filter link belongs",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "request": {
- "$ref": "ProfileFilterLink"
- },
- "response": {
- "$ref": "ProfileFilterLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.profileFilterLinks.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- "httpMethod": "PUT",
- "description": "Update an existing profile filter link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which profile filter link belongs.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "ID of the profile filter link to be updated.",
- "required": true,
- "pattern": "\\d+:\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to which filter link belongs",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to which profile filter link belongs",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "request": {
- "$ref": "ProfileFilterLink"
- },
- "response": {
- "$ref": "ProfileFilterLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "profileUserLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.profileUserLinks.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
- "httpMethod": "DELETE",
- "description": "Removes a user from the given view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to delete the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "insert": {
- "id": "analytics.management.profileUserLinks.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
- "httpMethod": "POST",
- "description": "Adds a new user to the given view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the user link for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to create the user link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to create the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "list": {
- "id": "analytics.management.profileUserLinks.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
- "httpMethod": "GET",
- "description": "Lists profile-user links for a given view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID which the given view (profile) belongs to.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of profile-user links to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "EntityUserLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users",
- "https://www.googleapis.com/auth/analytics.manage.users.readonly"
- ]
- },
- "update": {
- "id": "analytics.management.profileUserLinks.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
- "httpMethod": "PUT",
- "description": "Updates permissions for an existing user on the given view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to update the user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to update the user link for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile ID) to update the user link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to update the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- }
- }
- },
- "profiles": {
- "methods": {
- "delete": {
- "id": "analytics.management.profiles.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- "httpMethod": "DELETE",
- "description": "Deletes a view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to delete the view (profile) for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "ID of the view (profile) to be deleted.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to delete the view (profile) for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.profiles.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- "httpMethod": "GET",
- "description": "Gets a view (profile) to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the view (profile) for.",
- "required": true,
- "pattern": "[0-9]+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve the view (profile) for.",
- "required": true,
- "pattern": "[0-9]+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the view (profile) for.",
- "required": true,
- "pattern": "UA-[0-9]+-[0-9]+",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "Profile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.profiles.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
- "httpMethod": "POST",
- "description": "Create a new view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the view (profile) for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the view (profile) for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "Profile"
- },
- "response": {
- "$ref": "Profile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.profiles.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
- "httpMethod": "GET",
- "description": "Lists views (profiles) to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of views (profiles) to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "Profiles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.profiles.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing view (profile). This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the view (profile) belongs",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "ID of the view (profile) to be updated.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which the view (profile) belongs",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "Profile"
- },
- "response": {
- "$ref": "Profile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.profiles.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- "httpMethod": "PUT",
- "description": "Updates an existing view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the view (profile) belongs",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "ID of the view (profile) to be updated.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which the view (profile) belongs",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "Profile"
- },
- "response": {
- "$ref": "Profile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "remarketingAudience": {
- "methods": {
- "delete": {
- "id": "analytics.management.remarketingAudience.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
- "httpMethod": "DELETE",
- "description": "Delete a remarketing audience.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the remarketing audience belongs.",
- "required": true,
- "location": "path"
- },
- "remarketingAudienceId": {
- "type": "string",
- "description": "The ID of the remarketing audience to delete.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which the remarketing audience belongs.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "remarketingAudienceId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.remarketingAudience.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
- "httpMethod": "GET",
- "description": "Gets a remarketing audience to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account ID of the remarketing audience to retrieve.",
- "required": true,
- "location": "path"
- },
- "remarketingAudienceId": {
- "type": "string",
- "description": "The ID of the remarketing audience to retrieve.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "The web property ID of the remarketing audience to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "remarketingAudienceId"
- ],
- "response": {
- "$ref": "RemarketingAudience"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.remarketingAudience.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences",
- "httpMethod": "POST",
- "description": "Creates a new remarketing audience.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account ID for which to create the remarketing audience.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for which to create the remarketing audience.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "RemarketingAudience"
- },
- "response": {
- "$ref": "RemarketingAudience"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.remarketingAudience.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences",
- "httpMethod": "GET",
- "description": "Lists remarketing audiences to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account ID of the remarketing audiences to retrieve.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of remarketing audiences to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
+ "description": "Account ID to which this custom data source belongs.",
+ "type": "string"
+ },
+ "childLink": {
+ "properties": {
+ "href": {
+ "description": "Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Value is \"analytics#dailyUploads\". Value is \"analytics#uploads\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "created": {
+ "description": "Time this custom data source was created.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of custom data source.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Custom data source ID.",
+ "type": "string"
+ },
+ "importBehavior": {
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#customDataSource",
+ "description": "Resource type for Analytics custom data source.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this custom data source.",
+ "type": "string"
+ },
+ "parentLink": {
+ "description": "Parent link for this custom data source. Points to the web property to which this custom data source belongs.",
+ "properties": {
+ "href": {
+ "description": "Link to the web property to which this custom data source belongs.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#webproperty",
+ "description": "Value is \"analytics#webproperty\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "profilesLinked": {
+ "description": "IDs of views (profiles) linked to the custom data source.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "schema": {
+ "description": "Collection of schema headers of the custom data source.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "selfLink": {
+ "description": "Link for this Analytics custom data source.",
+ "type": "string"
},
"type": {
- "type": "string",
- "default": "all",
- "location": "query"
+ "description": "Type of the custom data source.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Time this custom data source was last modified.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Upload type of the custom data source.",
+ "type": "string"
},
"webPropertyId": {
- "type": "string",
- "description": "The web property ID of the remarketing audiences to retrieve.",
- "required": true,
- "location": "path"
+ "description": "Web property ID of the form UA-XXXXX-YY to which this custom data source belongs.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "RemarketingAudiences"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
},
- "patch": {
- "id": "analytics.management.remarketingAudience.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing remarketing audience. This method supports patch semantics.",
- "parameters": {
+ "type": "object"
+ },
+ "CustomDataSources": {
+ "description": "Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.",
+ "id": "CustomDataSources",
+ "properties": {
+ "items": {
+ "description": "Collection of custom data sources.",
+ "items": {
+ "$ref": "CustomDataSource"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#customDataSources",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this custom data source collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this custom data source collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomDimension": {
+ "description": "JSON template for Analytics Custom Dimension.",
+ "id": "CustomDimension",
+ "properties": {
"accountId": {
- "type": "string",
- "description": "The account ID of the remarketing audience to update.",
- "required": true,
- "location": "path"
+ "description": "Account ID.",
+ "type": "string"
+ },
+ "active": {
+ "description": "Boolean indicating whether the custom dimension is active.",
+ "type": "boolean"
+ },
+ "created": {
+ "description": "Time the custom dimension was created.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Custom dimension ID.",
+ "type": "string"
+ },
+ "index": {
+ "description": "Index of the custom dimension.",
+ "format": "int32",
+ "readOnly": true,
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#customDimension",
+ "description": "Kind value for a custom dimension. Set to \"analytics#customDimension\". It is a read-only field.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the custom dimension.",
+ "type": "string"
+ },
+ "parentLink": {
+ "description": "Parent link for the custom dimension. Points to the property to which the custom dimension belongs.",
+ "properties": {
+ "href": {
+ "description": "Link to the property to which the custom dimension belongs.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#webproperty",
+ "description": "Type of the parent link. Set to \"analytics#webproperty\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "scope": {
+ "description": "Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Link for the custom dimension",
+ "readOnly": true,
+ "type": "string"
+ },
+ "updated": {
+ "description": "Time the custom dimension was last modified.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Property ID.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomDimensions": {
+ "description": "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.",
+ "id": "CustomDimensions",
+ "properties": {
+ "items": {
+ "description": "Collection of custom dimensions.",
+ "items": {
+ "$ref": "CustomDimension"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#customDimensions",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this custom dimension collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this custom dimension collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomMetric": {
+ "description": "JSON template for Analytics Custom Metric.",
+ "id": "CustomMetric",
+ "properties": {
+ "accountId": {
+ "description": "Account ID.",
+ "type": "string"
+ },
+ "active": {
+ "description": "Boolean indicating whether the custom metric is active.",
+ "type": "boolean"
+ },
+ "created": {
+ "description": "Time the custom metric was created.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Custom metric ID.",
+ "type": "string"
+ },
+ "index": {
+ "description": "Index of the custom metric.",
+ "format": "int32",
+ "readOnly": true,
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#customMetric",
+ "description": "Kind value for a custom metric. Set to \"analytics#customMetric\". It is a read-only field.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "max_value": {
+ "description": "Max value of custom metric.",
+ "type": "string"
+ },
+ "min_value": {
+ "description": "Min value of custom metric.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the custom metric.",
+ "type": "string"
+ },
+ "parentLink": {
+ "description": "Parent link for the custom metric. Points to the property to which the custom metric belongs.",
+ "properties": {
+ "href": {
+ "description": "Link to the property to which the custom metric belongs.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#webproperty",
+ "description": "Type of the parent link. Set to \"analytics#webproperty\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "scope": {
+ "description": "Scope of the custom metric: HIT or PRODUCT.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Link for the custom metric",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Data type of custom metric.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Time the custom metric was last modified.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Property ID.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomMetrics": {
+ "description": "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.",
+ "id": "CustomMetrics",
+ "properties": {
+ "items": {
+ "description": "Collection of custom metrics.",
+ "items": {
+ "$ref": "CustomMetric"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#customMetrics",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this custom metric collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this custom metric collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EntityAdWordsLink": {
+ "description": "JSON template for Analytics Entity AdWords Link.",
+ "id": "EntityAdWordsLink",
+ "properties": {
+ "adWordsAccounts": {
+ "annotations": {
+ "required": [
+ "analytics.management.webPropertyAdWordsLinks.insert",
+ "analytics.management.webPropertyAdWordsLinks.update"
+ ]
+ },
+ "description": "A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.",
+ "items": {
+ "$ref": "AdWordsAccount"
+ },
+ "type": "array"
+ },
+ "entity": {
+ "description": "Web property being linked.",
+ "properties": {
+ "webPropertyRef": {
+ "$ref": "WebPropertyRef"
+ }
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "Entity AdWords link ID",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#entityAdWordsLink",
+ "description": "Resource type for entity AdWords link.",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "analytics.management.webPropertyAdWordsLinks.insert",
+ "analytics.management.webPropertyAdWordsLinks.update"
+ ]
+ },
+ "description": "Name of the link. This field is required when creating an AdWords link.",
+ "type": "string"
+ },
+ "profileIds": {
+ "description": "IDs of linked Views (Profiles) represented as strings.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "selfLink": {
+ "description": "URL link for this Google Analytics - Google AdWords link.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EntityAdWordsLinks": {
+ "description": "An entity AdWords link collection provides a list of GA-AdWords links Each resource in this collection corresponds to a single link.",
+ "id": "EntityAdWordsLinks",
+ "properties": {
+ "items": {
+ "description": "A list of entity AdWords links.",
+ "items": {
+ "$ref": "EntityAdWordsLink"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#entityAdWordsLinks",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Next link for this AdWords link collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Previous link for this AdWords link collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "EntityUserLink": {
+ "description": "JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.",
+ "id": "EntityUserLink",
+ "properties": {
+ "entity": {
+ "description": "Entity for this link. It can be an account, a web property, or a view (profile).",
+ "properties": {
+ "accountRef": {
+ "$ref": "AccountRef",
+ "description": "Account for this link."
+ },
+ "profileRef": {
+ "$ref": "ProfileRef",
+ "description": "View (Profile) for this link."
+ },
+ "webPropertyRef": {
+ "$ref": "WebPropertyRef",
+ "description": "Web property for this link."
+ }
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "Entity user link ID",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#entityUserLink",
+ "description": "Resource type for entity user link.",
+ "type": "string"
+ },
+ "permissions": {
+ "description": "Permissions the user has for this entity.",
+ "properties": {
+ "effective": {
+ "description": "Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "local": {
+ "description": "Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "Self link for this resource.",
+ "type": "string"
+ },
+ "userRef": {
+ "$ref": "UserRef",
+ "description": "User reference."
+ }
+ },
+ "type": "object"
+ },
+ "EntityUserLinks": {
+ "description": "An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.",
+ "id": "EntityUserLinks",
+ "properties": {
+ "items": {
+ "description": "A list of entity user links.",
+ "items": {
+ "$ref": "EntityUserLink"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#entityUserLinks",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Next link for this account collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Previous link for this account collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Experiment": {
+ "description": "JSON template for Analytics experiment resource.",
+ "id": "Experiment",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this experiment belongs. This field is read-only.",
+ "type": "string"
+ },
+ "created": {
+ "description": "Time the experiment was created. This field is read-only.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "description": {
+ "description": "Notes about this experiment.",
+ "type": "string"
+ },
+ "editableInGaUi": {
+ "description": "If true, the end user will be able to edit the experiment via the Google Analytics user interface.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "description": "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.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "equalWeighting": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "id": {
+ "annotations": {
+ "required": [
+ "analytics.management.experiments.patch",
+ "analytics.management.experiments.update"
+ ]
+ },
+ "description": "Experiment ID. Required for patch and update. Disallowed for create.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for the web property to which this experiment belongs. This field is read-only.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#experiment",
+ "description": "Resource type for an Analytics experiment. This field is read-only.",
+ "type": "string"
+ },
+ "minimumExperimentLengthInDays": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "analytics.management.experiments.insert",
+ "analytics.management.experiments.update"
+ ]
+ },
+ "description": "Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.",
+ "type": "string"
+ },
+ "objectiveMetric": {
+ "description": "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\".",
+ "type": "string"
+ },
+ "optimizationType": {
+ "description": "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\".",
+ "type": "string"
+ },
+ "parentLink": {
+ "description": "Parent link for an experiment. Points to the view (profile) to which this experiment belongs.",
+ "properties": {
+ "href": {
+ "description": "Link to the view (profile) to which this experiment belongs. This field is read-only.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#profile",
+ "description": "Value is \"analytics#profile\". This field is read-only.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to which this experiment belongs. This field is read-only.",
+ "type": "string"
+ },
+ "reasonExperimentEnded": {
+ "description": "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.",
+ "type": "string"
+ },
+ "rewriteVariationUrlsAsOriginal": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "selfLink": {
+ "description": "Link for this experiment. This field is read-only.",
+ "type": "string"
+ },
+ "servingFramework": {
+ "description": "The framework used to serve the experiment variations and evaluate the results. One of: \n- REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.\n- API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.\n- 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.",
+ "type": "string"
+ },
+ "snippet": {
+ "description": "The snippet of code to include on the control page(s). This field is read-only.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "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.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "status": {
+ "annotations": {
+ "required": [
+ "analytics.management.experiments.insert",
+ "analytics.management.experiments.update"
+ ]
+ },
+ "description": "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.",
+ "type": "string"
+ },
+ "trafficCoverage": {
+ "description": "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.",
+ "format": "double",
+ "type": "number"
+ },
+ "updated": {
+ "description": "Time the experiment was last modified. This field is read-only.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "variations": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "name": {
+ "annotations": {
+ "required": [
+ "analytics.management.experiments.insert",
+ "analytics.management.experiments.update"
+ ]
+ },
+ "description": "The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the variation. Possible values: \"ACTIVE\", \"INACTIVE\". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.",
+ "type": "string"
+ },
+ "weight": {
+ "description": "Weight that this variation should receive. Only present if the experiment is running. This field is read-only.",
+ "format": "double",
+ "type": "number"
+ },
+ "won": {
+ "description": "True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.",
+ "type": "string"
+ },
+ "winnerConfidenceLevel": {
+ "description": "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.",
+ "format": "double",
+ "type": "number"
+ },
+ "winnerFound": {
+ "description": "Boolean specifying whether a winner has been found for this experiment. This field is read-only.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Experiments": {
+ "description": "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.",
+ "id": "Experiments",
+ "properties": {
+ "items": {
+ "description": "A list of experiments.",
+ "items": {
+ "$ref": "Experiment"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#experiments",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this experiment collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this experiment collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of resources in the result.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Filter": {
+ "description": "JSON template for an Analytics account filter.",
+ "id": "Filter",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this filter belongs.",
+ "type": "string"
+ },
+ "advancedDetails": {
+ "description": "Details for the filter of the type ADVANCED.",
+ "properties": {
+ "caseSensitive": {
+ "description": "Indicates if the filter expressions are case sensitive.",
+ "type": "boolean"
+ },
+ "extractA": {
+ "description": "Expression to extract from field A.",
+ "type": "string"
+ },
+ "extractB": {
+ "description": "Expression to extract from field B.",
+ "type": "string"
+ },
+ "fieldA": {
+ "description": "Field A.",
+ "type": "string"
+ },
+ "fieldAIndex": {
+ "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "fieldARequired": {
+ "description": "Indicates if field A is required to match.",
+ "type": "boolean"
+ },
+ "fieldB": {
+ "description": "Field B.",
+ "type": "string"
+ },
+ "fieldBIndex": {
+ "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "fieldBRequired": {
+ "description": "Indicates if field B is required to match.",
+ "type": "boolean"
+ },
+ "outputConstructor": {
+ "description": "Expression used to construct the output value.",
+ "type": "string"
+ },
+ "outputToField": {
+ "description": "Output field.",
+ "type": "string"
+ },
+ "outputToFieldIndex": {
+ "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "overrideOutputField": {
+ "description": "Indicates if the existing value of the output field, if any, should be overridden by the output expression.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "created": {
+ "description": "Time this filter was created.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "excludeDetails": {
+ "$ref": "FilterExpression",
+ "description": "Details for the filter of the type EXCLUDE."
+ },
+ "id": {
+ "description": "Filter ID.",
+ "type": "string"
+ },
+ "includeDetails": {
+ "$ref": "FilterExpression",
+ "description": "Details for the filter of the type INCLUDE."
+ },
+ "kind": {
+ "default": "analytics#filter",
+ "description": "Resource type for Analytics filter.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "lowercaseDetails": {
+ "description": "Details for the filter of the type LOWER.",
+ "properties": {
+ "field": {
+ "description": "Field to use in the filter.",
+ "type": "string"
+ },
+ "fieldIndex": {
+ "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "analytics.management.filters.insert",
+ "analytics.management.filters.update"
+ ]
+ },
+ "description": "Name of this filter.",
+ "type": "string"
+ },
+ "parentLink": {
+ "description": "Parent link for this filter. Points to the account to which this filter belongs.",
+ "properties": {
+ "href": {
+ "description": "Link to the account to which this filter belongs.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#account",
+ "description": "Value is \"analytics#account\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "searchAndReplaceDetails": {
+ "description": "Details for the filter of the type SEARCH_AND_REPLACE.",
+ "properties": {
+ "caseSensitive": {
+ "description": "Determines if the filter is case sensitive.",
+ "type": "boolean"
+ },
+ "field": {
+ "description": "Field to use in the filter.",
+ "type": "string"
+ },
+ "fieldIndex": {
+ "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "replaceString": {
+ "description": "Term to replace the search term with.",
+ "type": "string"
+ },
+ "searchString": {
+ "description": "Term to search.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "Link for this filter.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "annotations": {
+ "required": [
+ "analytics.management.filters.insert",
+ "analytics.management.filters.update"
+ ]
+ },
+ "description": "Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Time this filter was last modified.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "uppercaseDetails": {
+ "description": "Details for the filter of the type UPPER.",
+ "properties": {
+ "field": {
+ "description": "Field to use in the filter.",
+ "type": "string"
+ },
+ "fieldIndex": {
+ "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "FilterExpression": {
+ "description": "JSON template for an Analytics filter expression.",
+ "id": "FilterExpression",
+ "properties": {
+ "caseSensitive": {
+ "description": "Determines if the filter is case sensitive.",
+ "type": "boolean"
+ },
+ "expressionValue": {
+ "description": "Filter expression value",
+ "type": "string"
+ },
+ "field": {
+ "description": "Field to filter. Possible values: \n- Content and Traffic \n- PAGE_REQUEST_URI, \n- PAGE_HOSTNAME, \n- PAGE_TITLE, \n- REFERRAL, \n- COST_DATA_URI (Campaign target URL), \n- HIT_TYPE, \n- INTERNAL_SEARCH_TERM, \n- INTERNAL_SEARCH_TYPE, \n- SOURCE_PROPERTY_TRACKING_ID, \n- Campaign or AdGroup \n- CAMPAIGN_SOURCE, \n- CAMPAIGN_MEDIUM, \n- CAMPAIGN_NAME, \n- CAMPAIGN_AD_GROUP, \n- CAMPAIGN_TERM, \n- CAMPAIGN_CONTENT, \n- CAMPAIGN_CODE, \n- CAMPAIGN_REFERRAL_PATH, \n- E-Commerce \n- TRANSACTION_COUNTRY, \n- TRANSACTION_REGION, \n- TRANSACTION_CITY, \n- TRANSACTION_AFFILIATION (Store or order location), \n- ITEM_NAME, \n- ITEM_CODE, \n- ITEM_VARIATION, \n- TRANSACTION_ID, \n- TRANSACTION_CURRENCY_CODE, \n- PRODUCT_ACTION_TYPE, \n- Audience/Users \n- BROWSER, \n- BROWSER_VERSION, \n- BROWSER_SIZE, \n- PLATFORM, \n- PLATFORM_VERSION, \n- LANGUAGE, \n- SCREEN_RESOLUTION, \n- SCREEN_COLORS, \n- JAVA_ENABLED (Boolean Field), \n- FLASH_VERSION, \n- GEO_SPEED (Connection speed), \n- VISITOR_TYPE, \n- GEO_ORGANIZATION (ISP organization), \n- GEO_DOMAIN, \n- GEO_IP_ADDRESS, \n- GEO_IP_VERSION, \n- Location \n- GEO_COUNTRY, \n- GEO_REGION, \n- GEO_CITY, \n- Event \n- EVENT_CATEGORY, \n- EVENT_ACTION, \n- EVENT_LABEL, \n- Other \n- CUSTOM_FIELD_1, \n- CUSTOM_FIELD_2, \n- USER_DEFINED_VALUE, \n- Application \n- APP_ID, \n- APP_INSTALLER_ID, \n- APP_NAME, \n- APP_VERSION, \n- SCREEN, \n- IS_APP (Boolean Field), \n- IS_FATAL_EXCEPTION (Boolean Field), \n- EXCEPTION_DESCRIPTION, \n- Mobile device \n- IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), \n- IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), \n- DEVICE_CATEGORY, \n- MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), \n- MOBILE_HAS_NFC_SUPPORT (Boolean Field), \n- MOBILE_HAS_CELLULAR_RADIO (Boolean Field), \n- MOBILE_HAS_WIFI_SUPPORT (Boolean Field), \n- MOBILE_BRAND_NAME, \n- MOBILE_MODEL_NAME, \n- MOBILE_MARKETING_NAME, \n- MOBILE_POINTING_METHOD, \n- Social \n- SOCIAL_NETWORK, \n- SOCIAL_ACTION, \n- SOCIAL_ACTION_TARGET, \n- Custom dimension \n- CUSTOM_DIMENSION (See accompanying field index),",
+ "type": "string"
+ },
+ "fieldIndex": {
+ "description": "The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#filterExpression",
+ "description": "Kind value for filter expression",
+ "type": "string"
+ },
+ "matchType": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FilterRef": {
+ "description": "JSON template for a profile filter link.",
+ "id": "FilterRef",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this filter belongs.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "href": {
+ "description": "Link for this filter.",
+ "type": "string"
+ },
+ "id": {
+ "annotations": {
+ "required": [
+ "analytics.management.profileFilterLinks.insert"
+ ]
+ },
+ "description": "Filter ID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#filterRef",
+ "description": "Kind value for filter reference.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this filter.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Filters": {
+ "description": "A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.",
+ "id": "Filters",
+ "properties": {
+ "items": {
+ "description": "A list of filters.",
+ "items": {
+ "$ref": "Filter"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#filters",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this filter collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this filter collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GaData": {
+ "description": "Analytics data for a given view (profile).",
+ "id": "GaData",
+ "properties": {
+ "columnHeaders": {
+ "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
+ "items": {
+ "properties": {
+ "columnType": {
+ "description": "Column Type. Either DIMENSION or METRIC.",
+ "type": "string"
+ },
+ "dataType": {
+ "description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Column name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "containsSampledData": {
+ "description": "Determines if Analytics data contains samples.",
+ "type": "boolean"
+ },
+ "dataLastRefreshed": {
+ "description": "The last refreshed time in seconds for Analytics data.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dataTable": {
+ "properties": {
+ "cols": {
+ "items": {
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "label": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "rows": {
+ "items": {
+ "properties": {
+ "c": {
+ "items": {
+ "properties": {
+ "v": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "Unique ID for this data response.",
+ "type": "string"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#gaData",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this Analytics data query.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this Analytics data query.",
+ "type": "string"
+ },
+ "profileInfo": {
+ "description": "Information for the view (profile), for which the Analytics data was requested.",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for the web property to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID.",
+ "type": "string"
+ },
+ "profileName": {
+ "description": "View (Profile) name.",
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Table ID for view (profile).",
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web Property ID to which this view (profile) belongs.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "query": {
+ "description": "Analytics data request query parameters.",
+ "properties": {
+ "dimensions": {
+ "description": "List of analytics dimensions.",
+ "type": "string"
+ },
+ "end-date": {
+ "description": "End date.",
+ "type": "string"
+ },
+ "filters": {
+ "description": "Comma-separated list of dimension or metric filters.",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Unique table ID.",
+ "type": "string"
+ },
+ "max-results": {
+ "description": "Maximum results per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "List of analytics metrics.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "samplingLevel": {
+ "description": "Desired sampling level",
+ "type": "string"
+ },
+ "segment": {
+ "description": "Analytics advanced segment.",
+ "type": "string"
+ },
+ "sort": {
+ "description": "List of dimensions or metrics based on which Analytics data is sorted.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "start-date": {
+ "description": "Start date.",
+ "type": "string"
+ },
+ "start-index": {
+ "description": "Start index.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "sampleSize": {
+ "description": "The number of samples used to calculate the result.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sampleSpace": {
+ "description": "Total size of the sample space from which the samples were selected.",
+ "format": "int64",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Link to this page.",
+ "type": "string"
+ },
+ "totalResults": {
+ "description": "The total number of rows for the query, regardless of the number of rows in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalsForAllResults": {
+ "additionalProperties": {
+ "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.",
+ "type": "string"
+ },
+ "description": "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.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "Goal": {
+ "description": "JSON template for Analytics goal resource.",
+ "id": "Goal",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this goal belongs.",
+ "type": "string"
+ },
+ "active": {
+ "description": "Determines whether this goal is active.",
+ "type": "boolean"
+ },
+ "created": {
+ "description": "Time this goal was created.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "eventDetails": {
+ "description": "Details for the goal of the type EVENT.",
+ "properties": {
+ "eventConditions": {
+ "description": "List of event conditions.",
+ "items": {
+ "properties": {
+ "comparisonType": {
+ "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.",
+ "type": "string"
+ },
+ "comparisonValue": {
+ "description": "Value used for this comparison.",
+ "format": "int64",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Expression used for this match.",
+ "type": "string"
+ },
+ "matchType": {
+ "description": "Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "useEventValue": {
+ "description": "Determines if the event value should be used as the value for this goal.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "Goal ID.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for the web property to which this goal belongs.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#goal",
+ "description": "Resource type for an Analytics goal.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Goal name.",
+ "type": "string"
+ },
+ "parentLink": {
+ "description": "Parent link for a goal. Points to the view (profile) to which this goal belongs.",
+ "properties": {
+ "href": {
+ "description": "Link to the view (profile) to which this goal belongs.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#profile",
+ "description": "Value is \"analytics#profile\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "profileId": {
+ "description": "View (Profile) ID to which this goal belongs.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Link for this goal.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Time this goal was last modified.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "urlDestinationDetails": {
+ "description": "Details for the goal of the type URL_DESTINATION.",
+ "properties": {
+ "caseSensitive": {
+ "description": "Determines if the goal URL must exactly match the capitalization of visited URLs.",
+ "type": "boolean"
+ },
+ "firstStepRequired": {
+ "description": "Determines if the first step in this goal is required.",
+ "type": "boolean"
+ },
+ "matchType": {
+ "description": "Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.",
+ "type": "string"
+ },
+ "steps": {
+ "description": "List of steps configured for this goal funnel.",
+ "items": {
+ "properties": {
+ "name": {
+ "description": "Step name.",
+ "type": "string"
+ },
+ "number": {
+ "description": "Step number.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "description": "URL for this step.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "url": {
+ "description": "URL for this goal.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "value": {
+ "description": "Goal value.",
+ "format": "float",
+ "type": "number"
+ },
+ "visitNumPagesDetails": {
+ "description": "Details for the goal of the type VISIT_NUM_PAGES.",
+ "properties": {
+ "comparisonType": {
+ "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.",
+ "type": "string"
+ },
+ "comparisonValue": {
+ "description": "Value used for this comparison.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "visitTimeOnSiteDetails": {
+ "description": "Details for the goal of the type VISIT_TIME_ON_SITE.",
+ "properties": {
+ "comparisonType": {
+ "description": "Type of comparison. Possible values are LESS_THAN or GREATER_THAN.",
+ "type": "string"
+ },
+ "comparisonValue": {
+ "description": "Value used for this comparison.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "webPropertyId": {
+ "description": "Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Goals": {
+ "description": "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.",
+ "id": "Goals",
+ "properties": {
+ "items": {
+ "description": "A list of goals.",
+ "items": {
+ "$ref": "Goal"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#goals",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this goal collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this goal collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of resources in the result.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "IncludeConditions": {
+ "description": "JSON template for an Analytics Remarketing Include Conditions.",
+ "id": "IncludeConditions",
+ "properties": {
+ "daysToLookBack": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "isSmartList": {
+ "description": "Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "analytics#includeConditions",
+ "description": "Resource type for include conditions.",
+ "type": "string"
+ },
+ "membershipDurationDays": {
+ "description": "Number of days (in the range 1 to 540) a user remains in the audience.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "segment": {
+ "description": "The segment condition that will cause a user to be added to an audience.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LinkedForeignAccount": {
+ "description": "JSON template for an Analytics Remarketing Audience Foreign Link.",
+ "id": "LinkedForeignAccount",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this linked foreign account belongs.",
+ "type": "string"
+ },
+ "eligibleForSearch": {
+ "description": "Boolean indicating whether this is eligible for search.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Entity ad account link ID.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for the web property to which this linked foreign account belongs.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#linkedForeignAccount",
+ "description": "Resource type for linked foreign account.",
+ "type": "string"
+ },
+ "linkedAccountId": {
+ "description": "The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.",
+ "type": "string"
},
"remarketingAudienceId": {
- "type": "string",
- "description": "The ID of the remarketing audience to update.",
- "required": true,
- "location": "path"
+ "description": "Remarketing audience ID to which this linked foreign account belongs.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of this foreign account link.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.",
+ "type": "string"
},
"webPropertyId": {
- "type": "string",
- "description": "The web property ID of the remarketing audience to update.",
- "required": true,
- "location": "path"
+ "description": "Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "remarketingAudienceId"
- ],
- "request": {
- "$ref": "RemarketingAudience"
- },
- "response": {
- "$ref": "RemarketingAudience"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
},
- "update": {
- "id": "analytics.management.remarketingAudience.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}",
- "httpMethod": "PUT",
- "description": "Updates an existing remarketing audience.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account ID of the remarketing audience to update.",
- "required": true,
- "location": "path"
+ "type": "object"
+ },
+ "McfData": {
+ "description": "Multi-Channel Funnels data for a given view (profile).",
+ "id": "McfData",
+ "properties": {
+ "columnHeaders": {
+ "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
+ "items": {
+ "properties": {
+ "columnType": {
+ "description": "Column Type. Either DIMENSION or METRIC.",
+ "type": "string"
+ },
+ "dataType": {
+ "description": "Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Column name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "remarketingAudienceId": {
- "type": "string",
- "description": "The ID of the remarketing audience to update.",
- "required": true,
- "location": "path"
+ "containsSampledData": {
+ "description": "Determines if the Analytics data contains sampled data.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Unique ID for this data response.",
+ "type": "string"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#mcfData",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this Analytics data query.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this Analytics data query.",
+ "type": "string"
+ },
+ "profileInfo": {
+ "description": "Information for the view (profile), for which the Analytics data was requested.",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for the web property to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID.",
+ "type": "string"
+ },
+ "profileName": {
+ "description": "View (Profile) name.",
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Table ID for view (profile).",
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web Property ID to which this view (profile) belongs.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "query": {
+ "description": "Analytics data request query parameters.",
+ "properties": {
+ "dimensions": {
+ "description": "List of analytics dimensions.",
+ "type": "string"
+ },
+ "end-date": {
+ "description": "End date.",
+ "type": "string"
+ },
+ "filters": {
+ "description": "Comma-separated list of dimension or metric filters.",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Unique table ID.",
+ "type": "string"
+ },
+ "max-results": {
+ "description": "Maximum results per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "List of analytics metrics.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "samplingLevel": {
+ "description": "Desired sampling level",
+ "type": "string"
+ },
+ "segment": {
+ "description": "Analytics advanced segment.",
+ "type": "string"
+ },
+ "sort": {
+ "description": "List of dimensions or metrics based on which Analytics data is sorted.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "start-date": {
+ "description": "Start date.",
+ "type": "string"
+ },
+ "start-index": {
+ "description": "Start index.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "items": {
+ "description": "A union object representing a dimension or metric value. Only one of \"primitiveValue\" or \"conversionPathValue\" attribute will be populated.",
+ "properties": {
+ "conversionPathValue": {
+ "description": "A conversion path dimension value, containing a list of interactions with their attributes.",
+ "items": {
+ "properties": {
+ "interactionType": {
+ "description": "Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.",
+ "type": "string"
+ },
+ "nodeValue": {
+ "description": "Node value of an interaction on conversion path. Such as source, medium etc.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "primitiveValue": {
+ "description": "A primitive dimension value. A primitive metric value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "sampleSize": {
+ "description": "The number of samples used to calculate the result.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sampleSpace": {
+ "description": "Total size of the sample space from which the samples were selected.",
+ "format": "int64",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Link to this page.",
+ "type": "string"
+ },
+ "totalResults": {
+ "description": "The total number of rows for the query, regardless of the number of rows in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalsForAllResults": {
+ "additionalProperties": {
+ "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.",
+ "type": "string"
+ },
+ "description": "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.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "Profile": {
+ "description": "JSON template for an Analytics view (profile).",
+ "id": "Profile",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "botFilteringEnabled": {
+ "description": "Indicates whether bot filtering is enabled for this view (profile).",
+ "type": "boolean"
+ },
+ "childLink": {
+ "description": "Child link for this view (profile). Points to the list of goals for this view (profile).",
+ "properties": {
+ "href": {
+ "description": "Link to the list of goals for this view (profile).",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#goals",
+ "description": "Value is \"analytics#goals\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "created": {
+ "description": "Time this view (profile) was created.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "currency": {
+ "description": "The currency type associated with this view (profile), defaults to USD. The supported values are:\nUSD, 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",
+ "type": "string"
+ },
+ "defaultPage": {
+ "description": "Default page for this view (profile).",
+ "type": "string"
+ },
+ "eCommerceTracking": {
+ "description": "Indicates whether ecommerce tracking is enabled for this view (profile).",
+ "type": "boolean"
+ },
+ "enhancedECommerceTracking": {
+ "description": "Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.",
+ "type": "boolean"
+ },
+ "excludeQueryParameters": {
+ "description": "The query parameters that are excluded from this view (profile).",
+ "type": "string"
+ },
+ "id": {
+ "description": "View (Profile) ID.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for the web property to which this view (profile) belongs.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#profile",
+ "description": "Resource type for Analytics view (profile).",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this view (profile).",
+ "type": "string"
+ },
+ "parentLink": {
+ "description": "Parent link for this view (profile). Points to the web property to which this view (profile) belongs.",
+ "properties": {
+ "href": {
+ "description": "Link to the web property to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#webproperty",
+ "description": "Value is \"analytics#webproperty\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "permissions": {
+ "description": "Permissions the user has for this view (profile).",
+ "properties": {
+ "effective": {
+ "description": "All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "Link for this view (profile).",
+ "readOnly": true,
+ "type": "string"
+ },
+ "siteSearchCategoryParameters": {
+ "description": "Site search category parameters for this view (profile).",
+ "type": "string"
+ },
+ "siteSearchQueryParameters": {
+ "description": "The site search query parameters for this view (profile).",
+ "type": "string"
+ },
+ "starred": {
+ "description": "Indicates whether this view (profile) is starred or not.",
+ "type": "boolean"
+ },
+ "stripSiteSearchCategoryParameters": {
+ "description": "Whether or not Analytics will strip search category parameters from the URLs in your reports.",
+ "type": "boolean"
+ },
+ "stripSiteSearchQueryParameters": {
+ "description": "Whether or not Analytics will strip search query parameters from the URLs in your reports.",
+ "type": "boolean"
+ },
+ "timezone": {
+ "description": "Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.",
+ "type": "string"
+ },
+ "type": {
+ "description": "View (Profile) type. Supported types: WEB or APP.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Time this view (profile) was last modified.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
},
"webPropertyId": {
- "type": "string",
- "description": "The web property ID of the remarketing audience to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "remarketingAudienceId"
- ],
- "request": {
- "$ref": "RemarketingAudience"
- },
- "response": {
- "$ref": "RemarketingAudience"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "segments": {
- "methods": {
- "list": {
- "id": "analytics.management.segments.list",
- "path": "management/segments",
- "httpMethod": "GET",
- "description": "Lists segments to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of segments to include in this response.",
- "format": "int32",
- "location": "query"
+ "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.",
+ "readOnly": true,
+ "type": "string"
},
- "start-index": {
- "type": "integer",
- "description": "An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
+ "websiteUrl": {
+ "description": "Website URL for this view (profile).",
+ "type": "string"
}
- },
- "response": {
- "$ref": "Segments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ },
+ "type": "object"
},
- "unsampledReports": {
- "methods": {
- "delete": {
- "id": "analytics.management.unsampledReports.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}",
- "httpMethod": "DELETE",
- "description": "Deletes an unsampled report.",
- "parameters": {
+ "ProfileFilterLink": {
+ "description": "JSON template for an Analytics profile filter link.",
+ "id": "ProfileFilterLink",
+ "properties": {
+ "filterRef": {
+ "$ref": "FilterRef",
+ "description": "Filter for this link."
+ },
+ "id": {
+ "description": "Profile filter link ID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#profileFilterLink",
+ "description": "Resource type for Analytics filter.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "profileRef": {
+ "$ref": "ProfileRef",
+ "description": "View (Profile) for this link."
+ },
+ "rank": {
+ "description": "The rank of this profile filter link relative to the other filters linked to the same profile.\nFor readonly (i.e., list and get) operations, the rank always starts at 1.\nFor 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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "selfLink": {
+ "description": "Link for this profile filter link.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProfileFilterLinks": {
+ "description": "A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.",
+ "id": "ProfileFilterLinks",
+ "properties": {
+ "items": {
+ "description": "A list of profile filter links.",
+ "items": {
+ "$ref": "ProfileFilterLink"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#profileFilterLinks",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this profile filter link collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this profile filter link collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProfileRef": {
+ "description": "JSON template for a linked view (profile).",
+ "id": "ProfileRef",
+ "properties": {
"accountId": {
- "type": "string",
- "description": "Account ID to delete the unsampled report for.",
- "required": true,
- "location": "path"
+ "description": "Account ID to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "href": {
+ "description": "Link for this view (profile).",
+ "type": "string"
+ },
+ "id": {
+ "description": "View (Profile) ID.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for the web property to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#profileRef",
+ "description": "Analytics view (profile) reference.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this view (profile).",
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProfileSummary": {
+ "description": "JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.",
+ "id": "ProfileSummary",
+ "properties": {
+ "id": {
+ "description": "View (profile) ID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#profileSummary",
+ "description": "Resource type for Analytics ProfileSummary.",
+ "type": "string"
+ },
+ "name": {
+ "description": "View (profile) name.",
+ "type": "string"
+ },
+ "starred": {
+ "description": "Indicates whether this view (profile) is starred or not.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "View (Profile) type. Supported types: WEB or APP.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Profiles": {
+ "description": "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).",
+ "id": "Profiles",
+ "properties": {
+ "items": {
+ "description": "A list of views (profiles).",
+ "items": {
+ "$ref": "Profile"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#profiles",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this view (profile) collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this view (profile) collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RealtimeData": {
+ "description": "Real time data for a given view (profile).",
+ "id": "RealtimeData",
+ "properties": {
+ "columnHeaders": {
+ "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
+ "items": {
+ "properties": {
+ "columnType": {
+ "description": "Column Type. Either DIMENSION or METRIC.",
+ "type": "string"
+ },
+ "dataType": {
+ "description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Column name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique ID for this data response.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#realtimeData",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "profileInfo": {
+ "description": "Information for the view (profile), for which the real time data was requested.",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for the web property to which this view (profile) belongs.",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "View (Profile) ID.",
+ "type": "string"
+ },
+ "profileName": {
+ "description": "View (Profile) name.",
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Table ID for view (profile).",
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web Property ID to which this view (profile) belongs.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "query": {
+ "description": "Real time data request query parameters.",
+ "properties": {
+ "dimensions": {
+ "description": "List of real time dimensions.",
+ "type": "string"
+ },
+ "filters": {
+ "description": "Comma-separated list of dimension or metric filters.",
+ "type": "string"
+ },
+ "ids": {
+ "description": "Unique table ID.",
+ "type": "string"
+ },
+ "max-results": {
+ "description": "Maximum results per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "List of real time metrics.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sort": {
+ "description": "List of dimensions or metrics based on which real time data is sorted.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "selfLink": {
+ "description": "Link to this page.",
+ "type": "string"
+ },
+ "totalResults": {
+ "description": "The total number of rows for the query, regardless of the number of rows in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalsForAllResults": {
+ "additionalProperties": {
+ "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.",
+ "type": "string"
+ },
+ "description": "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.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingAudience": {
+ "description": "JSON template for an Analytics remarketing audience.",
+ "id": "RemarketingAudience",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this remarketing audience belongs.",
+ "type": "string"
+ },
+ "audienceDefinition": {
+ "description": "The simple audience definition that will cause a user to be added to an audience.",
+ "properties": {
+ "includeConditions": {
+ "$ref": "IncludeConditions",
+ "description": "Defines the conditions to include users to the audience."
+ }
+ },
+ "type": "object"
+ },
+ "audienceType": {
+ "description": "The type of audience, either SIMPLE or STATE_BASED.",
+ "type": "string"
+ },
+ "created": {
+ "description": "Time this remarketing audience was created.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "The description of this remarketing audience.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Remarketing Audience ID.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for the web property to which this remarketing audience belongs.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#remarketingAudience",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "linkedAdAccounts": {
+ "description": "The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.",
+ "items": {
+ "$ref": "LinkedForeignAccount"
+ },
+ "type": "array"
+ },
+ "linkedViews": {
+ "description": "The views (profiles) that this remarketing audience is linked to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of this remarketing audience.",
+ "type": "string"
+ },
+ "stateBasedAudienceDefinition": {
+ "description": "A state based audience definition that will cause a user to be added or removed from an audience.",
+ "properties": {
+ "excludeConditions": {
+ "description": "Defines the conditions to exclude users from the audience.",
+ "properties": {
+ "exclusionDuration": {
+ "description": "Whether to make the exclusion TEMPORARY or PERMANENT.",
+ "type": "string"
+ },
+ "segment": {
+ "description": "The segment condition that will cause a user to be removed from an audience.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "includeConditions": {
+ "$ref": "IncludeConditions",
+ "description": "Defines the conditions to include users to the audience."
+ }
+ },
+ "type": "object"
+ },
+ "updated": {
+ "description": "Time this remarketing audience was last modified.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "webPropertyId": {
+ "description": "Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RemarketingAudiences": {
+ "description": "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.",
+ "id": "RemarketingAudiences",
+ "properties": {
+ "items": {
+ "description": "A list of remarketing audiences.",
+ "items": {
+ "$ref": "RemarketingAudience"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#remarketingAudiences",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this remarketing audience collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this view (profile) collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Segment": {
+ "description": "JSON template for an Analytics segment.",
+ "id": "Segment",
+ "properties": {
+ "created": {
+ "description": "Time the segment was created.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "definition": {
+ "description": "Segment definition.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Segment ID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#segment",
+ "description": "Resource type for Analytics segment.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Segment name.",
+ "type": "string"
+ },
+ "segmentId": {
+ "description": "Segment ID. Can be used with the 'segment' parameter in Core Reporting API.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Link for this segment.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type for a segment. Possible values are \"BUILT_IN\" or \"CUSTOM\".",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Time the segment was last modified.",
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Segments": {
+ "description": "An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.",
+ "id": "Segments",
+ "properties": {
+ "items": {
+ "description": "A list of segments.",
+ "items": {
+ "$ref": "Segment"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#segments",
+ "description": "Collection type for segments.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this segment collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this segment collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UnsampledReport": {
+ "description": "JSON template for Analytics unsampled report resource.",
+ "id": "UnsampledReport",
+ "properties": {
+ "accountId": {
+ "description": "Account ID to which this unsampled report belongs.",
+ "type": "string"
+ },
+ "cloudStorageDownloadDetails": {
+ "description": "Download details for a file stored in Google Cloud Storage.",
+ "properties": {
+ "bucketId": {
+ "description": "Id of the bucket the file object is stored in.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "Id of the file object containing the report data.",
+ "type": "string"
+ }
+ },
+ "readOnly": true,
+ "type": "object"
+ },
+ "created": {
+ "description": "Time this unsampled report was created.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "dimensions": {
+ "description": "The dimensions for the unsampled report.",
+ "type": "string"
+ },
+ "downloadType": {
+ "description": "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.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "driveDownloadDetails": {
+ "description": "Download details for a file stored in Google Drive.",
+ "properties": {
+ "documentId": {
+ "description": "Id of the document/file containing the report data.",
+ "type": "string"
+ }
+ },
+ "readOnly": true,
+ "type": "object"
+ },
+ "end-date": {
+ "annotations": {
+ "required": [
+ "analytics.management.filters.insert",
+ "analytics.management.unsampledReports.insert"
+ ]
+ },
+ "description": "The end date for the unsampled report.",
+ "type": "string"
+ },
+ "filters": {
+ "description": "The filters for the unsampled report.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unsampled report ID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#unsampledReport",
+ "description": "Resource type for an Analytics unsampled report.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "metrics": {
+ "annotations": {
+ "required": [
+ "analytics.management.filters.insert",
+ "analytics.management.unsampledReports.insert"
+ ]
+ },
+ "description": "The metrics for the unsampled report.",
+ "type": "string"
},
"profileId": {
- "type": "string",
- "description": "View (Profile) ID to delete the unsampled report for.",
- "required": true,
- "location": "path"
+ "description": "View (Profile) ID to which this unsampled report belongs.",
+ "type": "string"
},
- "unsampledReportId": {
- "type": "string",
- "description": "ID of the unsampled report to be deleted.",
- "required": true,
- "location": "path"
+ "segment": {
+ "description": "The segment for the unsampled report.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Link for this unsampled report.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "start-date": {
+ "annotations": {
+ "required": [
+ "analytics.management.filters.insert",
+ "analytics.management.unsampledReports.insert"
+ ]
+ },
+ "description": "The start date for the unsampled report.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "title": {
+ "annotations": {
+ "required": [
+ "analytics.management.filters.insert",
+ "analytics.management.unsampledReports.insert"
+ ]
+ },
+ "description": "Title of the unsampled report.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Time this unsampled report was last modified.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
},
"webPropertyId": {
- "type": "string",
- "description": "Web property ID to delete the unsampled reports for.",
- "required": true,
- "location": "path"
+ "description": "Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "unsampledReportId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
},
- "get": {
- "id": "analytics.management.unsampledReports.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}",
- "httpMethod": "GET",
- "description": "Returns a single unsampled report.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve unsampled report for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve unsampled report for.",
- "required": true,
- "location": "path"
- },
- "unsampledReportId": {
- "type": "string",
- "description": "ID of the unsampled report to retrieve.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve unsampled reports for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "unsampledReportId"
- ],
- "response": {
- "$ref": "UnsampledReport"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.unsampledReports.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
- "httpMethod": "POST",
- "description": "Create a new unsampled report.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the unsampled report for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to create the unsampled report for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the unsampled report for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "UnsampledReport"
- },
- "response": {
- "$ref": "UnsampledReport"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.unsampledReports.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
- "httpMethod": "GET",
- "description": "Lists unsampled reports to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of unsampled reports to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "UnsampledReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
+ "type": "object"
},
- "uploads": {
- "methods": {
- "deleteUploadData": {
- "id": "analytics.management.uploads.deleteUploadData",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData",
- "httpMethod": "POST",
- "description": "Delete data associated with a previous upload.",
- "parameters": {
+ "UnsampledReports": {
+ "description": "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.",
+ "id": "UnsampledReports",
+ "properties": {
+ "items": {
+ "description": "A list of unsampled reports.",
+ "items": {
+ "$ref": "UnsampledReport"
+ },
+ "type": "array"
+ },
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "analytics#unsampledReports",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this unsampled report collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this unsampled report collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of resources in the result.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Upload": {
+ "description": "Metadata returned for an upload operation.",
+ "id": "Upload",
+ "properties": {
"accountId": {
- "type": "string",
- "description": "Account Id for the uploads to be deleted.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
+ "description": "Account Id to which this upload belongs.",
+ "format": "int64",
+ "type": "string"
},
"customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id for the uploads to be deleted.",
- "required": true,
- "pattern": ".{22}",
- "location": "path"
+ "description": "Custom data source Id to which this data import belongs.",
+ "type": "string"
},
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id for the uploads to be deleted.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
+ "errors": {
+ "description": "Data import errors collection.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "A unique ID for this upload.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#upload",
+ "description": "Resource type for Analytics upload.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.",
+ "type": "string"
+ },
+ "uploadTime": {
+ "description": "Time this file is uploaded.",
+ "format": "date-time",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDataSourceId"
- ],
- "request": {
- "$ref": "AnalyticsDataimportDeleteUploadDataRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
},
- "get": {
- "id": "analytics.management.uploads.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}",
- "httpMethod": "GET",
- "description": "List uploads to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account Id for the upload to retrieve.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id for upload to retrieve.",
- "required": true,
- "pattern": ".{22}",
- "location": "path"
- },
- "uploadId": {
- "type": "string",
- "description": "Upload Id to retrieve.",
- "required": true,
- "pattern": ".{22}",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id for the upload to retrieve.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDataSourceId",
- "uploadId"
- ],
- "response": {
- "$ref": "Upload"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "list": {
- "id": "analytics.management.uploads.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
- "httpMethod": "GET",
- "description": "List uploads to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account Id for the uploads to retrieve.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id for uploads to retrieve.",
- "required": true,
- "pattern": ".{22}",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of uploads to include in this response.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id for the uploads to retrieve.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDataSourceId"
- ],
- "response": {
- "$ref": "Uploads"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "uploadData": {
- "id": "analytics.management.uploads.uploadData",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
- "httpMethod": "POST",
- "description": "Upload data for a custom data source.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account Id associated with the upload.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id to which the data being uploaded belongs.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property UA-string associated with the upload.",
- "required": true,
- "pattern": "UA-\\d+-\\d+",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDataSourceId"
- ],
- "response": {
- "$ref": "Upload"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "application/octet-stream"
- ],
- "maxSize": "1GB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads"
- }
- }
- }
- }
- }
+ "type": "object"
},
- "webPropertyAdWordsLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.webPropertyAdWordsLinks.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- "httpMethod": "DELETE",
- "description": "Deletes a web property-AdWords link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "location": "path"
+ "Uploads": {
+ "description": "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.",
+ "id": "Uploads",
+ "properties": {
+ "items": {
+ "description": "A list of uploads.",
+ "items": {
+ "$ref": "Upload"
+ },
+ "type": "array"
},
- "webPropertyAdWordsLinkId": {
- "type": "string",
- "description": "Web property AdWords link ID.",
- "required": true,
- "location": "path"
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
},
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to delete the AdWords link for.",
- "required": true,
- "location": "path"
+ "kind": {
+ "default": "analytics#uploads",
+ "description": "Collection type.",
+ "type": "string"
+ },
+ "nextLink": {
+ "description": "Link to next page for this upload collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this upload collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of resources in the result.",
+ "format": "int32",
+ "type": "integer"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "webPropertyAdWordsLinkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
},
- "get": {
- "id": "analytics.management.webPropertyAdWordsLinks.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- "httpMethod": "GET",
- "description": "Returns a web property-AdWords link to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "location": "path"
- },
- "webPropertyAdWordsLinkId": {
- "type": "string",
- "description": "Web property-AdWords link ID.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the AdWords link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "webPropertyAdWordsLinkId"
- ],
- "response": {
- "$ref": "EntityAdWordsLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.webPropertyAdWordsLinks.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
- "httpMethod": "POST",
- "description": "Creates a webProperty-AdWords link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the Google Analytics account to create the link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "EntityAdWordsLink"
- },
- "response": {
- "$ref": "EntityAdWordsLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.webPropertyAdWordsLinks.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
- "httpMethod": "GET",
- "description": "Lists webProperty-AdWords links for a given web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of webProperty-AdWords links to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first webProperty-AdWords link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the AdWords links for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "EntityAdWordsLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.webPropertyAdWordsLinks.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing webProperty-AdWords link. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "location": "path"
- },
- "webPropertyAdWordsLinkId": {
- "type": "string",
- "description": "Web property-AdWords link ID.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the AdWords link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "webPropertyAdWordsLinkId"
- ],
- "request": {
- "$ref": "EntityAdWordsLink"
- },
- "response": {
- "$ref": "EntityAdWordsLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.webPropertyAdWordsLinks.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- "httpMethod": "PUT",
- "description": "Updates an existing webProperty-AdWords link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "location": "path"
- },
- "webPropertyAdWordsLinkId": {
- "type": "string",
- "description": "Web property-AdWords link ID.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the AdWords link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "webPropertyAdWordsLinkId"
- ],
- "request": {
- "$ref": "EntityAdWordsLink"
- },
- "response": {
- "$ref": "EntityAdWordsLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
+ "type": "object"
},
- "webproperties": {
- "methods": {
- "get": {
- "id": "analytics.management.webproperties.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
- "httpMethod": "GET",
- "description": "Gets a web property to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the web property for.",
- "required": true,
- "pattern": "[0-9]+",
- "location": "path"
+ "UserRef": {
+ "description": "JSON template for a user reference.",
+ "id": "UserRef",
+ "properties": {
+ "email": {
+ "description": "Email ID of this user.",
+ "type": "string"
},
- "webPropertyId": {
- "type": "string",
- "description": "ID to retrieve the web property for.",
- "required": true,
- "pattern": "UA-[0-9]+-[0-9]+",
- "location": "path"
+ "id": {
+ "description": "User ID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#userRef",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "Webproperty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
},
- "insert": {
- "id": "analytics.management.webproperties.insert",
- "path": "management/accounts/{accountId}/webproperties",
- "httpMethod": "POST",
- "description": "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.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the web property for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "Webproperty"
- },
- "response": {
- "$ref": "Webproperty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.webproperties.list",
- "path": "management/accounts/{accountId}/webproperties",
- "httpMethod": "GET",
- "description": "Lists web properties to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of web properties to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Webproperties"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.webproperties.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing web property. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the web property belongs",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "Webproperty"
- },
- "response": {
- "$ref": "Webproperty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.webproperties.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
- "httpMethod": "PUT",
- "description": "Updates an existing web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the web property belongs",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "Webproperty"
- },
- "response": {
- "$ref": "Webproperty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
+ "type": "object"
},
- "webpropertyUserLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.webpropertyUserLinks.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
- "httpMethod": "DELETE",
- "description": "Removes a user from the given web property.",
- "parameters": {
+ "WebPropertyRef": {
+ "description": "JSON template for a web property reference.",
+ "id": "WebPropertyRef",
+ "properties": {
"accountId": {
- "type": "string",
- "description": "Account ID to delete the user link for.",
- "required": true,
- "location": "path"
+ "description": "Account ID to which this web property belongs.",
+ "type": "string"
},
- "linkId": {
- "type": "string",
- "description": "Link ID to delete the user link for.",
- "required": true,
- "location": "path"
+ "href": {
+ "description": "Link for this web property.",
+ "type": "string"
},
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to delete the user link for.",
- "required": true,
- "location": "path"
+ "id": {
+ "description": "Web property ID of the form UA-XXXXX-YY.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for this web property.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#webPropertyRef",
+ "description": "Analytics web property reference.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this web property.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "linkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
},
- "insert": {
- "id": "analytics.management.webpropertyUserLinks.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
- "httpMethod": "POST",
- "description": "Adds a new user to the given web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the user link for.",
- "required": true,
- "location": "path"
+ "type": "object"
+ },
+ "WebPropertySummary": {
+ "description": "JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.",
+ "id": "WebPropertySummary",
+ "properties": {
+ "id": {
+ "description": "Web property ID of the form UA-XXXXX-YY.",
+ "type": "string"
},
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to create the user link for.",
- "required": true,
- "location": "path"
+ "internalWebPropertyId": {
+ "description": "Internal ID for this web property.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#webPropertySummary",
+ "description": "Resource type for Analytics WebPropertySummary.",
+ "type": "string"
+ },
+ "level": {
+ "description": "Level for this web property. Possible values are STANDARD or PREMIUM.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Web property name.",
+ "type": "string"
+ },
+ "profiles": {
+ "description": "List of profiles under this web property.",
+ "items": {
+ "$ref": "ProfileSummary"
+ },
+ "type": "array"
+ },
+ "starred": {
+ "description": "Indicates whether this web property is starred or not.",
+ "type": "boolean"
+ },
+ "websiteUrl": {
+ "description": "Website url for this web property.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
},
- "list": {
- "id": "analytics.management.webpropertyUserLinks.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
- "httpMethod": "GET",
- "description": "Lists webProperty-user links for a given web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID which the given web property belongs to.",
- "required": true,
- "location": "path"
+ "type": "object"
+ },
+ "Webproperties": {
+ "description": "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.",
+ "id": "Webproperties",
+ "properties": {
+ "items": {
+ "description": "A list of web properties.",
+ "items": {
+ "$ref": "Webproperty"
+ },
+ "type": "array"
},
- "max-results": {
- "type": "integer",
- "description": "The maximum number of webProperty-user Links to include in this response.",
- "format": "int32",
- "location": "query"
+ "itemsPerPage": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
},
- "start-index": {
- "type": "integer",
- "description": "An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
+ "kind": {
+ "default": "analytics#webproperties",
+ "description": "Collection type.",
+ "type": "string"
},
- "webPropertyId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
+ "nextLink": {
+ "description": "Link to next page for this web property collection.",
+ "type": "string"
+ },
+ "previousLink": {
+ "description": "Link to previous page for this web property collection.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "description": "The total number of results for the query, regardless of the number of results in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "description": "Email ID of the authenticated user",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "EntityUserLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users",
- "https://www.googleapis.com/auth/analytics.manage.users.readonly"
- ]
},
- "update": {
- "id": "analytics.management.webpropertyUserLinks.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
- "httpMethod": "PUT",
- "description": "Updates permissions for an existing user on the given web property.",
- "parameters": {
+ "type": "object"
+ },
+ "Webproperty": {
+ "description": "JSON template for an Analytics web property.",
+ "id": "Webproperty",
+ "properties": {
"accountId": {
- "type": "string",
- "description": "Account ID to update the account-user link for.",
- "required": true,
- "location": "path"
+ "description": "Account ID to which this web property belongs.",
+ "type": "string"
},
- "linkId": {
- "type": "string",
- "description": "Link ID to update the account-user link for.",
- "required": true,
- "location": "path"
+ "childLink": {
+ "description": "Child link for this web property. Points to the list of views (profiles) for this web property.",
+ "properties": {
+ "href": {
+ "description": "Link to the list of views (profiles) for this web property.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#profiles",
+ "description": "Type of the parent link. Its value is \"analytics#profiles\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to update the account-user link for.",
- "required": true,
- "location": "path"
+ "created": {
+ "description": "Time this web property was created.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "defaultProfileId": {
+ "description": "Default view (profile) ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Web property ID of the form UA-XXXXX-YY.",
+ "type": "string"
+ },
+ "industryVertical": {
+ "description": "The industry vertical/category selected for this web property.",
+ "type": "string"
+ },
+ "internalWebPropertyId": {
+ "description": "Internal ID for this web property.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "kind": {
+ "default": "analytics#webproperty",
+ "description": "Resource type for Analytics WebProperty.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "level": {
+ "description": "Level for this web property. Possible values are STANDARD or PREMIUM.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of this web property.",
+ "type": "string"
+ },
+ "parentLink": {
+ "description": "Parent link for this web property. Points to the account to which this web property belongs.",
+ "properties": {
+ "href": {
+ "description": "Link to the account for this web property.",
+ "type": "string"
+ },
+ "type": {
+ "default": "analytics#account",
+ "description": "Type of the parent link. Its value is \"analytics#account\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "permissions": {
+ "description": "Permissions the user has for this web property.",
+ "properties": {
+ "effective": {
+ "description": "All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "profileCount": {
+ "description": "View (Profile) count for this web property.",
+ "format": "int32",
+ "readOnly": true,
+ "type": "integer"
+ },
+ "selfLink": {
+ "description": "Link for this web property.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "starred": {
+ "description": "Indicates whether this web property is starred or not.",
+ "type": "boolean"
+ },
+ "updated": {
+ "description": "Time this web property was last modified.",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "websiteUrl": {
+ "description": "Website url for this web property.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "linkId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- }
- }
+ },
+ "type": "object"
}
- }
},
- "metadata": {
- "resources": {
- "columns": {
- "methods": {
- "list": {
- "id": "analytics.metadata.columns.list",
- "path": "metadata/{reportType}/columns",
- "httpMethod": "GET",
- "description": "Lists all columns for a report type",
- "parameters": {
- "reportType": {
- "type": "string",
- "description": "Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API",
- "required": true,
- "pattern": "ga",
- "location": "path"
- }
- },
- "parameterOrder": [
- "reportType"
- ],
- "response": {
- "$ref": "Columns"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- }
- }
- },
- "provisioning": {
- "methods": {
- "createAccountTicket": {
- "id": "analytics.provisioning.createAccountTicket",
- "path": "provisioning/createAccountTicket",
- "httpMethod": "POST",
- "description": "Creates an account ticket.",
- "request": {
- "$ref": "AccountTicket"
- },
- "response": {
- "$ref": "AccountTicket"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.provision"
- ]
- },
- "createAccountTree": {
- "id": "analytics.provisioning.createAccountTree",
- "path": "provisioning/createAccount",
- "httpMethod": "POST",
- "description": "Provision account.",
- "request": {
- "$ref": "AccountTreeRequest"
- },
- "response": {
- "$ref": "AccountTreeResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.provision"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "analytics/v3/",
+ "title": "Google Analytics API",
+ "version": "v3"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/analytics/v3/analytics-gen.go b/vendor/google.golang.org/api/analytics/v3/analytics-gen.go
index 1797e72d4..23aa740f3 100644
--- a/vendor/google.golang.org/api/analytics/v3/analytics-gen.go
+++ b/vendor/google.golang.org/api/analytics/v3/analytics-gen.go
@@ -16606,11 +16606,12 @@ func (c *ManagementUploadsUploadDataCall) doRequest(alt string) (*http.Response,
body = new(bytes.Buffer)
reqHeaders.Set("Content-Type", "application/json")
}
- body, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
+ body, getBody, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
defer cleanup()
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
+ gensupport.SetGetBody(req, getBody)
googleapi.Expand(req.URL, map[string]string{
"accountId": c.accountId,
"webPropertyId": c.webPropertyId,
@@ -19273,7 +19274,7 @@ func (c *ProvisioningCreateAccountTreeCall) doRequest(alt string) (*http.Respons
}
reqHeaders.Set("Content-Type", "application/json")
c.urlParams_.Set("alt", alt)
- urls := googleapi.ResolveRelative(c.s.BasePath, "provisioning/createAccount")
+ urls := googleapi.ResolveRelative(c.s.BasePath, "provisioning/createAccountTree")
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
@@ -19321,7 +19322,7 @@ func (c *ProvisioningCreateAccountTreeCall) Do(opts ...googleapi.CallOption) (*A
// "description": "Provision account.",
// "httpMethod": "POST",
// "id": "analytics.provisioning.createAccountTree",
- // "path": "provisioning/createAccount",
+ // "path": "provisioning/createAccountTree",
// "request": {
// "$ref": "AccountTreeRequest"
// },
diff --git a/vendor/google.golang.org/api/analyticsreporting/v4/analyticsreporting-api.json b/vendor/google.golang.org/api/analyticsreporting/v4/analyticsreporting-api.json
index 0ec46e763..94387b511 100644
--- a/vendor/google.golang.org/api/analyticsreporting/v4/analyticsreporting-api.json
+++ b/vendor/google.golang.org/api/analyticsreporting/v4/analyticsreporting-api.json
@@ -1,1179 +1,4 @@
{
- "title": "Google Analytics Reporting API",
- "ownerName": "Google",
- "resources": {
- "reports": {
- "methods": {
- "batchGet": {
- "description": "Returns the Analytics data.",
- "request": {
- "$ref": "GetReportsRequest"
- },
- "response": {
- "$ref": "GetReportsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ],
- "parameters": {},
- "flatPath": "v4/reports:batchGet",
- "path": "v4/reports:batchGet",
- "id": "analyticsreporting.reports.batchGet"
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "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."
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
- }
- },
- "version": "v4",
- "baseUrl": "https://analyticsreporting.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Accesses Analytics report data.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180118",
- "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
- "id": "analyticsreporting:v4",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "SegmentSequenceStep": {
- "id": "SegmentSequenceStep",
- "description": "A segment sequence definition.",
- "type": "object",
- "properties": {
- "orFiltersForSegment": {
- "description": "A sequence is specified with a list of Or grouped filters which are\ncombined with `AND` operator.",
- "type": "array",
- "items": {
- "$ref": "OrFiltersForSegment"
- }
- },
- "matchType": {
- "description": "Specifies if the step immediately precedes or can be any time before the\nnext step.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified match type is treated as precedes.",
- "Operator indicates that the previous step precedes the next step.",
- "Operator indicates that the previous step immediately precedes the next\nstep."
- ],
- "enum": [
- "UNSPECIFIED_MATCH_TYPE",
- "PRECEDES",
- "IMMEDIATELY_PRECEDES"
- ]
- }
- }
- },
- "Metric": {
- "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
- "type": "object",
- "properties": {
- "formattingType": {
- "description": "Specifies how the metric expression should be formatted, for example\n`INTEGER`.",
- "type": "string",
- "enumDescriptions": [
- "Metric type is unspecified.",
- "Integer metric.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ],
- "enum": [
- "METRIC_TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "CURRENCY",
- "PERCENT",
- "TIME"
- ]
- },
- "alias": {
- "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
- "type": "string"
- },
- "expression": {
- "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
- "type": "string"
- }
- },
- "id": "Metric"
- },
- "PivotValueRegion": {
- "description": "The metric values in the pivot region.",
- "type": "object",
- "properties": {
- "values": {
- "description": "The values of the metrics in each of the pivot regions.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PivotValueRegion"
- },
- "Report": {
- "description": "The data response corresponding to the request.",
- "type": "object",
- "properties": {
- "data": {
- "description": "Response data.",
- "$ref": "ReportData"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Page token to retrieve the next page of results in the list."
- },
- "columnHeader": {
- "description": "The column headers.",
- "$ref": "ColumnHeader"
- }
- },
- "id": "Report"
- },
- "PivotHeader": {
- "description": "The headers for each of the pivot sections defined in the request.",
- "type": "object",
- "properties": {
- "pivotHeaderEntries": {
- "description": "A single pivot section header.",
- "type": "array",
- "items": {
- "$ref": "PivotHeaderEntry"
- }
- },
- "totalPivotGroupsCount": {
- "type": "integer",
- "description": "The total number of groups for this pivot.",
- "format": "int32"
- }
- },
- "id": "PivotHeader"
- },
- "DateRange": {
- "description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.",
- "type": "object",
- "properties": {
- "endDate": {
- "description": "The end date for the query in the format `YYYY-MM-DD`.",
- "type": "string"
- },
- "startDate": {
- "description": "The start date for the query in the format `YYYY-MM-DD`.",
- "type": "string"
- }
- },
- "id": "DateRange"
- },
- "MetricFilter": {
- "properties": {
- "metricName": {
- "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
- "type": "string"
- },
- "comparisonValue": {
- "description": "The value to compare against.",
- "type": "string"
- },
- "operator": {
- "enumDescriptions": [
- "If the operator is not specified, it is treated as `EQUAL`.",
- "Should the value of the metric be exactly equal to the comparison value.",
- "Should the value of the metric be less than to the comparison value.",
- "Should the value of the metric be greater than to the comparison value.",
- "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "EQUAL",
- "LESS_THAN",
- "GREATER_THAN",
- "IS_MISSING"
- ],
- "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
- "type": "string"
- },
- "not": {
- "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
- "type": "boolean"
- }
- },
- "id": "MetricFilter",
- "description": "MetricFilter specifies the filter on a metric.",
- "type": "object"
- },
- "ReportRequest": {
- "description": "The main request class which specifies the Reporting API request.",
- "type": "object",
- "properties": {
- "pivots": {
- "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
- "type": "array",
- "items": {
- "$ref": "Pivot"
- }
- },
- "includeEmptyRows": {
- "description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.",
- "type": "boolean"
- },
- "metricFilterClauses": {
- "description": "The metric filter clauses. They are logically combined with the `AND`\noperator. Metric filters look at only the first date range and not the\ncomparing date range. Note that filtering on metrics occurs after the\nmetrics are aggregated.",
- "type": "array",
- "items": {
- "$ref": "MetricFilterClause"
- }
- },
- "pageSize": {
- "description": "Page size is for paging and specifies the maximum number of returned rows.\nPage size should be \u003e= 0. A query returns the default of 1,000 rows.\nThe Analytics Core Reporting API returns a maximum of 10,000 rows per\nrequest, no matter how many you ask for. It can also return fewer rows\nthan requested, if there aren't as many dimension segments as you expect.\nFor instance, there are fewer than 300 possible values for `ga:country`,\nso when segmenting only by country, you can't get more than 300 rows,\neven if you set `pageSize` to a higher value.",
- "format": "int32",
- "type": "integer"
- },
- "hideTotals": {
- "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
- "type": "boolean"
- },
- "hideValueRanges": {
- "description": "If set to true, hides the minimum and maximum across all matching rows.\nThe default is false and the value ranges are returned.",
- "type": "boolean"
- },
- "cohortGroup": {
- "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition.",
- "$ref": "CohortGroup"
- },
- "filtersExpression": {
- "description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
- "type": "string"
- },
- "viewId": {
- "description": "The Analytics\n[view ID](https://support.google.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportRequest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`.",
- "type": "string"
- },
- "metrics": {
- "description": "The metrics requested.\nRequests must specify at least one metric. Requests can have a\ntotal of 10 metrics.",
- "type": "array",
- "items": {
- "$ref": "Metric"
- }
- },
- "dimensionFilterClauses": {
- "description": "The dimension filter clauses for filtering Dimension Values. They are\nlogically combined with the `AND` operator. Note that filtering occurs\nbefore any dimensions are aggregated, so that the returned metrics\nrepresent the total for only the relevant dimensions.",
- "type": "array",
- "items": {
- "$ref": "DimensionFilterClause"
- }
- },
- "orderBys": {
- "description": "Sort order on output rows. To compare two rows, the elements of the\nfollowing are applied in order until a difference is found. All date\nranges in the output get the same row order.",
- "type": "array",
- "items": {
- "$ref": "OrderBy"
- }
- },
- "segments": {
- "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request can contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `segments` definition. Requests\nwith segments must have the `ga:segment` dimension.",
- "type": "array",
- "items": {
- "$ref": "Segment"
- }
- },
- "samplingLevel": {
- "enumDescriptions": [
- "If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.",
- "Returns response with a sample size that balances speed and\naccuracy.",
- "It returns a fast response with a smaller sampling size.",
- "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower."
- ],
- "enum": [
- "SAMPLING_UNSPECIFIED",
- "DEFAULT",
- "SMALL",
- "LARGE"
- ],
- "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.",
- "type": "string"
- },
- "dimensions": {
- "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
- "type": "array",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dateRanges": {
- "type": "array",
- "items": {
- "$ref": "DateRange"
- },
- "description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition."
- },
- "pageToken": {
- "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
- "type": "string"
- }
- },
- "id": "ReportRequest"
- },
- "Dimension": {
- "description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the dimension to fetch, for example `ga:browser`.",
- "type": "string"
- },
- "histogramBuckets": {
- "description": "If non-empty, we place dimension values into buckets after string to\nint64. Dimension values that are not the string representation of an\nintegral value will be converted to zero. The bucket values have to be in\nincreasing order. Each bucket is closed on the lower end, and open on the\nupper end. The \"first\" bucket includes all values less than the first\nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nvalues that fall in a bucket get transformed to a new dimension value. For\nexample, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing buckets:\n\n- bucket #1: values \u003c 0, dimension value \"\u003c0\"\n- bucket #2: values in [0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in [4,7), dimension value \"4-6\"\n- bucket #6: values \u003e= 7, dimension value \"7+\"\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nthat dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for that purpose. Without that the dimension values\nwill be sorted according to dictionary\n(lexicographic) order. For example the ascending dictionary order is:\n\n \"\u003c50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGRAM_BUCKET` order is:\n\n \"\u003c50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe client has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a histogram-mutated dimension.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- }
- },
- "id": "Dimension"
- },
- "SimpleSegment": {
- "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
- "type": "object",
- "properties": {
- "orFiltersForSegment": {
- "description": "A list of segment filters groups which are combined with logical `AND`\noperator.",
- "type": "array",
- "items": {
- "$ref": "OrFiltersForSegment"
- }
- }
- },
- "id": "SimpleSegment"
- },
- "DynamicSegment": {
- "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the dynamic segment.",
- "type": "string"
- },
- "userSegment": {
- "$ref": "SegmentDefinition",
- "description": "User Segment to select users to include in the segment."
- },
- "sessionSegment": {
- "$ref": "SegmentDefinition",
- "description": "Session Segment to select sessions to include in the segment."
- }
- },
- "id": "DynamicSegment"
- },
- "ColumnHeader": {
- "type": "object",
- "properties": {
- "dimensions": {
- "description": "The dimension names in the response.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "metricHeader": {
- "description": "Metric headers for the metrics in the response.",
- "$ref": "MetricHeader"
- }
- },
- "id": "ColumnHeader",
- "description": "Column headers."
- },
- "SegmentFilterClause": {
- "id": "SegmentFilterClause",
- "description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
- "type": "object",
- "properties": {
- "metricFilter": {
- "$ref": "SegmentMetricFilter",
- "description": "Metric Filter for the segment definition."
- },
- "not": {
- "description": "Matches the complement (`!`) of the filter.",
- "type": "boolean"
- },
- "dimensionFilter": {
- "description": "Dimension Filter for the segment definition.",
- "$ref": "SegmentDimensionFilter"
- }
- }
- },
- "MetricFilterClause": {
- "type": "object",
- "properties": {
- "operator": {
- "enumDescriptions": [
- "Unspecified operator. It is treated as an `OR`.",
- "The logical `OR` operator.",
- "The logical `AND` operator."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "OR",
- "AND"
- ],
- "description": "The operator for combining multiple metric filters. If unspecified, it is\ntreated as an `OR`.",
- "type": "string"
- },
- "filters": {
- "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
- "type": "array",
- "items": {
- "$ref": "MetricFilter"
- }
- }
- },
- "id": "MetricFilterClause",
- "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined."
- },
- "Cohort": {
- "description": "Defines a cohort. A cohort is a group of users who share a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.",
- "type": "object",
- "properties": {
- "name": {
- "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
- "type": "string"
- },
- "dateRange": {
- "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field.",
- "$ref": "DateRange"
- },
- "type": {
- "type": "string",
- "enumDescriptions": [
- "If unspecified it's treated as `FIRST_VISIT_DATE`.",
- "Cohorts that are selected based on first visit date."
- ],
- "enum": [
- "UNSPECIFIED_COHORT_TYPE",
- "FIRST_VISIT_DATE"
- ],
- "description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated\nas `FIRST_VISIT_DATE` type cohort."
- }
- },
- "id": "Cohort"
- },
- "ReportRow": {
- "type": "object",
- "properties": {
- "metrics": {
- "description": "List of metrics for each requested DateRange.",
- "type": "array",
- "items": {
- "$ref": "DateRangeValues"
- }
- },
- "dimensions": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "List of requested dimensions."
- }
- },
- "id": "ReportRow",
- "description": "A row in the report."
- },
- "OrFiltersForSegment": {
- "description": "A list of segment filters in the `OR` group are combined with the logical OR\noperator.",
- "type": "object",
- "properties": {
- "segmentFilterClauses": {
- "description": "List of segment filters to be combined with a `OR` operator.",
- "type": "array",
- "items": {
- "$ref": "SegmentFilterClause"
- }
- }
- },
- "id": "OrFiltersForSegment"
- },
- "MetricHeader": {
- "id": "MetricHeader",
- "description": "The headers for the metrics.",
- "type": "object",
- "properties": {
- "metricHeaderEntries": {
- "type": "array",
- "items": {
- "$ref": "MetricHeaderEntry"
- },
- "description": "Headers for the metrics in the response."
- },
- "pivotHeaders": {
- "description": "Headers for the pivots in the response.",
- "type": "array",
- "items": {
- "$ref": "PivotHeader"
- }
- }
- }
- },
- "DimensionFilterClause": {
- "properties": {
- "operator": {
- "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified operator. It is treated as an `OR`.",
- "The logical `OR` operator.",
- "The logical `AND` operator."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "OR",
- "AND"
- ]
- },
- "filters": {
- "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
- "type": "array",
- "items": {
- "$ref": "DimensionFilter"
- }
- }
- },
- "id": "DimensionFilterClause",
- "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
- "type": "object"
- },
- "GetReportsResponse": {
- "type": "object",
- "properties": {
- "reports": {
- "description": "Responses corresponding to each of the request.",
- "type": "array",
- "items": {
- "$ref": "Report"
- }
- },
- "queryCost": {
- "description": "The amount of resource quota tokens deducted to execute the query. Includes\nall responses.",
- "format": "int32",
- "type": "integer"
- },
- "resourceQuotasRemaining": {
- "$ref": "ResourceQuotasRemaining",
- "description": "The amount of resource quota remaining for the property."
- }
- },
- "id": "GetReportsResponse",
- "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call."
- },
- "SequenceSegment": {
- "id": "SequenceSegment",
- "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
- "type": "object",
- "properties": {
- "firstStepShouldMatchFirstHit": {
- "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).",
- "type": "boolean"
- },
- "segmentSequenceSteps": {
- "description": "The list of steps in the sequence.",
- "type": "array",
- "items": {
- "$ref": "SegmentSequenceStep"
- }
- }
- }
- },
- "SegmentMetricFilter": {
- "id": "SegmentMetricFilter",
- "description": "Metric filter to be used in a segment filter clause.",
- "type": "object",
- "properties": {
- "metricName": {
- "description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.",
- "type": "string"
- },
- "scope": {
- "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.",
- "type": "string",
- "enumDescriptions": [
- "If the scope is unspecified, it defaults to the condition scope,\n`USER` or `SESSION` depending on if the segment is trying to choose\nusers or sessions.",
- "Product scope.",
- "Hit scope.",
- "Session scope.",
- "User scope."
- ],
- "enum": [
- "UNSPECIFIED_SCOPE",
- "PRODUCT",
- "HIT",
- "SESSION",
- "USER"
- ]
- },
- "maxComparisonValue": {
- "description": "Max comparison value is only used for `BETWEEN` operator.",
- "type": "string"
- },
- "comparisonValue": {
- "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
- "type": "string"
- },
- "operator": {
- "enum": [
- "UNSPECIFIED_OPERATOR",
- "LESS_THAN",
- "GREATER_THAN",
- "EQUAL",
- "BETWEEN"
- ],
- "description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified operator is treated as `LESS_THAN` operator.",
- "Checks if the metric value is less than comparison value.",
- "Checks if the metric value is greater than comparison value.",
- "Equals operator.",
- "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison."
- ]
- }
- }
- },
- "DateRangeValues": {
- "properties": {
- "values": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Each value corresponds to each Metric in the request."
- },
- "pivotValueRegions": {
- "description": "The values of each pivot region.",
- "type": "array",
- "items": {
- "$ref": "PivotValueRegion"
- }
- }
- },
- "id": "DateRangeValues",
- "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
- "type": "object"
- },
- "CohortGroup": {
- "type": "object",
- "properties": {
- "cohorts": {
- "description": "The definition for the cohort.",
- "type": "array",
- "items": {
- "$ref": "Cohort"
- }
- },
- "lifetimeValue": {
- "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
- "type": "boolean"
- }
- },
- "id": "CohortGroup",
- "description": "Defines a cohort group.\nFor example:\n\n \"cohortGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"type\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }"
- },
- "GetReportsRequest": {
- "description": "The batch request containing multiple report request.",
- "type": "object",
- "properties": {
- "useResourceQuotas": {
- "description": "Enables\n[resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4),\n(defaults to `False`). If this field is set to `True` the\nper view (profile) quotas are governed by the computational\ncost of the request. Note that using cost based quotas will\nhigher enable sampling rates. (10 Million for `SMALL`,\n100M for `LARGE`. See the\n[limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details.",
- "type": "boolean"
- },
- "reportRequests": {
- "description": "Requests, each request will have a separate response.\nThere can be a maximum of 5 requests. All requests should have the same\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.",
- "type": "array",
- "items": {
- "$ref": "ReportRequest"
- }
- }
- },
- "id": "GetReportsRequest"
- },
- "Pivot": {
- "type": "object",
- "properties": {
- "metrics": {
- "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
- "type": "array",
- "items": {
- "$ref": "Metric"
- }
- },
- "dimensions": {
- "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
- "type": "array",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensionFilterClauses": {
- "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
- "type": "array",
- "items": {
- "$ref": "DimensionFilterClause"
- }
- },
- "maxGroupCount": {
- "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
- "format": "int32",
- "type": "integer"
- },
- "startGroup": {
- "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Pivot",
- "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension."
- },
- "PivotHeaderEntry": {
- "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
- "type": "object",
- "properties": {
- "dimensionValues": {
- "description": "The values for the dimensions in the pivot.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "dimensionNames": {
- "description": "The name of the dimensions in the pivot response.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "metric": {
- "$ref": "MetricHeaderEntry",
- "description": "The metric header for the metric in the pivot."
- }
- },
- "id": "PivotHeaderEntry"
- },
- "SegmentFilter": {
- "properties": {
- "simpleSegment": {
- "$ref": "SimpleSegment",
- "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
- },
- "sequenceSegment": {
- "$ref": "SequenceSegment",
- "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators."
- },
- "not": {
- "description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
- "type": "boolean"
- }
- },
- "id": "SegmentFilter",
- "description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
- "type": "object"
- },
- "SegmentDefinition": {
- "id": "SegmentDefinition",
- "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
- "type": "object",
- "properties": {
- "segmentFilters": {
- "description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
- "type": "array",
- "items": {
- "$ref": "SegmentFilter"
- }
- }
- }
- },
- "MetricHeaderEntry": {
- "description": "Header for the metrics.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the header.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "Metric type is unspecified.",
- "Integer metric.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ],
- "enum": [
- "METRIC_TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "CURRENCY",
- "PERCENT",
- "TIME"
- ],
- "description": "The type of the metric, for example `INTEGER`.",
- "type": "string"
- }
- },
- "id": "MetricHeaderEntry"
- },
- "ResourceQuotasRemaining": {
- "description": "The resource quota tokens remaining for the property after the request is\ncompleted.",
- "type": "object",
- "properties": {
- "dailyQuotaTokensRemaining": {
- "description": "Daily resource quota remaining remaining.",
- "format": "int32",
- "type": "integer"
- },
- "hourlyQuotaTokensRemaining": {
- "description": "Hourly resource quota tokens remaining.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ResourceQuotasRemaining"
- },
- "ReportData": {
- "description": "The data part of the report.",
- "type": "object",
- "properties": {
- "totals": {
- "description": "For each requested date range, for the set of all rows that match\nthe query, every requested value format gets a total. The total\nfor a value format is computed by first totaling the metrics\nmentioned in the value format and then evaluating the value\nformat as a scalar expression. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of all relevant ga:sessions) + 2)`.\nTotals are computed before pagination.",
- "type": "array",
- "items": {
- "$ref": "DateRangeValues"
- }
- },
- "samplesReadCounts": {
- "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of samples read, one entry per date range.\nIf the results are not sampled this field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- },
- "isDataGolden": {
- "description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
- "type": "boolean"
- },
- "rows": {
- "description": "There's one ReportRow for every unique combination of dimensions.",
- "type": "array",
- "items": {
- "$ref": "ReportRow"
- }
- },
- "rowCount": {
- "description": "Total number of matching rows for this query.",
- "format": "int32",
- "type": "integer"
- },
- "dataLastRefreshed": {
- "description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
- "format": "google-datetime",
- "type": "string"
- },
- "maximums": {
- "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
- "type": "array",
- "items": {
- "$ref": "DateRangeValues"
- }
- },
- "minimums": {
- "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
- "type": "array",
- "items": {
- "$ref": "DateRangeValues"
- }
- },
- "samplingSpaceSizes": {
- "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- }
- },
- "id": "ReportData"
- },
- "DimensionFilter": {
- "type": "object",
- "properties": {
- "caseSensitive": {
- "type": "boolean",
- "description": "Should the match be case sensitive? Default is false."
- },
- "dimensionName": {
- "description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
- "type": "string"
- },
- "operator": {
- "enumDescriptions": [
- "If the match type is unspecified, it is treated as a `REGEXP`.",
- "The match expression is treated as a regular expression. All match types\nare not treated as regular expressions.",
- "Matches the value which begin with the match expression provided.",
- "Matches the values which end with the match expression provided.",
- "Substring match.",
- "The value should match the match expression entirely.",
- "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- If expression is not a valid int64, the client should expect\n an error.\n- Input dimensions that are not valid int64 values will never match the\n filter.",
- "Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions.",
- "Checks if the dimension is numerically less than the match expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.",
- "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "REGEXP",
- "BEGINS_WITH",
- "ENDS_WITH",
- "PARTIAL",
- "EXACT",
- "NUMERIC_EQUAL",
- "NUMERIC_GREATER_THAN",
- "NUMERIC_LESS_THAN",
- "IN_LIST"
- ],
- "description": "How to match the dimension to the expression. The default is REGEXP.",
- "type": "string"
- },
- "not": {
- "type": "boolean",
- "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\ndimension values will be excluded in the report. The default is false."
- },
- "expressions": {
- "description": "Strings or regular expression to match against. Only the first value of\nthe list is used for comparison unless the operator is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter the\ndimensions as explained in the description of the `IN_LIST` operator.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "DimensionFilter",
- "description": "Dimension filter specifies the filtering options on a dimension."
- },
- "SegmentDimensionFilter": {
- "description": "Dimension filter specifies the filtering options on a dimension.",
- "type": "object",
- "properties": {
- "minComparisonValue": {
- "description": "Minimum comparison values for `BETWEEN` match type.",
- "type": "string"
- },
- "maxComparisonValue": {
- "description": "Maximum comparison values for `BETWEEN` match type.",
- "type": "string"
- },
- "dimensionName": {
- "description": "Name of the dimension for which the filter is being applied.",
- "type": "string"
- },
- "operator": {
- "description": "The operator to use to match the dimension with the expressions.",
- "type": "string",
- "enumDescriptions": [
- "If the match type is unspecified, it is treated as a REGEXP.",
- "The match expression is treated as a regular expression. All other match\ntypes are not treated as regular expressions.",
- "Matches the values which begin with the match expression provided.",
- "Matches the values which end with the match expression provided.",
- "Substring match.",
- "The value should match the match expression entirely.",
- "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter.",
- "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- if expression is not a valid int64, the client should expect\n an error.\n- input dimensions that are not valid int64 values will never match the\n filter.\n\nChecks if the dimension is numerically less than the match expression.",
- "Checks if the dimension is numerically greater than the match\nexpression.",
- "Checks if the dimension is numerically between the minimum and maximum\nof the match expression, boundaries excluded."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "REGEXP",
- "BEGINS_WITH",
- "ENDS_WITH",
- "PARTIAL",
- "EXACT",
- "IN_LIST",
- "NUMERIC_LESS_THAN",
- "NUMERIC_GREATER_THAN",
- "NUMERIC_BETWEEN"
- ]
- },
- "expressions": {
- "description": "The list of expressions, only the first element is used for all operators",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "caseSensitive": {
- "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
- "type": "boolean"
- }
- },
- "id": "SegmentDimensionFilter"
- },
- "OrderBy": {
- "properties": {
- "sortOrder": {
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The sorting order for the field.",
- "type": "string",
- "enumDescriptions": [
- "If the sort order is unspecified, the default is ascending.",
- "Ascending sort. The field will be sorted in an ascending manner.",
- "Descending sort. The field will be sorted in a descending manner."
- ]
- },
- "fieldName": {
- "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
- "type": "string"
- },
- "orderType": {
- "enumDescriptions": [
- "Unspecified order type will be treated as sort based on value.",
- "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
- "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
- "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
- "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
- "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
- ],
- "enum": [
- "ORDER_TYPE_UNSPECIFIED",
- "VALUE",
- "DELTA",
- "SMART",
- "HISTOGRAM_BUCKET",
- "DIMENSION_AS_INTEGER"
- ],
- "description": "The order type. The default orderType is `VALUE`.",
- "type": "string"
- }
- },
- "id": "OrderBy",
- "description": "Specifies the sorting options.",
- "type": "object"
- },
- "Segment": {
- "id": "Segment",
- "description": "The segment definition, if the report needs to be segmented.\nA Segment is a subset of the Analytics data. For example, of the entire\nset of users, one Segment might be users from a particular country or city.",
- "type": "object",
- "properties": {
- "dynamicSegment": {
- "description": "A dynamic segment definition in the request.",
- "$ref": "DynamicSegment"
- },
- "segmentId": {
- "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
- "type": "string"
- }
- }
- }
- },
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "AnalyticsReporting",
"auth": {
"oauth2": {
"scopes": {
@@ -1186,8 +11,1183 @@
}
}
},
- "rootUrl": "https://analyticsreporting.googleapis.com/",
- "ownerDomain": "google.com",
+ "basePath": "",
+ "baseUrl": "https://analyticsreporting.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "AnalyticsReporting",
+ "description": "Accesses Analytics report data.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "analyticsreporting:v4",
+ "kind": "discovery#restDescription",
"name": "analyticsreporting",
- "batchPath": "batch"
-}
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "reports": {
+ "methods": {
+ "batchGet": {
+ "description": "Returns the Analytics data.",
+ "flatPath": "v4/reports:batchGet",
+ "httpMethod": "POST",
+ "id": "analyticsreporting.reports.batchGet",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v4/reports:batchGet",
+ "request": {
+ "$ref": "GetReportsRequest"
+ },
+ "response": {
+ "$ref": "GetReportsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180124",
+ "rootUrl": "https://analyticsreporting.googleapis.com/",
+ "schemas": {
+ "Cohort": {
+ "description": "Defines a cohort. A cohort is a group of users who share a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.",
+ "id": "Cohort",
+ "properties": {
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field."
+ },
+ "name": {
+ "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated\nas `FIRST_VISIT_DATE` type cohort.",
+ "enum": [
+ "UNSPECIFIED_COHORT_TYPE",
+ "FIRST_VISIT_DATE"
+ ],
+ "enumDescriptions": [
+ "If unspecified it's treated as `FIRST_VISIT_DATE`.",
+ "Cohorts that are selected based on first visit date."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CohortGroup": {
+ "description": "Defines a cohort group.\nFor example:\n\n \"cohortGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"type\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }",
+ "id": "CohortGroup",
+ "properties": {
+ "cohorts": {
+ "description": "The definition for the cohort.",
+ "items": {
+ "$ref": "Cohort"
+ },
+ "type": "array"
+ },
+ "lifetimeValue": {
+ "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ColumnHeader": {
+ "description": "Column headers.",
+ "id": "ColumnHeader",
+ "properties": {
+ "dimensions": {
+ "description": "The dimension names in the response.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "metricHeader": {
+ "$ref": "MetricHeader",
+ "description": "Metric headers for the metrics in the response."
+ }
+ },
+ "type": "object"
+ },
+ "DateRange": {
+ "description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.",
+ "id": "DateRange",
+ "properties": {
+ "endDate": {
+ "description": "The end date for the query in the format `YYYY-MM-DD`.",
+ "type": "string"
+ },
+ "startDate": {
+ "description": "The start date for the query in the format `YYYY-MM-DD`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DateRangeValues": {
+ "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
+ "id": "DateRangeValues",
+ "properties": {
+ "pivotValueRegions": {
+ "description": "The values of each pivot region.",
+ "items": {
+ "$ref": "PivotValueRegion"
+ },
+ "type": "array"
+ },
+ "values": {
+ "description": "Each value corresponds to each Metric in the request.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Dimension": {
+ "description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.",
+ "id": "Dimension",
+ "properties": {
+ "histogramBuckets": {
+ "description": "If non-empty, we place dimension values into buckets after string to\nint64. Dimension values that are not the string representation of an\nintegral value will be converted to zero. The bucket values have to be in\nincreasing order. Each bucket is closed on the lower end, and open on the\nupper end. The \"first\" bucket includes all values less than the first\nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nvalues that fall in a bucket get transformed to a new dimension value. For\nexample, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing buckets:\n\n- bucket #1: values \u003c 0, dimension value \"\u003c0\"\n- bucket #2: values in [0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in [4,7), dimension value \"4-6\"\n- bucket #6: values \u003e= 7, dimension value \"7+\"\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nthat dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for that purpose. Without that the dimension values\nwill be sorted according to dictionary\n(lexicographic) order. For example the ascending dictionary order is:\n\n \"\u003c50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGRAM_BUCKET` order is:\n\n \"\u003c50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe client has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a histogram-mutated dimension.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Name of the dimension to fetch, for example `ga:browser`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionFilter": {
+ "description": "Dimension filter specifies the filtering options on a dimension.",
+ "id": "DimensionFilter",
+ "properties": {
+ "caseSensitive": {
+ "description": "Should the match be case sensitive? Default is false.",
+ "type": "boolean"
+ },
+ "dimensionName": {
+ "description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
+ "type": "string"
+ },
+ "expressions": {
+ "description": "Strings or regular expression to match against. Only the first value of\nthe list is used for comparison unless the operator is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter the\ndimensions as explained in the description of the `IN_LIST` operator.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "not": {
+ "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\ndimension values will be excluded in the report. The default is false.",
+ "type": "boolean"
+ },
+ "operator": {
+ "description": "How to match the dimension to the expression. The default is REGEXP.",
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "REGEXP",
+ "BEGINS_WITH",
+ "ENDS_WITH",
+ "PARTIAL",
+ "EXACT",
+ "NUMERIC_EQUAL",
+ "NUMERIC_GREATER_THAN",
+ "NUMERIC_LESS_THAN",
+ "IN_LIST"
+ ],
+ "enumDescriptions": [
+ "If the match type is unspecified, it is treated as a `REGEXP`.",
+ "The match expression is treated as a regular expression. All match types\nare not treated as regular expressions.",
+ "Matches the value which begin with the match expression provided.",
+ "Matches the values which end with the match expression provided.",
+ "Substring match.",
+ "The value should match the match expression entirely.",
+ "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- If expression is not a valid int64, the client should expect\n an error.\n- Input dimensions that are not valid int64 values will never match the\n filter.",
+ "Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions.",
+ "Checks if the dimension is numerically less than the match expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.",
+ "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DimensionFilterClause": {
+ "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
+ "id": "DimensionFilterClause",
+ "properties": {
+ "filters": {
+ "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
+ "items": {
+ "$ref": "DimensionFilter"
+ },
+ "type": "array"
+ },
+ "operator": {
+ "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "OR",
+ "AND"
+ ],
+ "enumDescriptions": [
+ "Unspecified operator. It is treated as an `OR`.",
+ "The logical `OR` operator.",
+ "The logical `AND` operator."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DynamicSegment": {
+ "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
+ "id": "DynamicSegment",
+ "properties": {
+ "name": {
+ "description": "The name of the dynamic segment.",
+ "type": "string"
+ },
+ "sessionSegment": {
+ "$ref": "SegmentDefinition",
+ "description": "Session Segment to select sessions to include in the segment."
+ },
+ "userSegment": {
+ "$ref": "SegmentDefinition",
+ "description": "User Segment to select users to include in the segment."
+ }
+ },
+ "type": "object"
+ },
+ "GetReportsRequest": {
+ "description": "The batch request containing multiple report request.",
+ "id": "GetReportsRequest",
+ "properties": {
+ "reportRequests": {
+ "description": "Requests, each request will have a separate response.\nThere can be a maximum of 5 requests. All requests should have the same\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.",
+ "items": {
+ "$ref": "ReportRequest"
+ },
+ "type": "array"
+ },
+ "useResourceQuotas": {
+ "description": "Enables\n[resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4),\n(defaults to `False`). If this field is set to `True` the\nper view (profile) quotas are governed by the computational\ncost of the request. Note that using cost based quotas will\nhigher enable sampling rates. (10 Million for `SMALL`,\n100M for `LARGE`. See the\n[limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "GetReportsResponse": {
+ "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
+ "id": "GetReportsResponse",
+ "properties": {
+ "queryCost": {
+ "description": "The amount of resource quota tokens deducted to execute the query. Includes\nall responses.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "reports": {
+ "description": "Responses corresponding to each of the request.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ },
+ "resourceQuotasRemaining": {
+ "$ref": "ResourceQuotasRemaining",
+ "description": "The amount of resource quota remaining for the property."
+ }
+ },
+ "type": "object"
+ },
+ "Metric": {
+ "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
+ "id": "Metric",
+ "properties": {
+ "alias": {
+ "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
+ "type": "string"
+ },
+ "formattingType": {
+ "description": "Specifies how the metric expression should be formatted, for example\n`INTEGER`.",
+ "enum": [
+ "METRIC_TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "CURRENCY",
+ "PERCENT",
+ "TIME"
+ ],
+ "enumDescriptions": [
+ "Metric type is unspecified.",
+ "Integer metric.",
+ "Float metric.",
+ "Currency metric.",
+ "Percentage metric.",
+ "Time metric in `HH:MM:SS` format."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MetricFilter": {
+ "description": "MetricFilter specifies the filter on a metric.",
+ "id": "MetricFilter",
+ "properties": {
+ "comparisonValue": {
+ "description": "The value to compare against.",
+ "type": "string"
+ },
+ "metricName": {
+ "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
+ "type": "string"
+ },
+ "not": {
+ "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
+ "type": "boolean"
+ },
+ "operator": {
+ "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "EQUAL",
+ "LESS_THAN",
+ "GREATER_THAN",
+ "IS_MISSING"
+ ],
+ "enumDescriptions": [
+ "If the operator is not specified, it is treated as `EQUAL`.",
+ "Should the value of the metric be exactly equal to the comparison value.",
+ "Should the value of the metric be less than to the comparison value.",
+ "Should the value of the metric be greater than to the comparison value.",
+ "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MetricFilterClause": {
+ "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
+ "id": "MetricFilterClause",
+ "properties": {
+ "filters": {
+ "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
+ "items": {
+ "$ref": "MetricFilter"
+ },
+ "type": "array"
+ },
+ "operator": {
+ "description": "The operator for combining multiple metric filters. If unspecified, it is\ntreated as an `OR`.",
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "OR",
+ "AND"
+ ],
+ "enumDescriptions": [
+ "Unspecified operator. It is treated as an `OR`.",
+ "The logical `OR` operator.",
+ "The logical `AND` operator."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MetricHeader": {
+ "description": "The headers for the metrics.",
+ "id": "MetricHeader",
+ "properties": {
+ "metricHeaderEntries": {
+ "description": "Headers for the metrics in the response.",
+ "items": {
+ "$ref": "MetricHeaderEntry"
+ },
+ "type": "array"
+ },
+ "pivotHeaders": {
+ "description": "Headers for the pivots in the response.",
+ "items": {
+ "$ref": "PivotHeader"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MetricHeaderEntry": {
+ "description": "Header for the metrics.",
+ "id": "MetricHeaderEntry",
+ "properties": {
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the metric, for example `INTEGER`.",
+ "enum": [
+ "METRIC_TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "CURRENCY",
+ "PERCENT",
+ "TIME"
+ ],
+ "enumDescriptions": [
+ "Metric type is unspecified.",
+ "Integer metric.",
+ "Float metric.",
+ "Currency metric.",
+ "Percentage metric.",
+ "Time metric in `HH:MM:SS` format."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrFiltersForSegment": {
+ "description": "A list of segment filters in the `OR` group are combined with the logical OR\noperator.",
+ "id": "OrFiltersForSegment",
+ "properties": {
+ "segmentFilterClauses": {
+ "description": "List of segment filters to be combined with a `OR` operator.",
+ "items": {
+ "$ref": "SegmentFilterClause"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrderBy": {
+ "description": "Specifies the sorting options.",
+ "id": "OrderBy",
+ "properties": {
+ "fieldName": {
+ "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
+ "type": "string"
+ },
+ "orderType": {
+ "description": "The order type. The default orderType is `VALUE`.",
+ "enum": [
+ "ORDER_TYPE_UNSPECIFIED",
+ "VALUE",
+ "DELTA",
+ "SMART",
+ "HISTOGRAM_BUCKET",
+ "DIMENSION_AS_INTEGER"
+ ],
+ "enumDescriptions": [
+ "Unspecified order type will be treated as sort based on value.",
+ "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
+ "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
+ "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
+ "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
+ "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
+ ],
+ "type": "string"
+ },
+ "sortOrder": {
+ "description": "The sorting order for the field.",
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "enumDescriptions": [
+ "If the sort order is unspecified, the default is ascending.",
+ "Ascending sort. The field will be sorted in an ascending manner.",
+ "Descending sort. The field will be sorted in a descending manner."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Pivot": {
+ "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
+ "id": "Pivot",
+ "properties": {
+ "dimensionFilterClauses": {
+ "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
+ "items": {
+ "$ref": "DimensionFilterClause"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "maxGroupCount": {
+ "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "startGroup": {
+ "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "PivotHeader": {
+ "description": "The headers for each of the pivot sections defined in the request.",
+ "id": "PivotHeader",
+ "properties": {
+ "pivotHeaderEntries": {
+ "description": "A single pivot section header.",
+ "items": {
+ "$ref": "PivotHeaderEntry"
+ },
+ "type": "array"
+ },
+ "totalPivotGroupsCount": {
+ "description": "The total number of groups for this pivot.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "PivotHeaderEntry": {
+ "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
+ "id": "PivotHeaderEntry",
+ "properties": {
+ "dimensionNames": {
+ "description": "The name of the dimensions in the pivot response.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dimensionValues": {
+ "description": "The values for the dimensions in the pivot.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "metric": {
+ "$ref": "MetricHeaderEntry",
+ "description": "The metric header for the metric in the pivot."
+ }
+ },
+ "type": "object"
+ },
+ "PivotValueRegion": {
+ "description": "The metric values in the pivot region.",
+ "id": "PivotValueRegion",
+ "properties": {
+ "values": {
+ "description": "The values of the metrics in each of the pivot regions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "description": "The data response corresponding to the request.",
+ "id": "Report",
+ "properties": {
+ "columnHeader": {
+ "$ref": "ColumnHeader",
+ "description": "The column headers."
+ },
+ "data": {
+ "$ref": "ReportData",
+ "description": "Response data."
+ },
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportData": {
+ "description": "The data part of the report.",
+ "id": "ReportData",
+ "properties": {
+ "dataLastRefreshed": {
+ "description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "isDataGolden": {
+ "description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
+ "type": "boolean"
+ },
+ "maximums": {
+ "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
+ "items": {
+ "$ref": "DateRangeValues"
+ },
+ "type": "array"
+ },
+ "minimums": {
+ "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
+ "items": {
+ "$ref": "DateRangeValues"
+ },
+ "type": "array"
+ },
+ "rowCount": {
+ "description": "Total number of matching rows for this query.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rows": {
+ "description": "There's one ReportRow for every unique combination of dimensions.",
+ "items": {
+ "$ref": "ReportRow"
+ },
+ "type": "array"
+ },
+ "samplesReadCounts": {
+ "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of samples read, one entry per date range.\nIf the results are not sampled this field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "samplingSpaceSizes": {
+ "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "totals": {
+ "description": "For each requested date range, for the set of all rows that match\nthe query, every requested value format gets a total. The total\nfor a value format is computed by first totaling the metrics\nmentioned in the value format and then evaluating the value\nformat as a scalar expression. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of all relevant ga:sessions) + 2)`.\nTotals are computed before pagination.",
+ "items": {
+ "$ref": "DateRangeValues"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ReportRequest": {
+ "description": "The main request class which specifies the Reporting API request.",
+ "id": "ReportRequest",
+ "properties": {
+ "cohortGroup": {
+ "$ref": "CohortGroup",
+ "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition."
+ },
+ "dateRanges": {
+ "description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition.",
+ "items": {
+ "$ref": "DateRange"
+ },
+ "type": "array"
+ },
+ "dimensionFilterClauses": {
+ "description": "The dimension filter clauses for filtering Dimension Values. They are\nlogically combined with the `AND` operator. Note that filtering occurs\nbefore any dimensions are aggregated, so that the returned metrics\nrepresent the total for only the relevant dimensions.",
+ "items": {
+ "$ref": "DimensionFilterClause"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ },
+ "filtersExpression": {
+ "description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
+ "type": "string"
+ },
+ "hideTotals": {
+ "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
+ "type": "boolean"
+ },
+ "hideValueRanges": {
+ "description": "If set to true, hides the minimum and maximum across all matching rows.\nThe default is false and the value ranges are returned.",
+ "type": "boolean"
+ },
+ "includeEmptyRows": {
+ "description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.",
+ "type": "boolean"
+ },
+ "metricFilterClauses": {
+ "description": "The metric filter clauses. They are logically combined with the `AND`\noperator. Metric filters look at only the first date range and not the\ncomparing date range. Note that filtering on metrics occurs after the\nmetrics are aggregated.",
+ "items": {
+ "$ref": "MetricFilterClause"
+ },
+ "type": "array"
+ },
+ "metrics": {
+ "description": "The metrics requested.\nRequests must specify at least one metric. Requests can have a\ntotal of 10 metrics.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "orderBys": {
+ "description": "Sort order on output rows. To compare two rows, the elements of the\nfollowing are applied in order until a difference is found. All date\nranges in the output get the same row order.",
+ "items": {
+ "$ref": "OrderBy"
+ },
+ "type": "array"
+ },
+ "pageSize": {
+ "description": "Page size is for paging and specifies the maximum number of returned rows.\nPage size should be \u003e= 0. A query returns the default of 1,000 rows.\nThe Analytics Core Reporting API returns a maximum of 10,000 rows per\nrequest, no matter how many you ask for. It can also return fewer rows\nthan requested, if there aren't as many dimension segments as you expect.\nFor instance, there are fewer than 300 possible values for `ga:country`,\nso when segmenting only by country, you can't get more than 300 rows,\neven if you set `pageSize` to a higher value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
+ "type": "string"
+ },
+ "pivots": {
+ "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
+ "items": {
+ "$ref": "Pivot"
+ },
+ "type": "array"
+ },
+ "samplingLevel": {
+ "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.",
+ "enum": [
+ "SAMPLING_UNSPECIFIED",
+ "DEFAULT",
+ "SMALL",
+ "LARGE"
+ ],
+ "enumDescriptions": [
+ "If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.",
+ "Returns response with a sample size that balances speed and\naccuracy.",
+ "It returns a fast response with a smaller sampling size.",
+ "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower."
+ ],
+ "type": "string"
+ },
+ "segments": {
+ "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request can contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `segments` definition. Requests\nwith segments must have the `ga:segment` dimension.",
+ "items": {
+ "$ref": "Segment"
+ },
+ "type": "array"
+ },
+ "viewId": {
+ "description": "The Analytics\n[view ID](https://support.google.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportRequest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportRow": {
+ "description": "A row in the report.",
+ "id": "ReportRow",
+ "properties": {
+ "dimensions": {
+ "description": "List of requested dimensions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "metrics": {
+ "description": "List of metrics for each requested DateRange.",
+ "items": {
+ "$ref": "DateRangeValues"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ResourceQuotasRemaining": {
+ "description": "The resource quota tokens remaining for the property after the request is\ncompleted.",
+ "id": "ResourceQuotasRemaining",
+ "properties": {
+ "dailyQuotaTokensRemaining": {
+ "description": "Daily resource quota remaining remaining.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hourlyQuotaTokensRemaining": {
+ "description": "Hourly resource quota tokens remaining.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Segment": {
+ "description": "The segment definition, if the report needs to be segmented.\nA Segment is a subset of the Analytics data. For example, of the entire\nset of users, one Segment might be users from a particular country or city.",
+ "id": "Segment",
+ "properties": {
+ "dynamicSegment": {
+ "$ref": "DynamicSegment",
+ "description": "A dynamic segment definition in the request."
+ },
+ "segmentId": {
+ "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SegmentDefinition": {
+ "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
+ "id": "SegmentDefinition",
+ "properties": {
+ "segmentFilters": {
+ "description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
+ "items": {
+ "$ref": "SegmentFilter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SegmentDimensionFilter": {
+ "description": "Dimension filter specifies the filtering options on a dimension.",
+ "id": "SegmentDimensionFilter",
+ "properties": {
+ "caseSensitive": {
+ "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
+ "type": "boolean"
+ },
+ "dimensionName": {
+ "description": "Name of the dimension for which the filter is being applied.",
+ "type": "string"
+ },
+ "expressions": {
+ "description": "The list of expressions, only the first element is used for all operators",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "maxComparisonValue": {
+ "description": "Maximum comparison values for `BETWEEN` match type.",
+ "type": "string"
+ },
+ "minComparisonValue": {
+ "description": "Minimum comparison values for `BETWEEN` match type.",
+ "type": "string"
+ },
+ "operator": {
+ "description": "The operator to use to match the dimension with the expressions.",
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "REGEXP",
+ "BEGINS_WITH",
+ "ENDS_WITH",
+ "PARTIAL",
+ "EXACT",
+ "IN_LIST",
+ "NUMERIC_LESS_THAN",
+ "NUMERIC_GREATER_THAN",
+ "NUMERIC_BETWEEN"
+ ],
+ "enumDescriptions": [
+ "If the match type is unspecified, it is treated as a REGEXP.",
+ "The match expression is treated as a regular expression. All other match\ntypes are not treated as regular expressions.",
+ "Matches the values which begin with the match expression provided.",
+ "Matches the values which end with the match expression provided.",
+ "Substring match.",
+ "The value should match the match expression entirely.",
+ "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter.",
+ "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- if expression is not a valid int64, the client should expect\n an error.\n- input dimensions that are not valid int64 values will never match the\n filter.\n\nChecks if the dimension is numerically less than the match expression.",
+ "Checks if the dimension is numerically greater than the match\nexpression.",
+ "Checks if the dimension is numerically between the minimum and maximum\nof the match expression, boundaries excluded."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SegmentFilter": {
+ "description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
+ "id": "SegmentFilter",
+ "properties": {
+ "not": {
+ "description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
+ "type": "boolean"
+ },
+ "sequenceSegment": {
+ "$ref": "SequenceSegment",
+ "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators."
+ },
+ "simpleSegment": {
+ "$ref": "SimpleSegment",
+ "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
+ }
+ },
+ "type": "object"
+ },
+ "SegmentFilterClause": {
+ "description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
+ "id": "SegmentFilterClause",
+ "properties": {
+ "dimensionFilter": {
+ "$ref": "SegmentDimensionFilter",
+ "description": "Dimension Filter for the segment definition."
+ },
+ "metricFilter": {
+ "$ref": "SegmentMetricFilter",
+ "description": "Metric Filter for the segment definition."
+ },
+ "not": {
+ "description": "Matches the complement (`!`) of the filter.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SegmentMetricFilter": {
+ "description": "Metric filter to be used in a segment filter clause.",
+ "id": "SegmentMetricFilter",
+ "properties": {
+ "comparisonValue": {
+ "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
+ "type": "string"
+ },
+ "maxComparisonValue": {
+ "description": "Max comparison value is only used for `BETWEEN` operator.",
+ "type": "string"
+ },
+ "metricName": {
+ "description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.",
+ "type": "string"
+ },
+ "operator": {
+ "description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.",
+ "enum": [
+ "UNSPECIFIED_OPERATOR",
+ "LESS_THAN",
+ "GREATER_THAN",
+ "EQUAL",
+ "BETWEEN"
+ ],
+ "enumDescriptions": [
+ "Unspecified operator is treated as `LESS_THAN` operator.",
+ "Checks if the metric value is less than comparison value.",
+ "Checks if the metric value is greater than comparison value.",
+ "Equals operator.",
+ "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison."
+ ],
+ "type": "string"
+ },
+ "scope": {
+ "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.",
+ "enum": [
+ "UNSPECIFIED_SCOPE",
+ "PRODUCT",
+ "HIT",
+ "SESSION",
+ "USER"
+ ],
+ "enumDescriptions": [
+ "If the scope is unspecified, it defaults to the condition scope,\n`USER` or `SESSION` depending on if the segment is trying to choose\nusers or sessions.",
+ "Product scope.",
+ "Hit scope.",
+ "Session scope.",
+ "User scope."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SegmentSequenceStep": {
+ "description": "A segment sequence definition.",
+ "id": "SegmentSequenceStep",
+ "properties": {
+ "matchType": {
+ "description": "Specifies if the step immediately precedes or can be any time before the\nnext step.",
+ "enum": [
+ "UNSPECIFIED_MATCH_TYPE",
+ "PRECEDES",
+ "IMMEDIATELY_PRECEDES"
+ ],
+ "enumDescriptions": [
+ "Unspecified match type is treated as precedes.",
+ "Operator indicates that the previous step precedes the next step.",
+ "Operator indicates that the previous step immediately precedes the next\nstep."
+ ],
+ "type": "string"
+ },
+ "orFiltersForSegment": {
+ "description": "A sequence is specified with a list of Or grouped filters which are\ncombined with `AND` operator.",
+ "items": {
+ "$ref": "OrFiltersForSegment"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SequenceSegment": {
+ "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
+ "id": "SequenceSegment",
+ "properties": {
+ "firstStepShouldMatchFirstHit": {
+ "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).",
+ "type": "boolean"
+ },
+ "segmentSequenceSteps": {
+ "description": "The list of steps in the sequence.",
+ "items": {
+ "$ref": "SegmentSequenceStep"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SimpleSegment": {
+ "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
+ "id": "SimpleSegment",
+ "properties": {
+ "orFiltersForSegment": {
+ "description": "A list of segment filters groups which are combined with logical `AND`\noperator.",
+ "items": {
+ "$ref": "OrFiltersForSegment"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Google Analytics Reporting API",
+ "version": "v4",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json b/vendor/google.golang.org/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
index f80b6fba6..7c0bda59f 100644
--- a/vendor/google.golang.org/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
+++ b/vendor/google.golang.org/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
@@ -1,618 +1,421 @@
{
+ "basePath": "",
+ "baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Android Provisioning Partner",
+ "description": "Automates Android zero-touch enrollment for device resellers, customers, and EMMs.",
"discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/zero-touch/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "androiddeviceprovisioning:v1",
+ "kind": "discovery#restDescription",
+ "name": "androiddeviceprovisioning",
+ "ownerDomain": "google.com",
"ownerName": "Google",
- "version_module": true,
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
"resources": {
"customers": {
+ "methods": {
+ "list": {
+ "description": "Lists the user's customer accounts.",
+ "flatPath": "v1/customers",
+ "httpMethod": "GET",
+ "id": "androiddeviceprovisioning.customers.list",
+ "parameterOrder": [],
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of customers to show in a page of results.\nA number between 1 and 100 (inclusive).",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token specifying which result page to return.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/customers",
+ "response": {
+ "$ref": "CustomerListCustomersResponse"
+ }
+ }
+ },
"resources": {
- "devices": {
+ "configurations": {
"methods": {
- "unclaim": {
- "description": "Unclaims a device from a customer and removes it from zero-touch\nenrollment.\n\nAfter removing a device, a customer must contact their reseller to register\nthe device into zero-touch enrollment again.",
- "request": {
- "$ref": "CustomerUnclaimDeviceRequest"
- },
- "response": {
- "$ref": "Empty"
- },
+ "create": {
+ "description": "Creates a new configuration. Once created, a customer can apply the\nconfiguration to devices.",
+ "flatPath": "v1/customers/{customersId}/configurations",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.customers.configurations.create",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
"parameters": {
"parent": {
- "pattern": "^customers/[^/]+$",
+ "description": "Required. The customer that manages the configuration. An API resource name\nin the format `customers/[CUSTOMER_ID]`.",
"location": "path",
- "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
+ "pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
- "flatPath": "v1/customers/{customersId}/devices:unclaim",
- "path": "v1/{+parent}/devices:unclaim",
- "id": "androiddeviceprovisioning.customers.devices.unclaim"
- },
- "removeConfiguration": {
- "response": {
- "$ref": "Empty"
+ "path": "v1/{+parent}/configurations",
+ "request": {
+ "$ref": "Configuration"
},
+ "response": {
+ "$ref": "Configuration"
+ }
+ },
+ "delete": {
+ "description": "Deletes an unused configuration. The API call fails if the customer has\ndevices with the configuration applied.",
+ "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
+ "httpMethod": "DELETE",
+ "id": "androiddeviceprovisioning.customers.configurations.delete",
"parameterOrder": [
- "parent"
+ "name"
],
- "httpMethod": "POST",
"parameters": {
- "parent": {
+ "name": {
+ "description": "Required. The configuration to delete. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the\nconfiguration is applied to any devices, the API call fails.",
"location": "path",
- "description": "Required. The customer managing the device in the format\n`customers/[CUSTOMER_ID]`.",
+ "pattern": "^customers/[^/]+/configurations/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$"
+ "type": "string"
}
},
- "flatPath": "v1/customers/{customersId}/devices:removeConfiguration",
- "path": "v1/{+parent}/devices:removeConfiguration",
- "id": "androiddeviceprovisioning.customers.devices.removeConfiguration",
- "request": {
- "$ref": "CustomerRemoveConfigurationRequest"
- },
- "description": "Removes a configuration from device."
- },
- "applyConfiguration": {
+ "path": "v1/{+name}",
"response": {
"$ref": "Empty"
- },
+ }
+ },
+ "get": {
+ "description": "Gets the details of a configuration.",
+ "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
+ "httpMethod": "GET",
+ "id": "androiddeviceprovisioning.customers.configurations.get",
"parameterOrder": [
- "parent"
+ "name"
],
- "httpMethod": "POST",
"parameters": {
- "parent": {
- "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
+ "name": {
+ "description": "Required. The configuration to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.",
+ "location": "path",
+ "pattern": "^customers/[^/]+/configurations/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1/customers/{customersId}/devices:applyConfiguration",
- "path": "v1/{+parent}/devices:applyConfiguration",
- "id": "androiddeviceprovisioning.customers.devices.applyConfiguration",
- "description": "Applies a Configuration to the device to register the device for zero-touch\nenrollment. After applying a configuration to a device, the device\nautomatically provisions itself on first boot, or next factory reset.",
- "request": {
- "$ref": "CustomerApplyConfigurationRequest"
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Configuration"
}
},
"list": {
- "description": "Lists a customer's devices.",
+ "description": "Lists a customer's configurations.",
+ "flatPath": "v1/customers/{customersId}/configurations",
"httpMethod": "GET",
+ "id": "androiddeviceprovisioning.customers.configurations.list",
"parameterOrder": [
"parent"
],
- "response": {
- "$ref": "CustomerListDevicesResponse"
- },
"parameters": {
- "pageToken": {
- "description": "A token specifying which result page to return.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The maximum number of devices to show in a page of results.\nMust be between 1 and 100 inclusive.",
- "format": "int64",
- "type": "string",
- "location": "query"
- },
"parent": {
+ "description": "Required. The customer that manages the listed configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`.",
"location": "path",
- "description": "Required. The customer managing the devices. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
+ "pattern": "^customers/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$"
+ "type": "string"
}
},
- "flatPath": "v1/customers/{customersId}/devices",
- "id": "androiddeviceprovisioning.customers.devices.list",
- "path": "v1/{+parent}/devices"
+ "path": "v1/{+parent}/configurations",
+ "response": {
+ "$ref": "CustomerListConfigurationsResponse"
+ }
+ },
+ "patch": {
+ "description": "Updates a configuration's field values.",
+ "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
+ "httpMethod": "PATCH",
+ "id": "androiddeviceprovisioning.customers.configurations.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.",
+ "location": "path",
+ "pattern": "^customers/[^/]+/configurations/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Required. The field mask applied to the target `Configuration` before\nupdating the fields. To learn more about using field masks, read\n[FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in\nthe Protocol Buffers documentation.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Configuration"
+ },
+ "response": {
+ "$ref": "Configuration"
+ }
+ }
+ }
+ },
+ "devices": {
+ "methods": {
+ "applyConfiguration": {
+ "description": "Applies a Configuration to the device to register the device for zero-touch\nenrollment. After applying a configuration to a device, the device\nautomatically provisions itself on first boot, or next factory reset.",
+ "flatPath": "v1/customers/{customersId}/devices:applyConfiguration",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.customers.devices.applyConfiguration",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
+ "location": "path",
+ "pattern": "^customers/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/devices:applyConfiguration",
+ "request": {
+ "$ref": "CustomerApplyConfigurationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ }
},
"get": {
"description": "Gets the details of a device.",
+ "flatPath": "v1/customers/{customersId}/devices/{devicesId}",
"httpMethod": "GET",
- "response": {
- "$ref": "Device"
- },
+ "id": "androiddeviceprovisioning.customers.devices.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The device to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^customers/[^/]+/devices/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/customers/{customersId}/devices/{devicesId}",
- "id": "androiddeviceprovisioning.customers.devices.get",
- "path": "v1/{+name}"
- }
- }
- },
- "configurations": {
- "methods": {
- "get": {
- "path": "v1/{+name}",
- "id": "androiddeviceprovisioning.customers.configurations.get",
- "description": "Gets the details of a configuration.",
- "response": {
- "$ref": "Configuration"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Required. The configuration to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.",
"required": true,
- "type": "string",
- "pattern": "^customers/[^/]+/configurations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}"
- },
- "patch": {
- "description": "Updates a configuration's field values.",
- "request": {
- "$ref": "Configuration"
- },
- "response": {
- "$ref": "Configuration"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Required. The field mask applied to the target `Configuration` before\nupdating the fields. To learn more about using field masks, read\n[FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in\nthe Protocol Buffers documentation.",
- "format": "google-fieldmask",
"type": "string"
- },
- "name": {
- "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.",
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+/configurations/[^/]+$",
- "location": "path"
}
},
- "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
"path": "v1/{+name}",
- "id": "androiddeviceprovisioning.customers.configurations.patch"
+ "response": {
+ "$ref": "Device"
+ }
},
"list": {
- "description": "Lists a customer's configurations.",
- "response": {
- "$ref": "CustomerListConfigurationsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
+ "description": "Lists a customer's devices.",
+ "flatPath": "v1/customers/{customersId}/devices",
"httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "Required. The customer that manages the listed configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`.",
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/customers/{customersId}/configurations",
- "path": "v1/{+parent}/configurations",
- "id": "androiddeviceprovisioning.customers.configurations.list"
- },
- "create": {
- "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.customers.devices.list",
"parameterOrder": [
"parent"
],
- "response": {
- "$ref": "Configuration"
- },
"parameters": {
+ "pageSize": {
+ "description": "The maximum number of devices to show in a page of results.\nMust be between 1 and 100 inclusive.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token specifying which result page to return.",
+ "location": "query",
+ "type": "string"
+ },
"parent": {
- "description": "Required. The customer that manages the configuration. An API resource name\nin the format `customers/[CUSTOMER_ID]`.",
- "required": true,
- "type": "string",
+ "description": "Required. The customer managing the devices. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
+ "location": "path",
"pattern": "^customers/[^/]+$",
- "location": "path"
+ "required": true,
+ "type": "string"
}
},
- "flatPath": "v1/customers/{customersId}/configurations",
- "id": "androiddeviceprovisioning.customers.configurations.create",
- "path": "v1/{+parent}/configurations",
- "request": {
- "$ref": "Configuration"
- },
- "description": "Creates a new configuration. Once created, a customer can apply the\nconfiguration to devices."
+ "path": "v1/{+parent}/devices",
+ "response": {
+ "$ref": "CustomerListDevicesResponse"
+ }
},
- "delete": {
- "description": "Deletes an unused configuration. The API call fails if the customer has\ndevices with the configuration applied.",
+ "removeConfiguration": {
+ "description": "Removes a configuration from device.",
+ "flatPath": "v1/customers/{customersId}/devices:removeConfiguration",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.customers.devices.removeConfiguration",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The customer managing the device in the format\n`customers/[CUSTOMER_ID]`.",
+ "location": "path",
+ "pattern": "^customers/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/devices:removeConfiguration",
+ "request": {
+ "$ref": "CustomerRemoveConfigurationRequest"
+ },
"response": {
"$ref": "Empty"
- },
+ }
+ },
+ "unclaim": {
+ "description": "Unclaims a device from a customer and removes it from zero-touch\nenrollment.\n\nAfter removing a device, a customer must contact their reseller to register\nthe device into zero-touch enrollment again.",
+ "flatPath": "v1/customers/{customersId}/devices:unclaim",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.customers.devices.unclaim",
"parameterOrder": [
- "name"
+ "parent"
],
- "httpMethod": "DELETE",
"parameters": {
- "name": {
- "description": "Required. The configuration to delete. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the\nconfiguration is applied to any devices, the API call fails.",
+ "parent": {
+ "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
+ "location": "path",
+ "pattern": "^customers/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^customers/[^/]+/configurations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
- "path": "v1/{+name}",
- "id": "androiddeviceprovisioning.customers.configurations.delete"
+ "path": "v1/{+parent}/devices:unclaim",
+ "request": {
+ "$ref": "CustomerUnclaimDeviceRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ }
}
}
},
"dpcs": {
"methods": {
"list": {
- "path": "v1/{+parent}/dpcs",
- "id": "androiddeviceprovisioning.customers.dpcs.list",
"description": "Lists the DPCs (device policy controllers) that support zero-touch\nenrollment.",
- "response": {
- "$ref": "CustomerListDpcsResponse"
- },
+ "flatPath": "v1/customers/{customersId}/dpcs",
+ "httpMethod": "GET",
+ "id": "androiddeviceprovisioning.customers.dpcs.list",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
"parameters": {
"parent": {
"description": "Required. The customer that can use the DPCs in configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^customers/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/customers/{customersId}/dpcs"
- }
- }
- }
- },
- "methods": {
- "list": {
- "response": {
- "$ref": "CustomerListCustomersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The next_page_token value returned from a previous List request, if any.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The maximum number of items to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/customers",
- "path": "v1/customers",
- "id": "androiddeviceprovisioning.customers.list",
- "description": "List the user's customer accounts."
- }
- }
- },
- "partners": {
- "resources": {
- "devices": {
- "methods": {
- "claimAsync": {
- "httpMethod": "POST",
- "parameterOrder": [
- "partnerId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "partnerId": {
- "description": "Partner ID.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:claimAsync",
- "id": "androiddeviceprovisioning.partners.devices.claimAsync",
- "path": "v1/partners/{+partnerId}/devices:claimAsync",
- "request": {
- "$ref": "ClaimDevicesRequest"
- },
- "description": "Claim devices asynchronously."
- },
- "findByIdentifier": {
- "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
- "id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
- "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
- "request": {
- "$ref": "FindDevicesByDeviceIdentifierRequest"
- },
- "description": "Find devices by device identifier.",
- "httpMethod": "POST",
- "parameterOrder": [
- "partnerId"
- ],
- "response": {
- "$ref": "FindDevicesByDeviceIdentifierResponse"
- },
- "parameters": {
- "partnerId": {
- "location": "path",
- "description": "ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
"required": true,
"type": "string"
}
+ },
+ "path": "v1/{+parent}/dpcs",
+ "response": {
+ "$ref": "CustomerListDpcsResponse"
}
- },
- "unclaimAsync": {
- "request": {
- "$ref": "UnclaimDevicesRequest"
- },
- "description": "Unclaim devices asynchronously.",
- "httpMethod": "POST",
- "parameterOrder": [
- "partnerId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "partnerId": {
- "location": "path",
- "description": "Partner ID.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync",
- "id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
- "path": "v1/partners/{+partnerId}/devices:unclaimAsync"
- },
- "metadata": {
- "request": {
- "$ref": "UpdateDeviceMetadataRequest"
- },
- "description": "Update the metadata.",
- "response": {
- "$ref": "DeviceMetadata"
- },
- "parameterOrder": [
- "metadataOwnerId",
- "deviceId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "metadataOwnerId": {
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The owner of the newly set metadata. Set this to the partner ID.",
- "pattern": "^[^/]+$"
- },
- "deviceId": {
- "description": "ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
- "path": "v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata",
- "id": "androiddeviceprovisioning.partners.devices.metadata"
- },
- "updateMetadataAsync": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
- "description": "Partner ID.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
- "path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
- "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync",
- "request": {
- "$ref": "UpdateDeviceMetadataInBatchRequest"
- },
- "description": "Set metadata in batch asynchronously."
- },
- "get": {
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^partners/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
- "path": "v1/{+name}",
- "id": "androiddeviceprovisioning.partners.devices.get",
- "description": "Get a device."
- },
- "unclaim": {
- "request": {
- "$ref": "UnclaimDeviceRequest"
- },
- "description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
- "pattern": "^[^/]+$",
- "format": "int64",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the partner."
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:unclaim",
- "path": "v1/partners/{+partnerId}/devices:unclaim",
- "id": "androiddeviceprovisioning.partners.devices.unclaim"
- },
- "findByOwner": {
- "request": {
- "$ref": "FindDevicesByOwnerRequest"
- },
- "description": "Find devices by ownership.",
- "response": {
- "$ref": "FindDevicesByOwnerResponse"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
- "description": "ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:findByOwner",
- "path": "v1/partners/{+partnerId}/devices:findByOwner",
- "id": "androiddeviceprovisioning.partners.devices.findByOwner"
- },
- "claim": {
- "response": {
- "$ref": "ClaimDeviceResponse"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
- "description": "ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:claim",
- "path": "v1/partners/{+partnerId}/devices:claim",
- "id": "androiddeviceprovisioning.partners.devices.claim",
- "request": {
- "$ref": "ClaimDeviceRequest"
- },
- "description": "Claim the device identified by device identifier."
- }
- }
- },
- "customers": {
- "methods": {
- "create": {
- "request": {
- "$ref": "CreateCustomerRequest"
- },
- "description": "Creates a customer for zero-touch enrollment. After the method returns\nsuccessfully, admin and owner roles can manage devices and EMM configs\nby calling API methods or using their zero-touch enrollment portal. The API\ndoesn't notify the customer that they have access.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Company"
- },
- "parameters": {
- "parent": {
- "description": "Required. The parent resource ID in the format `partners/[PARTNER_ID]` that\nidentifies the reseller.",
- "required": true,
- "type": "string",
- "pattern": "^partners/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/partners/{partnersId}/customers",
- "id": "androiddeviceprovisioning.partners.customers.create",
- "path": "v1/{+parent}/customers"
- },
- "list": {
- "description": "Lists the customers that are enrolled to the reseller identified by the\n`partnerId` argument. This list includes customers that the reseller\ncreated and customers that enrolled themselves using the portal.",
- "response": {
- "$ref": "ListCustomersResponse"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "partnerId": {
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the partner."
- }
- },
- "flatPath": "v1/partners/{partnersId}/customers",
- "path": "v1/partners/{+partnerId}/customers",
- "id": "androiddeviceprovisioning.partners.customers.list"
}
}
}
@@ -621,312 +424,886 @@
"operations": {
"methods": {
"get": {
- "response": {
- "$ref": "Operation"
- },
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "flatPath": "v1/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "androiddeviceprovisioning.operations.get",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
"description": "The name of the operation resource.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^operations/.+$",
- "location": "path"
+ "required": true,
+ "type": "string"
}
},
- "flatPath": "v1/operations/{operationsId}",
"path": "v1/{+name}",
- "id": "androiddeviceprovisioning.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ "response": {
+ "$ref": "Operation"
+ }
+ }
+ }
+ },
+ "partners": {
+ "resources": {
+ "customers": {
+ "methods": {
+ "create": {
+ "description": "Creates a customer for zero-touch enrollment. After the method returns\nsuccessfully, admin and owner roles can manage devices and EMM configs\nby calling API methods or using their zero-touch enrollment portal. The API\ndoesn't notify the customer that they have access.",
+ "flatPath": "v1/partners/{partnersId}/customers",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.partners.customers.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource ID in the format `partners/[PARTNER_ID]` that\nidentifies the reseller.",
+ "location": "path",
+ "pattern": "^partners/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/customers",
+ "request": {
+ "$ref": "CreateCustomerRequest"
+ },
+ "response": {
+ "$ref": "Company"
+ }
+ },
+ "list": {
+ "description": "Lists the customers that are enrolled to the reseller identified by the\n`partnerId` argument. This list includes customers that the reseller\ncreated and customers that enrolled themselves using the portal.",
+ "flatPath": "v1/partners/{partnersId}/customers",
+ "httpMethod": "GET",
+ "id": "androiddeviceprovisioning.partners.customers.list",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "parameters": {
+ "partnerId": {
+ "description": "Required. The ID of the reseller partner.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/partners/{+partnerId}/customers",
+ "response": {
+ "$ref": "ListCustomersResponse"
+ }
+ }
+ }
+ },
+ "devices": {
+ "methods": {
+ "claim": {
+ "description": "Claims a device for a customer and adds it to zero-touch enrollment. If the\ndevice is already claimed by another customer, the call returns an error.",
+ "flatPath": "v1/partners/{partnersId}/devices:claim",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.partners.devices.claim",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "parameters": {
+ "partnerId": {
+ "description": "Required. The ID of the reseller partner.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/partners/{+partnerId}/devices:claim",
+ "request": {
+ "$ref": "ClaimDeviceRequest"
+ },
+ "response": {
+ "$ref": "ClaimDeviceResponse"
+ }
+ },
+ "claimAsync": {
+ "description": "Claims a batch of devices for a customer asynchronously. Adds the devices\nto zero-touch enrollment. To learn more, read [Long‑running batch\noperations](/zero-touch/guides/how-it-works#operations).",
+ "flatPath": "v1/partners/{partnersId}/devices:claimAsync",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.partners.devices.claimAsync",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "parameters": {
+ "partnerId": {
+ "description": "Required. The ID of the reseller partner.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/partners/{+partnerId}/devices:claimAsync",
+ "request": {
+ "$ref": "ClaimDevicesRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "findByIdentifier": {
+ "description": "Finds devices by hardware identifiers, such as IMEI.",
+ "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "parameters": {
+ "partnerId": {
+ "description": "Required. The ID of the reseller partner.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
+ "request": {
+ "$ref": "FindDevicesByDeviceIdentifierRequest"
+ },
+ "response": {
+ "$ref": "FindDevicesByDeviceIdentifierResponse"
+ }
+ },
+ "findByOwner": {
+ "description": "Finds devices claimed for customers. The results only contain devices\nregistered to the reseller that's identified by the `partnerId` argument.\nThe customer's devices purchased from other resellers don't appear in the\nresults.",
+ "flatPath": "v1/partners/{partnersId}/devices:findByOwner",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.partners.devices.findByOwner",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "parameters": {
+ "partnerId": {
+ "description": "Required. The ID of the reseller partner.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/partners/{+partnerId}/devices:findByOwner",
+ "request": {
+ "$ref": "FindDevicesByOwnerRequest"
+ },
+ "response": {
+ "$ref": "FindDevicesByOwnerResponse"
+ }
+ },
+ "get": {
+ "description": "Gets a device.",
+ "flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
+ "httpMethod": "GET",
+ "id": "androiddeviceprovisioning.partners.devices.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The device API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
+ "location": "path",
+ "pattern": "^partners/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Device"
+ }
+ },
+ "metadata": {
+ "description": "Updates reseller metadata associated with the device.",
+ "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.partners.devices.metadata",
+ "parameterOrder": [
+ "metadataOwnerId",
+ "deviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "Required. The ID of the reseller partner.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "metadataOwnerId": {
+ "description": "Required. The owner of the newly set metadata. Set this to the partner ID.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata",
+ "request": {
+ "$ref": "UpdateDeviceMetadataRequest"
+ },
+ "response": {
+ "$ref": "DeviceMetadata"
+ }
+ },
+ "unclaim": {
+ "description": "Unclaims a device from a customer and removes it from zero-touch\nenrollment.",
+ "flatPath": "v1/partners/{partnersId}/devices:unclaim",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.partners.devices.unclaim",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "parameters": {
+ "partnerId": {
+ "description": "Required. The ID of the reseller partner.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/partners/{+partnerId}/devices:unclaim",
+ "request": {
+ "$ref": "UnclaimDeviceRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ }
+ },
+ "unclaimAsync": {
+ "description": "Unclaims a batch of devices for a customer asynchronously. Removes the\ndevices from zero-touch enrollment. To learn more, read [Long‑running batch\noperations](/zero-touch/guides/how-it-works#operations).",
+ "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "parameters": {
+ "partnerId": {
+ "description": "Required. The reseller partner ID.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/partners/{+partnerId}/devices:unclaimAsync",
+ "request": {
+ "$ref": "UnclaimDevicesRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "updateMetadataAsync": {
+ "description": "Updates the reseller metadata attached to a batch of devices. This method\nupdates devices asynchronously and returns an `Operation` that can be used\nto track progress. Read [Long‑running batch\noperations](/zero-touch/guides/how-it-works#operations).",
+ "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
+ "httpMethod": "POST",
+ "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "parameters": {
+ "partnerId": {
+ "description": "Required. The reseller partner ID.",
+ "format": "int64",
+ "location": "path",
+ "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
+ "request": {
+ "$ref": "UpdateDeviceMetadataInBatchRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ }
+ }
+ }
}
}
}
},
- "parameters": {
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- }
- },
+ "revision": "20180317",
+ "rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
"schemas": {
- "CustomerListDevicesResponse": {
- "description": "Response message of customer's liting devices.",
- "type": "object",
+ "ClaimDeviceRequest": {
+ "description": "Request message to claim a device on behalf of a customer.",
+ "id": "ClaimDeviceRequest",
"properties": {
- "devices": {
- "description": "The customer's devices.",
- "type": "array",
+ "customerId": {
+ "description": "Required. The ID of the customer for whom the device is being claimed.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Required. The device identifier of the device to claim."
+ },
+ "sectionType": {
+ "description": "Required. The section type of the device's provisioning record.",
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClaimDeviceResponse": {
+ "description": "Response message containing device id of the claim.",
+ "id": "ClaimDeviceResponse",
+ "properties": {
+ "deviceId": {
+ "description": "The device ID of the claimed device.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceName": {
+ "description": "The resource name of the device in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ClaimDevicesRequest": {
+ "description": "Request to claim devices asynchronously in batch. Claiming a device adds the\ndevice to zero-touch enrollment and shows the device in the customer's view\nof the portal.",
+ "id": "ClaimDevicesRequest",
+ "properties": {
+ "claims": {
+ "description": "Required. A list of device claims.",
"items": {
- "$ref": "Device"
- }
+ "$ref": "PartnerClaim"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Company": {
+ "description": "A customer resource in the zero-touch enrollment API.",
+ "id": "Company",
+ "properties": {
+ "adminEmails": {
+ "description": "Input only. Optional. Email address of customer's users in the admin role.\nEach email address must be associated with a Google Account.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "companyId": {
+ "description": "Output only. The ID of the company. Assigned by the server.",
+ "format": "int64",
+ "type": "string"
+ },
+ "companyName": {
+ "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The API resource name of the company in the format\n`partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`. Assigned by the server.",
+ "type": "string"
+ },
+ "ownerEmails": {
+ "description": "Input only. Email address of customer's users in the owner role. At least\none `owner_email` is required. Each email address must be associated with a\nGoogle Account. Owners share the same access as admins but can also add,\ndelete, and edit your organization's portal users.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Configuration": {
+ "description": "A configuration collects the provisioning options for Android devices. Each\nconfiguration combines the following:\n\n* The EMM device policy controller (DPC) installed on the devices.\n* EMM policies enforced on the devices.\n* Metadata displayed on the device to help users during setup.\n\nCustomers can add as many configurations as they need. However, zero-touch\nenrollment works best when a customer sets a default configuration that's\napplied to any new devices the organization purchases.",
+ "id": "Configuration",
+ "properties": {
+ "companyName": {
+ "description": "Required. The name of the organization. Zero-touch enrollment shows this\norganization name to device users during device provisioning.",
+ "type": "string"
+ },
+ "configurationId": {
+ "description": "Output only. The ID of the configuration. Assigned by the server.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configurationName": {
+ "description": "Required. A short name that describes the configuration's purpose. For\nexample, _Sales team_ or _Temporary employees_. The zero-touch enrollment\nportal displays this name to IT admins.",
+ "type": "string"
+ },
+ "contactEmail": {
+ "description": "Required. The email address that device users can contact to get help.\nZero-touch enrollment shows this email address to device users before\ndevice provisioning. The value is validated on input.",
+ "type": "string"
+ },
+ "contactPhone": {
+ "description": "Required. The telephone number that device users can call, using another\ndevice, to get help. Zero-touch enrollment shows this number to device\nusers before device provisioning. Accepts numerals, spaces, the plus sign,\nhyphens, and parentheses.",
+ "type": "string"
+ },
+ "customMessage": {
+ "description": "A message, containing one or two sentences, to help device users get help\nor give them more details about what’s happening to their device.\nZero-touch enrollment shows this message before the device is provisioned.",
+ "type": "string"
+ },
+ "dpcExtras": {
+ "description": "The JSON-formatted EMM provisioning extras that are passed to the DPC.",
+ "type": "string"
+ },
+ "dpcResourcePath": {
+ "description": "Required. The resource name of the selected DPC (device policy controller)\nin the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,\ncall\n`customers.dpcs.list`.",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "Required. Whether this is the default configuration that zero-touch\nenrollment applies to any new devices the organization purchases in the\nfuture. Only one customer configuration can be the default. Setting this\nvalue to `true`, changes the previous default configuration's `isDefault`\nvalue to `false`.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateCustomerRequest": {
+ "description": "Request message to create a customer.",
+ "id": "CreateCustomerRequest",
+ "properties": {
+ "customer": {
+ "$ref": "Company",
+ "description": "Required. The company data to populate the new customer. Must contain a\nvalue for `companyName` and at least one `owner_email` that's associated\nwith a Google Account. The values for `companyId` and `name` must be empty."
+ }
+ },
+ "type": "object"
+ },
+ "CustomerApplyConfigurationRequest": {
+ "description": "Request message for customer to assign a configuration to device.",
+ "id": "CustomerApplyConfigurationRequest",
+ "properties": {
+ "configuration": {
+ "description": "Required. The configuration applied to the device in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.",
+ "type": "string"
+ },
+ "device": {
+ "$ref": "DeviceReference",
+ "description": "Required. The device the configuration is applied to."
+ }
+ },
+ "type": "object"
+ },
+ "CustomerListConfigurationsResponse": {
+ "description": "Response message of customer's listing configuration.",
+ "id": "CustomerListConfigurationsResponse",
+ "properties": {
+ "configurations": {
+ "description": "The configurations.",
+ "items": {
+ "$ref": "Configuration"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CustomerListCustomersResponse": {
+ "description": "Response message for listing my customers.",
+ "id": "CustomerListCustomersResponse",
+ "properties": {
+ "customers": {
+ "description": "The customer accounts the calling user is a member of.",
+ "items": {
+ "$ref": "Company"
+ },
+ "type": "array"
},
"nextPageToken": {
"description": "A token used to access the next page of results. Omitted if no further\nresults are available.",
"type": "string"
}
},
- "id": "CustomerListDevicesResponse"
+ "type": "object"
},
- "DevicesLongRunningOperationResponse": {
- "description": "Long running operation response.",
- "type": "object",
+ "CustomerListDevicesResponse": {
+ "description": "Response message of customer's liting devices.",
+ "id": "CustomerListDevicesResponse",
"properties": {
- "successCount": {
- "description": "Number of succeesfully processed ones.",
- "format": "int32",
- "type": "integer"
- },
- "perDeviceStatus": {
- "description": "Processing status for each device.\nOne `PerDeviceStatus` per device. The order is the same as in your requests.",
- "type": "array",
+ "devices": {
+ "description": "The customer's devices.",
"items": {
- "$ref": "OperationPerDevice"
- }
+ "$ref": "Device"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token used to access the next page of results. Omitted if no further\nresults are available.",
+ "type": "string"
}
},
- "id": "DevicesLongRunningOperationResponse"
+ "type": "object"
},
- "DeviceClaim": {
+ "CustomerListDpcsResponse": {
+ "description": "Response message of customer's listing DPCs.",
+ "id": "CustomerListDpcsResponse",
"properties": {
- "sectionType": {
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "Output only. The type of claim made on the device.",
+ "dpcs": {
+ "description": "The list of DPCs available to the customer that support zero-touch\nenrollment.",
+ "items": {
+ "$ref": "Dpc"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CustomerRemoveConfigurationRequest": {
+ "description": "Request message for customer to remove the configuration from device.",
+ "id": "CustomerRemoveConfigurationRequest",
+ "properties": {
+ "device": {
+ "$ref": "DeviceReference",
+ "description": "Required. The device to remove the configuration from."
+ }
+ },
+ "type": "object"
+ },
+ "CustomerUnclaimDeviceRequest": {
+ "description": "Request message for customer to unclaim a device.",
+ "id": "CustomerUnclaimDeviceRequest",
+ "properties": {
+ "device": {
+ "$ref": "DeviceReference",
+ "description": "Required. The device to unclaim."
+ }
+ },
+ "type": "object"
+ },
+ "Device": {
+ "description": "An Android device registered for zero-touch enrollment.",
+ "id": "Device",
+ "properties": {
+ "claims": {
+ "description": "Output only. The provisioning claims for a device. Devices claimed for\nzero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.\nCall\n`partners.devices.unclaim`\nor\n`partners.devices.unclaimAsync`\nto remove the device from zero-touch enrollment.",
+ "items": {
+ "$ref": "DeviceClaim"
+ },
+ "type": "array"
+ },
+ "configuration": {
+ "description": "Not available to resellers.",
"type": "string"
},
+ "deviceId": {
+ "description": "Output only. The ID of the device. Assigned by the server.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "The hardware IDs that identify a manufactured device. To learn more, read\n[Identifiers](/zero-touch/guides/identifiers)."
+ },
+ "deviceMetadata": {
+ "$ref": "DeviceMetadata",
+ "description": "The metadata attached to the device. Structured as key-value pairs. To\nlearn more, read [Device metadata](/zero-touch/guides/metadata)."
+ },
+ "name": {
+ "description": "Output only. The API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeviceClaim": {
+ "description": "A record of a device claimed by a reseller for a customer. Devices claimed\nfor zero-touch enrollment have a claim with the type\n`SECTION_TYPE_ZERO_TOUCH`. To learn more, read\n[Claim devices for customers](/zero-touch/guides/how-it-works#claim).",
+ "id": "DeviceClaim",
+ "properties": {
"ownerCompanyId": {
"description": "The ID of the Customer that purchased the device.",
"format": "int64",
"type": "string"
- }
- },
- "id": "DeviceClaim",
- "description": "A record of a device claimed by a reseller for a customer. Devices claimed\nfor zero-touch enrollment have a claim with the type\n`SECTION_TYPE_ZERO_TOUCH`. To learn more, read\n[Claim devices for customers](/zero-touch/guides/how-it-works#claim).",
- "type": "object"
- },
- "PerDeviceStatusInBatch": {
- "properties": {
- "status": {
- "enumDescriptions": [
- "Invalid code. Shouldn't be used.",
- "Unknown error.\nWe don't expect this error to occur here.",
- "Other error.\nWe know/expect this error, but there's no defined error code for the\nerror.",
- "Success.",
- "Permission denied.",
- "Invalid device identifier.",
- "Invalid section type.",
- "This section is claimed by another company."
- ],
- "enum": [
- "SINGLE_DEVICE_STATUS_UNSPECIFIED",
- "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR",
- "SINGLE_DEVICE_STATUS_OTHER_ERROR",
- "SINGLE_DEVICE_STATUS_SUCCESS",
- "SINGLE_DEVICE_STATUS_PERMISSION_DENIED",
- "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER",
- "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
- "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS"
- ],
- "description": "Process result.",
- "type": "string"
- },
- "errorIdentifier": {
- "description": "Error identifier.",
- "type": "string"
- },
- "errorMessage": {
- "description": "Error message.",
- "type": "string"
- },
- "deviceId": {
- "description": "Device ID of the device if process succeeds.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "PerDeviceStatusInBatch",
- "description": "Stores the processing result for each device.",
- "type": "object"
- },
- "FindDevicesByOwnerRequest": {
- "properties": {
- "limit": {
- "description": "The number of devices to show in the result.",
- "format": "int64",
- "type": "string"
- },
- "pageToken": {
- "description": "Page token.",
- "type": "string"
},
"sectionType": {
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ],
+ "description": "Output only. The type of claim made on the device.",
"enum": [
"SECTION_TYPE_UNSPECIFIED",
"SECTION_TYPE_ZERO_TOUCH"
],
- "description": "The section type.",
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
"type": "string"
- },
- "customerId": {
- "description": "List of customer IDs to search for.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
}
},
- "id": "FindDevicesByOwnerRequest",
- "description": "Request to find devices by customers.",
- "type": "object"
- },
- "ClaimDevicesRequest": {
- "properties": {
- "claims": {
- "description": "List of claims.",
- "type": "array",
- "items": {
- "$ref": "PartnerClaim"
- }
- }
- },
- "id": "ClaimDevicesRequest",
- "description": "Request to claim devices asynchronously in batch.",
"type": "object"
},
"DeviceIdentifier": {
"description": "Encapsulates hardware and product IDs to identify a manufactured device. To\nlearn more, read [Identifiers](/zero-touch/guides/identifiers).",
- "type": "object",
+ "id": "DeviceIdentifier",
"properties": {
- "serialNumber": {
- "description": "The manufacturer's serial number for the device. This value might not be\nunique.",
- "type": "string"
- },
"imei": {
"description": "The device’s IMEI number. Validated on input.",
"type": "string"
},
+ "manufacturer": {
+ "description": "Required. The device manufacturer’s name. Matches the device's built-in\nvalue returned from `android.os.Build.MANUFACTURER`. Allowed values are\nlisted in [manufacturer names](/zero-touch/resources/manufacturer-names).",
+ "type": "string"
+ },
"meid": {
"description": "The device’s MEID number.",
"type": "string"
},
- "manufacturer": {
- "description": "Required. The device manufacturer’s name. Matches the device's built-in\nvalue returned from `android.os.Build.MANUFACTURER`. Allowed values are\nlisted in [manufacturer names](/zero-touch/resources/manufacturer-names).",
+ "serialNumber": {
+ "description": "The manufacturer's serial number for the device. This value might not be\nunique.",
"type": "string"
}
},
- "id": "DeviceIdentifier"
+ "type": "object"
+ },
+ "DeviceMetadata": {
+ "description": "Metadata entries that can be attached to a `Device`. To learn more, read\n[Device metadata](/zero-touch/guides/metadata).",
+ "id": "DeviceMetadata",
+ "properties": {
+ "entries": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata entries recorded as key-value pairs.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "DeviceReference": {
+ "description": "A `DeviceReference` is an API abstraction that lets you supply a _device_\nargument to a method using one of the following identifier types:\n\n* A numeric API resource ID.\n* Real-world hardware IDs, such as IMEI number, belonging to the manufactured\n device.\n\nMethods that operate on devices take a `DeviceReference` as a parameter type\nbecause it's more flexible for the caller. To learn more about device\nidentifiers, read [Identifiers](/zero-touch/guides/identifiers).",
+ "id": "DeviceReference",
+ "properties": {
+ "deviceId": {
+ "description": "The ID of the device.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "The hardware IDs of the device."
+ }
+ },
+ "type": "object"
+ },
+ "DevicesLongRunningOperationMetadata": {
+ "description": "Tracks the status of a long-running operation to asynchronously update a\nbatch of reseller metadata attached to devices. To learn more, read\n[Long‑running batch operations](/zero-touch/guides/how-it-works#operations).",
+ "id": "DevicesLongRunningOperationMetadata",
+ "properties": {
+ "devicesCount": {
+ "description": "The number of metadata updates in the operation. This might be different\nfrom the number of updates in the request if the API can't parse some of\nthe updates.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "processingStatus": {
+ "description": "The processing status of the operation.",
+ "enum": [
+ "BATCH_PROCESS_STATUS_UNSPECIFIED",
+ "BATCH_PROCESS_PENDING",
+ "BATCH_PROCESS_IN_PROGRESS",
+ "BATCH_PROCESS_PROCESSED"
+ ],
+ "enumDescriptions": [
+ "Invalid code. Shouldn't be used.",
+ "Pending.",
+ "In progress.",
+ "Processed.\nThis doesn't mean all items were processed sucessfully, you should\ncheck the `response` field for the result of every item."
+ ],
+ "type": "string"
+ },
+ "progress": {
+ "description": "The processing progress of the operation. Measured as a number from 0 to\n100. A value of 10O doesnt always mean the operation completed—check for\nthe inclusion of a `done` field.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DevicesLongRunningOperationResponse": {
+ "description": "Tracks the status of a long-running operation to claim, unclaim, or attach\nmetadata to devices. To learn more, read\n[Long‑running batch operations](/zero-touch/guides/how-it-works#operations).",
+ "id": "DevicesLongRunningOperationResponse",
+ "properties": {
+ "perDeviceStatus": {
+ "description": "The processing status for each device in the operation.\nOne `PerDeviceStatus` per device. The list order matches the items in the\noriginal request.",
+ "items": {
+ "$ref": "OperationPerDevice"
+ },
+ "type": "array"
+ },
+ "successCount": {
+ "description": "A summary of how many items in the operation the server processed\nsuccessfully. Updated as the operation progresses.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Dpc": {
+ "description": "An EMM's DPC ([device policy controller](/android/work/dpc/build-dpc)).\nZero-touch enrollment installs a DPC (listed in the `Configuration`) on a\ndevice to maintain the customer's mobile policies. All the DPCs listed by the\nAPI support zero-touch enrollment and are available in Google Play.",
+ "id": "Dpc",
+ "properties": {
+ "dpcName": {
+ "description": "Output only. The title of the DPC app in Google Play. For example, _Google\nApps Device Policy_. Useful in an application's user interface.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by\nthe server. To maintain a reference to a DPC across customer accounts,\npersist and match the last path component (`DPC_ID`).",
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Output only. The DPC's Android application ID that looks like a Java\npackage name. Zero-touch enrollment installs the DPC app onto a device\nusing this identifier.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "FindDevicesByDeviceIdentifierRequest": {
+ "description": "Request to find devices.",
+ "id": "FindDevicesByDeviceIdentifierRequest",
+ "properties": {
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Required. The device identifier to search for."
+ },
+ "limit": {
+ "description": "Required. The maximum number of devices to show in a page of results. Must\nbe between 1 and 100 inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token specifying which result page to return.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FindDevicesByDeviceIdentifierResponse": {
+ "description": "Response containing found devices.",
+ "id": "FindDevicesByDeviceIdentifierResponse",
+ "properties": {
+ "devices": {
+ "description": "Found devices.",
+ "items": {
+ "$ref": "Device"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token used to access the next page of results. Omitted if no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FindDevicesByOwnerRequest": {
+ "description": "Request to find devices by customers.",
+ "id": "FindDevicesByOwnerRequest",
+ "properties": {
+ "customerId": {
+ "description": "Required. The list of customer IDs to search for.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "limit": {
+ "description": "Required. The maximum number of devices to show in a page of results. Must\nbe between 1 and 100 inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token specifying which result page to return.",
+ "type": "string"
+ },
+ "sectionType": {
+ "description": "Required. The section type of the device's provisioning record.",
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FindDevicesByOwnerResponse": {
+ "description": "Response containing found devices.",
+ "id": "FindDevicesByOwnerResponse",
+ "properties": {
+ "devices": {
+ "description": "The customer's devices.",
+ "items": {
+ "$ref": "Device"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token used to access the next page of results.\nOmitted if no further results are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListCustomersResponse": {
+ "description": "Response message of all customers related to this partner.",
+ "id": "ListCustomersResponse",
+ "properties": {
+ "customers": {
+ "description": "List of customers related to this reseller partner.",
+ "items": {
+ "$ref": "Company"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
+ "id": "Operation",
"properties": {
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
},
"error": {
"$ref": "Status",
@@ -940,642 +1317,265 @@
"description": "This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
"type": "object"
},
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- }
- },
- "id": "Operation"
- },
- "Dpc": {
- "properties": {
"name": {
- "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by\nthe server. To maintain a reference to a DPC across customer accounts,\npersist and match the last path component (`DPC_ID`).",
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
},
- "packageName": {
- "description": "Output only. The DPC's Android application ID that looks like a Java\npackage name. Zero-touch enrollment installs the DPC app onto a device\nusing this identifier.",
- "type": "string"
- },
- "dpcName": {
- "description": "Output only. The title of the DPC app in Google Play. For example, _Google\nApps Device Policy_. Useful in an application's user interface.",
- "type": "string"
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
+ "type": "object"
}
},
- "id": "Dpc",
- "description": "An EMM's DPC ([device policy controller](/android/work/dpc/build-dpc)).\nZero-touch enrollment installs a DPC (listed in the `Configuration`) on a\ndevice to maintain the customer's mobile policies. All the DPCs listed by the\nAPI support zero-touch enrollment and are available in Google Play.",
"type": "object"
},
- "CustomerApplyConfigurationRequest": {
- "description": "Request message for customer to assign a configuration to device.",
- "type": "object",
+ "OperationPerDevice": {
+ "description": "A task for each device in the operation. Corresponds to each device\nchange in the request.",
+ "id": "OperationPerDevice",
"properties": {
- "configuration": {
- "description": "Required. The configuration applied to the device in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.",
+ "claim": {
+ "$ref": "PartnerClaim",
+ "description": "A copy of the original device-claim request received by the server."
+ },
+ "result": {
+ "$ref": "PerDeviceStatusInBatch",
+ "description": "The processing result for each device."
+ },
+ "unclaim": {
+ "$ref": "PartnerUnclaim",
+ "description": "A copy of the original device-unclaim request received by the server."
+ },
+ "updateMetadata": {
+ "$ref": "UpdateMetadataArguments",
+ "description": "A copy of the original metadata-update request received by the server."
+ }
+ },
+ "type": "object"
+ },
+ "PartnerClaim": {
+ "description": "Identifies one claim request.",
+ "id": "PartnerClaim",
+ "properties": {
+ "customerId": {
+ "description": "Required. The ID of the customer for whom the device is being claimed.",
+ "format": "int64",
"type": "string"
},
- "device": {
- "description": "Required. The device the configuration is applied to.",
- "$ref": "DeviceReference"
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Required. Device identifier of the device."
+ },
+ "deviceMetadata": {
+ "$ref": "DeviceMetadata",
+ "description": "Required. The metadata to attach to the device at claim."
+ },
+ "sectionType": {
+ "description": "Required. The section type of the device's provisioning record.",
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "type": "string"
}
},
- "id": "CustomerApplyConfigurationRequest"
+ "type": "object"
},
- "UnclaimDevicesRequest": {
- "description": "Request to unclaim devices asynchronously in batch.",
- "type": "object",
+ "PartnerUnclaim": {
+ "description": "Identifies one unclaim request.",
+ "id": "PartnerUnclaim",
"properties": {
- "unclaims": {
- "description": "List of devices to unclaim.",
- "type": "array",
- "items": {
- "$ref": "PartnerUnclaim"
- }
+ "deviceId": {
+ "description": "Device ID of the device.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Device identifier of the device."
+ },
+ "sectionType": {
+ "description": "Required. The section type of the device's provisioning record.",
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "type": "string"
}
},
- "id": "UnclaimDevicesRequest"
+ "type": "object"
},
- "CustomerUnclaimDeviceRequest": {
- "description": "Request message for customer to unclaim a device.",
- "type": "object",
+ "PerDeviceStatusInBatch": {
+ "description": "Captures the processing status for each device in the operation.",
+ "id": "PerDeviceStatusInBatch",
"properties": {
- "device": {
- "description": "Required. The device to unclaim.",
- "$ref": "DeviceReference"
+ "deviceId": {
+ "description": "If processing succeeds, the device ID of the device.",
+ "format": "int64",
+ "type": "string"
+ },
+ "errorIdentifier": {
+ "description": "If processing fails, the error type.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "If processing fails, a developer message explaining what went wrong.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The result status of the device after processing.",
+ "enum": [
+ "SINGLE_DEVICE_STATUS_UNSPECIFIED",
+ "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR",
+ "SINGLE_DEVICE_STATUS_OTHER_ERROR",
+ "SINGLE_DEVICE_STATUS_SUCCESS",
+ "SINGLE_DEVICE_STATUS_PERMISSION_DENIED",
+ "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER",
+ "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
+ "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS"
+ ],
+ "enumDescriptions": [
+ "Invalid code. Shouldn't be used.",
+ "Unknown error.\nWe don't expect this error to occur here.",
+ "Other error.\nWe know/expect this error, but there's no defined error code for the\nerror.",
+ "Success.",
+ "Permission denied.",
+ "Invalid device identifier.",
+ "Invalid section type.",
+ "This section is claimed by another company."
+ ],
+ "type": "string"
}
},
- "id": "CustomerUnclaimDeviceRequest"
+ "type": "object"
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
"properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object"
},
- "FindDevicesByDeviceIdentifierRequest": {
- "properties": {
- "deviceIdentifier": {
- "description": "The device identifier to search.",
- "$ref": "DeviceIdentifier"
- },
- "pageToken": {
- "description": "Page token.",
- "type": "string"
- },
- "limit": {
- "description": "Number of devices to show.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "FindDevicesByDeviceIdentifierRequest",
- "description": "Request to find devices.",
- "type": "object"
- },
- "CustomerListConfigurationsResponse": {
- "description": "Response message of customer's listing configuration.",
- "type": "object",
- "properties": {
- "configurations": {
- "description": "The configurations.",
- "type": "array",
- "items": {
- "$ref": "Configuration"
- }
- }
- },
- "id": "CustomerListConfigurationsResponse"
- },
- "OperationPerDevice": {
- "description": "Operation the server received for every device.",
- "type": "object",
- "properties": {
- "claim": {
- "description": "Request to claim a device.",
- "$ref": "PartnerClaim"
- },
- "updateMetadata": {
- "description": "Request to set metadata for a device.",
- "$ref": "UpdateMetadataArguments"
- },
- "unclaim": {
- "description": "Request to unclaim a device.",
- "$ref": "PartnerUnclaim"
- },
- "result": {
- "$ref": "PerDeviceStatusInBatch",
- "description": "Processing result for every device."
- }
- },
- "id": "OperationPerDevice"
- },
- "FindDevicesByOwnerResponse": {
- "description": "Response containing found devices.",
- "type": "object",
- "properties": {
- "devices": {
- "description": "Devices found.",
- "type": "array",
- "items": {
- "$ref": "Device"
- }
- },
- "nextPageToken": {
- "description": "Page token of the next page.",
- "type": "string"
- }
- },
- "id": "FindDevicesByOwnerResponse"
- },
- "CustomerRemoveConfigurationRequest": {
- "description": "Request message for customer to remove the configuration from device.",
- "type": "object",
- "properties": {
- "device": {
- "$ref": "DeviceReference",
- "description": "Required. The device to remove the configuration from."
- }
- },
- "id": "CustomerRemoveConfigurationRequest"
- },
- "ClaimDeviceRequest": {
- "description": "Request message to claim a device on behalf of a customer.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The device identifier of the device to claim."
- },
- "sectionType": {
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "The section to claim.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ]
- },
- "customerId": {
- "description": "The customer to claim for.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "ClaimDeviceRequest"
- },
- "DevicesLongRunningOperationMetadata": {
- "description": "Long running operation metadata.",
- "type": "object",
- "properties": {
- "processingStatus": {
- "description": "The overall processing status.",
- "type": "string",
- "enumDescriptions": [
- "Invalid code. Shouldn't be used.",
- "Pending.",
- "In progress.",
- "Processed.\nThis doesn't mean all items were processed sucessfully, you should\ncheck the `response` field for the result of every item."
- ],
- "enum": [
- "BATCH_PROCESS_STATUS_UNSPECIFIED",
- "BATCH_PROCESS_PENDING",
- "BATCH_PROCESS_IN_PROGRESS",
- "BATCH_PROCESS_PROCESSED"
- ]
- },
- "progress": {
- "description": "Processing progress from 0 to 100.",
- "format": "int32",
- "type": "integer"
- },
- "devicesCount": {
- "description": "Number of devices parsed in your requests.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DevicesLongRunningOperationMetadata"
- },
- "UpdateDeviceMetadataInBatchRequest": {
- "description": "Request to update device metadata in batch.",
- "type": "object",
- "properties": {
- "updates": {
- "description": "List of metadata updates.",
- "type": "array",
- "items": {
- "$ref": "UpdateMetadataArguments"
- }
- }
- },
- "id": "UpdateDeviceMetadataInBatchRequest"
- },
- "ListCustomersResponse": {
- "description": "Response message of all customers related to this partner.",
- "type": "object",
- "properties": {
- "customers": {
- "description": "List of customers related to this partner.",
- "type": "array",
- "items": {
- "$ref": "Company"
- }
- }
- },
- "id": "ListCustomersResponse"
- },
- "ClaimDeviceResponse": {
- "description": "Response message containing device id of the claim.",
- "type": "object",
- "properties": {
- "deviceName": {
- "description": "The resource name of the device in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
- "type": "string"
- },
- "deviceId": {
- "description": "The device ID of the claimed device.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "ClaimDeviceResponse"
- },
- "UpdateMetadataArguments": {
- "properties": {
- "deviceIdentifier": {
- "description": "Device identifier.",
- "$ref": "DeviceIdentifier"
- },
- "deviceMetadata": {
- "description": "The metadata to update.",
- "$ref": "DeviceMetadata"
- },
- "deviceId": {
- "description": "Device ID of the device.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "UpdateMetadataArguments",
- "description": "Identifies metdata updates to one device.",
- "type": "object"
- },
- "DeviceReference": {
- "properties": {
- "deviceIdentifier": {
- "description": "The hardware IDs of the device.",
- "$ref": "DeviceIdentifier"
- },
- "deviceId": {
- "description": "The ID of the device.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "DeviceReference",
- "description": "A `DeviceReference` is an API abstraction that lets you supply a _device_\nargument to a method using one of the following identifier types:\n\n* A numeric API resource ID.\n* Real-world hardware IDs, such as IMEI number, belonging to the manufactured\n device.\n\nMethods that operate on devices take a `DeviceReference` as a parameter type\nbecause it's more flexible for the caller. To learn more about device\nidentifiers, read [Identifiers](/zero-touch/guides/identifiers).",
- "type": "object"
- },
- "Device": {
- "description": "An Android device registered for zero-touch enrollment.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The hardware IDs that identify a manufactured device. To learn more, read\n[Identifiers](/zero-touch/guides/identifiers)."
- },
- "deviceMetadata": {
- "description": "The metadata attached to the device. Structured as key-value pairs. To\nlearn more, read [Device metadata](/zero-touch/guides/metadata).",
- "$ref": "DeviceMetadata"
- },
- "name": {
- "description": "Output only. The API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.",
- "type": "string"
- },
- "deviceId": {
- "description": "Output only. The ID of the device. Assigned by the server.",
- "format": "int64",
- "type": "string"
- },
- "configuration": {
- "description": "Not available to resellers.",
- "type": "string"
- },
- "claims": {
- "description": "Output only. The provisioning claims for a device. Devices claimed for\nzero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.\nCall\n`partners.devices.unclaim`\nor\n`partners.devices.unclaimAsync`\nto remove the device from zero-touch enrollment.",
- "type": "array",
- "items": {
- "$ref": "DeviceClaim"
- }
- }
- },
- "id": "Device"
- },
- "CreateCustomerRequest": {
- "description": "Request message to create a customer.",
- "type": "object",
- "properties": {
- "customer": {
- "$ref": "Company",
- "description": "Required. The company data to populate the new customer. Must contain a\nvalue for `companyName` and at least one `owner_email` that's associated\nwith a Google Account. The values for `companyId` and `name` must be empty."
- }
- },
- "id": "CreateCustomerRequest"
- },
- "Company": {
- "description": "A customer resource in the zero-touch enrollment API.",
- "type": "object",
- "properties": {
- "companyId": {
- "description": "Output only. The ID of the company. Assigned by the server.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Output only. The API resource name of the company in the format\n`partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`. Assigned by the server.",
- "type": "string"
- },
- "companyName": {
- "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal.",
- "type": "string"
- },
- "adminEmails": {
- "description": "Input only. Optional. Email address of customer's users in the admin role.\nEach email address must be associated with a Google Account.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "ownerEmails": {
- "description": "Input only. Email address of customer's users in the owner role. At least\none `owner_email` is required. Each email address must be associated with a\nGoogle Account. Owners share the same access as admins but can also add,\ndelete, and edit your organization's portal users.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Company"
- },
- "Configuration": {
- "properties": {
- "companyName": {
- "description": "Required. The name of the organization. Zero-touch enrollment shows this\norganization name to device users during device provisioning.",
- "type": "string"
- },
- "configurationId": {
- "description": "Output only. The ID of the configuration. Assigned by the server.",
- "format": "int64",
- "type": "string"
- },
- "dpcResourcePath": {
- "description": "Required. The resource name of the selected DPC (device policy controller)\nin the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,\ncall\n`customers.dpcs.list`.",
- "type": "string"
- },
- "isDefault": {
- "description": "Required. Whether this is the default configuration that zero-touch\nenrollment applies to any new devices the organization purchases in the\nfuture. Only one customer configuration can be the default. Setting this\nvalue to `true`, changes the previous default configuration's `isDefault`\nvalue to `false`.",
- "type": "boolean"
- },
- "dpcExtras": {
- "description": "The JSON-formatted EMM provisioning extras that are passed to the DPC.",
- "type": "string"
- },
- "customMessage": {
- "description": "A message, containing one or two sentences, to help device users get help\nor give them more details about what’s happening to their device.\nZero-touch enrollment shows this message before the device is provisioned.",
- "type": "string"
- },
- "contactEmail": {
- "description": "Required. The email address that device users can contact to get help.\nZero-touch enrollment shows this email address to device users before\ndevice provisioning. The value is validated on input.",
- "type": "string"
- },
- "name": {
- "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.",
- "type": "string"
- },
- "configurationName": {
- "description": "Required. A short name that describes the configuration's purpose. For\nexample, _Sales team_ or _Temporary employees_. The zero-touch enrollment\nportal displays this name to IT admins.",
- "type": "string"
- },
- "contactPhone": {
- "description": "Required. The telephone number that device users can call, using another\ndevice, to get help. Zero-touch enrollment shows this number to device\nusers before device provisioning. Accepts numerals, spaces, the plus sign,\nhyphens, and parentheses.",
- "type": "string"
- }
- },
- "id": "Configuration",
- "description": "A configuration collects the provisioning options for Android devices. Each\nconfiguration combines the following:\n\n* The EMM device policy controller (DPC) installed on the devices.\n* EMM policies enforced on the devices.\n* Metadata displayed on the device to help users during setup.\n\nCustomers can add as many configurations as they need. However, zero-touch\nenrollment works best when a customer sets a default configuration that's\napplied to any new devices the organization purchases.",
- "type": "object"
- },
- "UpdateDeviceMetadataRequest": {
- "properties": {
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "The metdata to set."
- }
- },
- "id": "UpdateDeviceMetadataRequest",
- "description": "Request to set metadata for a device.",
- "type": "object"
- },
- "CustomerListDpcsResponse": {
- "properties": {
- "dpcs": {
- "description": "The list of DPCs available to the customer that support zero-touch\nenrollment.",
- "type": "array",
- "items": {
- "$ref": "Dpc"
- }
- }
- },
- "id": "CustomerListDpcsResponse",
- "description": "Response message of customer's listing DPCs.",
- "type": "object"
- },
- "PartnerUnclaim": {
- "description": "Identifies one unclaim request.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "Device identifier of the device."
- },
- "sectionType": {
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "Section type to unclaim.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ]
- },
- "deviceId": {
- "description": "Device ID of the device.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "PartnerUnclaim"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "FindDevicesByDeviceIdentifierResponse": {
- "description": "Response containing found devices.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Page token of the next page.",
- "type": "string"
- },
- "devices": {
- "description": "Found devices.",
- "type": "array",
- "items": {
- "$ref": "Device"
- }
- }
- },
- "id": "FindDevicesByDeviceIdentifierResponse"
- },
- "PartnerClaim": {
- "description": "Identifies one claim request.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "description": "Device identifier of the device.",
- "$ref": "DeviceIdentifier"
- },
- "deviceMetadata": {
- "description": "Metadata to set at claim.",
- "$ref": "DeviceMetadata"
- },
- "sectionType": {
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "Section type to claim.",
- "type": "string"
- },
- "customerId": {
- "description": "Customer ID to claim for.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "PartnerClaim"
- },
"UnclaimDeviceRequest": {
"description": "Request message to unclaim a device.",
- "type": "object",
+ "id": "UnclaimDeviceRequest",
"properties": {
+ "deviceId": {
+ "description": "The device ID returned by `ClaimDevice`.",
+ "format": "int64",
+ "type": "string"
+ },
"deviceIdentifier": {
"$ref": "DeviceIdentifier",
"description": "The device identifier you used when you claimed this device."
},
"sectionType": {
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ],
+ "description": "Required. The section type of the device's provisioning record.",
"enum": [
"SECTION_TYPE_UNSPECIFIED",
"SECTION_TYPE_ZERO_TOUCH"
],
- "description": "The section type to unclaim for.",
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
"type": "string"
- },
+ }
+ },
+ "type": "object"
+ },
+ "UnclaimDevicesRequest": {
+ "description": "Request to unclaim devices asynchronously in batch.",
+ "id": "UnclaimDevicesRequest",
+ "properties": {
+ "unclaims": {
+ "description": "Required. The list of devices to unclaim.",
+ "items": {
+ "$ref": "PartnerUnclaim"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UpdateDeviceMetadataInBatchRequest": {
+ "description": "Request to update device metadata in batch.",
+ "id": "UpdateDeviceMetadataInBatchRequest",
+ "properties": {
+ "updates": {
+ "description": "Required. The list of metadata updates.",
+ "items": {
+ "$ref": "UpdateMetadataArguments"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UpdateDeviceMetadataRequest": {
+ "description": "Request to set metadata for a device.",
+ "id": "UpdateDeviceMetadataRequest",
+ "properties": {
+ "deviceMetadata": {
+ "$ref": "DeviceMetadata",
+ "description": "Required. The metdata to attach to the device."
+ }
+ },
+ "type": "object"
+ },
+ "UpdateMetadataArguments": {
+ "description": "Identifies metdata updates to one device.",
+ "id": "UpdateMetadataArguments",
+ "properties": {
"deviceId": {
- "description": "The device ID returned by `ClaimDevice`.",
+ "description": "Device ID of the device.",
"format": "int64",
"type": "string"
- }
- },
- "id": "UnclaimDeviceRequest"
- },
- "DeviceMetadata": {
- "description": "Metadata entries that can be attached to a `Device`. To learn more, read\n[Device metadata](/zero-touch/guides/metadata).",
- "type": "object",
- "properties": {
- "entries": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata entries recorded as key-value pairs.",
- "type": "object"
- }
- },
- "id": "DeviceMetadata"
- },
- "CustomerListCustomersResponse": {
- "description": "Response message for listing my customers.",
- "type": "object",
- "properties": {
- "customers": {
- "description": "Customers the current user can act as.",
- "type": "array",
- "items": {
- "$ref": "Company"
- }
},
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
- "type": "string"
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Device identifier."
+ },
+ "deviceMetadata": {
+ "$ref": "DeviceMetadata",
+ "description": "Required. The metadata to update."
}
},
- "id": "CustomerListCustomersResponse"
+ "type": "object"
}
},
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "version": "v1",
- "baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
- "canonicalName": "Android Provisioning Partner",
- "kind": "discovery#restDescription",
- "description": "Automates reseller integration into zero-touch enrollment by assigning devices to customers and creating device reports.",
"servicePath": "",
- "rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "androiddeviceprovisioning",
- "batchPath": "batch",
- "id": "androiddeviceprovisioning:v1",
- "documentationLink": "https://developers.google.com/zero-touch/",
- "revision": "20180114",
- "title": "Android Device Provisioning Partner API"
-}
+ "title": "Android Device Provisioning Partner API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-gen.go b/vendor/google.golang.org/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-gen.go
index 8201e4b4f..973e06063 100644
--- a/vendor/google.golang.org/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-gen.go
+++ b/vendor/google.golang.org/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-gen.go
@@ -165,13 +165,16 @@ type PartnersDevicesService struct {
// ClaimDeviceRequest: Request message to claim a device on behalf of a
// customer.
type ClaimDeviceRequest struct {
- // CustomerId: The customer to claim for.
+ // CustomerId: Required. The ID of the customer for whom the device is
+ // being claimed.
CustomerId int64 `json:"customerId,omitempty,string"`
- // DeviceIdentifier: The device identifier of the device to claim.
+ // DeviceIdentifier: Required. The device identifier of the device to
+ // claim.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
- // SectionType: The section to claim.
+ // SectionType: Required. The section type of the device's provisioning
+ // record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
@@ -240,9 +243,12 @@ func (s *ClaimDeviceResponse) MarshalJSON() ([]byte, error) {
}
// ClaimDevicesRequest: Request to claim devices asynchronously in
-// batch.
+// batch. Claiming a device adds the
+// device to zero-touch enrollment and shows the device in the
+// customer's view
+// of the portal.
type ClaimDevicesRequest struct {
- // Claims: List of claims.
+ // Claims: Required. A list of device claims.
Claims []*PartnerClaim `json:"claims,omitempty"`
// ForceSendFields is a list of field names (e.g. "Claims") to
@@ -545,12 +551,12 @@ func (s *CustomerListConfigurationsResponse) MarshalJSON() ([]byte, error) {
// CustomerListCustomersResponse: Response message for listing my
// customers.
type CustomerListCustomersResponse struct {
- // Customers: Customers the current user can act as.
+ // Customers: The customer accounts the calling user is a member of.
Customers []*Company `json:"customers,omitempty"`
- // NextPageToken: Token to retrieve the next page of results, or empty
- // if there are no
- // more results in the list.
+ // NextPageToken: A token used to access the next page of results.
+ // Omitted if no further
+ // results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -939,12 +945,21 @@ func (s *DeviceReference) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// DevicesLongRunningOperationMetadata: Long running operation metadata.
+// DevicesLongRunningOperationMetadata: 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).
type DevicesLongRunningOperationMetadata struct {
- // DevicesCount: Number of devices parsed in your requests.
+ // DevicesCount: 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 int64 `json:"devicesCount,omitempty"`
- // ProcessingStatus: The overall processing status.
+ // ProcessingStatus: The processing status of the operation.
//
// Possible values:
// "BATCH_PROCESS_STATUS_UNSPECIFIED" - Invalid code. Shouldn't be
@@ -957,7 +972,11 @@ type DevicesLongRunningOperationMetadata struct {
// check the `response` field for the result of every item.
ProcessingStatus string `json:"processingStatus,omitempty"`
- // Progress: Processing progress from 0 to 100.
+ // Progress: 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 int64 `json:"progress,omitempty"`
// ForceSendFields is a list of field names (e.g. "DevicesCount") to
@@ -983,14 +1002,22 @@ func (s *DevicesLongRunningOperationMetadata) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// DevicesLongRunningOperationResponse: Long running operation response.
+// DevicesLongRunningOperationResponse: 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).
type DevicesLongRunningOperationResponse struct {
- // PerDeviceStatus: Processing status for each device.
- // One `PerDeviceStatus` per device. The order is the same as in your
- // requests.
+ // PerDeviceStatus: The processing status for each device in the
+ // operation.
+ // One `PerDeviceStatus` per device. The list order matches the items in
+ // the
+ // original request.
PerDeviceStatus []*OperationPerDevice `json:"perDeviceStatus,omitempty"`
- // SuccessCount: Number of succeesfully processed ones.
+ // SuccessCount: A summary of how many items in the operation the server
+ // processed
+ // successfully. Updated as the operation progresses.
SuccessCount int64 `json:"successCount,omitempty"`
// ForceSendFields is a list of field names (e.g. "PerDeviceStatus") to
@@ -1088,13 +1115,15 @@ type Empty struct {
// FindDevicesByDeviceIdentifierRequest: Request to find devices.
type FindDevicesByDeviceIdentifierRequest struct {
- // DeviceIdentifier: The device identifier to search.
+ // DeviceIdentifier: Required. The device identifier to search for.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
- // Limit: Number of devices to show.
+ // Limit: Required. The maximum number of devices to show in a page of
+ // results. Must
+ // be between 1 and 100 inclusive.
Limit int64 `json:"limit,omitempty,string"`
- // PageToken: Page token.
+ // PageToken: A token specifying which result page to return.
PageToken string `json:"pageToken,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceIdentifier") to
@@ -1127,7 +1156,9 @@ type FindDevicesByDeviceIdentifierResponse struct {
// Devices: Found devices.
Devices []*Device `json:"devices,omitempty"`
- // NextPageToken: Page token of the next page.
+ // NextPageToken: A token used to access the next page of results.
+ // Omitted if no further
+ // results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -1159,16 +1190,19 @@ func (s *FindDevicesByDeviceIdentifierResponse) MarshalJSON() ([]byte, error) {
// FindDevicesByOwnerRequest: Request to find devices by customers.
type FindDevicesByOwnerRequest struct {
- // CustomerId: List of customer IDs to search for.
+ // CustomerId: Required. The list of customer IDs to search for.
CustomerId googleapi.Int64s `json:"customerId,omitempty"`
- // Limit: The number of devices to show in the result.
+ // Limit: Required. The maximum number of devices to show in a page of
+ // results. Must
+ // be between 1 and 100 inclusive.
Limit int64 `json:"limit,omitempty,string"`
- // PageToken: Page token.
+ // PageToken: A token specifying which result page to return.
PageToken string `json:"pageToken,omitempty"`
- // SectionType: The section type.
+ // SectionType: Required. The section type of the device's provisioning
+ // record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
@@ -1200,10 +1234,12 @@ func (s *FindDevicesByOwnerRequest) MarshalJSON() ([]byte, error) {
// FindDevicesByOwnerResponse: Response containing found devices.
type FindDevicesByOwnerResponse struct {
- // Devices: Devices found.
+ // Devices: The customer's devices.
Devices []*Device `json:"devices,omitempty"`
- // NextPageToken: Page token of the next page.
+ // NextPageToken: A token used to access the next page of
+ // results.
+ // Omitted if no further results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -1236,7 +1272,7 @@ func (s *FindDevicesByOwnerResponse) MarshalJSON() ([]byte, error) {
// ListCustomersResponse: Response message of all customers related to
// this partner.
type ListCustomersResponse struct {
- // Customers: List of customers related to this partner.
+ // Customers: List of customers related to this reseller partner.
Customers []*Company `json:"customers,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -1327,18 +1363,23 @@ func (s *Operation) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// OperationPerDevice: Operation the server received for every device.
+// OperationPerDevice: A task for each device in the operation.
+// Corresponds to each device
+// change in the request.
type OperationPerDevice struct {
- // Claim: Request to claim a device.
+ // Claim: A copy of the original device-claim request received by the
+ // server.
Claim *PartnerClaim `json:"claim,omitempty"`
- // Result: Processing result for every device.
+ // Result: The processing result for each device.
Result *PerDeviceStatusInBatch `json:"result,omitempty"`
- // Unclaim: Request to unclaim a device.
+ // Unclaim: A copy of the original device-unclaim request received by
+ // the server.
Unclaim *PartnerUnclaim `json:"unclaim,omitempty"`
- // UpdateMetadata: Request to set metadata for a device.
+ // UpdateMetadata: A copy of the original metadata-update request
+ // received by the server.
UpdateMetadata *UpdateMetadataArguments `json:"updateMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "Claim") to
@@ -1366,16 +1407,19 @@ func (s *OperationPerDevice) MarshalJSON() ([]byte, error) {
// PartnerClaim: Identifies one claim request.
type PartnerClaim struct {
- // CustomerId: Customer ID to claim for.
+ // CustomerId: Required. The ID of the customer for whom the device is
+ // being claimed.
CustomerId int64 `json:"customerId,omitempty,string"`
- // DeviceIdentifier: Device identifier of the device.
+ // DeviceIdentifier: Required. Device identifier of the device.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
- // DeviceMetadata: Metadata to set at claim.
+ // DeviceMetadata: Required. The metadata to attach to the device at
+ // claim.
DeviceMetadata *DeviceMetadata `json:"deviceMetadata,omitempty"`
- // SectionType: Section type to claim.
+ // SectionType: Required. The section type of the device's provisioning
+ // record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
@@ -1413,7 +1457,8 @@ type PartnerUnclaim struct {
// DeviceIdentifier: Device identifier of the device.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
- // SectionType: Section type to unclaim.
+ // SectionType: Required. The section type of the device's provisioning
+ // record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
@@ -1443,18 +1488,20 @@ func (s *PartnerUnclaim) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// PerDeviceStatusInBatch: Stores the processing result for each device.
+// PerDeviceStatusInBatch: Captures the processing status for each
+// device in the operation.
type PerDeviceStatusInBatch struct {
- // DeviceId: Device ID of the device if process succeeds.
+ // DeviceId: If processing succeeds, the device ID of the device.
DeviceId int64 `json:"deviceId,omitempty,string"`
- // ErrorIdentifier: Error identifier.
+ // ErrorIdentifier: If processing fails, the error type.
ErrorIdentifier string `json:"errorIdentifier,omitempty"`
- // ErrorMessage: Error message.
+ // ErrorMessage: If processing fails, a developer message explaining
+ // what went wrong.
ErrorMessage string `json:"errorMessage,omitempty"`
- // Status: Process result.
+ // Status: The result status of the device after processing.
//
// Possible values:
// "SINGLE_DEVICE_STATUS_UNSPECIFIED" - Invalid code. Shouldn't be
@@ -1625,7 +1672,8 @@ type UnclaimDeviceRequest struct {
// this device.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
- // SectionType: The section type to unclaim for.
+ // SectionType: Required. The section type of the device's provisioning
+ // record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
@@ -1658,7 +1706,7 @@ func (s *UnclaimDeviceRequest) MarshalJSON() ([]byte, error) {
// UnclaimDevicesRequest: Request to unclaim devices asynchronously in
// batch.
type UnclaimDevicesRequest struct {
- // Unclaims: List of devices to unclaim.
+ // Unclaims: Required. The list of devices to unclaim.
Unclaims []*PartnerUnclaim `json:"unclaims,omitempty"`
// ForceSendFields is a list of field names (e.g. "Unclaims") to
@@ -1687,7 +1735,7 @@ func (s *UnclaimDevicesRequest) MarshalJSON() ([]byte, error) {
// UpdateDeviceMetadataInBatchRequest: Request to update device metadata
// in batch.
type UpdateDeviceMetadataInBatchRequest struct {
- // Updates: List of metadata updates.
+ // Updates: Required. The list of metadata updates.
Updates []*UpdateMetadataArguments `json:"updates,omitempty"`
// ForceSendFields is a list of field names (e.g. "Updates") to
@@ -1715,7 +1763,7 @@ func (s *UpdateDeviceMetadataInBatchRequest) MarshalJSON() ([]byte, error) {
// UpdateDeviceMetadataRequest: Request to set metadata for a device.
type UpdateDeviceMetadataRequest struct {
- // DeviceMetadata: The metdata to set.
+ // DeviceMetadata: Required. The metdata to attach to the device.
DeviceMetadata *DeviceMetadata `json:"deviceMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceMetadata") to
@@ -1750,7 +1798,7 @@ type UpdateMetadataArguments struct {
// DeviceIdentifier: Device identifier.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
- // DeviceMetadata: The metadata to update.
+ // DeviceMetadata: Required. The metadata to update.
DeviceMetadata *DeviceMetadata `json:"deviceMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceId") to
@@ -1786,21 +1834,22 @@ type CustomersListCall struct {
header_ http.Header
}
-// List: List the user's customer accounts.
+// List: Lists the user's customer accounts.
func (r *CustomersService) List() *CustomersListCall {
c := &CustomersListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
return c
}
// PageSize sets the optional parameter "pageSize": The maximum number
-// of items to return.
+// of customers to show in a page of results.
+// A number between 1 and 100 (inclusive).
func (c *CustomersListCall) PageSize(pageSize int64) *CustomersListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
}
-// PageToken sets the optional parameter "pageToken": The
-// next_page_token value returned from a previous List request, if any.
+// PageToken sets the optional parameter "pageToken": A token specifying
+// which result page to return.
func (c *CustomersListCall) PageToken(pageToken string) *CustomersListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
@@ -1897,20 +1946,20 @@ func (c *CustomersListCall) Do(opts ...googleapi.CallOption) (*CustomerListCusto
}
return ret, nil
// {
- // "description": "List the user's customer accounts.",
+ // "description": "Lists the user's customer accounts.",
// "flatPath": "v1/customers",
// "httpMethod": "GET",
// "id": "androiddeviceprovisioning.customers.list",
// "parameterOrder": [],
// "parameters": {
// "pageSize": {
- // "description": "The maximum number of items to return.",
+ // "description": "The maximum number of customers to show in a page of results.\nA number between 1 and 100 (inclusive).",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
- // "description": "The next_page_token value returned from a previous List request, if any.",
+ // "description": "A token specifying which result page to return.",
// "location": "query",
// "type": "string"
// }
@@ -3891,7 +3940,7 @@ func (c *PartnersCustomersListCall) Do(opts ...googleapi.CallOption) (*ListCusto
// ],
// "parameters": {
// "partnerId": {
- // "description": "The ID of the partner.",
+ // "description": "Required. The ID of the reseller partner.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
@@ -3918,7 +3967,10 @@ type PartnersDevicesClaimCall struct {
header_ http.Header
}
-// Claim: Claim the device identified by device identifier.
+// Claim: 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.
func (r *PartnersDevicesService) Claim(partnerId int64, claimdevicerequest *ClaimDeviceRequest) *PartnersDevicesClaimCall {
c := &PartnersDevicesClaimCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.partnerId = partnerId
@@ -4012,7 +4064,7 @@ func (c *PartnersDevicesClaimCall) Do(opts ...googleapi.CallOption) (*ClaimDevic
}
return ret, nil
// {
- // "description": "Claim the device identified by device identifier.",
+ // "description": "Claims a device for a customer and adds it to zero-touch enrollment. If the\ndevice is already claimed by another customer, the call returns an error.",
// "flatPath": "v1/partners/{partnersId}/devices:claim",
// "httpMethod": "POST",
// "id": "androiddeviceprovisioning.partners.devices.claim",
@@ -4021,7 +4073,7 @@ func (c *PartnersDevicesClaimCall) Do(opts ...googleapi.CallOption) (*ClaimDevic
// ],
// "parameters": {
// "partnerId": {
- // "description": "ID of the partner.",
+ // "description": "Required. The ID of the reseller partner.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
@@ -4051,7 +4103,11 @@ type PartnersDevicesClaimAsyncCall struct {
header_ http.Header
}
-// ClaimAsync: Claim devices asynchronously.
+// ClaimAsync: 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).
func (r *PartnersDevicesService) ClaimAsync(partnerId int64, claimdevicesrequest *ClaimDevicesRequest) *PartnersDevicesClaimAsyncCall {
c := &PartnersDevicesClaimAsyncCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.partnerId = partnerId
@@ -4145,7 +4201,7 @@ func (c *PartnersDevicesClaimAsyncCall) Do(opts ...googleapi.CallOption) (*Opera
}
return ret, nil
// {
- // "description": "Claim devices asynchronously.",
+ // "description": "Claims a batch of devices for a customer asynchronously. Adds the devices\nto zero-touch enrollment. To learn more, read [Long‑running batch\noperations](/zero-touch/guides/how-it-works#operations).",
// "flatPath": "v1/partners/{partnersId}/devices:claimAsync",
// "httpMethod": "POST",
// "id": "androiddeviceprovisioning.partners.devices.claimAsync",
@@ -4154,7 +4210,7 @@ func (c *PartnersDevicesClaimAsyncCall) Do(opts ...googleapi.CallOption) (*Opera
// ],
// "parameters": {
// "partnerId": {
- // "description": "Partner ID.",
+ // "description": "Required. The ID of the reseller partner.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
@@ -4184,7 +4240,8 @@ type PartnersDevicesFindByIdentifierCall struct {
header_ http.Header
}
-// FindByIdentifier: Find devices by device identifier.
+// FindByIdentifier: Finds devices by hardware identifiers, such as
+// IMEI.
func (r *PartnersDevicesService) FindByIdentifier(partnerId int64, finddevicesbydeviceidentifierrequest *FindDevicesByDeviceIdentifierRequest) *PartnersDevicesFindByIdentifierCall {
c := &PartnersDevicesFindByIdentifierCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.partnerId = partnerId
@@ -4279,7 +4336,7 @@ func (c *PartnersDevicesFindByIdentifierCall) Do(opts ...googleapi.CallOption) (
}
return ret, nil
// {
- // "description": "Find devices by device identifier.",
+ // "description": "Finds devices by hardware identifiers, such as IMEI.",
// "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
// "httpMethod": "POST",
// "id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
@@ -4288,7 +4345,7 @@ func (c *PartnersDevicesFindByIdentifierCall) Do(opts ...googleapi.CallOption) (
// ],
// "parameters": {
// "partnerId": {
- // "description": "ID of the partner.",
+ // "description": "Required. The ID of the reseller partner.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
@@ -4339,7 +4396,13 @@ type PartnersDevicesFindByOwnerCall struct {
header_ http.Header
}
-// FindByOwner: Find devices by ownership.
+// FindByOwner: 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.
func (r *PartnersDevicesService) FindByOwner(partnerId int64, finddevicesbyownerrequest *FindDevicesByOwnerRequest) *PartnersDevicesFindByOwnerCall {
c := &PartnersDevicesFindByOwnerCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.partnerId = partnerId
@@ -4433,7 +4496,7 @@ func (c *PartnersDevicesFindByOwnerCall) Do(opts ...googleapi.CallOption) (*Find
}
return ret, nil
// {
- // "description": "Find devices by ownership.",
+ // "description": "Finds devices claimed for customers. The results only contain devices\nregistered to the reseller that's identified by the `partnerId` argument.\nThe customer's devices purchased from other resellers don't appear in the\nresults.",
// "flatPath": "v1/partners/{partnersId}/devices:findByOwner",
// "httpMethod": "POST",
// "id": "androiddeviceprovisioning.partners.devices.findByOwner",
@@ -4442,7 +4505,7 @@ func (c *PartnersDevicesFindByOwnerCall) Do(opts ...googleapi.CallOption) (*Find
// ],
// "parameters": {
// "partnerId": {
- // "description": "ID of the partner.",
+ // "description": "Required. The ID of the reseller partner.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
@@ -4493,7 +4556,7 @@ type PartnersDevicesGetCall struct {
header_ http.Header
}
-// Get: Get a device.
+// Get: Gets a device.
func (r *PartnersDevicesService) Get(name string) *PartnersDevicesGetCall {
c := &PartnersDevicesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -4594,7 +4657,7 @@ func (c *PartnersDevicesGetCall) Do(opts ...googleapi.CallOption) (*Device, erro
}
return ret, nil
// {
- // "description": "Get a device.",
+ // "description": "Gets a device.",
// "flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
// "httpMethod": "GET",
// "id": "androiddeviceprovisioning.partners.devices.get",
@@ -4603,7 +4666,7 @@ func (c *PartnersDevicesGetCall) Do(opts ...googleapi.CallOption) (*Device, erro
// ],
// "parameters": {
// "name": {
- // "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
+ // "description": "Required. The device API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
// "location": "path",
// "pattern": "^partners/[^/]+/devices/[^/]+$",
// "required": true,
@@ -4630,7 +4693,7 @@ type PartnersDevicesMetadataCall struct {
header_ http.Header
}
-// Metadata: Update the metadata.
+// Metadata: Updates reseller metadata associated with the device.
func (r *PartnersDevicesService) Metadata(metadataOwnerId int64, deviceId int64, updatedevicemetadatarequest *UpdateDeviceMetadataRequest) *PartnersDevicesMetadataCall {
c := &PartnersDevicesMetadataCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.metadataOwnerId = metadataOwnerId
@@ -4726,7 +4789,7 @@ func (c *PartnersDevicesMetadataCall) Do(opts ...googleapi.CallOption) (*DeviceM
}
return ret, nil
// {
- // "description": "Update the metadata.",
+ // "description": "Updates reseller metadata associated with the device.",
// "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
// "httpMethod": "POST",
// "id": "androiddeviceprovisioning.partners.devices.metadata",
@@ -4736,7 +4799,7 @@ func (c *PartnersDevicesMetadataCall) Do(opts ...googleapi.CallOption) (*DeviceM
// ],
// "parameters": {
// "deviceId": {
- // "description": "ID of the partner.",
+ // "description": "Required. The ID of the reseller partner.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
@@ -4744,7 +4807,7 @@ func (c *PartnersDevicesMetadataCall) Do(opts ...googleapi.CallOption) (*DeviceM
// "type": "string"
// },
// "metadataOwnerId": {
- // "description": "The owner of the newly set metadata. Set this to the partner ID.",
+ // "description": "Required. The owner of the newly set metadata. Set this to the partner ID.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
@@ -4774,8 +4837,9 @@ type PartnersDevicesUnclaimCall struct {
header_ http.Header
}
-// Unclaim: Unclaim the device identified by the `device_id` or the
-// `deviceIdentifier`.
+// Unclaim: Unclaims a device from a customer and removes it from
+// zero-touch
+// enrollment.
func (r *PartnersDevicesService) Unclaim(partnerId int64, unclaimdevicerequest *UnclaimDeviceRequest) *PartnersDevicesUnclaimCall {
c := &PartnersDevicesUnclaimCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.partnerId = partnerId
@@ -4869,7 +4933,7 @@ func (c *PartnersDevicesUnclaimCall) Do(opts ...googleapi.CallOption) (*Empty, e
}
return ret, nil
// {
- // "description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`.",
+ // "description": "Unclaims a device from a customer and removes it from zero-touch\nenrollment.",
// "flatPath": "v1/partners/{partnersId}/devices:unclaim",
// "httpMethod": "POST",
// "id": "androiddeviceprovisioning.partners.devices.unclaim",
@@ -4878,7 +4942,7 @@ func (c *PartnersDevicesUnclaimCall) Do(opts ...googleapi.CallOption) (*Empty, e
// ],
// "parameters": {
// "partnerId": {
- // "description": "ID of the partner.",
+ // "description": "Required. The ID of the reseller partner.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
@@ -4908,7 +4972,12 @@ type PartnersDevicesUnclaimAsyncCall struct {
header_ http.Header
}
-// UnclaimAsync: Unclaim devices asynchronously.
+// UnclaimAsync: 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).
func (r *PartnersDevicesService) UnclaimAsync(partnerId int64, unclaimdevicesrequest *UnclaimDevicesRequest) *PartnersDevicesUnclaimAsyncCall {
c := &PartnersDevicesUnclaimAsyncCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.partnerId = partnerId
@@ -5002,7 +5071,7 @@ func (c *PartnersDevicesUnclaimAsyncCall) Do(opts ...googleapi.CallOption) (*Ope
}
return ret, nil
// {
- // "description": "Unclaim devices asynchronously.",
+ // "description": "Unclaims a batch of devices for a customer asynchronously. Removes the\ndevices from zero-touch enrollment. To learn more, read [Long‑running batch\noperations](/zero-touch/guides/how-it-works#operations).",
// "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync",
// "httpMethod": "POST",
// "id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
@@ -5011,7 +5080,7 @@ func (c *PartnersDevicesUnclaimAsyncCall) Do(opts ...googleapi.CallOption) (*Ope
// ],
// "parameters": {
// "partnerId": {
- // "description": "Partner ID.",
+ // "description": "Required. The reseller partner ID.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
@@ -5041,7 +5110,13 @@ type PartnersDevicesUpdateMetadataAsyncCall struct {
header_ http.Header
}
-// UpdateMetadataAsync: Set metadata in batch asynchronously.
+// UpdateMetadataAsync: 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).
func (r *PartnersDevicesService) UpdateMetadataAsync(partnerId int64, updatedevicemetadatainbatchrequest *UpdateDeviceMetadataInBatchRequest) *PartnersDevicesUpdateMetadataAsyncCall {
c := &PartnersDevicesUpdateMetadataAsyncCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.partnerId = partnerId
@@ -5135,7 +5210,7 @@ func (c *PartnersDevicesUpdateMetadataAsyncCall) Do(opts ...googleapi.CallOption
}
return ret, nil
// {
- // "description": "Set metadata in batch asynchronously.",
+ // "description": "Updates the reseller metadata attached to a batch of devices. This method\nupdates devices asynchronously and returns an `Operation` that can be used\nto track progress. Read [Long‑running batch\noperations](/zero-touch/guides/how-it-works#operations).",
// "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
// "httpMethod": "POST",
// "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync",
@@ -5144,7 +5219,7 @@ func (c *PartnersDevicesUpdateMetadataAsyncCall) Do(opts ...googleapi.CallOption
// ],
// "parameters": {
// "partnerId": {
- // "description": "Partner ID.",
+ // "description": "Required. The reseller partner ID.",
// "format": "int64",
// "location": "path",
// "pattern": "^[^/]+$",
diff --git a/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-api.json b/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-api.json
index 9c35a2c0f..0a26af61e 100644
--- a/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-api.json
+++ b/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-api.json
@@ -1,4407 +1,4437 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/fAl5BHlYqwU8XIUMb6QGOitbCcM\"",
- "discoveryVersion": "v1",
- "id": "androidenterprise:v1",
- "name": "androidenterprise",
- "canonicalName": "Android Enterprise",
- "version": "v1",
- "revision": "20180111",
- "title": "Google Play EMM API",
- "description": "Manages the deployment of apps to Android for Work users.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android/work/play/emm-api",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/androidenterprise/v1/",
- "basePath": "/androidenterprise/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "androidenterprise/v1/",
- "batchPath": "batch/androidenterprise/v1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/androidenterprise": {
- "description": "Manage corporate Android devices"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/androidenterprise": {
+ "description": "Manage corporate Android devices"
+ }
+ }
}
- }
- }
- },
- "schemas": {
- "Administrator": {
- "id": "Administrator",
- "type": "object",
- "description": "This represents an enterprise admin who can manage the enterprise in the managed Google Play store.",
- "properties": {
- "email": {
- "type": "string",
- "description": "The admin's email address."
- }
- }
},
- "AdministratorWebToken": {
- "id": "AdministratorWebToken",
- "type": "object",
- "description": "A token authorizing an admin to access an iframe.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#administratorWebToken\".",
- "default": "androidenterprise#administratorWebToken"
- },
- "token": {
- "type": "string",
- "description": "An opaque token to be passed to the Play front-end to generate an iframe."
- }
- }
+ "basePath": "/androidenterprise/v1/",
+ "baseUrl": "https://www.googleapis.com/androidenterprise/v1/",
+ "batchPath": "batch/androidenterprise/v1",
+ "canonicalName": "Android Enterprise",
+ "description": "Manages the deployment of apps to Android for Work users.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/android/work/play/emm-api",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/LiPjx_lgD_TPXh9gKbSg82lZeFI\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/android-16.png",
+ "x32": "https://www.google.com/images/icons/product/android-32.png"
},
- "AdministratorWebTokenSpec": {
- "id": "AdministratorWebTokenSpec",
- "type": "object",
- "description": "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.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#administratorWebTokenSpec\".",
- "default": "androidenterprise#administratorWebTokenSpec"
- },
- "parent": {
- "type": "string",
- "description": "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."
- },
- "permission": {
- "type": "array",
- "description": "The list of permissions the admin is granted within the iframe. The admin will only be allowed to view an iframe if they have all of the permissions associated with it. The only valid value is \"approveApps\" that will allow the admin to access the iframe in \"approve\" mode.",
- "items": {
+ "id": "androidenterprise:v1",
+ "kind": "discovery#restDescription",
+ "name": "androidenterprise",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
- }
- }
- },
- "AndroidDevicePolicyConfig": {
- "id": "AndroidDevicePolicyConfig",
- "type": "object",
- "description": "The Android Device Policy configuration of an enterprise.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#androidDevicePolicyConfig\".",
- "default": "androidenterprise#androidDevicePolicyConfig"
},
- "state": {
- "type": "string",
- "description": "The state of Android Device Policy. \"enabled\" indicates that Android Device Policy is enabled for the enterprise and the EMM is allowed to manage devices with Android Device Policy, while \"disabled\" means that it cannot."
- }
- }
- },
- "AppRestrictionsSchema": {
- "id": "AppRestrictionsSchema",
- "type": "object",
- "description": "Represents the list of app restrictions available to be pre-configured for the product.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#appRestrictionsSchema\".",
- "default": "androidenterprise#appRestrictionsSchema"
- },
- "restrictions": {
- "type": "array",
- "description": "The set of restrictions that make up this schema.",
- "items": {
- "$ref": "AppRestrictionsSchemaRestriction"
- }
- }
- }
- },
- "AppRestrictionsSchemaChangeEvent": {
- "id": "AppRestrictionsSchemaChangeEvent",
- "type": "object",
- "description": "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.",
- "properties": {
- "productId": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "AppRestrictionsSchemaRestriction": {
- "id": "AppRestrictionsSchemaRestriction",
- "type": "object",
- "description": "A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.",
- "properties": {
- "defaultValue": {
- "$ref": "AppRestrictionsSchemaRestrictionRestrictionValue",
- "description": "The default value of the restriction. bundle and bundleArray restrictions never have a default value."
- },
- "description": {
- "type": "string",
- "description": "A longer description of the restriction, giving more detail of what it affects."
- },
- "entry": {
- "type": "array",
- "description": "For choice or multiselect restrictions, the list of possible entries' human-readable names.",
- "items": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
- },
- "entryValue": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
},
"key": {
- "type": "string",
- "description": "The unique key that the product uses to identify the restriction, e.g. \"com.google.android.gm.fieldname\"."
- },
- "nestedRestriction": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "AppRestrictionsSchemaRestriction"
- }
- },
- "restrictionType": {
- "type": "string",
- "description": "The type of the restriction."
- },
- "title": {
- "type": "string",
- "description": "The name of the restriction."
- }
- }
- },
- "AppRestrictionsSchemaRestrictionRestrictionValue": {
- "id": "AppRestrictionsSchemaRestrictionRestrictionValue",
- "type": "object",
- "description": "A typed value for the restriction.",
- "properties": {
- "type": {
- "type": "string",
- "description": "The type of the value being provided."
- },
- "valueBool": {
- "type": "boolean",
- "description": "The boolean value - this will only be present if type is bool."
- },
- "valueInteger": {
- "type": "integer",
- "description": "The integer value - this will only be present if type is integer.",
- "format": "int32"
- },
- "valueMultiselect": {
- "type": "array",
- "description": "The list of string values - this will only be present if type is multiselect.",
- "items": {
+ "description": "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.",
+ "location": "query",
"type": "string"
- }
},
- "valueString": {
- "type": "string",
- "description": "The string value - this will be present for types string, choice and hidden."
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "AppUpdateEvent": {
- "id": "AppUpdateEvent",
- "type": "object",
- "description": "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.",
- "properties": {
- "productId": {
- "type": "string",
- "description": "The id of the product (e.g. \"app:com.google.android.gm\") that was updated. This field will always be present."
- }
- }
- },
- "AppVersion": {
- "id": "AppVersion",
- "type": "object",
- "description": "This represents a single version of the app.",
- "properties": {
- "track": {
- "type": "string",
- "description": "The track that this app was published in. For example if track is \"alpha\", this is an alpha version of the app."
+ "protocol": "rest",
+ "resources": {
+ "devices": {
+ "methods": {
+ "get": {
+ "description": "Retrieves the details of a device.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.devices.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "getState": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.devices.getState",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
+ "response": {
+ "$ref": "DeviceState"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the IDs of all of a user's devices.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.devices.list",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices",
+ "response": {
+ "$ref": "DevicesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "patch": {
+ "description": "Updates the device policy. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidenterprise.devices.patch",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields to update. If not set, all modifiable fields will be modified.\n\nWhen set in a query parameter, this field should be specified as updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...",
+ "location": "query",
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
+ "request": {
+ "$ref": "Device"
+ },
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "setState": {
+ "description": "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.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.devices.setState",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
+ "request": {
+ "$ref": "DeviceState"
+ },
+ "response": {
+ "$ref": "DeviceState"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "update": {
+ "description": "Updates the device policy",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.devices.update",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields to update. If not set, all modifiable fields will be modified.\n\nWhen set in a query parameter, this field should be specified as updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...",
+ "location": "query",
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
+ "request": {
+ "$ref": "Device"
+ },
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
- "versionCode": {
- "type": "integer",
- "description": "Unique increasing identifier for the app version.",
- "format": "int32"
+ "enterprises": {
+ "methods": {
+ "acknowledgeNotificationSet": {
+ "description": "Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.acknowledgeNotificationSet",
+ "parameters": {
+ "notificationSetId": {
+ "description": "The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/acknowledgeNotificationSet",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "completeSignup": {
+ "description": "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.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.completeSignup",
+ "parameters": {
+ "completionToken": {
+ "description": "The Completion token initially returned by GenerateSignupUrl.",
+ "location": "query",
+ "type": "string"
+ },
+ "enterpriseToken": {
+ "description": "The Enterprise token appended to the Callback URL.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/completeSignup",
+ "response": {
+ "$ref": "Enterprise"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "createWebToken": {
+ "description": "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.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.createWebToken",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/createWebToken",
+ "request": {
+ "$ref": "AdministratorWebTokenSpec"
+ },
+ "response": {
+ "$ref": "AdministratorWebToken"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the binding between the EMM and enterprise. This is now deprecated. Use this method only to unenroll customers that were previously enrolled with the insert call, then enroll them again with the enroll call.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.enterprises.delete",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "enroll": {
+ "description": "Enrolls an enterprise with the calling EMM.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.enroll",
+ "parameterOrder": [
+ "token"
+ ],
+ "parameters": {
+ "token": {
+ "description": "The token provided by the enterprise to register the EMM.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/enroll",
+ "request": {
+ "$ref": "Enterprise"
+ },
+ "response": {
+ "$ref": "Enterprise"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "generateSignupUrl": {
+ "description": "Generates a sign-up URL.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.generateSignupUrl",
+ "parameters": {
+ "callbackUrl": {
+ "description": "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.\nBeware 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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/signupUrl",
+ "response": {
+ "$ref": "SignupInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the name and domain of an enterprise.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.enterprises.get",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}",
+ "response": {
+ "$ref": "Enterprise"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "getAndroidDevicePolicyConfig": {
+ "description": "Returns the Android Device Policy config resource.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.enterprises.getAndroidDevicePolicyConfig",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/androidDevicePolicyConfig",
+ "response": {
+ "$ref": "AndroidDevicePolicyConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "getServiceAccount": {
+ "description": "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.\n\nThis method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error.\n\nSubsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials.\n\nOnce the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.enterprises.getServiceAccount",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "keyType": {
+ "description": "The type of credential to return with the service account. Required.",
+ "enum": [
+ "googleCredentials",
+ "pkcs12"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/serviceAccount",
+ "response": {
+ "$ref": "ServiceAccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "getStoreLayout": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.enterprises.getStoreLayout",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout",
+ "response": {
+ "$ref": "StoreLayout"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "insert": {
+ "description": "Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.insert",
+ "parameterOrder": [
+ "token"
+ ],
+ "parameters": {
+ "token": {
+ "description": "The token provided by the enterprise to register the EMM.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises",
+ "request": {
+ "$ref": "Enterprise"
+ },
+ "response": {
+ "$ref": "Enterprise"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.enterprises.list",
+ "parameterOrder": [
+ "domain"
+ ],
+ "parameters": {
+ "domain": {
+ "description": "The exact primary domain name of the enterprise to look up.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises",
+ "response": {
+ "$ref": "EnterprisesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "pullNotificationSet": {
+ "description": "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.\nA notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty.\nNotifications 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.\nMultiple 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.\nIf no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.pullNotificationSet",
+ "parameters": {
+ "requestMode": {
+ "description": "The request mode for pulling notifications.\nSpecifying 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.\nSpeciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present.\nIf omitted, defaults to waitForNotifications.",
+ "enum": [
+ "returnImmediately",
+ "waitForNotifications"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/pullNotificationSet",
+ "response": {
+ "$ref": "NotificationSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "sendTestPushNotification": {
+ "description": "Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.sendTestPushNotification",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/sendTestPushNotification",
+ "response": {
+ "$ref": "EnterprisesSendTestPushNotificationResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "setAccount": {
+ "description": "Sets the account that will be used to authenticate to the API as the enterprise.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.enterprises.setAccount",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/account",
+ "request": {
+ "$ref": "EnterpriseAccount"
+ },
+ "response": {
+ "$ref": "EnterpriseAccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "setAndroidDevicePolicyConfig": {
+ "description": "Sets the Android Device Policy config resource. EMM may use this method to enable or disable Android Device Policy support for the specified enterprise. To learn more about managing devices and apps with Android Device Policy, see the Android Management API.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.enterprises.setAndroidDevicePolicyConfig",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/androidDevicePolicyConfig",
+ "request": {
+ "$ref": "AndroidDevicePolicyConfig"
+ },
+ "response": {
+ "$ref": "AndroidDevicePolicyConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "setStoreLayout": {
+ "description": "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.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.enterprises.setStoreLayout",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout",
+ "request": {
+ "$ref": "StoreLayout"
+ },
+ "response": {
+ "$ref": "StoreLayout"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "unenroll": {
+ "description": "Unenrolls an enterprise from the calling EMM.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.unenroll",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/unenroll",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
- "versionString": {
- "type": "string",
- "description": "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\")."
- }
- }
- },
- "ApprovalUrlInfo": {
- "id": "ApprovalUrlInfo",
- "type": "object",
- "description": "Information on an approval URL.",
- "properties": {
- "approvalUrl": {
- "type": "string",
- "description": "A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call."
+ "entitlements": {
+ "methods": {
+ "delete": {
+ "description": "Removes an entitlement to an app for a user.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.entitlements.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "entitlementId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "entitlementId": {
+ "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "get": {
+ "description": "Retrieves details of an entitlement.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.entitlements.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "entitlementId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "entitlementId": {
+ "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
+ "response": {
+ "$ref": "Entitlement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Lists all entitlements for the specified user. Only the ID is set.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.entitlements.list",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/entitlements",
+ "response": {
+ "$ref": "EntitlementsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "patch": {
+ "description": "Adds or updates an entitlement to an app for a user. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidenterprise.entitlements.patch",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "entitlementId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "entitlementId": {
+ "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "install": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
+ "request": {
+ "$ref": "Entitlement"
+ },
+ "response": {
+ "$ref": "Entitlement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "update": {
+ "description": "Adds or updates an entitlement to an app for a user.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.entitlements.update",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "entitlementId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "entitlementId": {
+ "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "install": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
+ "request": {
+ "$ref": "Entitlement"
+ },
+ "response": {
+ "$ref": "Entitlement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#approvalUrlInfo\".",
- "default": "androidenterprise#approvalUrlInfo"
- }
- }
- },
- "AuthenticationToken": {
- "id": "AuthenticationToken",
- "type": "object",
- "description": "An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#authenticationToken\".",
- "default": "androidenterprise#authenticationToken"
+ "grouplicenses": {
+ "methods": {
+ "get": {
+ "description": "Retrieves details of an enterprise's group license for a product.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.grouplicenses.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "groupLicenseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "groupLicenseId": {
+ "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}",
+ "response": {
+ "$ref": "GroupLicense"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Retrieves IDs of all products for which the enterprise has a group license.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.grouplicenses.list",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/groupLicenses",
+ "response": {
+ "$ref": "GroupLicensesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
- "token": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "ConfigurationVariables": {
- "id": "ConfigurationVariables",
- "type": "object",
- "description": "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.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#configurationVariables\".",
- "default": "androidenterprise#configurationVariables"
+ "grouplicenseusers": {
+ "methods": {
+ "list": {
+ "description": "Retrieves the IDs of the users who have been granted entitlements under the license.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.grouplicenseusers.list",
+ "parameterOrder": [
+ "enterpriseId",
+ "groupLicenseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "groupLicenseId": {
+ "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users",
+ "response": {
+ "$ref": "GroupLicenseUsersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
- "mcmId": {
- "type": "string",
- "description": "The ID of the managed configurations settings."
+ "installs": {
+ "methods": {
+ "delete": {
+ "description": "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.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.installs.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId",
+ "installId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "installId": {
+ "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "get": {
+ "description": "Retrieves details of an installation of an app on a device.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.installs.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId",
+ "installId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "installId": {
+ "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
+ "response": {
+ "$ref": "Install"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the details of all apps installed on the specified device.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.installs.list",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs",
+ "response": {
+ "$ref": "InstallsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "httpMethod": "PATCH",
+ "id": "androidenterprise.installs.patch",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId",
+ "installId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "installId": {
+ "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
+ "request": {
+ "$ref": "Install"
+ },
+ "response": {
+ "$ref": "Install"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "update": {
+ "description": "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.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.installs.update",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId",
+ "installId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "installId": {
+ "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
+ "request": {
+ "$ref": "Install"
+ },
+ "response": {
+ "$ref": "Install"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
- "variableSet": {
- "type": "array",
- "description": "The variable set that is attributed to the user.",
- "items": {
- "$ref": "VariableSet"
- }
- }
- }
- },
- "Device": {
- "id": "Device",
- "type": "object",
- "description": "A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.",
- "properties": {
- "androidId": {
- "type": "string",
- "description": "The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, \"123456789abcdef0\"."
+ "managedconfigurationsfordevice": {
+ "methods": {
+ "delete": {
+ "description": "Removes a per-device managed configuration for an app for the specified device.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.managedconfigurationsfordevice.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId",
+ "managedConfigurationForDeviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "managedConfigurationForDeviceId": {
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "get": {
+ "description": "Retrieves details of a per-device managed configuration.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.managedconfigurationsfordevice.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId",
+ "managedConfigurationForDeviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "managedConfigurationForDeviceId": {
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
+ "response": {
+ "$ref": "ManagedConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Lists all the per-device managed configurations for the specified device. Only the ID is set.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.managedconfigurationsfordevice.list",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice",
+ "response": {
+ "$ref": "ManagedConfigurationsForDeviceListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "patch": {
+ "description": "Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidenterprise.managedconfigurationsfordevice.patch",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId",
+ "managedConfigurationForDeviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "managedConfigurationForDeviceId": {
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
+ "request": {
+ "$ref": "ManagedConfiguration"
+ },
+ "response": {
+ "$ref": "ManagedConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "update": {
+ "description": "Adds or updates a per-device managed configuration for an app for the specified device.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.managedconfigurationsfordevice.update",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "deviceId",
+ "managedConfigurationForDeviceId"
+ ],
+ "parameters": {
+ "deviceId": {
+ "description": "The Android ID of the device.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "managedConfigurationForDeviceId": {
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
+ "request": {
+ "$ref": "ManagedConfiguration"
+ },
+ "response": {
+ "$ref": "ManagedConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#device\".",
- "default": "androidenterprise#device"
+ "managedconfigurationsforuser": {
+ "methods": {
+ "delete": {
+ "description": "Removes a per-user managed configuration for an app for the specified user.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.managedconfigurationsforuser.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "managedConfigurationForUserId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "managedConfigurationForUserId": {
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "get": {
+ "description": "Retrieves details of a per-user managed configuration for an app for the specified user.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.managedconfigurationsforuser.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "managedConfigurationForUserId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "managedConfigurationForUserId": {
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
+ "response": {
+ "$ref": "ManagedConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Lists all the per-user managed configurations for the specified user. Only the ID is set.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.managedconfigurationsforuser.list",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser",
+ "response": {
+ "$ref": "ManagedConfigurationsForUserListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "httpMethod": "PATCH",
+ "id": "androidenterprise.managedconfigurationsforuser.patch",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "managedConfigurationForUserId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "managedConfigurationForUserId": {
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
+ "request": {
+ "$ref": "ManagedConfiguration"
+ },
+ "response": {
+ "$ref": "ManagedConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "update": {
+ "description": "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.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.managedconfigurationsforuser.update",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId",
+ "managedConfigurationForUserId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "managedConfigurationForUserId": {
+ "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
+ "request": {
+ "$ref": "ManagedConfiguration"
+ },
+ "response": {
+ "$ref": "ManagedConfiguration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
- "managementType": {
- "type": "string",
- "description": "Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations.\n\nPossible values include: \n- \"managedDevice\", a device that has the EMM's device policy controller (DPC) as the device owner. \n- \"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. \n- \"containerApp\", no longer used (deprecated). \n- \"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."
- },
- "policy": {
- "$ref": "Policy",
- "description": "The policy enforced on the device."
- }
- }
- },
- "DeviceState": {
- "id": "DeviceState",
- "type": "object",
- "description": "The state of a user's device, as accessed by the getState and setState methods on device resources.",
- "properties": {
- "accountState": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#deviceState\".",
- "default": "androidenterprise#deviceState"
- }
- }
- },
- "DevicesListResponse": {
- "id": "DevicesListResponse",
- "type": "object",
- "description": "The device resources for the user.",
- "properties": {
- "device": {
- "type": "array",
- "description": "A managed device.",
- "items": {
- "$ref": "Device"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#devicesListResponse\".",
- "default": "androidenterprise#devicesListResponse"
- }
- }
- },
- "Enterprise": {
- "id": "Enterprise",
- "type": "object",
- "description": "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: \n- 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. \n- 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.",
- "properties": {
- "administrator": {
- "type": "array",
- "description": "Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.",
- "items": {
- "$ref": "Administrator"
- }
- },
- "id": {
- "type": "string",
- "description": "The unique ID for the enterprise."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterprise\".",
- "default": "androidenterprise#enterprise"
- },
- "name": {
- "type": "string",
- "description": "The name of the enterprise, for example, \"Example, Inc\"."
- },
- "primaryDomain": {
- "type": "string",
- "description": "The enterprise's primary domain, such as \"example.com\".",
- "annotations": {
- "required": [
- "androidenterprise.enterprises.insert"
- ]
- }
- }
- }
- },
- "EnterpriseAccount": {
- "id": "EnterpriseAccount",
- "type": "object",
- "description": "A service account that can be used to authenticate as the enterprise to API calls that require such authentication.",
- "properties": {
- "accountEmail": {
- "type": "string",
- "description": "The email address of the service account."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterpriseAccount\".",
- "default": "androidenterprise#enterpriseAccount"
- }
- }
- },
- "EnterprisesListResponse": {
- "id": "EnterprisesListResponse",
- "type": "object",
- "description": "The matching enterprise resources.",
- "properties": {
- "enterprise": {
- "type": "array",
- "description": "An enterprise.",
- "items": {
- "$ref": "Enterprise"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterprisesListResponse\".",
- "default": "androidenterprise#enterprisesListResponse"
- }
- }
- },
- "EnterprisesSendTestPushNotificationResponse": {
- "id": "EnterprisesSendTestPushNotificationResponse",
- "type": "object",
- "properties": {
- "messageId": {
- "type": "string",
- "description": "The message ID of the test push notification that was sent."
- },
- "topicName": {
- "type": "string",
- "description": "The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent."
- }
- }
- },
- "Entitlement": {
- "id": "Entitlement",
- "type": "object",
- "description": "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.\n\nThe 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.\n\nIf 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.\n\nIf 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.\n\nEntitlements 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.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#entitlement\".",
- "default": "androidenterprise#entitlement"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product that the entitlement is for. For example, \"app:com.google.android.gm\"."
- },
- "reason": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "EntitlementsListResponse": {
- "id": "EntitlementsListResponse",
- "type": "object",
- "description": "The entitlement resources for the user.",
- "properties": {
- "entitlement": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "Entitlement"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#entitlementsListResponse\".",
- "default": "androidenterprise#entitlementsListResponse"
- }
- }
- },
- "GroupLicense": {
- "id": "GroupLicense",
- "type": "object",
- "description": "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.\n\nUse 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.\n\nOnly 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.",
- "properties": {
- "acquisitionKind": {
- "type": "string",
- "description": "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)."
- },
- "approval": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicense\".",
- "default": "androidenterprise#groupLicense"
- },
- "numProvisioned": {
- "type": "integer",
- "description": "The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.",
- "format": "int32"
- },
- "numPurchased": {
- "type": "integer",
- "description": "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\").",
- "format": "int32"
+ "managedconfigurationssettings": {
+ "methods": {
+ "list": {
+ "description": "Lists all the managed configurations settings for the specified app. Only the ID and the name is set.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.managedconfigurationssettings.list",
+ "parameterOrder": [
+ "enterpriseId",
+ "productId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product for which the managed configurations settings applies to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettings",
+ "response": {
+ "$ref": "ManagedConfigurationsSettingsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
"permissions": {
- "type": "string",
- "description": "The permission approval status of the product. This field is only set if the product is approved. Possible states are: \n- \"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.), \n- \"needsReapproval\", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved, \n- \"allCurrentAndFutureApproved\", the current permissions are approved and any future permission updates will be automatically approved without administrator review."
+ "methods": {
+ "get": {
+ "description": "Retrieves details of an Android app permission for display to an enterprise admin.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.permissions.get",
+ "parameterOrder": [
+ "permissionId"
+ ],
+ "parameters": {
+ "language": {
+ "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\")",
+ "location": "query",
+ "type": "string"
+ },
+ "permissionId": {
+ "description": "The ID of the permission.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "permissions/{permissionId}",
+ "response": {
+ "$ref": "Permission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
},
- "productId": {
- "type": "string",
- "description": "The ID of the product that the license is for. For example, \"app:com.google.android.gm\"."
+ "products": {
+ "methods": {
+ "approve": {
+ "description": "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.\n\nTo 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.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.products.approve",
+ "parameterOrder": [
+ "enterpriseId",
+ "productId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/products/{productId}/approve",
+ "request": {
+ "$ref": "ProductsApproveRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "generateApprovalUrl": {
+ "description": "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.\n\nAdmins 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.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.products.generateApprovalUrl",
+ "parameterOrder": [
+ "enterpriseId",
+ "productId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance \"en-US\".",
+ "location": "query",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl",
+ "response": {
+ "$ref": "ProductsGenerateApprovalUrlResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "get": {
+ "description": "Retrieves details of a product for display to an enterprise admin.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.products.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "productId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\").",
+ "location": "query",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product, e.g. \"app:com.google.android.gm\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/products/{productId}",
+ "response": {
+ "$ref": "Product"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "getAppRestrictionsSchema": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.products.getAppRestrictionsSchema",
+ "parameterOrder": [
+ "enterpriseId",
+ "productId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\").",
+ "location": "query",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema",
+ "response": {
+ "$ref": "AppRestrictionsSchema"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "getPermissions": {
+ "description": "Retrieves the Android app permissions required by this app.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.products.getPermissions",
+ "parameterOrder": [
+ "enterpriseId",
+ "productId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/products/{productId}/permissions",
+ "response": {
+ "$ref": "ProductPermissions"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Finds approved products that match a query, or all approved products if there is no query.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.products.list",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "approved": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "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.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "query": {
+ "description": "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "token": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/products",
+ "response": {
+ "$ref": "ProductsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "unapprove": {
+ "description": "Unapproves the specified product (and the relevant app permissions, if any)",
+ "httpMethod": "POST",
+ "id": "androidenterprise.products.unapprove",
+ "parameterOrder": [
+ "enterpriseId",
+ "productId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/products/{productId}/unapprove",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
+ },
+ "serviceaccountkeys": {
+ "methods": {
+ "delete": {
+ "description": "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.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.serviceaccountkeys.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "keyId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "keyId": {
+ "description": "The ID of the key.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/serviceAccountKeys/{keyId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "insert": {
+ "description": "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.\n\nOnly the type of the key should be populated in the resource to be inserted.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.serviceaccountkeys.insert",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/serviceAccountKeys",
+ "request": {
+ "$ref": "ServiceAccountKey"
+ },
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.serviceaccountkeys.list",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/serviceAccountKeys",
+ "response": {
+ "$ref": "ServiceAccountKeysListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
+ },
+ "storelayoutclusters": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a cluster.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.storelayoutclusters.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId",
+ "clusterId"
+ ],
+ "parameters": {
+ "clusterId": {
+ "description": "The ID of the cluster.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "get": {
+ "description": "Retrieves details of a cluster.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.storelayoutclusters.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId",
+ "clusterId"
+ ],
+ "parameters": {
+ "clusterId": {
+ "description": "The ID of the cluster.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
+ "response": {
+ "$ref": "StoreCluster"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new cluster in a page.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.storelayoutclusters.insert",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters",
+ "request": {
+ "$ref": "StoreCluster"
+ },
+ "response": {
+ "$ref": "StoreCluster"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the details of all clusters on the specified page.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.storelayoutclusters.list",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters",
+ "response": {
+ "$ref": "StoreLayoutClustersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "patch": {
+ "description": "Updates a cluster. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidenterprise.storelayoutclusters.patch",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId",
+ "clusterId"
+ ],
+ "parameters": {
+ "clusterId": {
+ "description": "The ID of the cluster.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
+ "request": {
+ "$ref": "StoreCluster"
+ },
+ "response": {
+ "$ref": "StoreCluster"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "update": {
+ "description": "Updates a cluster.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.storelayoutclusters.update",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId",
+ "clusterId"
+ ],
+ "parameters": {
+ "clusterId": {
+ "description": "The ID of the cluster.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
+ "request": {
+ "$ref": "StoreCluster"
+ },
+ "response": {
+ "$ref": "StoreCluster"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
+ },
+ "storelayoutpages": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a store page.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.storelayoutpages.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "get": {
+ "description": "Retrieves details of a store page.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.storelayoutpages.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
+ "response": {
+ "$ref": "StorePage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new store page.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.storelayoutpages.insert",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages",
+ "request": {
+ "$ref": "StorePage"
+ },
+ "response": {
+ "$ref": "StorePage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the details of all pages in the store.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.storelayoutpages.list",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages",
+ "response": {
+ "$ref": "StoreLayoutPagesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "patch": {
+ "description": "Updates the content of a store page. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidenterprise.storelayoutpages.patch",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
+ "request": {
+ "$ref": "StorePage"
+ },
+ "response": {
+ "$ref": "StorePage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "update": {
+ "description": "Updates the content of a store page.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.storelayoutpages.update",
+ "parameterOrder": [
+ "enterpriseId",
+ "pageId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
+ "request": {
+ "$ref": "StorePage"
+ },
+ "response": {
+ "$ref": "StorePage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
+ },
+ "users": {
+ "methods": {
+ "delete": {
+ "description": "Deleted an EMM-managed user.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.users.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "generateAuthenticationToken": {
+ "description": "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.\n\nThis call only works with EMM-managed accounts.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.users.generateAuthenticationToken",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/authenticationToken",
+ "response": {
+ "$ref": "AuthenticationToken"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "generateToken": {
+ "description": "Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.\n\nThis call only works with Google managed accounts.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.users.generateToken",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/token",
+ "response": {
+ "$ref": "UserToken"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a user's details.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.users.get",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}",
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "getAvailableProductSet": {
+ "description": "Retrieves the set of products a user is entitled to access.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.users.getAvailableProductSet",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
+ "response": {
+ "$ref": "ProductSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "insert": {
+ "description": "Creates a new EMM-managed user.\n\nThe Users resource passed in the body of the request should include an accountIdentifier and an accountType.\nIf 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.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.users.insert",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users",
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.users.list",
+ "parameterOrder": [
+ "enterpriseId",
+ "email"
+ ],
+ "parameters": {
+ "email": {
+ "description": "The exact primary email address of the user to look up.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users",
+ "response": {
+ "$ref": "UsersListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "patch": {
+ "description": "Updates the details of an EMM-managed user.\n\nCan 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.",
+ "httpMethod": "PATCH",
+ "id": "androidenterprise.users.patch",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}",
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "revokeDeviceAccess": {
+ "description": "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.\n\nThis call only works with EMM-managed accounts.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.users.revokeDeviceAccess",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/deviceAccess",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "revokeToken": {
+ "description": "Revokes a previously generated token (activation code) for the user.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.users.revokeToken",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/token",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "setAvailableProductSet": {
+ "description": "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.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.users.setAvailableProductSet",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
+ "request": {
+ "$ref": "ProductSet"
+ },
+ "response": {
+ "$ref": "ProductSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "update": {
+ "description": "Updates the details of an EMM-managed user.\n\nCan 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.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.users.update",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}",
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
}
- }
},
- "GroupLicenseUsersListResponse": {
- "id": "GroupLicenseUsersListResponse",
- "type": "object",
- "description": "The user resources for the group license.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicenseUsersListResponse\".",
- "default": "androidenterprise#groupLicenseUsersListResponse"
+ "revision": "20180322",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Administrator": {
+ "description": "This represents an enterprise admin who can manage the enterprise in the managed Google Play store.",
+ "id": "Administrator",
+ "properties": {
+ "email": {
+ "description": "The admin's email address.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "user": {
- "type": "array",
- "description": "A user of an enterprise.",
- "items": {
- "$ref": "User"
- }
+ "AdministratorWebToken": {
+ "description": "A token authorizing an admin to access an iframe.",
+ "id": "AdministratorWebToken",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#administratorWebToken",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#administratorWebToken\".",
+ "type": "string"
+ },
+ "token": {
+ "description": "An opaque token to be passed to the Play front-end to generate an iframe.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdministratorWebTokenSpec": {
+ "description": "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.",
+ "id": "AdministratorWebTokenSpec",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#administratorWebTokenSpec",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#administratorWebTokenSpec\".",
+ "type": "string"
+ },
+ "parent": {
+ "description": "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.",
+ "type": "string"
+ },
+ "permission": {
+ "description": "The list of permissions the admin is granted within the iframe. The admin will only be allowed to view an iframe if they have all of the permissions associated with it. The only valid value is \"approveApps\" that will allow the admin to access the iframe in \"approve\" mode.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AndroidDevicePolicyConfig": {
+ "description": "The Android Device Policy configuration of an enterprise.",
+ "id": "AndroidDevicePolicyConfig",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#androidDevicePolicyConfig",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#androidDevicePolicyConfig\".",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state of Android Device Policy. \"enabled\" indicates that Android Device Policy is enabled for the enterprise and the EMM is allowed to manage devices with Android Device Policy, while \"disabled\" means that it cannot.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AppRestrictionsSchema": {
+ "description": "Represents the list of app restrictions available to be pre-configured for the product.",
+ "id": "AppRestrictionsSchema",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#appRestrictionsSchema",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#appRestrictionsSchema\".",
+ "type": "string"
+ },
+ "restrictions": {
+ "description": "The set of restrictions that make up this schema.",
+ "items": {
+ "$ref": "AppRestrictionsSchemaRestriction"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AppRestrictionsSchemaChangeEvent": {
+ "description": "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.",
+ "id": "AppRestrictionsSchemaChangeEvent",
+ "properties": {
+ "productId": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AppRestrictionsSchemaRestriction": {
+ "description": "A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.",
+ "id": "AppRestrictionsSchemaRestriction",
+ "properties": {
+ "defaultValue": {
+ "$ref": "AppRestrictionsSchemaRestrictionRestrictionValue",
+ "description": "The default value of the restriction. bundle and bundleArray restrictions never have a default value."
+ },
+ "description": {
+ "description": "A longer description of the restriction, giving more detail of what it affects.",
+ "type": "string"
+ },
+ "entry": {
+ "description": "For choice or multiselect restrictions, the list of possible entries' human-readable names.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "entryValue": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "key": {
+ "description": "The unique key that the product uses to identify the restriction, e.g. \"com.google.android.gm.fieldname\".",
+ "type": "string"
+ },
+ "nestedRestriction": {
+ "description": "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.",
+ "items": {
+ "$ref": "AppRestrictionsSchemaRestriction"
+ },
+ "type": "array"
+ },
+ "restrictionType": {
+ "description": "The type of the restriction.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The name of the restriction.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AppRestrictionsSchemaRestrictionRestrictionValue": {
+ "description": "A typed value for the restriction.",
+ "id": "AppRestrictionsSchemaRestrictionRestrictionValue",
+ "properties": {
+ "type": {
+ "description": "The type of the value being provided.",
+ "type": "string"
+ },
+ "valueBool": {
+ "description": "The boolean value - this will only be present if type is bool.",
+ "type": "boolean"
+ },
+ "valueInteger": {
+ "description": "The integer value - this will only be present if type is integer.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "valueMultiselect": {
+ "description": "The list of string values - this will only be present if type is multiselect.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "valueString": {
+ "description": "The string value - this will be present for types string, choice and hidden.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AppUpdateEvent": {
+ "description": "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.",
+ "id": "AppUpdateEvent",
+ "properties": {
+ "productId": {
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") that was updated. This field will always be present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AppVersion": {
+ "description": "This represents a single version of the app.",
+ "id": "AppVersion",
+ "properties": {
+ "track": {
+ "description": "The track that this app was published in. For example if track is \"alpha\", this is an alpha version of the app.",
+ "type": "string"
+ },
+ "versionCode": {
+ "description": "Unique increasing identifier for the app version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "versionString": {
+ "description": "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\").",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ApprovalUrlInfo": {
+ "description": "Information on an approval URL.",
+ "id": "ApprovalUrlInfo",
+ "properties": {
+ "approvalUrl": {
+ "description": "A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#approvalUrlInfo",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#approvalUrlInfo\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthenticationToken": {
+ "description": "An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.",
+ "id": "AuthenticationToken",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#authenticationToken",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#authenticationToken\".",
+ "type": "string"
+ },
+ "token": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConfigurationVariables": {
+ "description": "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.",
+ "id": "ConfigurationVariables",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#configurationVariables",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#configurationVariables\".",
+ "type": "string"
+ },
+ "mcmId": {
+ "description": "The ID of the managed configurations settings.",
+ "type": "string"
+ },
+ "variableSet": {
+ "description": "The variable set that is attributed to the user.",
+ "items": {
+ "$ref": "VariableSet"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Device": {
+ "description": "A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.",
+ "id": "Device",
+ "properties": {
+ "androidId": {
+ "description": "The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, \"123456789abcdef0\".",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#device",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#device\".",
+ "type": "string"
+ },
+ "managementType": {
+ "description": "Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations.\n\nPossible values include: \n- \"managedDevice\", a device that has the EMM's device policy controller (DPC) as the device owner. \n- \"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. \n- \"containerApp\", no longer used (deprecated). \n- \"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.",
+ "type": "string"
+ },
+ "policy": {
+ "$ref": "Policy",
+ "description": "The policy enforced on the device."
+ }
+ },
+ "type": "object"
+ },
+ "DeviceState": {
+ "description": "The state of a user's device, as accessed by the getState and setState methods on device resources.",
+ "id": "DeviceState",
+ "properties": {
+ "accountState": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#deviceState",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#deviceState\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DevicesListResponse": {
+ "description": "The device resources for the user.",
+ "id": "DevicesListResponse",
+ "properties": {
+ "device": {
+ "description": "A managed device.",
+ "items": {
+ "$ref": "Device"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "androidenterprise#devicesListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#devicesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Enterprise": {
+ "description": "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: \n- 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. \n- 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.",
+ "id": "Enterprise",
+ "properties": {
+ "administrator": {
+ "description": "Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.",
+ "items": {
+ "$ref": "Administrator"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "The unique ID for the enterprise.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#enterprise",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterprise\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the enterprise, for example, \"Example, Inc\".",
+ "type": "string"
+ },
+ "primaryDomain": {
+ "annotations": {
+ "required": [
+ "androidenterprise.enterprises.insert"
+ ]
+ },
+ "description": "The enterprise's primary domain, such as \"example.com\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EnterpriseAccount": {
+ "description": "A service account that can be used to authenticate as the enterprise to API calls that require such authentication.",
+ "id": "EnterpriseAccount",
+ "properties": {
+ "accountEmail": {
+ "description": "The email address of the service account.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#enterpriseAccount",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterpriseAccount\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EnterprisesListResponse": {
+ "description": "The matching enterprise resources.",
+ "id": "EnterprisesListResponse",
+ "properties": {
+ "enterprise": {
+ "description": "An enterprise.",
+ "items": {
+ "$ref": "Enterprise"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "androidenterprise#enterprisesListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterprisesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EnterprisesSendTestPushNotificationResponse": {
+ "id": "EnterprisesSendTestPushNotificationResponse",
+ "properties": {
+ "messageId": {
+ "description": "The message ID of the test push notification that was sent.",
+ "type": "string"
+ },
+ "topicName": {
+ "description": "The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Entitlement": {
+ "description": "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.\n\nThe 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.\n\nIf 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.\n\nIf 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.\n\nEntitlements 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.",
+ "id": "Entitlement",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#entitlement",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#entitlement\".",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product that the entitlement is for. For example, \"app:com.google.android.gm\".",
+ "type": "string"
+ },
+ "reason": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EntitlementsListResponse": {
+ "description": "The entitlement resources for the user.",
+ "id": "EntitlementsListResponse",
+ "properties": {
+ "entitlement": {
+ "description": "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.",
+ "items": {
+ "$ref": "Entitlement"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "androidenterprise#entitlementsListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#entitlementsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GroupLicense": {
+ "description": "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.\n\nUse 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.\n\nOnly 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.",
+ "id": "GroupLicense",
+ "properties": {
+ "acquisitionKind": {
+ "description": "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).",
+ "type": "string"
+ },
+ "approval": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#groupLicense",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicense\".",
+ "type": "string"
+ },
+ "numProvisioned": {
+ "description": "The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "numPurchased": {
+ "description": "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\").",
+ "format": "int32",
+ "type": "integer"
+ },
+ "permissions": {
+ "description": "The permission approval status of the product. This field is only set if the product is approved. Possible states are: \n- \"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.), \n- \"needsReapproval\", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved, \n- \"allCurrentAndFutureApproved\", the current permissions are approved and any future permission updates will be automatically approved without administrator review.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product that the license is for. For example, \"app:com.google.android.gm\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GroupLicenseUsersListResponse": {
+ "description": "The user resources for the group license.",
+ "id": "GroupLicenseUsersListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#groupLicenseUsersListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicenseUsersListResponse\".",
+ "type": "string"
+ },
+ "user": {
+ "description": "A user of an enterprise.",
+ "items": {
+ "$ref": "User"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GroupLicensesListResponse": {
+ "description": "The grouplicense resources for the enterprise.",
+ "id": "GroupLicensesListResponse",
+ "properties": {
+ "groupLicense": {
+ "description": "A group license for a product approved for use in the enterprise.",
+ "items": {
+ "$ref": "GroupLicense"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "androidenterprise#groupLicensesListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicensesListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Install": {
+ "description": "The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending).\n\nThe 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.\n\nThe 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.\n\nNote that it is not possible to force the installation of a specific version of an app: the version code is read-only.\n\nIf a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.\n\nThe 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.",
+ "id": "Install",
+ "properties": {
+ "installState": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#install",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#install\".",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product that the install is for. For example, \"app:com.google.android.gm\".",
+ "type": "string"
+ },
+ "versionCode": {
+ "description": "The version of the installed product. Guaranteed to be set only if the install state is \"installed\".",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "InstallFailureEvent": {
+ "description": "An event generated when an app installation failed on a device",
+ "id": "InstallFailureEvent",
+ "properties": {
+ "deviceId": {
+ "description": "The Android ID of the device. This field will always be present.",
+ "type": "string"
+ },
+ "failureDetails": {
+ "description": "Additional details on the failure if applicable.",
+ "type": "string"
+ },
+ "failureReason": {
+ "description": "The reason for the installation failure. This field will always be present.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "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.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user. This field will always be present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InstallsListResponse": {
+ "description": "The install resources for the device.",
+ "id": "InstallsListResponse",
+ "properties": {
+ "install": {
+ "description": "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.",
+ "items": {
+ "$ref": "Install"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "androidenterprise#installsListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#installsListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LocalizedText": {
+ "description": "A localized string with its locale.",
+ "id": "LocalizedText",
+ "properties": {
+ "locale": {
+ "description": "The BCP47 tag for a locale. (e.g. \"en-US\", \"de\").",
+ "type": "string"
+ },
+ "text": {
+ "description": "The text localized in the associated locale.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MaintenanceWindow": {
+ "description": "Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window.",
+ "id": "MaintenanceWindow",
+ "properties": {
+ "durationMs": {
+ "description": "Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).",
+ "format": "int64",
+ "type": "string"
+ },
+ "startTimeAfterMidnightMs": {
+ "description": "Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedConfiguration": {
+ "description": "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.",
+ "id": "ManagedConfiguration",
+ "properties": {
+ "configurationVariables": {
+ "$ref": "ConfigurationVariables",
+ "description": "Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user."
+ },
+ "kind": {
+ "default": "androidenterprise#managedConfiguration",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfiguration\".",
+ "type": "string"
+ },
+ "managedProperty": {
+ "description": "The set of managed properties for this configuration.",
+ "items": {
+ "$ref": "ManagedProperty"
+ },
+ "type": "array"
+ },
+ "productId": {
+ "description": "The ID of the product that the managed configuration is for, e.g. \"app:com.google.android.gm\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedConfigurationsForDeviceListResponse": {
+ "description": "The managed configuration resources for the device.",
+ "id": "ManagedConfigurationsForDeviceListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#managedConfigurationsForDeviceListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsForDeviceListResponse\".",
+ "type": "string"
+ },
+ "managedConfigurationForDevice": {
+ "description": "A managed configuration for an app on a specific device.",
+ "items": {
+ "$ref": "ManagedConfiguration"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedConfigurationsForUserListResponse": {
+ "description": "The managed configuration resources for the user.",
+ "id": "ManagedConfigurationsForUserListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#managedConfigurationsForUserListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsForUserListResponse\".",
+ "type": "string"
+ },
+ "managedConfigurationForUser": {
+ "description": "A managed configuration for an app for a specific user.",
+ "items": {
+ "$ref": "ManagedConfiguration"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedConfigurationsSettings": {
+ "description": "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.",
+ "id": "ManagedConfigurationsSettings",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#managedConfigurationsSettings",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsSettings\".",
+ "type": "string"
+ },
+ "lastUpdatedTimestampMillis": {
+ "description": "The last updated time of the managed configuration settings in milliseconds since 1970-01-01T00:00:00Z.",
+ "format": "int64",
+ "type": "string"
+ },
+ "managedProperty": {
+ "description": "The set of managed properties for this configuration.",
+ "items": {
+ "$ref": "ManagedProperty"
+ },
+ "type": "array"
+ },
+ "mcmId": {
+ "description": "The ID of the managed configurations settings.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the managed configurations settings.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedConfigurationsSettingsListResponse": {
+ "description": "The managed configurations settings for a product.",
+ "id": "ManagedConfigurationsSettingsListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#managedConfigurationsSettingsListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsSettingsListResponse\".",
+ "type": "string"
+ },
+ "managedConfigurationsSettings": {
+ "description": "A managed configurations settings for an app that may be assigned to a group of users in an enterprise.",
+ "items": {
+ "$ref": "ManagedConfigurationsSettings"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedProperty": {
+ "description": "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.",
+ "id": "ManagedProperty",
+ "properties": {
+ "key": {
+ "description": "The unique key that identifies the property.",
+ "type": "string"
+ },
+ "valueBool": {
+ "description": "The boolean value - this will only be present if type of the property is bool.",
+ "type": "boolean"
+ },
+ "valueBundle": {
+ "$ref": "ManagedPropertyBundle",
+ "description": "The bundle of managed properties - this will only be present if type of the property is bundle."
+ },
+ "valueBundleArray": {
+ "description": "The list of bundles of properties - this will only be present if type of the property is bundle_array.",
+ "items": {
+ "$ref": "ManagedPropertyBundle"
+ },
+ "type": "array"
+ },
+ "valueInteger": {
+ "description": "The integer value - this will only be present if type of the property is integer.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "valueString": {
+ "description": "The string value - this will only be present if type of the property is string, choice or hidden.",
+ "type": "string"
+ },
+ "valueStringArray": {
+ "description": "The list of string values - this will only be present if type of the property is multiselect.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedPropertyBundle": {
+ "description": "A bundle of managed properties.",
+ "id": "ManagedPropertyBundle",
+ "properties": {
+ "managedProperty": {
+ "description": "The list of managed properties.",
+ "items": {
+ "$ref": "ManagedProperty"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "NewDeviceEvent": {
+ "description": "An event generated when a new device is ready to be managed.",
+ "id": "NewDeviceEvent",
+ "properties": {
+ "deviceId": {
+ "description": "The Android ID of the device. This field will always be present.",
+ "type": "string"
+ },
+ "dpcPackageName": {
+ "description": "Policy app on the device.",
+ "type": "string"
+ },
+ "managementType": {
+ "description": "Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations.\n\nPossible values include: \n- \"managedDevice\", a device where the DPC is set as device owner, \n- \"managedProfile\", a device where the DPC is set as profile owner.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user. This field will always be present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NewPermissionsEvent": {
+ "description": "An event generated when new permissions are added to an app.",
+ "id": "NewPermissionsEvent",
+ "properties": {
+ "approvedPermissions": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "productId": {
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which new permissions were added. This field will always be present.",
+ "type": "string"
+ },
+ "requestedPermissions": {
+ "description": "The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Notification": {
+ "description": "A notification of one event relating to an enterprise.",
+ "id": "Notification",
+ "properties": {
+ "appRestrictionsSchemaChangeEvent": {
+ "$ref": "AppRestrictionsSchemaChangeEvent",
+ "description": "Notifications about new app restrictions schema changes."
+ },
+ "appUpdateEvent": {
+ "$ref": "AppUpdateEvent",
+ "description": "Notifications about app updates."
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise for which the notification is sent. This will always be present.",
+ "type": "string"
+ },
+ "installFailureEvent": {
+ "$ref": "InstallFailureEvent",
+ "description": "Notifications about an app installation failure."
+ },
+ "newDeviceEvent": {
+ "$ref": "NewDeviceEvent",
+ "description": "Notifications about new devices."
+ },
+ "newPermissionsEvent": {
+ "$ref": "NewPermissionsEvent",
+ "description": "Notifications about new app permissions."
+ },
+ "notificationType": {
+ "description": "Type of the notification.",
+ "type": "string"
+ },
+ "productApprovalEvent": {
+ "$ref": "ProductApprovalEvent",
+ "description": "Notifications about changes to a product's approval status."
+ },
+ "productAvailabilityChangeEvent": {
+ "$ref": "ProductAvailabilityChangeEvent",
+ "description": "Notifications about product availability changes."
+ },
+ "timestampMillis": {
+ "description": "The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NotificationSet": {
+ "description": "A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request.",
+ "id": "NotificationSet",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#notificationSet",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#notificationSet\".",
+ "type": "string"
+ },
+ "notification": {
+ "description": "The notifications received, or empty if no notifications are present.",
+ "items": {
+ "$ref": "Notification"
+ },
+ "type": "array"
+ },
+ "notificationSetId": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PageInfo": {
+ "id": "PageInfo",
+ "properties": {
+ "resultPerPage": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "startIndex": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalResults": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Permission": {
+ "description": "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.\n\nThe 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.",
+ "id": "Permission",
+ "properties": {
+ "description": {
+ "description": "A longer description of the Permissions resource, giving more details of what it affects.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#permission",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#permission\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the permission.",
+ "type": "string"
+ },
+ "permissionId": {
+ "description": "An opaque string uniquely identifying the permission.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Policy": {
+ "description": "The device policy for a given managed device.",
+ "id": "Policy",
+ "properties": {
+ "autoUpdatePolicy": {
+ "description": "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.",
+ "type": "string"
+ },
+ "maintenanceWindow": {
+ "$ref": "MaintenanceWindow",
+ "description": "The maintenance window defining when apps running in the foreground should be updated. This feature is only supported on fully managed devices."
+ },
+ "productAvailabilityPolicy": {
+ "description": "The availability granted to the device for the specified products. \"all\" gives the device access to all products, regardless of approval status. \"allApproved\" entitles the device to access all products that are approved for the enterprise. \"allApproved\" and \"all\" do 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.",
+ "type": "string"
+ },
+ "productPolicy": {
+ "description": "The list of product policies.",
+ "items": {
+ "$ref": "ProductPolicy"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Product": {
+ "description": "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.)\n\nThe 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.",
+ "id": "Product",
+ "properties": {
+ "appVersion": {
+ "description": "App versions currently available for this product.",
+ "items": {
+ "$ref": "AppVersion"
+ },
+ "type": "array"
+ },
+ "authorName": {
+ "description": "The name of the author of the product (for example, the app developer).",
+ "type": "string"
+ },
+ "availableCountries": {
+ "description": "The countries which this app is available in.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "availableTracks": {
+ "description": "The tracks that are visible to the enterprise.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "category": {
+ "description": "The app category (e.g. RACING, SOCIAL, etc.)",
+ "type": "string"
+ },
+ "contentRating": {
+ "description": "The content rating for this app.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The localized promotional description, if available.",
+ "type": "string"
+ },
+ "detailsUrl": {
+ "description": "A link to the (consumer) Google Play details page for the product.",
+ "type": "string"
+ },
+ "distributionChannel": {
+ "description": "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.",
+ "type": "string"
+ },
+ "iconUrl": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#product",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#product\".",
+ "type": "string"
+ },
+ "lastUpdatedTimestampMillis": {
+ "description": "The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "minAndroidSdkVersion": {
+ "description": "The minimum Android SDK necessary to run the app.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "permissions": {
+ "description": "A list of permissions required by the app.",
+ "items": {
+ "$ref": "ProductPermission"
+ },
+ "type": "array"
+ },
+ "productId": {
+ "description": "A string of the form app:\u003cpackage name\u003e. For example, app:com.google.android.gm represents the Gmail app.",
+ "type": "string"
+ },
+ "productPricing": {
+ "description": "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).",
+ "type": "string"
+ },
+ "recentChanges": {
+ "description": "A description of the recent changes made to the app.",
+ "type": "string"
+ },
+ "requiresContainerApp": {
+ "description": "Deprecated.",
+ "type": "boolean"
+ },
+ "screenshotUrls": {
+ "description": "A list of screenshot links representing the app.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "signingCertificate": {
+ "$ref": "ProductSigningCertificate",
+ "description": "The certificate used to sign this product."
+ },
+ "smallIconUrl": {
+ "description": "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.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The name of the product.",
+ "type": "string"
+ },
+ "workDetailsUrl": {
+ "description": "A link to the managed Google Play details page for the product, for use by an Enterprise admin.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductApprovalEvent": {
+ "description": "An event generated when a product's approval status is changed.",
+ "id": "ProductApprovalEvent",
+ "properties": {
+ "approved": {
+ "description": "Whether the product was approved or unapproved. This field will always be present.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductAvailabilityChangeEvent": {
+ "description": "An event generated whenever a product's availability changes.",
+ "id": "ProductAvailabilityChangeEvent",
+ "properties": {
+ "availabilityStatus": {
+ "description": "The new state of the product. This field will always be present.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the product availability changed. This field will always be present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductPermission": {
+ "description": "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.\n\nThe API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.",
+ "id": "ProductPermission",
+ "properties": {
+ "permissionId": {
+ "description": "An opaque string uniquely identifying the permission.",
+ "type": "string"
+ },
+ "state": {
+ "description": "Whether the permission has been accepted or not.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductPermissions": {
+ "description": "Information about the permissions required by a specific app and whether they have been accepted by the enterprise.",
+ "id": "ProductPermissions",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#productPermissions",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productPermissions\".",
+ "type": "string"
+ },
+ "permission": {
+ "description": "The permissions required by the app.",
+ "items": {
+ "$ref": "ProductPermission"
+ },
+ "type": "array"
+ },
+ "productId": {
+ "description": "The ID of the app that the permissions relate to, e.g. \"app:com.google.android.gm\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductPolicy": {
+ "description": "The policy for a product.",
+ "id": "ProductPolicy",
+ "properties": {
+ "productId": {
+ "description": "The ID of the product. For example, \"app:com.google.android.gm\".",
+ "type": "string"
+ },
+ "tracks": {
+ "description": "Grants visibility to the specified track(s) of the product to the device. The track available to the device is based on the following order of preference: alpha, beta, production. For example, if an app has a prod version, a beta version and an alpha version and the enterprise has been granted visibility to both the alpha and beta tracks, if tracks is {\"beta\", \"production\"} then the beta version of the app is made available to the device. If there are no app versions in the specified track adding the \"alpha\" and \"beta\" values to the list of tracks will have no effect. Note that the enterprise requires access to alpha and/or beta tracks before users can be granted visibility to apps in those tracks.\n\nThe allowed sets are: {} (considered equivalent to {\"production\"}) {\"production\"} {\"beta\", \"production\"} {\"alpha\", \"beta\", \"production\"} The order of elements is not relevant. Any other set of tracks will be rejected with an error.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ProductSet": {
+ "description": "A set of products.",
+ "id": "ProductSet",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#productSet",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productSet\".",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The list of product IDs making up the set of products.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "productSetBehavior": {
+ "description": "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.",
+ "type": "string"
+ },
+ "productVisibility": {
+ "description": "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.",
+ "items": {
+ "$ref": "ProductVisibility"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ProductSigningCertificate": {
+ "id": "ProductSigningCertificate",
+ "properties": {
+ "certificateHashSha1": {
+ "description": "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.)",
+ "type": "string"
+ },
+ "certificateHashSha256": {
+ "description": "The base64 urlsafe encoded SHA2-256 hash of the certificate.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductVisibility": {
+ "description": "A product to be made visible to a user.",
+ "id": "ProductVisibility",
+ "properties": {
+ "productId": {
+ "description": "The product ID to make visible to the user. Required for each item in the productVisibility list.",
+ "type": "string"
+ },
+ "tracks": {
+ "description": "Grants visibility to the specified track(s) of the product to the user. The track available to the user is based on the following order of preference: alpha, beta, production. For example, if an app has a prod version, a beta version and an alpha version and the enterprise has been granted visibility to both the alpha and beta tracks, if tracks is {\"beta\", \"production\"} the user will be able to install the app and they will get the beta version of the app. If there are no app versions in the specified track adding the \"alpha\" and \"beta\" values to the list of tracks will have no effect. Note that the enterprise requires access to alpha and/or beta tracks before users can be granted visibility to apps in those tracks.\n\nThe allowed sets are: {} (considered equivalent to {\"production\"}) {\"production\"} {\"beta\", \"production\"} {\"alpha\", \"beta\", \"production\"} The order of elements is not relevant. Any other set of tracks will be rejected with an error.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ProductsApproveRequest": {
+ "id": "ProductsApproveRequest",
+ "properties": {
+ "approvalUrlInfo": {
+ "$ref": "ApprovalUrlInfo",
+ "description": "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."
+ },
+ "approvedPermissions": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductsGenerateApprovalUrlResponse": {
+ "id": "ProductsGenerateApprovalUrlResponse",
+ "properties": {
+ "url": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductsListResponse": {
+ "description": "The matching products.",
+ "id": "ProductsListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#productsListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productsListResponse\".",
+ "type": "string"
+ },
+ "pageInfo": {
+ "$ref": "PageInfo",
+ "description": "General pagination information."
+ },
+ "product": {
+ "description": "Information about a product (e.g. an app) in the Google Play store, for display to an enterprise admin.",
+ "items": {
+ "$ref": "Product"
+ },
+ "type": "array"
+ },
+ "tokenPagination": {
+ "$ref": "TokenPagination",
+ "description": "Pagination information for token pagination."
+ }
+ },
+ "type": "object"
+ },
+ "ServiceAccount": {
+ "description": "A service account identity, including the name and credentials that can be used to authenticate as the service account.",
+ "id": "ServiceAccount",
+ "properties": {
+ "key": {
+ "$ref": "ServiceAccountKey",
+ "description": "Credentials that can be used to authenticate as this ServiceAccount."
+ },
+ "kind": {
+ "default": "androidenterprise#serviceAccount",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#serviceAccount\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "The account name of the service account, in the form of an email address. Assigned by the server.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ServiceAccountKey": {
+ "description": "Credentials that can be used to authenticate as a service account.",
+ "id": "ServiceAccountKey",
+ "properties": {
+ "data": {
+ "description": "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.",
+ "type": "string"
+ },
+ "id": {
+ "description": "An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#serviceAccountKey",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#serviceAccountKey\".",
+ "type": "string"
+ },
+ "publicData": {
+ "description": "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.",
+ "type": "string"
+ },
+ "type": {
+ "annotations": {
+ "required": [
+ "androidenterprise.serviceaccountkeys.insert"
+ ]
+ },
+ "description": "The file format of the generated key data.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ServiceAccountKeysListResponse": {
+ "id": "ServiceAccountKeysListResponse",
+ "properties": {
+ "serviceAccountKey": {
+ "description": "The service account credentials.",
+ "items": {
+ "$ref": "ServiceAccountKey"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SignupInfo": {
+ "description": "A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token.",
+ "id": "SignupInfo",
+ "properties": {
+ "completionToken": {
+ "description": "An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#signupInfo",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#signupInfo\".",
+ "type": "string"
+ },
+ "url": {
+ "description": "A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StoreCluster": {
+ "description": "Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.",
+ "id": "StoreCluster",
+ "properties": {
+ "id": {
+ "description": "Unique ID of this cluster. Assigned by the server. Immutable once assigned.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#storeCluster",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeCluster\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "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.",
+ "items": {
+ "$ref": "LocalizedText"
+ },
+ "type": "array"
+ },
+ "orderInPage": {
+ "description": "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.\n\nThe 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.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "StoreLayout": {
+ "description": "General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened.",
+ "id": "StoreLayout",
+ "properties": {
+ "homepageId": {
+ "description": "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.\n\nNot specifying a homepage is equivalent to setting the store layout type to \"basic\".",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#storeLayout",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeLayout\".",
+ "type": "string"
+ },
+ "storeLayoutType": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StoreLayoutClustersListResponse": {
+ "description": "The store page resources for the enterprise.",
+ "id": "StoreLayoutClustersListResponse",
+ "properties": {
+ "cluster": {
+ "description": "A store cluster of an enterprise.",
+ "items": {
+ "$ref": "StoreCluster"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "androidenterprise#storeLayoutClustersListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeLayoutClustersListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StoreLayoutPagesListResponse": {
+ "description": "The store page resources for the enterprise.",
+ "id": "StoreLayoutPagesListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#storeLayoutPagesListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeLayoutPagesListResponse\".",
+ "type": "string"
+ },
+ "page": {
+ "description": "A store page of an enterprise.",
+ "items": {
+ "$ref": "StorePage"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "StorePage": {
+ "description": "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.",
+ "id": "StorePage",
+ "properties": {
+ "id": {
+ "description": "Unique ID of this page. Assigned by the server. Immutable once assigned.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#storePage",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storePage\".",
+ "type": "string"
+ },
+ "link": {
+ "description": "Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.\n\nNo attempt is made to verify that all pages are reachable from the homepage.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "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.",
+ "items": {
+ "$ref": "LocalizedText"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TokenPagination": {
+ "id": "TokenPagination",
+ "properties": {
+ "nextPageToken": {
+ "type": "string"
+ },
+ "previousPageToken": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "User": {
+ "description": "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: \n- The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). \n- 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.",
+ "id": "User",
+ "properties": {
+ "accountIdentifier": {
+ "annotations": {
+ "required": [
+ "androidenterprise.users.insert"
+ ]
+ },
+ "description": "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.",
+ "type": "string"
+ },
+ "accountType": {
+ "annotations": {
+ "required": [
+ "androidenterprise.users.insert"
+ ]
+ },
+ "description": "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.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "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.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID for the user.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#user",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#user\".",
+ "type": "string"
+ },
+ "managementType": {
+ "description": "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.",
+ "type": "string"
+ },
+ "primaryEmail": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserToken": {
+ "description": "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.",
+ "id": "UserToken",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#userToken",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#userToken\".",
+ "type": "string"
+ },
+ "token": {
+ "description": "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.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "The unique ID for the user.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UsersListResponse": {
+ "description": "The matching user resources.",
+ "id": "UsersListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#usersListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#usersListResponse\".",
+ "type": "string"
+ },
+ "user": {
+ "description": "A user of an enterprise.",
+ "items": {
+ "$ref": "User"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VariableSet": {
+ "description": "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.",
+ "id": "VariableSet",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#variableSet",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#variableSet\".",
+ "type": "string"
+ },
+ "placeholder": {
+ "description": "The placeholder string; defined by EMM.",
+ "type": "string"
+ },
+ "userValue": {
+ "description": "The value of the placeholder, specific to the user.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "GroupLicensesListResponse": {
- "id": "GroupLicensesListResponse",
- "type": "object",
- "description": "The grouplicense resources for the enterprise.",
- "properties": {
- "groupLicense": {
- "type": "array",
- "description": "A group license for a product approved for use in the enterprise.",
- "items": {
- "$ref": "GroupLicense"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicensesListResponse\".",
- "default": "androidenterprise#groupLicensesListResponse"
- }
- }
- },
- "Install": {
- "id": "Install",
- "type": "object",
- "description": "The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending).\n\nThe 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.\n\nThe 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.\n\nNote that it is not possible to force the installation of a specific version of an app: the version code is read-only.\n\nIf a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.\n\nThe 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.",
- "properties": {
- "installState": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#install\".",
- "default": "androidenterprise#install"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product that the install is for. For example, \"app:com.google.android.gm\"."
- },
- "versionCode": {
- "type": "integer",
- "description": "The version of the installed product. Guaranteed to be set only if the install state is \"installed\".",
- "format": "int32"
- }
- }
- },
- "InstallFailureEvent": {
- "id": "InstallFailureEvent",
- "type": "object",
- "description": "An event generated when an app installation failed on a device",
- "properties": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device. This field will always be present."
- },
- "failureDetails": {
- "type": "string",
- "description": "Additional details on the failure if applicable."
- },
- "failureReason": {
- "type": "string",
- "description": "The reason for the installation failure. This field will always be present."
- },
- "productId": {
- "type": "string",
- "description": "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."
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user. This field will always be present."
- }
- }
- },
- "InstallsListResponse": {
- "id": "InstallsListResponse",
- "type": "object",
- "description": "The install resources for the device.",
- "properties": {
- "install": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "Install"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#installsListResponse\".",
- "default": "androidenterprise#installsListResponse"
- }
- }
- },
- "LocalizedText": {
- "id": "LocalizedText",
- "type": "object",
- "description": "A localized string with its locale.",
- "properties": {
- "locale": {
- "type": "string",
- "description": "The BCP47 tag for a locale. (e.g. \"en-US\", \"de\")."
- },
- "text": {
- "type": "string",
- "description": "The text localized in the associated locale."
- }
- }
- },
- "ManagedConfiguration": {
- "id": "ManagedConfiguration",
- "type": "object",
- "description": "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.",
- "properties": {
- "configurationVariables": {
- "$ref": "ConfigurationVariables",
- "description": "Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfiguration\".",
- "default": "androidenterprise#managedConfiguration"
- },
- "managedProperty": {
- "type": "array",
- "description": "The set of managed properties for this configuration.",
- "items": {
- "$ref": "ManagedProperty"
- }
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product that the managed configuration is for, e.g. \"app:com.google.android.gm\"."
- }
- }
- },
- "ManagedConfigurationsForDeviceListResponse": {
- "id": "ManagedConfigurationsForDeviceListResponse",
- "type": "object",
- "description": "The managed configuration resources for the device.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsForDeviceListResponse\".",
- "default": "androidenterprise#managedConfigurationsForDeviceListResponse"
- },
- "managedConfigurationForDevice": {
- "type": "array",
- "description": "A managed configuration for an app on a specific device.",
- "items": {
- "$ref": "ManagedConfiguration"
- }
- }
- }
- },
- "ManagedConfigurationsForUserListResponse": {
- "id": "ManagedConfigurationsForUserListResponse",
- "type": "object",
- "description": "The managed configuration resources for the user.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsForUserListResponse\".",
- "default": "androidenterprise#managedConfigurationsForUserListResponse"
- },
- "managedConfigurationForUser": {
- "type": "array",
- "description": "A managed configuration for an app for a specific user.",
- "items": {
- "$ref": "ManagedConfiguration"
- }
- }
- }
- },
- "ManagedConfigurationsSettings": {
- "id": "ManagedConfigurationsSettings",
- "type": "object",
- "description": "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.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsSettings\".",
- "default": "androidenterprise#managedConfigurationsSettings"
- },
- "managedProperty": {
- "type": "array",
- "description": "The set of managed properties for this configuration.",
- "items": {
- "$ref": "ManagedProperty"
- }
- },
- "mcmId": {
- "type": "string",
- "description": "The ID of the managed configurations settings."
- },
- "name": {
- "type": "string",
- "description": "The name of the managed configurations settings."
- }
- }
- },
- "ManagedConfigurationsSettingsListResponse": {
- "id": "ManagedConfigurationsSettingsListResponse",
- "type": "object",
- "description": "The managed configurations settings for a product.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsSettingsListResponse\".",
- "default": "androidenterprise#managedConfigurationsSettingsListResponse"
- },
- "managedConfigurationsSettings": {
- "type": "array",
- "description": "A managed configurations settings for an app that may be assigned to a group of users in an enterprise.",
- "items": {
- "$ref": "ManagedConfigurationsSettings"
- }
- }
- }
- },
- "ManagedProperty": {
- "id": "ManagedProperty",
- "type": "object",
- "description": "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.",
- "properties": {
- "key": {
- "type": "string",
- "description": "The unique key that identifies the property."
- },
- "valueBool": {
- "type": "boolean",
- "description": "The boolean value - this will only be present if type of the property is bool."
- },
- "valueBundle": {
- "$ref": "ManagedPropertyBundle",
- "description": "The bundle of managed properties - this will only be present if type of the property is bundle."
- },
- "valueBundleArray": {
- "type": "array",
- "description": "The list of bundles of properties - this will only be present if type of the property is bundle_array.",
- "items": {
- "$ref": "ManagedPropertyBundle"
- }
- },
- "valueInteger": {
- "type": "integer",
- "description": "The integer value - this will only be present if type of the property is integer.",
- "format": "int32"
- },
- "valueString": {
- "type": "string",
- "description": "The string value - this will only be present if type of the property is string, choice or hidden."
- },
- "valueStringArray": {
- "type": "array",
- "description": "The list of string values - this will only be present if type of the property is multiselect.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ManagedPropertyBundle": {
- "id": "ManagedPropertyBundle",
- "type": "object",
- "description": "A bundle of managed properties.",
- "properties": {
- "managedProperty": {
- "type": "array",
- "description": "The list of managed properties.",
- "items": {
- "$ref": "ManagedProperty"
- }
- }
- }
- },
- "NewDeviceEvent": {
- "id": "NewDeviceEvent",
- "type": "object",
- "description": "An event generated when a new device is ready to be managed.",
- "properties": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device. This field will always be present."
- },
- "dpcPackageName": {
- "type": "string",
- "description": "Policy app on the device."
- },
- "managementType": {
- "type": "string",
- "description": "Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations.\n\nPossible values include: \n- \"managedDevice\", a device where the DPC is set as device owner, \n- \"managedProfile\", a device where the DPC is set as profile owner."
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user. This field will always be present."
- }
- }
- },
- "NewPermissionsEvent": {
- "id": "NewPermissionsEvent",
- "type": "object",
- "description": "An event generated when new permissions are added to an app.",
- "properties": {
- "approvedPermissions": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "productId": {
- "type": "string",
- "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which new permissions were added. This field will always be present."
- },
- "requestedPermissions": {
- "type": "array",
- "description": "The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Notification": {
- "id": "Notification",
- "type": "object",
- "description": "A notification of one event relating to an enterprise.",
- "properties": {
- "appRestrictionsSchemaChangeEvent": {
- "$ref": "AppRestrictionsSchemaChangeEvent",
- "description": "Notifications about new app restrictions schema changes."
- },
- "appUpdateEvent": {
- "$ref": "AppUpdateEvent",
- "description": "Notifications about app updates."
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise for which the notification is sent. This will always be present."
- },
- "installFailureEvent": {
- "$ref": "InstallFailureEvent",
- "description": "Notifications about an app installation failure."
- },
- "newDeviceEvent": {
- "$ref": "NewDeviceEvent",
- "description": "Notifications about new devices."
- },
- "newPermissionsEvent": {
- "$ref": "NewPermissionsEvent",
- "description": "Notifications about new app permissions."
- },
- "notificationType": {
- "type": "string",
- "description": "Type of the notification."
- },
- "productApprovalEvent": {
- "$ref": "ProductApprovalEvent",
- "description": "Notifications about changes to a product's approval status."
- },
- "productAvailabilityChangeEvent": {
- "$ref": "ProductAvailabilityChangeEvent",
- "description": "Notifications about product availability changes."
- },
- "timestampMillis": {
- "type": "string",
- "description": "The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present.",
- "format": "int64"
- }
- }
- },
- "NotificationSet": {
- "id": "NotificationSet",
- "type": "object",
- "description": "A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#notificationSet\".",
- "default": "androidenterprise#notificationSet"
- },
- "notification": {
- "type": "array",
- "description": "The notifications received, or empty if no notifications are present.",
- "items": {
- "$ref": "Notification"
- }
- },
- "notificationSetId": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "PageInfo": {
- "id": "PageInfo",
- "type": "object",
- "properties": {
- "resultPerPage": {
- "type": "integer",
- "format": "int32"
- },
- "startIndex": {
- "type": "integer",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "Permission": {
- "id": "Permission",
- "type": "object",
- "description": "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.\n\nThe 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.",
- "properties": {
- "description": {
- "type": "string",
- "description": "A longer description of the Permissions resource, giving more details of what it affects."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#permission\".",
- "default": "androidenterprise#permission"
- },
- "name": {
- "type": "string",
- "description": "The name of the permission."
- },
- "permissionId": {
- "type": "string",
- "description": "An opaque string uniquely identifying the permission."
- }
- }
- },
- "Policy": {
- "id": "Policy",
- "type": "object",
- "description": "The device policy for a given managed device.",
- "properties": {
- "productAvailabilityPolicy": {
- "type": "string",
- "description": "The availability granted to the device for the specified products. \"all\" gives the device access to all products, regardless of approval status. \"allApproved\" entitles the device to access all products that are approved for the enterprise. \"allApproved\" and \"all\" do 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."
- },
- "productPolicy": {
- "type": "array",
- "description": "The list of product policies.",
- "items": {
- "$ref": "ProductPolicy"
- }
- }
- }
- },
- "Product": {
- "id": "Product",
- "type": "object",
- "description": "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.)\n\nThe 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.",
- "properties": {
- "appVersion": {
- "type": "array",
- "description": "App versions currently available for this product.",
- "items": {
- "$ref": "AppVersion"
- }
- },
- "authorName": {
- "type": "string",
- "description": "The name of the author of the product (for example, the app developer)."
- },
- "availableCountries": {
- "type": "array",
- "description": "The countries which this app is available in.",
- "items": {
- "type": "string"
- }
- },
- "availableTracks": {
- "type": "array",
- "description": "The tracks that are visible to the enterprise.",
- "items": {
- "type": "string"
- }
- },
- "category": {
- "type": "string",
- "description": "The app category (e.g. RACING, SOCIAL, etc.)"
- },
- "contentRating": {
- "type": "string",
- "description": "The content rating for this app."
- },
- "description": {
- "type": "string",
- "description": "The localized promotional description, if available."
- },
- "detailsUrl": {
- "type": "string",
- "description": "A link to the (consumer) Google Play details page for the product."
- },
- "distributionChannel": {
- "type": "string",
- "description": "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."
- },
- "iconUrl": {
- "type": "string",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#product\".",
- "default": "androidenterprise#product"
- },
- "lastUpdatedTimestampMillis": {
- "type": "string",
- "description": "The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch.",
- "format": "int64"
- },
- "minAndroidSdkVersion": {
- "type": "integer",
- "description": "The minimum Android SDK necessary to run the app.",
- "format": "int32"
- },
- "permissions": {
- "type": "array",
- "description": "A list of permissions required by the app.",
- "items": {
- "$ref": "ProductPermission"
- }
- },
- "productId": {
- "type": "string",
- "description": "A string of the form app:\u003cpackage name\u003e. For example, app:com.google.android.gm represents the Gmail app."
- },
- "productPricing": {
- "type": "string",
- "description": "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)."
- },
- "recentChanges": {
- "type": "string",
- "description": "A description of the recent changes made to the app."
- },
- "requiresContainerApp": {
- "type": "boolean",
- "description": "Deprecated."
- },
- "screenshotUrls": {
- "type": "array",
- "description": "A list of screenshot links representing the app.",
- "items": {
- "type": "string"
- }
- },
- "signingCertificate": {
- "$ref": "ProductSigningCertificate",
- "description": "The certificate used to sign this product."
- },
- "smallIconUrl": {
- "type": "string",
- "description": "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."
- },
- "title": {
- "type": "string",
- "description": "The name of the product."
- },
- "workDetailsUrl": {
- "type": "string",
- "description": "A link to the managed Google Play details page for the product, for use by an Enterprise admin."
- }
- }
- },
- "ProductApprovalEvent": {
- "id": "ProductApprovalEvent",
- "type": "object",
- "description": "An event generated when a product's approval status is changed.",
- "properties": {
- "approved": {
- "type": "string",
- "description": "Whether the product was approved or unapproved. This field will always be present."
- },
- "productId": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "ProductAvailabilityChangeEvent": {
- "id": "ProductAvailabilityChangeEvent",
- "type": "object",
- "description": "An event generated whenever a product's availability changes.",
- "properties": {
- "availabilityStatus": {
- "type": "string",
- "description": "The new state of the product. This field will always be present."
- },
- "productId": {
- "type": "string",
- "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the product availability changed. This field will always be present."
- }
- }
- },
- "ProductPermission": {
- "id": "ProductPermission",
- "type": "object",
- "description": "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.\n\nThe API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.",
- "properties": {
- "permissionId": {
- "type": "string",
- "description": "An opaque string uniquely identifying the permission."
- },
- "state": {
- "type": "string",
- "description": "Whether the permission has been accepted or not."
- }
- }
- },
- "ProductPermissions": {
- "id": "ProductPermissions",
- "type": "object",
- "description": "Information about the permissions required by a specific app and whether they have been accepted by the enterprise.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productPermissions\".",
- "default": "androidenterprise#productPermissions"
- },
- "permission": {
- "type": "array",
- "description": "The permissions required by the app.",
- "items": {
- "$ref": "ProductPermission"
- }
- },
- "productId": {
- "type": "string",
- "description": "The ID of the app that the permissions relate to, e.g. \"app:com.google.android.gm\"."
- }
- }
- },
- "ProductPolicy": {
- "id": "ProductPolicy",
- "type": "object",
- "description": "The policy for a product.",
- "properties": {
- "productId": {
- "type": "string",
- "description": "The ID of the product. For example, \"app:com.google.android.gm\"."
- },
- "tracks": {
- "type": "array",
- "description": "Grants visibility to the specified track(s) of the product to the device. The track available to the device is based on the following order of preference: alpha, beta, production. For example, if an app has a prod version, a beta version and an alpha version and the enterprise has been granted visibility to both the alpha and beta tracks, if tracks is {\"beta\", \"production\"} then the beta version of the app is made available to the device. If there are no app versions in the specified track adding the \"alpha\" and \"beta\" values to the list of tracks will have no effect. Note that the enterprise requires access to alpha and/or beta tracks before users can be granted visibility to apps in those tracks.\n\nThe allowed sets are: {} (considered equivalent to {\"production\"}) {\"production\"} {\"beta\", \"production\"} {\"alpha\", \"beta\", \"production\"} The order of elements is not relevant. Any other set of tracks will be rejected with an error.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ProductSet": {
- "id": "ProductSet",
- "type": "object",
- "description": "A set of products.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productSet\".",
- "default": "androidenterprise#productSet"
- },
- "productId": {
- "type": "array",
- "description": "The list of product IDs making up the set of products.",
- "items": {
- "type": "string"
- }
- },
- "productSetBehavior": {
- "type": "string",
- "description": "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."
- },
- "productVisibility": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "ProductVisibility"
- }
- }
- }
- },
- "ProductSigningCertificate": {
- "id": "ProductSigningCertificate",
- "type": "object",
- "properties": {
- "certificateHashSha1": {
- "type": "string",
- "description": "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.)"
- },
- "certificateHashSha256": {
- "type": "string",
- "description": "The base64 urlsafe encoded SHA2-256 hash of the certificate."
- }
- }
- },
- "ProductVisibility": {
- "id": "ProductVisibility",
- "type": "object",
- "description": "A product to be made visible to a user.",
- "properties": {
- "productId": {
- "type": "string",
- "description": "The product ID to make visible to the user. Required for each item in the productVisibility list."
- },
- "tracks": {
- "type": "array",
- "description": "Grants visibility to the specified track(s) of the product to the user. The track available to the user is based on the following order of preference: alpha, beta, production. For example, if an app has a prod version, a beta version and an alpha version and the enterprise has been granted visibility to both the alpha and beta tracks, if tracks is {\"beta\", \"production\"} the user will be able to install the app and they will get the beta version of the app. If there are no app versions in the specified track adding the \"alpha\" and \"beta\" values to the list of tracks will have no effect. Note that the enterprise requires access to alpha and/or beta tracks before users can be granted visibility to apps in those tracks.\n\nThe allowed sets are: {} (considered equivalent to {\"production\"}) {\"production\"} {\"beta\", \"production\"} {\"alpha\", \"beta\", \"production\"} The order of elements is not relevant. Any other set of tracks will be rejected with an error.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ProductsApproveRequest": {
- "id": "ProductsApproveRequest",
- "type": "object",
- "properties": {
- "approvalUrlInfo": {
- "$ref": "ApprovalUrlInfo",
- "description": "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."
- },
- "approvedPermissions": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "ProductsGenerateApprovalUrlResponse": {
- "id": "ProductsGenerateApprovalUrlResponse",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "ProductsListResponse": {
- "id": "ProductsListResponse",
- "type": "object",
- "description": "The matching products.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productsListResponse\".",
- "default": "androidenterprise#productsListResponse"
- },
- "pageInfo": {
- "$ref": "PageInfo",
- "description": "General pagination information."
- },
- "product": {
- "type": "array",
- "description": "Information about a product (e.g. an app) in the Google Play store, for display to an enterprise admin.",
- "items": {
- "$ref": "Product"
- }
- },
- "tokenPagination": {
- "$ref": "TokenPagination",
- "description": "Pagination information for token pagination."
- }
- }
- },
- "ServiceAccount": {
- "id": "ServiceAccount",
- "type": "object",
- "description": "A service account identity, including the name and credentials that can be used to authenticate as the service account.",
- "properties": {
- "key": {
- "$ref": "ServiceAccountKey",
- "description": "Credentials that can be used to authenticate as this ServiceAccount."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#serviceAccount\".",
- "default": "androidenterprise#serviceAccount"
- },
- "name": {
- "type": "string",
- "description": "The account name of the service account, in the form of an email address. Assigned by the server."
- }
- }
- },
- "ServiceAccountKey": {
- "id": "ServiceAccountKey",
- "type": "object",
- "description": "Credentials that can be used to authenticate as a service account.",
- "properties": {
- "data": {
- "type": "string",
- "description": "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."
- },
- "id": {
- "type": "string",
- "description": "An opaque, unique identifier for this ServiceAccountKey. Assigned by the server."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#serviceAccountKey\".",
- "default": "androidenterprise#serviceAccountKey"
- },
- "publicData": {
- "type": "string",
- "description": "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."
- },
- "type": {
- "type": "string",
- "description": "The file format of the generated key data.",
- "annotations": {
- "required": [
- "androidenterprise.serviceaccountkeys.insert"
- ]
- }
- }
- }
- },
- "ServiceAccountKeysListResponse": {
- "id": "ServiceAccountKeysListResponse",
- "type": "object",
- "properties": {
- "serviceAccountKey": {
- "type": "array",
- "description": "The service account credentials.",
- "items": {
- "$ref": "ServiceAccountKey"
- }
- }
- }
- },
- "SignupInfo": {
- "id": "SignupInfo",
- "type": "object",
- "description": "A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token.",
- "properties": {
- "completionToken": {
- "type": "string",
- "description": "An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#signupInfo\".",
- "default": "androidenterprise#signupInfo"
- },
- "url": {
- "type": "string",
- "description": "A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe."
- }
- }
- },
- "StoreCluster": {
- "id": "StoreCluster",
- "type": "object",
- "description": "Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique ID of this cluster. Assigned by the server. Immutable once assigned."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeCluster\".",
- "default": "androidenterprise#storeCluster"
- },
- "name": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "LocalizedText"
- }
- },
- "orderInPage": {
- "type": "string",
- "description": "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.\n\nThe 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."
- },
- "productId": {
- "type": "array",
- "description": "List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "StoreLayout": {
- "id": "StoreLayout",
- "type": "object",
- "description": "General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened.",
- "properties": {
- "homepageId": {
- "type": "string",
- "description": "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.\n\nNot specifying a homepage is equivalent to setting the store layout type to \"basic\"."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeLayout\".",
- "default": "androidenterprise#storeLayout"
- },
- "storeLayoutType": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "StoreLayoutClustersListResponse": {
- "id": "StoreLayoutClustersListResponse",
- "type": "object",
- "description": "The store page resources for the enterprise.",
- "properties": {
- "cluster": {
- "type": "array",
- "description": "A store cluster of an enterprise.",
- "items": {
- "$ref": "StoreCluster"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeLayoutClustersListResponse\".",
- "default": "androidenterprise#storeLayoutClustersListResponse"
- }
- }
- },
- "StoreLayoutPagesListResponse": {
- "id": "StoreLayoutPagesListResponse",
- "type": "object",
- "description": "The store page resources for the enterprise.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeLayoutPagesListResponse\".",
- "default": "androidenterprise#storeLayoutPagesListResponse"
- },
- "page": {
- "type": "array",
- "description": "A store page of an enterprise.",
- "items": {
- "$ref": "StorePage"
- }
- }
- }
- },
- "StorePage": {
- "id": "StorePage",
- "type": "object",
- "description": "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.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique ID of this page. Assigned by the server. Immutable once assigned."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storePage\".",
- "default": "androidenterprise#storePage"
- },
- "link": {
- "type": "array",
- "description": "Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.\n\nNo attempt is made to verify that all pages are reachable from the homepage.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "LocalizedText"
- }
- }
- }
- },
- "TokenPagination": {
- "id": "TokenPagination",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string"
- },
- "previousPageToken": {
- "type": "string"
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "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: \n- The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). \n- 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.",
- "properties": {
- "accountIdentifier": {
- "type": "string",
- "description": "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.",
- "annotations": {
- "required": [
- "androidenterprise.users.insert"
- ]
- }
- },
- "accountType": {
- "type": "string",
- "description": "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.",
- "annotations": {
- "required": [
- "androidenterprise.users.insert"
- ]
- }
- },
- "displayName": {
- "type": "string",
- "description": "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."
- },
- "id": {
- "type": "string",
- "description": "The unique ID for the user."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#user\".",
- "default": "androidenterprise#user"
- },
- "managementType": {
- "type": "string",
- "description": "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."
- },
- "primaryEmail": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "UserToken": {
- "id": "UserToken",
- "type": "object",
- "description": "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.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#userToken\".",
- "default": "androidenterprise#userToken"
- },
- "token": {
- "type": "string",
- "description": "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."
- },
- "userId": {
- "type": "string",
- "description": "The unique ID for the user."
- }
- }
- },
- "UsersListResponse": {
- "id": "UsersListResponse",
- "type": "object",
- "description": "The matching user resources.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#usersListResponse\".",
- "default": "androidenterprise#usersListResponse"
- },
- "user": {
- "type": "array",
- "description": "A user of an enterprise.",
- "items": {
- "$ref": "User"
- }
- }
- }
- },
- "VariableSet": {
- "id": "VariableSet",
- "type": "object",
- "description": "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.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#variableSet\".",
- "default": "androidenterprise#variableSet"
- },
- "placeholder": {
- "type": "string",
- "description": "The placeholder string; defined by EMM."
- },
- "userValue": {
- "type": "string",
- "description": "The value of the placeholder, specific to the user."
- }
- }
- }
- },
- "resources": {
- "devices": {
- "methods": {
- "get": {
- "id": "androidenterprise.devices.get",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
- "httpMethod": "GET",
- "description": "Retrieves the details of a device.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "response": {
- "$ref": "Device"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getState": {
- "id": "androidenterprise.devices.getState",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "response": {
- "$ref": "DeviceState"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.devices.list",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices",
- "httpMethod": "GET",
- "description": "Retrieves the IDs of all of a user's devices.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "DevicesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.devices.patch",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
- "httpMethod": "PATCH",
- "description": "Updates the device policy. This method supports patch semantics.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "type": "string",
- "description": "Mask that identifies which fields to update. If not set, all modifiable fields will be modified.\n\nWhen set in a query parameter, this field should be specified as updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "request": {
- "$ref": "Device"
- },
- "response": {
- "$ref": "Device"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "setState": {
- "id": "androidenterprise.devices.setState",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
- "httpMethod": "PUT",
- "description": "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.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "request": {
- "$ref": "DeviceState"
- },
- "response": {
- "$ref": "DeviceState"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.devices.update",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
- "httpMethod": "PUT",
- "description": "Updates the device policy",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "type": "string",
- "description": "Mask that identifies which fields to update. If not set, all modifiable fields will be modified.\n\nWhen set in a query parameter, this field should be specified as updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "request": {
- "$ref": "Device"
- },
- "response": {
- "$ref": "Device"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "enterprises": {
- "methods": {
- "acknowledgeNotificationSet": {
- "id": "androidenterprise.enterprises.acknowledgeNotificationSet",
- "path": "enterprises/acknowledgeNotificationSet",
- "httpMethod": "POST",
- "description": "Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.",
- "parameters": {
- "notificationSetId": {
- "type": "string",
- "description": "The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided.",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "completeSignup": {
- "id": "androidenterprise.enterprises.completeSignup",
- "path": "enterprises/completeSignup",
- "httpMethod": "POST",
- "description": "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.",
- "parameters": {
- "completionToken": {
- "type": "string",
- "description": "The Completion token initially returned by GenerateSignupUrl.",
- "location": "query"
- },
- "enterpriseToken": {
- "type": "string",
- "description": "The Enterprise token appended to the Callback URL.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Enterprise"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "createWebToken": {
- "id": "androidenterprise.enterprises.createWebToken",
- "path": "enterprises/{enterpriseId}/createWebToken",
- "httpMethod": "POST",
- "description": "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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "request": {
- "$ref": "AdministratorWebTokenSpec"
- },
- "response": {
- "$ref": "AdministratorWebToken"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "delete": {
- "id": "androidenterprise.enterprises.delete",
- "path": "enterprises/{enterpriseId}",
- "httpMethod": "DELETE",
- "description": "Deletes the binding between the EMM and enterprise. This is now deprecated. Use this method only to unenroll customers that were previously enrolled with the insert call, then enroll them again with the enroll call.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "enroll": {
- "id": "androidenterprise.enterprises.enroll",
- "path": "enterprises/enroll",
- "httpMethod": "POST",
- "description": "Enrolls an enterprise with the calling EMM.",
- "parameters": {
- "token": {
- "type": "string",
- "description": "The token provided by the enterprise to register the EMM.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "token"
- ],
- "request": {
- "$ref": "Enterprise"
- },
- "response": {
- "$ref": "Enterprise"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "generateSignupUrl": {
- "id": "androidenterprise.enterprises.generateSignupUrl",
- "path": "enterprises/signupUrl",
- "httpMethod": "POST",
- "description": "Generates a sign-up URL.",
- "parameters": {
- "callbackUrl": {
- "type": "string",
- "description": "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.\nBeware 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.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SignupInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.enterprises.get",
- "path": "enterprises/{enterpriseId}",
- "httpMethod": "GET",
- "description": "Retrieves the name and domain of an enterprise.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "Enterprise"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getAndroidDevicePolicyConfig": {
- "id": "androidenterprise.enterprises.getAndroidDevicePolicyConfig",
- "path": "enterprises/{enterpriseId}/androidDevicePolicyConfig",
- "httpMethod": "GET",
- "description": "Returns the Android Device Policy config resource.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "AndroidDevicePolicyConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getServiceAccount": {
- "id": "androidenterprise.enterprises.getServiceAccount",
- "path": "enterprises/{enterpriseId}/serviceAccount",
- "httpMethod": "GET",
- "description": "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.\n\nThis method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error.\n\nSubsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials.\n\nOnce the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "keyType": {
- "type": "string",
- "description": "The type of credential to return with the service account. Required.",
- "enum": [
- "googleCredentials",
- "pkcs12"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "ServiceAccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getStoreLayout": {
- "id": "androidenterprise.enterprises.getStoreLayout",
- "path": "enterprises/{enterpriseId}/storeLayout",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "StoreLayout"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "insert": {
- "id": "androidenterprise.enterprises.insert",
- "path": "enterprises",
- "httpMethod": "POST",
- "description": "Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.",
- "parameters": {
- "token": {
- "type": "string",
- "description": "The token provided by the enterprise to register the EMM.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "token"
- ],
- "request": {
- "$ref": "Enterprise"
- },
- "response": {
- "$ref": "Enterprise"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.enterprises.list",
- "path": "enterprises",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "domain": {
- "type": "string",
- "description": "The exact primary domain name of the enterprise to look up.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "domain"
- ],
- "response": {
- "$ref": "EnterprisesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "pullNotificationSet": {
- "id": "androidenterprise.enterprises.pullNotificationSet",
- "path": "enterprises/pullNotificationSet",
- "httpMethod": "POST",
- "description": "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.\nA notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty.\nNotifications 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.\nMultiple 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.\nIf no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.",
- "parameters": {
- "requestMode": {
- "type": "string",
- "description": "The request mode for pulling notifications.\nSpecifying 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.\nSpeciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present.\nIf omitted, defaults to waitForNotifications.",
- "enum": [
- "returnImmediately",
- "waitForNotifications"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "response": {
- "$ref": "NotificationSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "sendTestPushNotification": {
- "id": "androidenterprise.enterprises.sendTestPushNotification",
- "path": "enterprises/{enterpriseId}/sendTestPushNotification",
- "httpMethod": "POST",
- "description": "Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "EnterprisesSendTestPushNotificationResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "setAccount": {
- "id": "androidenterprise.enterprises.setAccount",
- "path": "enterprises/{enterpriseId}/account",
- "httpMethod": "PUT",
- "description": "Sets the account that will be used to authenticate to the API as the enterprise.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "request": {
- "$ref": "EnterpriseAccount"
- },
- "response": {
- "$ref": "EnterpriseAccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "setAndroidDevicePolicyConfig": {
- "id": "androidenterprise.enterprises.setAndroidDevicePolicyConfig",
- "path": "enterprises/{enterpriseId}/androidDevicePolicyConfig",
- "httpMethod": "PUT",
- "description": "Sets the Android Device Policy config resource. EMM may use this method to enable or disable Android Device Policy support for the specified enterprise. To learn more about managing devices and apps with Android Device Policy, see the Android Management API.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "request": {
- "$ref": "AndroidDevicePolicyConfig"
- },
- "response": {
- "$ref": "AndroidDevicePolicyConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "setStoreLayout": {
- "id": "androidenterprise.enterprises.setStoreLayout",
- "path": "enterprises/{enterpriseId}/storeLayout",
- "httpMethod": "PUT",
- "description": "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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "request": {
- "$ref": "StoreLayout"
- },
- "response": {
- "$ref": "StoreLayout"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "unenroll": {
- "id": "androidenterprise.enterprises.unenroll",
- "path": "enterprises/{enterpriseId}/unenroll",
- "httpMethod": "POST",
- "description": "Unenrolls an enterprise from the calling EMM.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "entitlements": {
- "methods": {
- "delete": {
- "id": "androidenterprise.entitlements.delete",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- "httpMethod": "DELETE",
- "description": "Removes an entitlement to an app for a user.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "entitlementId": {
- "type": "string",
- "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "entitlementId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.entitlements.get",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- "httpMethod": "GET",
- "description": "Retrieves details of an entitlement.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "entitlementId": {
- "type": "string",
- "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "entitlementId"
- ],
- "response": {
- "$ref": "Entitlement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.entitlements.list",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements",
- "httpMethod": "GET",
- "description": "Lists all entitlements for the specified user. Only the ID is set.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "EntitlementsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.entitlements.patch",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- "httpMethod": "PATCH",
- "description": "Adds or updates an entitlement to an app for a user. This method supports patch semantics.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "entitlementId": {
- "type": "string",
- "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "install": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "entitlementId"
- ],
- "request": {
- "$ref": "Entitlement"
- },
- "response": {
- "$ref": "Entitlement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.entitlements.update",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- "httpMethod": "PUT",
- "description": "Adds or updates an entitlement to an app for a user.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "entitlementId": {
- "type": "string",
- "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "install": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "entitlementId"
- ],
- "request": {
- "$ref": "Entitlement"
- },
- "response": {
- "$ref": "Entitlement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "grouplicenses": {
- "methods": {
- "get": {
- "id": "androidenterprise.grouplicenses.get",
- "path": "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}",
- "httpMethod": "GET",
- "description": "Retrieves details of an enterprise's group license for a product.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "groupLicenseId": {
- "type": "string",
- "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "groupLicenseId"
- ],
- "response": {
- "$ref": "GroupLicense"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.grouplicenses.list",
- "path": "enterprises/{enterpriseId}/groupLicenses",
- "httpMethod": "GET",
- "description": "Retrieves IDs of all products for which the enterprise has a group license.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "GroupLicensesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "grouplicenseusers": {
- "methods": {
- "list": {
- "id": "androidenterprise.grouplicenseusers.list",
- "path": "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users",
- "httpMethod": "GET",
- "description": "Retrieves the IDs of the users who have been granted entitlements under the license.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "groupLicenseId": {
- "type": "string",
- "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "groupLicenseId"
- ],
- "response": {
- "$ref": "GroupLicenseUsersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "installs": {
- "methods": {
- "delete": {
- "id": "androidenterprise.installs.delete",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- "httpMethod": "DELETE",
- "description": "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.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "installId": {
- "type": "string",
- "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "installId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.installs.get",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- "httpMethod": "GET",
- "description": "Retrieves details of an installation of an app on a device.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "installId": {
- "type": "string",
- "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "installId"
- ],
- "response": {
- "$ref": "Install"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.installs.list",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs",
- "httpMethod": "GET",
- "description": "Retrieves the details of all apps installed on the specified device.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "response": {
- "$ref": "InstallsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.installs.patch",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- "httpMethod": "PATCH",
- "description": "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.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "installId": {
- "type": "string",
- "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "installId"
- ],
- "request": {
- "$ref": "Install"
- },
- "response": {
- "$ref": "Install"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.installs.update",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- "httpMethod": "PUT",
- "description": "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.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "installId": {
- "type": "string",
- "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "installId"
- ],
- "request": {
- "$ref": "Install"
- },
- "response": {
- "$ref": "Install"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "managedconfigurationsfordevice": {
- "methods": {
- "delete": {
- "id": "androidenterprise.managedconfigurationsfordevice.delete",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
- "httpMethod": "DELETE",
- "description": "Removes a per-device managed configuration for an app for the specified device.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "managedConfigurationForDeviceId": {
- "type": "string",
- "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "managedConfigurationForDeviceId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.managedconfigurationsfordevice.get",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
- "httpMethod": "GET",
- "description": "Retrieves details of a per-device managed configuration.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "managedConfigurationForDeviceId": {
- "type": "string",
- "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "managedConfigurationForDeviceId"
- ],
- "response": {
- "$ref": "ManagedConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.managedconfigurationsfordevice.list",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice",
- "httpMethod": "GET",
- "description": "Lists all the per-device managed configurations for the specified device. Only the ID is set.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "response": {
- "$ref": "ManagedConfigurationsForDeviceListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.managedconfigurationsfordevice.patch",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
- "httpMethod": "PATCH",
- "description": "Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "managedConfigurationForDeviceId": {
- "type": "string",
- "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "managedConfigurationForDeviceId"
- ],
- "request": {
- "$ref": "ManagedConfiguration"
- },
- "response": {
- "$ref": "ManagedConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.managedconfigurationsfordevice.update",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
- "httpMethod": "PUT",
- "description": "Adds or updates a per-device managed configuration for an app for the specified device.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "managedConfigurationForDeviceId": {
- "type": "string",
- "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "managedConfigurationForDeviceId"
- ],
- "request": {
- "$ref": "ManagedConfiguration"
- },
- "response": {
- "$ref": "ManagedConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "managedconfigurationsforuser": {
- "methods": {
- "delete": {
- "id": "androidenterprise.managedconfigurationsforuser.delete",
- "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
- "httpMethod": "DELETE",
- "description": "Removes a per-user managed configuration for an app for the specified user.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "managedConfigurationForUserId": {
- "type": "string",
- "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "managedConfigurationForUserId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.managedconfigurationsforuser.get",
- "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
- "httpMethod": "GET",
- "description": "Retrieves details of a per-user managed configuration for an app for the specified user.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "managedConfigurationForUserId": {
- "type": "string",
- "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "managedConfigurationForUserId"
- ],
- "response": {
- "$ref": "ManagedConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.managedconfigurationsforuser.list",
- "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser",
- "httpMethod": "GET",
- "description": "Lists all the per-user managed configurations for the specified user. Only the ID is set.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "ManagedConfigurationsForUserListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.managedconfigurationsforuser.patch",
- "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
- "httpMethod": "PATCH",
- "description": "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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "managedConfigurationForUserId": {
- "type": "string",
- "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "managedConfigurationForUserId"
- ],
- "request": {
- "$ref": "ManagedConfiguration"
- },
- "response": {
- "$ref": "ManagedConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.managedconfigurationsforuser.update",
- "path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
- "httpMethod": "PUT",
- "description": "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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "managedConfigurationForUserId": {
- "type": "string",
- "description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "managedConfigurationForUserId"
- ],
- "request": {
- "$ref": "ManagedConfiguration"
- },
- "response": {
- "$ref": "ManagedConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "managedconfigurationssettings": {
- "methods": {
- "list": {
- "id": "androidenterprise.managedconfigurationssettings.list",
- "path": "enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettings",
- "httpMethod": "GET",
- "description": "Lists all the managed configurations settings for the specified app. Only the ID and the name is set.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product for which the managed configurations settings applies to.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "response": {
- "$ref": "ManagedConfigurationsSettingsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "permissions": {
- "methods": {
- "get": {
- "id": "androidenterprise.permissions.get",
- "path": "permissions/{permissionId}",
- "httpMethod": "GET",
- "description": "Retrieves details of an Android app permission for display to an enterprise admin.",
- "parameters": {
- "language": {
- "type": "string",
- "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\")",
- "location": "query"
- },
- "permissionId": {
- "type": "string",
- "description": "The ID of the permission.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "permissionId"
- ],
- "response": {
- "$ref": "Permission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "products": {
- "methods": {
- "approve": {
- "id": "androidenterprise.products.approve",
- "path": "enterprises/{enterpriseId}/products/{productId}/approve",
- "httpMethod": "POST",
- "description": "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.\n\nTo 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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "request": {
- "$ref": "ProductsApproveRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "generateApprovalUrl": {
- "id": "androidenterprise.products.generateApprovalUrl",
- "path": "enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl",
- "httpMethod": "POST",
- "description": "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.\n\nAdmins 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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "languageCode": {
- "type": "string",
- "description": "The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance \"en-US\".",
- "location": "query"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "response": {
- "$ref": "ProductsGenerateApprovalUrlResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.products.get",
- "path": "enterprises/{enterpriseId}/products/{productId}",
- "httpMethod": "GET",
- "description": "Retrieves details of a product for display to an enterprise admin.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\").",
- "location": "query"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getAppRestrictionsSchema": {
- "id": "androidenterprise.products.getAppRestrictionsSchema",
- "path": "enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\").",
- "location": "query"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "response": {
- "$ref": "AppRestrictionsSchema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getPermissions": {
- "id": "androidenterprise.products.getPermissions",
- "path": "enterprises/{enterpriseId}/products/{productId}/permissions",
- "httpMethod": "GET",
- "description": "Retrieves the Android app permissions required by this app.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "response": {
- "$ref": "ProductPermissions"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.products.list",
- "path": "enterprises/{enterpriseId}/products",
- "httpMethod": "GET",
- "description": "Finds approved products that match a query, or all approved products if there is no query.",
- "parameters": {
- "approved": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "format": "uint32",
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "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).",
- "location": "query"
- },
- "token": {
- "type": "string",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "ProductsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "unapprove": {
- "id": "androidenterprise.products.unapprove",
- "path": "enterprises/{enterpriseId}/products/{productId}/unapprove",
- "httpMethod": "POST",
- "description": "Unapproves the specified product (and the relevant app permissions, if any)",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "serviceaccountkeys": {
- "methods": {
- "delete": {
- "id": "androidenterprise.serviceaccountkeys.delete",
- "path": "enterprises/{enterpriseId}/serviceAccountKeys/{keyId}",
- "httpMethod": "DELETE",
- "description": "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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "keyId": {
- "type": "string",
- "description": "The ID of the key.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "keyId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "insert": {
- "id": "androidenterprise.serviceaccountkeys.insert",
- "path": "enterprises/{enterpriseId}/serviceAccountKeys",
- "httpMethod": "POST",
- "description": "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.\n\nOnly the type of the key should be populated in the resource to be inserted.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "request": {
- "$ref": "ServiceAccountKey"
- },
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.serviceaccountkeys.list",
- "path": "enterprises/{enterpriseId}/serviceAccountKeys",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "ServiceAccountKeysListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "storelayoutclusters": {
- "methods": {
- "delete": {
- "id": "androidenterprise.storelayoutclusters.delete",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
- "httpMethod": "DELETE",
- "description": "Deletes a cluster.",
- "parameters": {
- "clusterId": {
- "type": "string",
- "description": "The ID of the cluster.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId",
- "clusterId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.storelayoutclusters.get",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
- "httpMethod": "GET",
- "description": "Retrieves details of a cluster.",
- "parameters": {
- "clusterId": {
- "type": "string",
- "description": "The ID of the cluster.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId",
- "clusterId"
- ],
- "response": {
- "$ref": "StoreCluster"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "insert": {
- "id": "androidenterprise.storelayoutclusters.insert",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters",
- "httpMethod": "POST",
- "description": "Inserts a new cluster in a page.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId"
- ],
- "request": {
- "$ref": "StoreCluster"
- },
- "response": {
- "$ref": "StoreCluster"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.storelayoutclusters.list",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters",
- "httpMethod": "GET",
- "description": "Retrieves the details of all clusters on the specified page.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId"
- ],
- "response": {
- "$ref": "StoreLayoutClustersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.storelayoutclusters.patch",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
- "httpMethod": "PATCH",
- "description": "Updates a cluster. This method supports patch semantics.",
- "parameters": {
- "clusterId": {
- "type": "string",
- "description": "The ID of the cluster.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId",
- "clusterId"
- ],
- "request": {
- "$ref": "StoreCluster"
- },
- "response": {
- "$ref": "StoreCluster"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.storelayoutclusters.update",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
- "httpMethod": "PUT",
- "description": "Updates a cluster.",
- "parameters": {
- "clusterId": {
- "type": "string",
- "description": "The ID of the cluster.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId",
- "clusterId"
- ],
- "request": {
- "$ref": "StoreCluster"
- },
- "response": {
- "$ref": "StoreCluster"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "storelayoutpages": {
- "methods": {
- "delete": {
- "id": "androidenterprise.storelayoutpages.delete",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
- "httpMethod": "DELETE",
- "description": "Deletes a store page.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.storelayoutpages.get",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
- "httpMethod": "GET",
- "description": "Retrieves details of a store page.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId"
- ],
- "response": {
- "$ref": "StorePage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "insert": {
- "id": "androidenterprise.storelayoutpages.insert",
- "path": "enterprises/{enterpriseId}/storeLayout/pages",
- "httpMethod": "POST",
- "description": "Inserts a new store page.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "request": {
- "$ref": "StorePage"
- },
- "response": {
- "$ref": "StorePage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.storelayoutpages.list",
- "path": "enterprises/{enterpriseId}/storeLayout/pages",
- "httpMethod": "GET",
- "description": "Retrieves the details of all pages in the store.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "StoreLayoutPagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.storelayoutpages.patch",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
- "httpMethod": "PATCH",
- "description": "Updates the content of a store page. This method supports patch semantics.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId"
- ],
- "request": {
- "$ref": "StorePage"
- },
- "response": {
- "$ref": "StorePage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.storelayoutpages.update",
- "path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
- "httpMethod": "PUT",
- "description": "Updates the content of a store page.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "pageId"
- ],
- "request": {
- "$ref": "StorePage"
- },
- "response": {
- "$ref": "StorePage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "delete": {
- "id": "androidenterprise.users.delete",
- "path": "enterprises/{enterpriseId}/users/{userId}",
- "httpMethod": "DELETE",
- "description": "Deleted an EMM-managed user.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "generateAuthenticationToken": {
- "id": "androidenterprise.users.generateAuthenticationToken",
- "path": "enterprises/{enterpriseId}/users/{userId}/authenticationToken",
- "httpMethod": "POST",
- "description": "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.\n\nThis call only works with EMM-managed accounts.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "AuthenticationToken"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "generateToken": {
- "id": "androidenterprise.users.generateToken",
- "path": "enterprises/{enterpriseId}/users/{userId}/token",
- "httpMethod": "POST",
- "description": "Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.\n\nThis call only works with Google managed accounts.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "UserToken"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.users.get",
- "path": "enterprises/{enterpriseId}/users/{userId}",
- "httpMethod": "GET",
- "description": "Retrieves a user's details.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getAvailableProductSet": {
- "id": "androidenterprise.users.getAvailableProductSet",
- "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
- "httpMethod": "GET",
- "description": "Retrieves the set of products a user is entitled to access.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "ProductSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "insert": {
- "id": "androidenterprise.users.insert",
- "path": "enterprises/{enterpriseId}/users",
- "httpMethod": "POST",
- "description": "Creates a new EMM-managed user.\n\nThe Users resource passed in the body of the request should include an accountIdentifier and an accountType.\nIf 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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.users.list",
- "path": "enterprises/{enterpriseId}/users",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "email": {
- "type": "string",
- "description": "The exact primary email address of the user to look up.",
- "required": true,
- "location": "query"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "email"
- ],
- "response": {
- "$ref": "UsersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.users.patch",
- "path": "enterprises/{enterpriseId}/users/{userId}",
- "httpMethod": "PATCH",
- "description": "Updates the details of an EMM-managed user.\n\nCan 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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "revokeDeviceAccess": {
- "id": "androidenterprise.users.revokeDeviceAccess",
- "path": "enterprises/{enterpriseId}/users/{userId}/deviceAccess",
- "httpMethod": "DELETE",
- "description": "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.\n\nThis call only works with EMM-managed accounts.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "revokeToken": {
- "id": "androidenterprise.users.revokeToken",
- "path": "enterprises/{enterpriseId}/users/{userId}/token",
- "httpMethod": "DELETE",
- "description": "Revokes a previously generated token (activation code) for the user.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "setAvailableProductSet": {
- "id": "androidenterprise.users.setAvailableProductSet",
- "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
- "httpMethod": "PUT",
- "description": "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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "request": {
- "$ref": "ProductSet"
- },
- "response": {
- "$ref": "ProductSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.users.update",
- "path": "enterprises/{enterpriseId}/users/{userId}",
- "httpMethod": "PUT",
- "description": "Updates the details of an EMM-managed user.\n\nCan 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.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "androidenterprise/v1/",
+ "title": "Google Play EMM API",
+ "version": "v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-gen.go b/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-gen.go
index 514def3ea..41124825e 100644
--- a/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-gen.go
+++ b/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-gen.go
@@ -1524,6 +1524,41 @@ func (s *LocalizedText) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// MaintenanceWindow: Maintenance window for managed Google Play
+// Accounts. This allows Play store to update the apps on the foreground
+// in the designated window.
+type MaintenanceWindow struct {
+ // DurationMs: Duration of the maintenance window, in milliseconds. The
+ // duration must be between 30 minutes and 24 hours (inclusive).
+ DurationMs int64 `json:"durationMs,omitempty,string"`
+
+ // StartTimeAfterMidnightMs: Start time of the maintenance window, in
+ // milliseconds after midnight on the device. Windows can span midnight.
+ StartTimeAfterMidnightMs int64 `json:"startTimeAfterMidnightMs,omitempty,string"`
+
+ // ForceSendFields is a list of field names (e.g. "DurationMs") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "DurationMs") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *MaintenanceWindow) MarshalJSON() ([]byte, error) {
+ type NoMethod MaintenanceWindow
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// ManagedConfiguration: 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
@@ -1662,6 +1697,10 @@ type ManagedConfigurationsSettings struct {
// string "androidenterprise#managedConfigurationsSettings".
Kind string `json:"kind,omitempty"`
+ // LastUpdatedTimestampMillis: The last updated time of the managed
+ // configuration settings in milliseconds since 1970-01-01T00:00:00Z.
+ LastUpdatedTimestampMillis int64 `json:"lastUpdatedTimestampMillis,omitempty,string"`
+
// ManagedProperty: The set of managed properties for this
// configuration.
ManagedProperty []*ManagedProperty `json:"managedProperty,omitempty"`
@@ -2094,6 +2133,18 @@ func (s *Permission) MarshalJSON() ([]byte, error) {
// Policy: The device policy for a given managed device.
type Policy struct {
+ // AutoUpdatePolicy: 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 `json:"autoUpdatePolicy,omitempty"`
+
+ // MaintenanceWindow: The maintenance window defining when apps running
+ // in the foreground should be updated. This feature is only supported
+ // on fully managed devices.
+ MaintenanceWindow *MaintenanceWindow `json:"maintenanceWindow,omitempty"`
+
// ProductAvailabilityPolicy: The availability granted to the device for
// the specified products. "all" gives the device access to all
// products, regardless of approval status. "allApproved" entitles the
@@ -2110,22 +2161,21 @@ type Policy struct {
// ProductPolicy: The list of product policies.
ProductPolicy []*ProductPolicy `json:"productPolicy,omitempty"`
- // ForceSendFields is a list of field names (e.g.
- // "ProductAvailabilityPolicy") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
+ // ForceSendFields is a list of field names (e.g. "AutoUpdatePolicy") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g.
- // "ProductAvailabilityPolicy") to include in API requests with the JSON
- // null value. By default, fields with empty values are omitted from API
- // requests. However, any field with an empty value appearing in
- // NullFields will be sent to the server as null. It is an error if a
- // field in this list has a non-empty value. This may be used to include
- // null fields in Patch requests.
+ // NullFields is a list of field names (e.g. "AutoUpdatePolicy") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
NullFields []string `json:"-"`
}
diff --git a/vendor/google.golang.org/api/androidmanagement/v1/androidmanagement-api.json b/vendor/google.golang.org/api/androidmanagement/v1/androidmanagement-api.json
index f5dc90632..b4cae61d3 100644
--- a/vendor/google.golang.org/api/androidmanagement/v1/androidmanagement-api.json
+++ b/vendor/google.golang.org/api/androidmanagement/v1/androidmanagement-api.json
@@ -1,5 +1,4 @@
{
- "id": "androidmanagement:v1",
"auth": {
"oauth2": {
"scopes": {
@@ -9,179 +8,220 @@
}
}
},
+ "basePath": "",
+ "baseUrl": "https://androidmanagement.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Android Management",
"description": "The Android Management API provides remote enterprise management of Android devices and apps.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/android/management",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "androidmanagement:v1",
+ "kind": "discovery#restDescription",
+ "name": "androidmanagement",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
"protocol": "rest",
- "title": "Android Management API",
"resources": {
- "signupUrls": {
+ "enterprises": {
"methods": {
"create": {
- "id": "androidmanagement.signupUrls.create",
- "response": {
- "$ref": "SignupUrl"
- },
- "parameterOrder": [],
- "description": "Creates an enterprise signup URL.",
- "flatPath": "v1/signupUrls",
+ "description": "Creates an enterprise. This is the last step in the enterprise signup flow.",
+ "flatPath": "v1/enterprises",
"httpMethod": "POST",
+ "id": "androidmanagement.enterprises.create",
+ "parameterOrder": [],
"parameters": {
- "callbackUrl": {
- "description": "The callback URL to which the admin will be redirected 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.",
+ "enterpriseToken": {
+ "description": "The enterprise token appended to the callback URL.",
"location": "query",
"type": "string"
},
"projectId": {
- "description": "The id of the Google Cloud Platform project which will own the enterprise.",
+ "description": "The ID of the Google Cloud Platform project which will own the enterprise.",
+ "location": "query",
+ "type": "string"
+ },
+ "signupUrlName": {
+ "description": "The name of the SignupUrl used to sign up for the enterprise.",
"location": "query",
"type": "string"
}
},
- "path": "v1/signupUrls",
+ "path": "v1/enterprises",
+ "request": {
+ "$ref": "Enterprise"
+ },
+ "response": {
+ "$ref": "Enterprise"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "get": {
+ "description": "Gets an enterprise.",
+ "flatPath": "v1/enterprises/{enterprisesId}",
+ "httpMethod": "GET",
+ "id": "androidmanagement.enterprises.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Enterprise"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "patch": {
+ "description": "Updates an enterprise.",
+ "flatPath": "v1/enterprises/{enterprisesId}",
+ "httpMethod": "PATCH",
+ "id": "androidmanagement.enterprises.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "The field mask indicating the fields to update. If not set, all modifiable fields will be modified.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Enterprise"
+ },
+ "response": {
+ "$ref": "Enterprise"
+ },
"scopes": [
"https://www.googleapis.com/auth/androidmanagement"
]
}
- }
- },
- "enterprises": {
+ },
"resources": {
- "policies": {
- "methods": {
- "get": {
- "id": "androidmanagement.enterprises.policies.get",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "Gets a policy.",
- "flatPath": "v1/enterprises/{enterprisesId}/policies/{policiesId}",
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}",
- "required": true,
- "pattern": "^enterprises/[^/]+/policies/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "list": {
- "id": "androidmanagement.enterprises.policies.list",
- "response": {
- "$ref": "ListPoliciesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "description": "Lists policies for a given enterprise.",
- "flatPath": "v1/enterprises/{enterprisesId}/policies",
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "The requested page size. The actual page size may be fixed to a min or max value.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "parent": {
- "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
- "required": true,
- "pattern": "^enterprises/[^/]+$",
- "location": "path",
- "type": "string"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/{+parent}/policies",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "patch": {
- "id": "androidmanagement.enterprises.policies.patch",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "Updates or creates a policy.",
- "request": {
- "$ref": "Policy"
- },
- "flatPath": "v1/enterprises/{enterprisesId}/policies/{policiesId}",
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "description": "The field mask indicating the fields to update. If not set, all modifiable fields will be modified.",
- "location": "query",
- "type": "string",
- "format": "google-fieldmask"
- },
- "name": {
- "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}",
- "required": true,
- "pattern": "^enterprises/[^/]+/policies/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "delete": {
- "id": "androidmanagement.enterprises.policies.delete",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "Deletes a policy. This operation is only permitted if no devices are currently referencing the policy.",
- "flatPath": "v1/enterprises/{enterprisesId}/policies/{policiesId}",
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}",
- "required": true,
- "pattern": "^enterprises/[^/]+/policies/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- }
- }
- },
"applications": {
"methods": {
"get": {
- "id": "androidmanagement.enterprises.applications.get",
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "name"
- ],
"description": "Gets info about an application.",
"flatPath": "v1/enterprises/{enterprisesId}/applications/{applicationsId}",
"httpMethod": "GET",
+ "id": "androidmanagement.enterprises.applications.get",
+ "parameterOrder": [
+ "name"
+ ],
"parameters": {
"languageCode": {
"description": "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.",
@@ -189,71 +229,472 @@
"type": "string"
},
"name": {
- "description": "The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}",
- "required": true,
- "pattern": "^enterprises/[^/]+/applications/[^/]+$",
+ "description": "The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}.",
"location": "path",
+ "pattern": "^enterprises/[^/]+/applications/[^/]+$",
+ "required": true,
"type": "string"
}
},
"path": "v1/{+name}",
+ "response": {
+ "$ref": "Application"
+ },
"scopes": [
"https://www.googleapis.com/auth/androidmanagement"
]
}
}
},
- "enrollmentTokens": {
+ "devices": {
"methods": {
- "create": {
- "id": "androidmanagement.enterprises.enrollmentTokens.create",
- "response": {
- "$ref": "EnrollmentToken"
+ "delete": {
+ "description": "Deletes a device. This operation wipes the device.",
+ "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}",
+ "httpMethod": "DELETE",
+ "id": "androidmanagement.enterprises.devices.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "get": {
+ "description": "Gets a device.",
+ "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}",
+ "httpMethod": "GET",
+ "id": "androidmanagement.enterprises.devices.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "issueCommand": {
+ "description": "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.",
+ "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}:issueCommand",
+ "httpMethod": "POST",
+ "id": "androidmanagement.enterprises.devices.issueCommand",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:issueCommand",
+ "request": {
+ "$ref": "Command"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "list": {
+ "description": "Lists devices for a given enterprise.",
+ "flatPath": "v1/enterprises/{enterprisesId}/devices",
+ "httpMethod": "GET",
+ "id": "androidmanagement.enterprises.devices.list",
"parameterOrder": [
"parent"
],
- "description": "Creates an enrollment token for a given enterprise.",
- "request": {
- "$ref": "EnrollmentToken"
+ "parameters": {
+ "pageSize": {
+ "description": "The requested page size. The actual page size may be fixed to a min or max value.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results returned by the server.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
},
+ "path": "v1/{+parent}/devices",
+ "response": {
+ "$ref": "ListDevicesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "patch": {
+ "description": "Updates a device.",
+ "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}",
+ "httpMethod": "PATCH",
+ "id": "androidmanagement.enterprises.devices.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "The field mask indicating the fields to update. If not set, all modifiable fields will be modified.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Device"
+ },
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "description": "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.",
+ "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}/operations/{operationsId}:cancel",
+ "httpMethod": "POST",
+ "id": "androidmanagement.enterprises.devices.operations.cancel",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/devices/[^/]+/operations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:cancel",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "delete": {
+ "description": "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.",
+ "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}/operations/{operationsId}",
+ "httpMethod": "DELETE",
+ "id": "androidmanagement.enterprises.devices.operations.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/devices/[^/]+/operations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "get": {
+ "description": "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.",
+ "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "androidmanagement.enterprises.devices.operations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/devices/[^/]+/operations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "list": {
+ "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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.",
+ "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}/operations",
+ "httpMethod": "GET",
+ "id": "androidmanagement.enterprises.devices.operations.list",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/devices/[^/]+/operations$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "enrollmentTokens": {
+ "methods": {
+ "create": {
+ "description": "Creates an enrollment token for a given enterprise.",
"flatPath": "v1/enterprises/{enterprisesId}/enrollmentTokens",
"httpMethod": "POST",
+ "id": "androidmanagement.enterprises.enrollmentTokens.create",
+ "parameterOrder": [
+ "parent"
+ ],
"parameters": {
"parent": {
- "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
- "required": true,
- "pattern": "^enterprises/[^/]+$",
+ "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
"location": "path",
+ "pattern": "^enterprises/[^/]+$",
+ "required": true,
"type": "string"
}
},
"path": "v1/{+parent}/enrollmentTokens",
+ "request": {
+ "$ref": "EnrollmentToken"
+ },
+ "response": {
+ "$ref": "EnrollmentToken"
+ },
"scopes": [
"https://www.googleapis.com/auth/androidmanagement"
]
},
"delete": {
+ "description": "Deletes an enrollment token. This operation invalidates the token, preventing its future use.",
+ "flatPath": "v1/enterprises/{enterprisesId}/enrollmentTokens/{enrollmentTokensId}",
+ "httpMethod": "DELETE",
"id": "androidmanagement.enterprises.enrollmentTokens.delete",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"name"
],
- "description": "Deletes an enrollment token, which prevents future use of the token.",
- "flatPath": "v1/enterprises/{enterprisesId}/enrollmentTokens/{enrollmentTokensId}",
- "httpMethod": "DELETE",
"parameters": {
"name": {
- "description": "The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}",
- "required": true,
- "pattern": "^enterprises/[^/]+/enrollmentTokens/[^/]+$",
+ "description": "The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.",
"location": "path",
+ "pattern": "^enterprises/[^/]+/enrollmentTokens/[^/]+$",
+ "required": true,
"type": "string"
}
},
"path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ }
+ }
+ },
+ "policies": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a policy. This operation is only permitted if no devices are currently referencing the policy.",
+ "flatPath": "v1/enterprises/{enterprisesId}/policies/{policiesId}",
+ "httpMethod": "DELETE",
+ "id": "androidmanagement.enterprises.policies.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/policies/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "get": {
+ "description": "Gets a policy.",
+ "flatPath": "v1/enterprises/{enterprisesId}/policies/{policiesId}",
+ "httpMethod": "GET",
+ "id": "androidmanagement.enterprises.policies.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/policies/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "list": {
+ "description": "Lists policies for a given enterprise.",
+ "flatPath": "v1/enterprises/{enterprisesId}/policies",
+ "httpMethod": "GET",
+ "id": "androidmanagement.enterprises.policies.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "The requested page size. The actual page size may be fixed to a min or max value.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results returned by the server.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/policies",
+ "response": {
+ "$ref": "ListPoliciesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidmanagement"
+ ]
+ },
+ "patch": {
+ "description": "Updates or creates a policy.",
+ "flatPath": "v1/enterprises/{enterprisesId}/policies/{policiesId}",
+ "httpMethod": "PATCH",
+ "id": "androidmanagement.enterprises.policies.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.",
+ "location": "path",
+ "pattern": "^enterprises/[^/]+/policies/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "The field mask indicating the fields to update. If not set, all modifiable fields will be modified.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Policy"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
"scopes": [
"https://www.googleapis.com/auth/androidmanagement"
]
@@ -263,400 +704,61 @@
"webTokens": {
"methods": {
"create": {
+ "description": "Creates a web token to access an embeddable managed Google Play web UI for a given enterprise.",
+ "flatPath": "v1/enterprises/{enterprisesId}/webTokens",
+ "httpMethod": "POST",
"id": "androidmanagement.enterprises.webTokens.create",
- "response": {
- "$ref": "WebToken"
- },
"parameterOrder": [
"parent"
],
- "description": "Creates a web token to access an embeddable managed Google Play web UI for a given enterprise.",
- "request": {
- "$ref": "WebToken"
- },
- "flatPath": "v1/enterprises/{enterprisesId}/webTokens",
- "httpMethod": "POST",
"parameters": {
"parent": {
- "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
- "required": true,
- "pattern": "^enterprises/[^/]+$",
+ "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
"location": "path",
+ "pattern": "^enterprises/[^/]+$",
+ "required": true,
"type": "string"
}
},
"path": "v1/{+parent}/webTokens",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- }
- }
- },
- "devices": {
- "resources": {
- "operations": {
- "methods": {
- "get": {
- "id": "androidmanagement.enterprises.devices.operations.get",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "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.",
- "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}/operations/{operationsId}",
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "pattern": "^enterprises/[^/]+/devices/[^/]+/operations/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "list": {
- "id": "androidmanagement.enterprises.devices.operations.list",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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.",
- "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}/operations",
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "filter": {
- "description": "The standard list filter.",
- "location": "query",
- "type": "string"
- },
- "name": {
- "description": "The name of the operation's parent resource.",
- "required": true,
- "pattern": "^enterprises/[^/]+/devices/[^/]+/operations$",
- "location": "path",
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "delete": {
- "id": "androidmanagement.enterprises.devices.operations.delete",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "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.",
- "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}/operations/{operationsId}",
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "pattern": "^enterprises/[^/]+/devices/[^/]+/operations/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "cancel": {
- "id": "androidmanagement.enterprises.devices.operations.cancel",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "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.",
- "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}/operations/{operationsId}:cancel",
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "pattern": "^enterprises/[^/]+/devices/[^/]+/operations/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}:cancel",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- }
- }
- }
- },
- "methods": {
- "get": {
- "id": "androidmanagement.enterprises.devices.get",
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "Gets a device.",
- "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}",
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}",
- "required": true,
- "pattern": "^enterprises/[^/]+/devices/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "list": {
- "id": "androidmanagement.enterprises.devices.list",
- "response": {
- "$ref": "ListDevicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "description": "Lists devices for a given enterprise.",
- "flatPath": "v1/enterprises/{enterprisesId}/devices",
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "The requested page size. The actual page size may be fixed to a min or max value.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "parent": {
- "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
- "required": true,
- "pattern": "^enterprises/[^/]+$",
- "location": "path",
- "type": "string"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/{+parent}/devices",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "issueCommand": {
- "id": "androidmanagement.enterprises.devices.issueCommand",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "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.",
"request": {
- "$ref": "Command"
+ "$ref": "WebToken"
},
- "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}:issueCommand",
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}",
- "required": true,
- "pattern": "^enterprises/[^/]+/devices/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}:issueCommand",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "patch": {
- "id": "androidmanagement.enterprises.devices.patch",
"response": {
- "$ref": "Device"
+ "$ref": "WebToken"
},
- "parameterOrder": [
- "name"
- ],
- "description": "Updates a device.",
- "request": {
- "$ref": "Device"
- },
- "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}",
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "description": "The field mask indicating the fields to update. If not set, all modifiable fields will be modified.",
- "location": "query",
- "type": "string",
- "format": "google-fieldmask"
- },
- "name": {
- "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}",
- "required": true,
- "pattern": "^enterprises/[^/]+/devices/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "delete": {
- "id": "androidmanagement.enterprises.devices.delete",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "Deletes a device, which causes the device to be wiped.",
- "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}",
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}",
- "required": true,
- "pattern": "^enterprises/[^/]+/devices/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
"scopes": [
"https://www.googleapis.com/auth/androidmanagement"
]
}
}
}
- },
+ }
+ },
+ "signupUrls": {
"methods": {
"create": {
- "id": "androidmanagement.enterprises.create",
- "response": {
- "$ref": "Enterprise"
- },
- "parameterOrder": [],
- "description": "Creates an enterprise by completing the enterprise signup flow.",
- "request": {
- "$ref": "Enterprise"
- },
- "flatPath": "v1/enterprises",
+ "description": "Creates an enterprise signup URL.",
+ "flatPath": "v1/signupUrls",
"httpMethod": "POST",
+ "id": "androidmanagement.signupUrls.create",
+ "parameterOrder": [],
"parameters": {
- "signupUrlName": {
- "description": "The name of the SignupUrl used to sign up for the enterprise.",
- "location": "query",
- "type": "string"
- },
- "enterpriseToken": {
- "description": "The enterprise token appended to the callback URL.",
+ "callbackUrl": {
+ "description": "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.",
"location": "query",
"type": "string"
},
"projectId": {
- "description": "The id of the Google Cloud Platform project which will own the enterprise.",
+ "description": "The ID of the Google Cloud Platform project which will own the enterprise.",
"location": "query",
"type": "string"
}
},
- "path": "v1/enterprises",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "get": {
- "id": "androidmanagement.enterprises.get",
+ "path": "v1/signupUrls",
"response": {
- "$ref": "Enterprise"
+ "$ref": "SignupUrl"
},
- "parameterOrder": [
- "name"
- ],
- "description": "Gets an enterprise.",
- "flatPath": "v1/enterprises/{enterprisesId}",
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
- "required": true,
- "pattern": "^enterprises/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "scopes": [
- "https://www.googleapis.com/auth/androidmanagement"
- ]
- },
- "patch": {
- "id": "androidmanagement.enterprises.patch",
- "response": {
- "$ref": "Enterprise"
- },
- "parameterOrder": [
- "name"
- ],
- "description": "Updates an enterprise.",
- "request": {
- "$ref": "Enterprise"
- },
- "flatPath": "v1/enterprises/{enterprisesId}",
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "description": "The field mask indicating the fields to update. If not set, all modifiable fields will be modified.",
- "location": "query",
- "type": "string",
- "format": "google-fieldmask"
- },
- "name": {
- "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
- "required": true,
- "pattern": "^enterprises/[^/]+$",
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
"scopes": [
"https://www.googleapis.com/auth/androidmanagement"
]
@@ -664,46 +766,293 @@
}
}
},
+ "revision": "20180320",
+ "rootUrl": "https://androidmanagement.googleapis.com/",
"schemas": {
- "Device": {
- "description": "A device owned by an enterprise. Unless otherwise noted, all fields are read-only and cannot be modified by an update device request.",
- "type": "object",
+ "AlwaysOnVpnPackage": {
+ "description": "Configuration for an always-on VPN connection.",
+ "id": "AlwaysOnVpnPackage",
"properties": {
- "userName": {
- "description": "The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.",
+ "lockdownEnabled": {
+ "description": "Disallows networking when the VPN is not connected.",
+ "type": "boolean"
+ },
+ "packageName": {
+ "description": "The package name of the VPN app.",
"type": "string"
- },
- "disabledReason": {
- "description": "If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field may be modified by an update request.",
- "$ref": "UserFacingMessage"
- },
- "policyName": {
- "description": "The name of the policy that is intended to be applied to the device. If empty, the policy_name for the user that owns this device is applied. This field may be modified by an update request. The name of the policy is in the form enterprises/{enterpriseId}/policies/{policyId}. It is also permissible to only specify the policyId when updating this field as long as the policyId contains no slashes since the rest of the policy name can be inferred from context.",
- "type": "string"
- },
- "lastPolicyComplianceReportTime": {
- "description": "The last time the device sent a policy compliance report.",
- "type": "string",
- "format": "google-datetime"
- },
- "nonComplianceDetails": {
- "description": "Details about policy settings for which the device is not in compliance.",
- "type": "array",
+ }
+ },
+ "type": "object"
+ },
+ "ApiLevelCondition": {
+ "description": "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.",
+ "id": "ApiLevelCondition",
+ "properties": {
+ "minApiLevel": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Application": {
+ "description": "Information about an app.",
+ "id": "Application",
+ "properties": {
+ "managedProperties": {
+ "description": "The set of managed properties available to be pre-configured for the app.",
"items": {
- "$ref": "NonComplianceDetail"
- }
+ "$ref": "ManagedProperty"
+ },
+ "type": "array"
},
- "lastPolicySyncTime": {
- "description": "The last time the device fetched its policy.",
- "type": "string",
- "format": "google-datetime"
+ "name": {
+ "description": "The name of the app in the form enterprises/{enterpriseId}/applications/{package_name}.",
+ "type": "string"
},
- "networkInfo": {
- "description": "Device network information. This information is only available when networkInfoEnabled is true in the device's policy.",
- "$ref": "NetworkInfo"
+ "permissions": {
+ "description": "The permissions required by the app.",
+ "items": {
+ "$ref": "ApplicationPermission"
+ },
+ "type": "array"
+ },
+ "title": {
+ "description": "The title of the app. Localized.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ApplicationPermission": {
+ "description": "A permission required by the app.",
+ "id": "ApplicationPermission",
+ "properties": {
+ "description": {
+ "description": "A longer description of the permission, providing more detail on what it affects. Localized.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the permission. Localized.",
+ "type": "string"
+ },
+ "permissionId": {
+ "description": "An opaque string uniquely identifying the permission. Not localized.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ApplicationPolicy": {
+ "description": "Policy for an individual app.",
+ "id": "ApplicationPolicy",
+ "properties": {
+ "defaultPermissionPolicy": {
+ "description": "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.",
+ "enum": [
+ "PERMISSION_POLICY_UNSPECIFIED",
+ "PROMPT",
+ "GRANT",
+ "DENY"
+ ],
+ "enumDescriptions": [
+ "Policy not specified. If no policy is specified for a permission at any level, then the PROMPT behavior is used by default.",
+ "Prompt the user to grant a permission.",
+ "Automatically grant a permission.",
+ "Automatically deny a permission."
+ ],
+ "type": "string"
+ },
+ "delegatedScopes": {
+ "description": "The scopes delegated to the app from Android Device Policy.",
+ "enumDescriptions": [
+ "No delegation scope specified.",
+ "Grants access to certificate installation and management.",
+ "Grants access to managed configurations management.",
+ "Grants access to blocking uninstallation.",
+ "Grants access to permission policy and permission grant state.",
+ "Grants access to package access state.",
+ "Grants access for enabling system apps."
+ ],
+ "items": {
+ "enum": [
+ "DELEGATED_SCOPE_UNSPECIFIED",
+ "CERT_INSTALL",
+ "MANAGED_CONFIGURATIONS",
+ "BLOCK_UNINSTALL",
+ "PERMISSION_GRANT",
+ "PACKAGE_ACCESS",
+ "ENABLE_SYSTEM_APP"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "installType": {
+ "description": "The type of installation to perform.",
+ "enum": [
+ "INSTALL_TYPE_UNSPECIFIED",
+ "PREINSTALLED",
+ "FORCE_INSTALLED"
+ ],
+ "enumDescriptions": [
+ "No automatic installation is performed. Any other app policies will be applied if the user installs the app.",
+ "The app is automatically installed and can be removed by the user.",
+ "The app is automatically installed and can't be removed by the user."
+ ],
+ "type": "string"
+ },
+ "lockTaskAllowed": {
+ "description": "Whether the app is allowed to lock itself in full-screen mode.",
+ "type": "boolean"
+ },
+ "managedConfiguration": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "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: \u003ctable\u003e \u003ctr\u003e\u003ctd\u003e\u003ci\u003etype\u003c/i\u003e\u003c/td\u003e\u003ctd\u003e\u003ci\u003eJSON value\u003c/i\u003e\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eBOOL\u003c/td\u003e\u003ctd\u003etrue or false\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eSTRING\u003c/td\u003e\u003ctd\u003estring\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eINTEGER\u003c/td\u003e\u003ctd\u003enumber\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eCHOICE\u003c/td\u003e\u003ctd\u003estring\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eMULTISELECT\u003c/td\u003e\u003ctd\u003earray of strings\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eHIDDEN\u003c/td\u003e\u003ctd\u003estring\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eBUNDLE_ARRAY\u003c/td\u003e\u003ctd\u003earray of objects\u003c/td\u003e\u003c/tr\u003e \u003c/table\u003e",
+ "type": "object"
+ },
+ "minimumVersionCode": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "packageName": {
+ "description": "The package name of the app. For example, com.google.android.youtube for the YouTube app.",
+ "type": "string"
+ },
+ "permissionGrants": {
+ "description": "Explicit permission grants or denials for the app. These values override the default_permission_policy.",
+ "items": {
+ "$ref": "PermissionGrant"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Command": {
+ "description": "A command.",
+ "id": "Command",
+ "properties": {
+ "createTime": {
+ "description": "The timestamp at which the command was created. The timestamp is automatically generated by the server.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "duration": {
+ "description": "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.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "errorCode": {
+ "description": "If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller.",
+ "enum": [
+ "COMMAND_ERROR_CODE_UNSPECIFIED",
+ "UNKNOWN",
+ "API_LEVEL",
+ "MANAGEMENT_MODE",
+ "INVALID_VALUE",
+ "UNSUPPORTED"
+ ],
+ "enumDescriptions": [
+ "There was no error.",
+ "An unknown error occurred.",
+ "The API level of the device does not support this command.",
+ "The management mode (profile owner, device owner, etc.) does not support the command.",
+ "The command has an invalid parameter value.",
+ "The device doesn't support the command. Updating Android Device Policy to the latest version may resolve the issue."
+ ],
+ "type": "string"
+ },
+ "newPassword": {
+ "description": "For commands of type RESET_PASSWORD, optionally specifies the new password.",
+ "type": "string"
+ },
+ "resetPasswordFlags": {
+ "description": "For commands of type RESET_PASSWORD, optionally specifies flags.",
+ "enumDescriptions": [
+ "This value is ignored.",
+ "Don't allow other admins to change the password again until the user has entered it.",
+ "Don't ask for user credentials on device boot.",
+ "Lock the device after password reset."
+ ],
+ "items": {
+ "enum": [
+ "RESET_PASSWORD_FLAG_UNSPECIFIED",
+ "REQUIRE_ENTRY",
+ "DO_NOT_ASK_CREDENTIALS_ON_BOOT",
+ "LOCK_NOW"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "The type of the command.",
+ "enum": [
+ "COMMAND_TYPE_UNSPECIFIED",
+ "LOCK",
+ "RESET_PASSWORD",
+ "REBOOT"
+ ],
+ "enumDescriptions": [
+ "This value is disallowed.",
+ "Lock the device, as if the lock screen timeout had expired.",
+ "Reset the user's password.",
+ "Reboot the device. Only supported on API level 24+."
+ ],
+ "type": "string"
+ },
+ "userName": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ComplianceRule": {
+ "description": "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.",
+ "id": "ComplianceRule",
+ "properties": {
+ "apiLevelCondition": {
+ "$ref": "ApiLevelCondition",
+ "description": "A condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement."
+ },
+ "disableApps": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "nonComplianceDetailCondition": {
+ "$ref": "NonComplianceDetailCondition",
+ "description": "A condition which is satisfied if there exists any matching NonComplianceDetail for the device."
+ }
+ },
+ "type": "object"
+ },
+ "Device": {
+ "description": "A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.",
+ "id": "Device",
+ "properties": {
+ "apiLevel": {
+ "description": "The API level of the Android platform version running on the device.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appliedPolicyName": {
+ "description": "The name of the policy currently applied to the device.",
+ "type": "string"
+ },
+ "appliedPolicyVersion": {
+ "description": "The version of the policy currently applied to the device.",
+ "format": "int64",
+ "type": "string"
},
"appliedState": {
- "description": "The state that is currently applied by the device.",
+ "description": "The state currently applied to the device.",
"enum": [
"DEVICE_STATE_UNSPECIFIED",
"ACTIVE",
@@ -715,126 +1064,983 @@
"This value is disallowed.",
"The device is active.",
"The device is disabled.",
- "The device was deleted. This state will never be returned by an API call, but will be used in the final policy compliance report published to Cloud Pub/Sub when the device acknowledges the deletion.",
- "The device is being provisioned. Newly enrolled devices will be in this state until they have applied policy."
+ "The device was deleted. This state will never be returned by an API call, but is used in the final policy compliance report published to Cloud Pub/Sub when the device acknowledges the deletion.",
+ "The device is being provisioned. Newly enrolled devices are in this state until they have a policy applied."
],
"type": "string"
},
+ "deviceSettings": {
+ "$ref": "DeviceSettings",
+ "description": "Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy."
+ },
+ "disabledReason": {
+ "$ref": "UserFacingMessage",
+ "description": "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."
+ },
+ "displays": {
+ "description": "Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.",
+ "items": {
+ "$ref": "Display"
+ },
+ "type": "array"
+ },
+ "enrollmentTime": {
+ "description": "The time of device enrollment.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"enrollmentTokenData": {
- "description": "If this device was enrolled with an enrollment token with additional data provided, this field contains that data.",
+ "description": "If the device was enrolled with an enrollment token with additional data provided, this field contains that data.",
"type": "string"
},
"enrollmentTokenName": {
- "description": "If this device was enrolled with an enrollment token, this field contains the name of the token.",
+ "description": "If the device was enrolled with an enrollment token, this field contains the name of the token.",
"type": "string"
},
- "memoryInfo": {
- "description": "Memory information. This information is only available when memoryInfoEnabled is true in the device's policy.",
- "$ref": "MemoryInfo"
+ "hardwareInfo": {
+ "$ref": "HardwareInfo",
+ "description": "Detailed information about the device hardware."
},
- "state": {
- "description": "The state that is intended to be applied to the device. This field may be modified by an update request. Note that UpdateDevice only handles toggling between ACTIVE and DISABLED states. Use the delete device method to cause the device to enter the DELETED state.",
- "enum": [
- "DEVICE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DISABLED",
- "DELETED",
- "PROVISIONING"
- ],
- "enumDescriptions": [
- "This value is disallowed.",
- "The device is active.",
- "The device is disabled.",
- "The device was deleted. This state will never be returned by an API call, but will be used in the final policy compliance report published to Cloud Pub/Sub when the device acknowledges the deletion.",
- "The device is being provisioned. Newly enrolled devices will be in this state until they have applied policy."
- ],
+ "hardwareStatusSamples": {
+ "description": "Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.",
+ "items": {
+ "$ref": "HardwareStatus"
+ },
+ "type": "array"
+ },
+ "lastPolicyComplianceReportTime": {
+ "description": "The last time the device sent a policy compliance report.",
+ "format": "google-datetime",
"type": "string"
},
- "softwareInfo": {
- "description": "Detailed information about the device software. This information is only available when softwareInfoEnabled is true in the device's policy.",
- "$ref": "SoftwareInfo"
+ "lastPolicySyncTime": {
+ "description": "The last time the device fetched its policy.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "lastStatusReportTime": {
+ "description": "The last time the device sent a status report.",
+ "format": "google-datetime",
+ "type": "string"
},
"memoryEvents": {
- "description": "Events related to memory and storage measurements in chronological order. This information is only available when memoryInfoEnabled is true in the device's policy.",
- "type": "array",
+ "description": "Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.",
"items": {
"$ref": "MemoryEvent"
- }
+ },
+ "type": "array"
},
- "previousDeviceNames": {
- "description": "The previous device names used for the same physical device when it has been enrolled multiple times. 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.",
- "type": "array",
+ "memoryInfo": {
+ "$ref": "MemoryInfo",
+ "description": "Memory information. This information is only available if memoryInfoEnabled is true in the device's policy."
+ },
+ "name": {
+ "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
+ "type": "string"
+ },
+ "networkInfo": {
+ "$ref": "NetworkInfo",
+ "description": "Device network information. This information is only available if networkInfoEnabled is true in the device's policy."
+ },
+ "nonComplianceDetails": {
+ "description": "Details about policy settings that the device is not compliant with.",
"items": {
- "type": "string"
- }
+ "$ref": "NonComplianceDetail"
+ },
+ "type": "array"
},
"policyCompliant": {
"description": "Whether the device is compliant with its policy.",
"type": "boolean"
},
- "lastStatusReportTime": {
- "description": "The last time the device sent a status report.",
- "type": "string",
- "format": "google-datetime"
- },
- "deviceSettings": {
- "description": "Device settings information. This information is only available when deviceSettingsEnabled is true in the device's policy.",
- "$ref": "DeviceSettings"
- },
- "name": {
- "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}",
+ "policyName": {
+ "description": "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.",
"type": "string"
},
- "hardwareStatusSamples": {
- "description": "Hardware status samples in chronological order. This information is only available when hardwareStatusEnabled is true in the device's policy.",
- "type": "array",
- "items": {
- "$ref": "HardwareStatus"
- }
- },
- "enrollmentTime": {
- "description": "The time of device enrollment.",
- "type": "string",
- "format": "google-datetime"
- },
- "appliedPolicyVersion": {
- "description": "The version of the policy that is currently applied by the device.",
- "type": "string",
- "format": "int64"
- },
- "apiLevel": {
- "description": "The API level of the Android platform version running on the device.",
- "type": "integer",
- "format": "int32"
- },
- "hardwareInfo": {
- "description": "Detailed information about the device hardware.",
- "$ref": "HardwareInfo"
- },
- "appliedPolicyName": {
- "description": "The name of the policy that is currently applied by the device.",
- "type": "string"
- },
- "displays": {
- "description": "Displays on the device. This information is only available when displayInfoEnabled is true in the device's policy.",
- "type": "array",
- "items": {
- "$ref": "Display"
- }
- },
"powerManagementEvents": {
- "description": "Power management events on the device in chronological order. This information is only available when powerManagementEventsEnabled is true in the device's policy.",
- "type": "array",
+ "description": "Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.",
"items": {
"$ref": "PowerManagementEvent"
- }
+ },
+ "type": "array"
+ },
+ "previousDeviceNames": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "softwareInfo": {
+ "$ref": "SoftwareInfo",
+ "description": "Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy."
+ },
+ "state": {
+ "description": "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.",
+ "enum": [
+ "DEVICE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DISABLED",
+ "DELETED",
+ "PROVISIONING"
+ ],
+ "enumDescriptions": [
+ "This value is disallowed.",
+ "The device is active.",
+ "The device is disabled.",
+ "The device was deleted. This state will never be returned by an API call, but is used in the final policy compliance report published to Cloud Pub/Sub when the device acknowledges the deletion.",
+ "The device is being provisioned. Newly enrolled devices are in this state until they have a policy applied."
+ ],
+ "type": "string"
+ },
+ "userName": {
+ "description": "The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.",
+ "type": "string"
}
},
- "id": "Device"
+ "type": "object"
+ },
+ "DeviceSettings": {
+ "description": "Information about security related device settings on device.",
+ "id": "DeviceSettings",
+ "properties": {
+ "adbEnabled": {
+ "description": "Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.",
+ "type": "boolean"
+ },
+ "developmentSettingsEnabled": {
+ "description": "Whether developer mode is enabled on the device.",
+ "type": "boolean"
+ },
+ "encryptionStatus": {
+ "description": "Encryption status from DevicePolicyManager.",
+ "enum": [
+ "ENCRYPTION_STATUS_UNSPECIFIED",
+ "UNSUPPORTED",
+ "INACTIVE",
+ "ACTIVATING",
+ "ACTIVE",
+ "ACTIVE_DEFAULT_KEY",
+ "ACTIVE_PER_USER"
+ ],
+ "enumDescriptions": [
+ "Unspecified. No device should have this type.",
+ "Encryption is not supported by the device.",
+ "Encryption is supported by the device, but is not currently active.",
+ "Encryption is not currently active, but is currently being activated.",
+ "Encryption is active.",
+ "Encryption is active, but an encryption key is not set by the user.",
+ "Encryption is active, and the encryption key is tied to the user profile."
+ ],
+ "type": "string"
+ },
+ "isDeviceSecure": {
+ "description": "Whether the device is secured with PIN/password.",
+ "type": "boolean"
+ },
+ "isEncrypted": {
+ "description": "Whether the storage encryption is enabled.",
+ "type": "boolean"
+ },
+ "unknownSourcesEnabled": {
+ "description": "Whether installing apps from unknown sources is enabled.",
+ "type": "boolean"
+ },
+ "verifyAppsEnabled": {
+ "description": "Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Display": {
+ "description": "Device display information.",
+ "id": "Display",
+ "properties": {
+ "density": {
+ "description": "Display density expressed as dots-per-inch.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "displayId": {
+ "description": "Unique display id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "height": {
+ "description": "Display height in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the display.",
+ "type": "string"
+ },
+ "refreshRate": {
+ "description": "Refresh rate of the display in frames per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the display.",
+ "enum": [
+ "DISPLAY_STATE_UNSPECIFIED",
+ "OFF",
+ "ON",
+ "DOZE",
+ "SUSPENDED"
+ ],
+ "enumDescriptions": [
+ "This value is disallowed.",
+ "Display is off.",
+ "Display is on.",
+ "Display is dozing in a low power state",
+ "Display is dozing in a suspended low power state."
+ ],
+ "type": "string"
+ },
+ "width": {
+ "description": "Display width in pixels.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "EnrollmentToken": {
+ "description": "An enrollment token.",
+ "id": "EnrollmentToken",
+ "properties": {
+ "additionalData": {
+ "description": "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.",
+ "type": "string"
+ },
+ "duration": {
+ "description": "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.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "expirationTimestamp": {
+ "description": "The expiration time of the token. This is a read-only field generated by the server.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.",
+ "type": "string"
+ },
+ "policyName": {
+ "description": "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.",
+ "type": "string"
+ },
+ "qrCode": {
+ "description": "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.",
+ "type": "string"
+ },
+ "value": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Enterprise": {
+ "description": "The configuration applied to an enterprise.",
+ "id": "Enterprise",
+ "properties": {
+ "appAutoApprovalEnabled": {
+ "description": "Whether permissions for apps installed via policy are automatically approved. If enabled, you must display an app's permissions to the enterprise admin before setting the app to be installed in a policy.",
+ "type": "boolean"
+ },
+ "enabledNotificationTypes": {
+ "description": "The types of Google Pub/Sub notifications enabled for the enterprise.",
+ "enumDescriptions": [
+ "This value is ignored.",
+ "A notification sent when a device enrolls.",
+ "A notification sent when a device issues a policy compliance report.",
+ "A notification sent when a device issues a status report.",
+ "A notification sent when a device command has completed."
+ ],
+ "items": {
+ "enum": [
+ "NOTIFICATION_TYPE_UNSPECIFIED",
+ "ENROLLMENT",
+ "COMPLIANCE_REPORT",
+ "STATUS_REPORT",
+ "COMMAND"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "enterpriseDisplayName": {
+ "description": "The name of the enterprise displayed to users.",
+ "type": "string"
+ },
+ "logo": {
+ "$ref": "ExternalData",
+ "description": "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."
+ },
+ "name": {
+ "description": "The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.",
+ "type": "string"
+ },
+ "primaryColor": {
+ "description": "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 \u003c\u003c 16) | (green \u003c\u003c 8) | blue, where the value of each component is between 0 and 255, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pubsubTopic": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ExternalData": {
+ "description": "Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash.",
+ "id": "ExternalData",
+ "properties": {
+ "sha256Hash": {
+ "description": "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.",
+ "type": "string"
+ },
+ "url": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HardwareInfo": {
+ "description": "Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy.",
+ "id": "HardwareInfo",
+ "properties": {
+ "batteryShutdownTemperatures": {
+ "description": "Battery shutdown temperature thresholds in Celsius for each battery on the device.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "batteryThrottlingTemperatures": {
+ "description": "Battery throttling temperature thresholds in Celsius for each battery on the device.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "brand": {
+ "description": "Brand of the device. For example, Google.",
+ "type": "string"
+ },
+ "cpuShutdownTemperatures": {
+ "description": "CPU shutdown temperature thresholds in Celsius for each CPU on the device.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "cpuThrottlingTemperatures": {
+ "description": "CPU throttling temperature thresholds in Celsius for each CPU on the device.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "deviceBasebandVersion": {
+ "description": "Baseband version. For example, MDM9625_104662.22.05.34p.",
+ "type": "string"
+ },
+ "gpuShutdownTemperatures": {
+ "description": "GPU shutdown temperature thresholds in Celsius for each GPU on the device.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "gpuThrottlingTemperatures": {
+ "description": "GPU throttling temperature thresholds in Celsius for each GPU on the device.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "hardware": {
+ "description": "Name of the hardware. For example, Angler.",
+ "type": "string"
+ },
+ "manufacturer": {
+ "description": "Manufacturer. For example, Motorola.",
+ "type": "string"
+ },
+ "model": {
+ "description": "The model of the device. For example, Asus Nexus 7.",
+ "type": "string"
+ },
+ "serialNumber": {
+ "description": "The device serial number.",
+ "type": "string"
+ },
+ "skinShutdownTemperatures": {
+ "description": "Device skin shutdown temperature thresholds in Celsius.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "skinThrottlingTemperatures": {
+ "description": "Device skin throttling temperature thresholds in Celsius.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "HardwareStatus": {
+ "description": "Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.",
+ "id": "HardwareStatus",
+ "properties": {
+ "batteryTemperatures": {
+ "description": "Current battery temperatures in Celsius for each battery on the device.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "cpuTemperatures": {
+ "description": "Current CPU temperatures in Celsius for each CPU on the device.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "cpuUsages": {
+ "description": "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.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "createTime": {
+ "description": "The time the measurements were taken.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "fanSpeeds": {
+ "description": "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.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "gpuTemperatures": {
+ "description": "Current GPU temperatures in Celsius for each GPU on the device.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "skinTemperatures": {
+ "description": "Current device skin temperatures in Celsius.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListDevicesResponse": {
+ "description": "Response to a request to list devices for a given enterprise.",
+ "id": "ListDevicesResponse",
+ "properties": {
+ "devices": {
+ "description": "The list of devices.",
+ "items": {
+ "$ref": "Device"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "If there are more results, a token to retrieve next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListPoliciesResponse": {
+ "description": "Response to a request to list policies for a given enterprise.",
+ "id": "ListPoliciesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "If there are more results, a token to retrieve next page of results.",
+ "type": "string"
+ },
+ "policies": {
+ "description": "The list of policies.",
+ "items": {
+ "$ref": "Policy"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedProperty": {
+ "description": "Managed property.",
+ "id": "ManagedProperty",
+ "properties": {
+ "defaultValue": {
+ "description": "The default value of the property. BUNDLE_ARRAY properties don't have a default value.",
+ "type": "any"
+ },
+ "description": {
+ "description": "A longer description of the property, providing more detail of what it affects. Localized.",
+ "type": "string"
+ },
+ "entries": {
+ "description": "For CHOICE or MULTISELECT properties, the list of possible entries.",
+ "items": {
+ "$ref": "ManagedPropertyEntry"
+ },
+ "type": "array"
+ },
+ "key": {
+ "description": "The unique key that the app uses to identify the property, e.g. \"com.google.android.gm.fieldname\".",
+ "type": "string"
+ },
+ "nestedProperties": {
+ "description": "For BUNDLE_ARRAY properties, the list of nested properties. A BUNDLE_ARRAY property is at most two levels deep.",
+ "items": {
+ "$ref": "ManagedProperty"
+ },
+ "type": "array"
+ },
+ "title": {
+ "description": "The name of the property. Localized.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the property.",
+ "enum": [
+ "MANAGED_PROPERTY_TYPE_UNSPECIFIED",
+ "BOOL",
+ "STRING",
+ "INTEGER",
+ "CHOICE",
+ "MULTISELECT",
+ "HIDDEN",
+ "BUNDLE_ARRAY"
+ ],
+ "enumDescriptions": [
+ "Not used.",
+ "A property of boolean type.",
+ "A property of string type.",
+ "A property of integer type.",
+ "A choice of one item from a set.",
+ "A choice of multiple items from a set.",
+ "A hidden restriction of string type (the default value can be used to pass along information that can't be modified, such as a version code).",
+ "An array of property bundles."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedPropertyEntry": {
+ "description": "An entry of a managed property.",
+ "id": "ManagedPropertyEntry",
+ "properties": {
+ "name": {
+ "description": "The human-readable name of the value. Localized.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The machine-readable value of the entry, which should be used in the configuration. Not localized.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MemoryEvent": {
+ "description": "An event related to memory and storage measurements.",
+ "id": "MemoryEvent",
+ "properties": {
+ "byteCount": {
+ "description": "The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium.",
+ "format": "int64",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "The creation time of the event.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "eventType": {
+ "description": "Event type.",
+ "enum": [
+ "MEMORY_EVENT_TYPE_UNSPECIFIED",
+ "RAM_MEASURED",
+ "INTERNAL_STORAGE_MEASURED",
+ "EXTERNAL_STORAGE_DETECTED",
+ "EXTERNAL_STORAGE_REMOVED",
+ "EXTERNAL_STORAGE_MEASURED"
+ ],
+ "enumDescriptions": [
+ "Unspecified. No events have this type.",
+ "Free space in RAM was measured.",
+ "Free space in internal storage was measured.",
+ "A new external storage medium was detected. The reported byte count is the total capacity of the storage medium.",
+ "An external storage medium was removed. The reported byte count is zero.",
+ "Free space in an external storage medium was measured."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MemoryInfo": {
+ "description": "Information about device memory and storage.",
+ "id": "MemoryInfo",
+ "properties": {
+ "totalInternalStorage": {
+ "description": "Total internal storage on device in bytes.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totalRam": {
+ "description": "Total RAM on device in bytes.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NetworkInfo": {
+ "description": "Device network info.",
+ "id": "NetworkInfo",
+ "properties": {
+ "imei": {
+ "description": "IMEI number of the GSM device. For example, A1000031212.",
+ "type": "string"
+ },
+ "meid": {
+ "description": "MEID number of the CDMA device. For example, A00000292788E1.",
+ "type": "string"
+ },
+ "networkOperatorName": {
+ "description": "Alphabetic name of current registered operator. For example, Vodafone.",
+ "type": "string"
+ },
+ "wifiMacAddress": {
+ "description": "Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NonComplianceDetail": {
+ "description": "Provides detail about non-compliance with a policy setting.",
+ "id": "NonComplianceDetail",
+ "properties": {
+ "currentValue": {
+ "description": "If the policy setting could not be applied, the current value of the setting on the device.",
+ "type": "any"
+ },
+ "fieldPath": {
+ "description": "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",
+ "type": "string"
+ },
+ "installationFailureReason": {
+ "description": "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.",
+ "enum": [
+ "INSTALLATION_FAILURE_REASON_UNSPECIFIED",
+ "INSTALLATION_FAILURE_REASON_UNKNOWN",
+ "IN_PROGRESS",
+ "NOT_FOUND",
+ "NOT_COMPATIBLE_WITH_DEVICE",
+ "NOT_APPROVED",
+ "PERMISSIONS_NOT_ACCEPTED",
+ "NOT_AVAILABLE_IN_COUNTRY",
+ "NO_LICENSES_REMAINING",
+ "NOT_ENROLLED",
+ "USER_INVALID"
+ ],
+ "enumDescriptions": [
+ "This value is disallowed.",
+ "An unknown condition is preventing the app from being installed. Some potential reasons are that the device doesn't have enough storage, the device network connection is unreliable, or the installation is taking longer than expected. The installation will be retried automatically.",
+ "The installation is still in progress.",
+ "The app was not found in Play.",
+ "The app is incompatible with the device.",
+ "The app has not been approved by the admin.",
+ "The app has new permissions that have not been accepted by the admin.",
+ "The app is not available in the user's country.",
+ "There are no licenses available to assign to the user.",
+ "The enterprise is no longer enrolled with managed Play or Android Device Policy is not enabled for the enterprise.",
+ "The user is no longer valid. The user may have been deleted or disabled."
+ ],
+ "type": "string"
+ },
+ "nonComplianceReason": {
+ "description": "The reason the device is not in compliance with the setting.",
+ "enum": [
+ "NON_COMPLIANCE_REASON_UNSPECIFIED",
+ "API_LEVEL",
+ "MANAGEMENT_MODE",
+ "USER_ACTION",
+ "INVALID_VALUE",
+ "APP_NOT_INSTALLED",
+ "UNSUPPORTED",
+ "APP_INSTALLED",
+ "PENDING",
+ "APP_INCOMPATIBLE",
+ "APP_NOT_UPDATED"
+ ],
+ "enumDescriptions": [
+ "This value is disallowed.",
+ "The setting is not supported in the API level of the Android version running on the device.",
+ "The management mode (profile owner, device owner, etc.) doesn't support the setting.",
+ "The user has not taken required action to comply with the setting.",
+ "The setting has an invalid value.",
+ "The app required to implement the policy is not installed.",
+ "The policy is not supported by the version of Android Device Policy on the device.",
+ "A blocked app is installed.",
+ "The setting hasn't been applied at the time of the report, but is expected to be applied shortly.",
+ "The setting can't be applied to the app because the app doesn't support it, for example because its target SDK version is not high enough.",
+ "The app is installed, but it hasn't been updated to the minimum version code specified by policy."
+ ],
+ "type": "string"
+ },
+ "packageName": {
+ "description": "The package name indicating which app is out of compliance, if applicable.",
+ "type": "string"
+ },
+ "settingName": {
+ "description": "The name of the policy setting. This is the JSON field name of a top-level Policy field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NonComplianceDetailCondition": {
+ "description": "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.",
+ "id": "NonComplianceDetailCondition",
+ "properties": {
+ "nonComplianceReason": {
+ "description": "The reason the device is not in compliance with the setting. If not set, then this condition matches any reason.",
+ "enum": [
+ "NON_COMPLIANCE_REASON_UNSPECIFIED",
+ "API_LEVEL",
+ "MANAGEMENT_MODE",
+ "USER_ACTION",
+ "INVALID_VALUE",
+ "APP_NOT_INSTALLED",
+ "UNSUPPORTED",
+ "APP_INSTALLED",
+ "PENDING",
+ "APP_INCOMPATIBLE",
+ "APP_NOT_UPDATED"
+ ],
+ "enumDescriptions": [
+ "This value is disallowed.",
+ "The setting is not supported in the API level of the Android version running on the device.",
+ "The management mode (profile owner, device owner, etc.) doesn't support the setting.",
+ "The user has not taken required action to comply with the setting.",
+ "The setting has an invalid value.",
+ "The app required to implement the policy is not installed.",
+ "The policy is not supported by the version of Android Device Policy on the device.",
+ "A blocked app is installed.",
+ "The setting hasn't been applied at the time of the report, but is expected to be applied shortly.",
+ "The setting can't be applied to the app because the app doesn't support it, for example because its target SDK version is not high enough.",
+ "The app is installed, but it hasn't been updated to the minimum version code specified by policy."
+ ],
+ "type": "string"
+ },
+ "packageName": {
+ "description": "The package name of the app that's out of compliance. If not set, then this condition matches any package name.",
+ "type": "string"
+ },
+ "settingName": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
+ "properties": {
+ "done": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "name": {
+ "description": "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.",
+ "type": "string"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "PackageNameList": {
+ "description": "A list of package names.",
+ "id": "PackageNameList",
+ "properties": {
+ "packageNames": {
+ "description": "A list of package names.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PasswordRequirements": {
+ "description": "Requirements for the password used to unlock a device.",
+ "id": "PasswordRequirements",
+ "properties": {
+ "maximumFailedPasswordsForWipe": {
+ "description": "Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "passwordExpirationTimeout": {
+ "description": "Password expiration timeout.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "passwordHistoryLength": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "passwordMinimumLength": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "passwordMinimumLetters": {
+ "description": "Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "passwordMinimumLowerCase": {
+ "description": "Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "passwordMinimumNonLetter": {
+ "description": "Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "passwordMinimumNumeric": {
+ "description": "Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "passwordMinimumSymbols": {
+ "description": "Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "passwordMinimumUpperCase": {
+ "description": "Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "passwordQuality": {
+ "description": "The required password quality.",
+ "enum": [
+ "PASSWORD_QUALITY_UNSPECIFIED",
+ "BIOMETRIC_WEAK",
+ "SOMETHING",
+ "NUMERIC",
+ "NUMERIC_COMPLEX",
+ "ALPHABETIC",
+ "ALPHANUMERIC",
+ "COMPLEX"
+ ],
+ "enumDescriptions": [
+ "There are no password requirements.",
+ "The device must be secured with a low-security biometric recognition technology, at minimum. This includes technologies that can recognize the identity of an individual that are roughly equivalent to a 3-digit PIN (false detection is less than 1 in 1,000).",
+ "A password is required, but there are no restrictions on what the password must contain.",
+ "The password must contain numeric characters.",
+ "The password must contain numeric characters with no repeating (4444) or ordered (1234, 4321, 2468) sequences.",
+ "The password must contain alphabetic (or symbol) characters.",
+ "The password must contain both numeric and alphabetic (or symbol) characters.",
+ "The password must contain at least a letter, a numerical digit and a special symbol. Other password constraints, for example, password_minimum_letters are enforced."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"PermissionGrant": {
"description": "Configuration for an Android permission and its grant state.",
- "type": "object",
+ "id": "PermissionGrant",
"properties": {
"permission": {
"description": "The android permission, e.g. android.permission.READ_CALENDAR.",
@@ -857,122 +2063,151 @@
"type": "string"
}
},
- "id": "PermissionGrant"
+ "type": "object"
},
- "Application": {
- "description": "Application information.",
- "type": "object",
+ "PersistentPreferredActivity": {
+ "description": "A default activity for handling intents that match a particular intent filter.",
+ "id": "PersistentPreferredActivity",
"properties": {
- "managedProperties": {
- "description": "The set of managed properties available to be pre-configured for the application.",
- "type": "array",
+ "actions": {
+ "description": "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.",
"items": {
- "$ref": "ManagedProperty"
- }
- },
- "title": {
- "description": "The title of the application. Localized.",
- "type": "string"
- },
- "permissions": {
- "description": "The permissions required by the app.",
- "type": "array",
- "items": {
- "$ref": "ApplicationPermission"
- }
- },
- "name": {
- "description": "The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}",
- "type": "string"
- }
- },
- "id": "Application"
- },
- "Status": {
- "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer",
- "format": "int32"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "message": {
- "description": "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.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "AlwaysOnVpnPackage": {
- "description": "Configuration for an always-on VPN connection.",
- "type": "object",
- "properties": {
- "packageName": {
- "description": "The package name of the VPN app.",
- "type": "string"
- },
- "lockdownEnabled": {
- "description": "Disallows networking when the VPN is not connected.",
- "type": "boolean"
- }
- },
- "id": "AlwaysOnVpnPackage"
- },
- "ApplicationPolicy": {
- "description": "Policy for an individual app.",
- "type": "object",
- "properties": {
- "lockTaskAllowed": {
- "description": "Whether the application is allowed to lock itself in full-screen mode.",
- "type": "boolean"
- },
- "permissionGrants": {
- "description": "Explicit permission grants or denials for the app. These values override the default_permission_policy.",
- "type": "array",
- "items": {
- "$ref": "PermissionGrant"
- }
- },
- "managedConfiguration": {
- "description": "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: \u003ctable\u003e \u003ctr\u003e\u003ctd\u003e\u003ci\u003etype\u003c/i\u003e\u003c/td\u003e\u003ctd\u003e\u003ci\u003eJSON value\u003c/i\u003e\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eBOOL\u003c/td\u003e\u003ctd\u003etrue or false\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eSTRING\u003c/td\u003e\u003ctd\u003estring\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eINTEGER\u003c/td\u003e\u003ctd\u003enumber\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eCHOICE\u003c/td\u003e\u003ctd\u003estring\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eMULTISELECT\u003c/td\u003e\u003ctd\u003earray of strings\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eHIDDEN\u003c/td\u003e\u003ctd\u003estring\u003c/td\u003e\u003c/tr\u003e \u003ctr\u003e\u003ctd\u003eBUNDLE_ARRAY\u003c/td\u003e\u003ctd\u003earray of objects\u003c/td\u003e\u003c/tr\u003e \u003c/table\u003e",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
+ "type": "string"
},
- "type": "object"
+ "type": "array"
},
- "packageName": {
- "description": "The package name of the app, e.g. com.google.android.youtube for the YouTube app.",
+ "categories": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "receiverActivity": {
+ "description": "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.",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Policy": {
+ "description": "A policy resources represents a group settings that govern the behavior of a managed device and the apps installed on it.",
+ "id": "Policy",
+ "properties": {
+ "accountTypesWithManagementDisabled": {
+ "description": "Account types that can't be managed by the user.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "installType": {
- "description": "The type of installation to perform.",
+ "addUserDisabled": {
+ "description": "Whether adding new users and profiles is disabled.",
+ "type": "boolean"
+ },
+ "adjustVolumeDisabled": {
+ "description": "Whether adjusting the master volume is disabled.",
+ "type": "boolean"
+ },
+ "alwaysOnVpnPackage": {
+ "$ref": "AlwaysOnVpnPackage",
+ "description": "Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting."
+ },
+ "androidDevicePolicyTracks": {
+ "description": "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.",
+ "enumDescriptions": [
+ "This value is ignored.",
+ "The production track, which provides the latest stable release.",
+ "The beta track, which provides the latest beta release."
+ ],
+ "items": {
+ "enum": [
+ "APP_TRACK_UNSPECIFIED",
+ "PRODUCTION",
+ "BETA"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "appAutoUpdatePolicy": {
+ "description": "The app auto update policy, which controls when automatic app updates can be applied.",
"enum": [
- "INSTALL_TYPE_UNSPECIFIED",
- "PREINSTALLED",
- "FORCE_INSTALLED"
+ "APP_AUTO_UPDATE_POLICY_UNSPECIFIED",
+ "CHOICE_TO_THE_USER",
+ "NEVER",
+ "WIFI_ONLY",
+ "ALWAYS"
],
"enumDescriptions": [
- "No automatic installation is performed. Any other app policies will be applied if the user installs the app.",
- "The application is automatically installed and can be removed by the user.",
- "The application is automatically installed and cannot be removed by the user."
+ "The auto-update policy is not set. Equivalent to CHOICE_TO_THE_USER.",
+ "The user can control auto-updates.",
+ "Apps are never auto-updated.",
+ "Apps are auto-updated over Wi-Fi only.",
+ "Apps are auto-updated at any time. Data charges may apply."
],
"type": "string"
},
+ "applications": {
+ "description": "Policy applied to apps.",
+ "items": {
+ "$ref": "ApplicationPolicy"
+ },
+ "type": "array"
+ },
+ "autoTimeRequired": {
+ "description": "Whether auto time is required, which prevents the user from manually setting the date and time.",
+ "type": "boolean"
+ },
+ "blockApplicationsEnabled": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "bluetoothConfigDisabled": {
+ "description": "Whether configuring bluetooth is disabled.",
+ "type": "boolean"
+ },
+ "bluetoothContactSharingDisabled": {
+ "description": "Whether bluetooth contact sharing is disabled.",
+ "type": "boolean"
+ },
+ "bluetoothDisabled": {
+ "description": "Whether bluetooth is disabled. Prefer this setting over bluetooth_config_disabled because bluetooth_config_disabled can be bypassed by the user.",
+ "type": "boolean"
+ },
+ "cameraDisabled": {
+ "description": "Whether all cameras on the device are disabled.",
+ "type": "boolean"
+ },
+ "cellBroadcastsConfigDisabled": {
+ "description": "Whether configuring cell broadcast is disabled.",
+ "type": "boolean"
+ },
+ "complianceRules": {
+ "description": "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.",
+ "items": {
+ "$ref": "ComplianceRule"
+ },
+ "type": "array"
+ },
+ "createWindowsDisabled": {
+ "description": "Whether creating windows besides app windows is disabled.",
+ "type": "boolean"
+ },
+ "credentialsConfigDisabled": {
+ "description": "Whether configuring user credentials is disabled.",
+ "type": "boolean"
+ },
+ "dataRoamingDisabled": {
+ "description": "Whether roaming data services are disabled.",
+ "type": "boolean"
+ },
+ "debuggingFeaturesAllowed": {
+ "description": "Whether the user is allowed to enable debugging features.",
+ "type": "boolean"
+ },
"defaultPermissionPolicy": {
- "description": "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.",
+ "description": "The default permission policy for runtime permission requests.",
"enum": [
"PERMISSION_POLICY_UNSPECIFIED",
"PROMPT",
@@ -986,402 +2221,54 @@
"Automatically deny a permission."
],
"type": "string"
- }
- },
- "id": "ApplicationPolicy"
- },
- "ApplicationPermission": {
- "description": "Application permission.",
- "type": "object",
- "properties": {
- "description": {
- "description": "A longer description of the permission, giving more details of what it affects. Localized.",
- "type": "string"
},
- "permissionId": {
- "description": "An opaque string uniquely identifying the permission. Not localized.",
- "type": "string"
+ "deviceOwnerLockScreenInfo": {
+ "$ref": "UserFacingMessage",
+ "description": "The device owner information to be shown on the lock screen."
},
- "name": {
- "description": "The name of the permission. Localized.",
- "type": "string"
- }
- },
- "id": "ApplicationPermission"
- },
- "ProxyInfo": {
- "description": "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.",
- "type": "object",
- "properties": {
- "host": {
- "description": "The host of the direct proxy.",
- "type": "string"
- },
- "port": {
- "description": "The port of the direct proxy.",
- "type": "integer",
- "format": "int32"
- },
- "excludedHosts": {
- "description": "For a direct proxy, the hosts for which the proxy is bypassed. The host names may contain wildcards such as *.example.com.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "pacUri": {
- "description": "The URI of the PAC script used to configure the proxy.",
- "type": "string"
- }
- },
- "id": "ProxyInfo"
- },
- "ManagedProperty": {
- "description": "Managed property.",
- "type": "object",
- "properties": {
- "nestedProperties": {
- "description": "For BUNDLE_ARRAY properties, the list of nested properties. A BUNDLE_ARRAY property is at most two levels deep.",
- "type": "array",
- "items": {
- "$ref": "ManagedProperty"
- }
- },
- "description": {
- "description": "A longer description of the property, giving more detail of what it affects. Localized.",
- "type": "string"
- },
- "defaultValue": {
- "description": "The default value of the properties. BUNDLE_ARRAY properties never have a default value.",
- "type": "any"
- },
- "title": {
- "description": "The name of the property. Localized.",
- "type": "string"
- },
- "key": {
- "description": "The unique key that the application uses to identify the property, e.g. \"com.google.android.gm.fieldname\".",
- "type": "string"
- },
- "entries": {
- "description": "For CHOICE or MULTISELECT properties, the list of possible entries.",
- "type": "array",
- "items": {
- "$ref": "ManagedPropertyEntry"
- }
- },
- "type": {
- "description": "The type of the property.",
+ "encryptionPolicy": {
+ "description": "Whether encryption is enabled",
"enum": [
- "MANAGED_PROPERTY_TYPE_UNSPECIFIED",
- "BOOL",
- "STRING",
- "INTEGER",
- "CHOICE",
- "MULTISELECT",
- "HIDDEN",
- "BUNDLE_ARRAY"
+ "ENCRYPTION_POLICY_UNSPECIFIED",
+ "ENABLED_WITHOUT_PASSWORD",
+ "ENABLED_WITH_PASSWORD"
],
"enumDescriptions": [
- "Not used.",
- "A property of boolean type.",
- "A property of string type.",
- "A property of integer type.",
- "A choice of one item from a set.",
- "A choice of multiple items from a set.",
- "A hidden restriction of string type (the default value can be used to pass along information that cannot be modified, such as a version code).",
- "An array of property bundles."
- ],
- "type": "string"
- }
- },
- "id": "ManagedProperty"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "done": {
- "description": "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.",
- "type": "boolean"
- },
- "metadata": {
- "description": "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.",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "response": {
- "description": "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.",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "name": {
- "description": "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.",
- "type": "string"
- }
- },
- "id": "Operation"
- },
- "NonComplianceDetailCondition": {
- "description": "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.",
- "type": "object",
- "properties": {
- "nonComplianceReason": {
- "description": "The reason the device is not in compliance with the setting. If not set, then this condition matches any reason.",
- "enum": [
- "NON_COMPLIANCE_REASON_UNSPECIFIED",
- "API_LEVEL",
- "ADMIN_TYPE",
- "USER_ACTION",
- "INVALID_VALUE",
- "APP_NOT_INSTALLED",
- "UNSUPPORTED",
- "APP_INSTALLED",
- "PENDING",
- "APP_INCOMPATIBLE",
- "APP_NOT_UPDATED"
- ],
- "enumDescriptions": [
- "This value is disallowed.",
- "The setting is not supported in the API level of Android OS version the device is running.",
- "The admin type (profile owner, device owner, etc.) does not support the setting.",
- "The user has not taken required action to comply with the setting.",
- "The setting has an invalid value.",
- "The application required to implement the policy is not installed.",
- "The policy is not supported by the version of Android Device Policy on the device.",
- "A blocked application is installed.",
- "The setting was not applied yet at the time of the report, but is expected to be applied shortly.",
- "The setting cannot be applied to the application because the application doesn't support it, for example because its target SDK version is not high enough.",
- "The application is installed but not updated to the minimum version code specified by policy"
+ "This value is ignored, i.e. no encryption required",
+ "Encryption required but no password required to boot",
+ "Encryption required with password required to boot"
],
"type": "string"
},
- "settingName": {
- "description": "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.",
- "type": "string"
- },
- "packageName": {
- "description": "The package name indicating which application is out of compliance. If not set, then this condition matches any package name.",
- "type": "string"
- }
- },
- "id": "NonComplianceDetailCondition"
- },
- "NonComplianceDetail": {
- "description": "Provides detail about non-compliance with a policy setting.",
- "type": "object",
- "properties": {
- "settingName": {
- "description": "The name of the policy setting. This is the JSON field name of a top-level Policy field.",
- "type": "string"
- },
- "currentValue": {
- "description": "If the policy setting could not be applied, the current value of the setting on the device.",
- "type": "any"
- },
- "packageName": {
- "description": "The package name indicating which application is out of compliance, if applicable.",
- "type": "string"
- },
- "installationFailureReason": {
- "description": "If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app cannot be installed or updated.",
- "enum": [
- "INSTALLATION_FAILURE_REASON_UNSPECIFIED",
- "INSTALLATION_FAILURE_REASON_UNKNOWN",
- "IN_PROGRESS",
- "NOT_FOUND",
- "NOT_COMPATIBLE_WITH_DEVICE",
- "NOT_APPROVED",
- "PERMISSIONS_NOT_ACCEPTED",
- "NOT_AVAILABLE_IN_COUNTRY",
- "NO_LICENSES_REMAINING",
- "NOT_ENROLLED",
- "USER_INVALID"
- ],
- "enumDescriptions": [
- "This value is disallowed.",
- "An unknown condition is preventing the app from being installed. Some potential reaons are that the device does not have enough storage, the device network connection is unreliable, or the installation is taking longer than expected. The installation will be retried automatically.",
- "The installation is still in progress.",
- "The app was not found in Play.",
- "The app is incompatible with the device.",
- "The app has not been approved by the admin.",
- "The app has new permissions that have not been accepted by the admin.",
- "The app is not available in the user's country.",
- "There are no more licenses to assign to the user.",
- "The enterprise is no longer enrolled with Play for Work or Android Device Policy is not enabled for the enterprise.",
- "The user is no longer valid. The user may have been deleted or disabled."
- ],
- "type": "string"
- },
- "fieldPath": {
- "description": "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",
- "type": "string"
- },
- "nonComplianceReason": {
- "description": "The reason the device is not in compliance with the setting.",
- "enum": [
- "NON_COMPLIANCE_REASON_UNSPECIFIED",
- "API_LEVEL",
- "ADMIN_TYPE",
- "USER_ACTION",
- "INVALID_VALUE",
- "APP_NOT_INSTALLED",
- "UNSUPPORTED",
- "APP_INSTALLED",
- "PENDING",
- "APP_INCOMPATIBLE",
- "APP_NOT_UPDATED"
- ],
- "enumDescriptions": [
- "This value is disallowed.",
- "The setting is not supported in the API level of Android OS version the device is running.",
- "The admin type (profile owner, device owner, etc.) does not support the setting.",
- "The user has not taken required action to comply with the setting.",
- "The setting has an invalid value.",
- "The application required to implement the policy is not installed.",
- "The policy is not supported by the version of Android Device Policy on the device.",
- "A blocked application is installed.",
- "The setting was not applied yet at the time of the report, but is expected to be applied shortly.",
- "The setting cannot be applied to the application because the application doesn't support it, for example because its target SDK version is not high enough.",
- "The application is installed but not updated to the minimum version code specified by policy"
- ],
- "type": "string"
- }
- },
- "id": "NonComplianceDetail"
- },
- "PackageNameList": {
- "description": "A list of package names.",
- "type": "object",
- "properties": {
- "packageNames": {
- "description": "A list of package names.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PackageNameList"
- },
- "ListDevicesResponse": {
- "description": "Response to a request to list devices for a given enterprise.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If there are more results, a token to retrieve next page of results.",
- "type": "string"
- },
- "devices": {
- "description": "The list of devices.",
- "type": "array",
- "items": {
- "$ref": "Device"
- }
- }
- },
- "id": "ListDevicesResponse"
- },
- "PersistentPreferredActivity": {
- "description": "A default activity for handling intents that match a particular intent filter.",
- "type": "object",
- "properties": {
- "receiverActivity": {
- "description": "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.",
- "type": "string"
- },
- "actions": {
- "description": "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "categories": {
- "description": "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PersistentPreferredActivity"
- },
- "Policy": {
- "description": "A policy, which governs behavior for a device.",
- "type": "object",
- "properties": {
- "outgoingCallsDisabled": {
- "description": "Whether outgoing calls are disabled.",
- "type": "boolean"
- },
- "screenCaptureDisabled": {
- "description": "Whether screen capture is disabled.",
- "type": "boolean"
- },
- "bluetoothDisabled": {
- "description": "Whether bluetooth is disabled. Prefer this setting over bluetooth_config_disabled because bluetooth_config_disabled can be bypassed by the user.",
- "type": "boolean"
- },
- "installAppsDisabled": {
- "description": "Whether user installation of apps is disabled.",
+ "ensureVerifyAppsEnabled": {
+ "description": "Whether app verification is force-enabled.",
"type": "boolean"
},
"factoryResetDisabled": {
"description": "Whether factory resetting from settings is disabled.",
"type": "boolean"
},
- "modifyAccountsDisabled": {
- "description": "Whether adding or removing accounts is disabled.",
+ "frpAdminEmails": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "funDisabled": {
+ "description": "Whether the user is allowed to have fun. Controls whether the Easter egg game in Settings is disabled.",
+ "type": "boolean"
+ },
+ "installAppsDisabled": {
+ "description": "Whether user installation of apps is disabled.",
"type": "boolean"
},
"installUnknownSourcesAllowed": {
"description": "Whether the user is allowed to enable the \"Unknown Sources\" setting, which allows installation of apps from unknown sources.",
"type": "boolean"
},
- "stayOnPluggedModes": {
- "description": "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.",
- "enumDescriptions": [
- "This value is ignored.",
- "Power source is an AC charger.",
- "Power source is a USB port.",
- "Power source is wireless."
- ],
- "type": "array",
- "items": {
- "enum": [
- "BATTERY_PLUGGED_MODE_UNSPECIFIED",
- "AC",
- "USB",
- "WIRELESS"
- ],
- "type": "string"
- }
- },
- "networkResetDisabled": {
- "description": "Whether resetting network settings is disabled.",
- "type": "boolean"
- },
- "shortSupportMessage": {
- "description": "A message displayed to the user in the settings screen wherever functionality has been disabled by the admin.",
- "$ref": "UserFacingMessage"
- },
- "wifiConfigDisabled": {
- "description": "Whether configuring WiFi access points is disabled.",
- "type": "boolean"
- },
- "networkEscapeHatchEnabled": {
- "description": "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.",
+ "keyguardDisabled": {
+ "description": "Whether the keyguard is disabled.",
"type": "boolean"
},
"keyguardDisabledFeatures": {
@@ -1396,7 +2283,6 @@
"Disable text entry into notifications on secure keyguard screens.",
"Disable all current and future keyguard customizations."
],
- "type": "array",
"items": {
"enum": [
"KEYGUARD_DISABLED_FEATURE_UNSPECIFIED",
@@ -1409,709 +2295,219 @@
"ALL_FEATURES"
],
"type": "string"
- }
+ },
+ "type": "array"
},
- "defaultPermissionPolicy": {
- "description": "The default permission policy for requests for runtime permissions.",
+ "kioskCustomLauncherEnabled": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "locationMode": {
+ "description": "The degree of location detection enabled. The user may change the value unless the user is otherwise blocked from accessing device settings.",
"enum": [
- "PERMISSION_POLICY_UNSPECIFIED",
- "PROMPT",
- "GRANT",
- "DENY"
+ "LOCATION_MODE_UNSPECIFIED",
+ "HIGH_ACCURACY",
+ "SENSORS_ONLY",
+ "BATTERY_SAVING",
+ "OFF"
],
"enumDescriptions": [
- "Policy not specified. If no policy is specified for a permission at any level, then the PROMPT behavior is used by default.",
- "Prompt the user to grant a permission.",
- "Automatically grant a permission.",
- "Automatically deny a permission."
+ "The current device value is not modified.",
+ "All location detection methods are enabled, including GPS, networks, and other sensors.",
+ "Only GPS and other sensors are enabled.",
+ "Only the network location provider is enabled.",
+ "Location detection is disabled."
],
"type": "string"
},
+ "longSupportMessage": {
+ "$ref": "UserFacingMessage",
+ "description": "A message displayed to the user in the device administators settings screen."
+ },
"maximumTimeToLock": {
- "description": "Maximum time in milliseconds for user activity until the device will lock. A value of 0 means there is no restriction.",
- "type": "string",
- "format": "int64"
- },
- "safeBootDisabled": {
- "description": "Whether rebooting the device into safe boot is disabled.",
- "type": "boolean"
- },
- "setUserIconDisabled": {
- "description": "Whether changing the user icon is disabled.",
- "type": "boolean"
- },
- "recommendedGlobalProxy": {
- "description": "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.",
- "$ref": "ProxyInfo"
- },
- "applications": {
- "description": "Policy applied to apps.",
- "type": "array",
- "items": {
- "$ref": "ApplicationPolicy"
- }
- },
- "outgoingBeamDisabled": {
- "description": "Whether using NFC to beam out data from apps is disabled.",
- "type": "boolean"
- },
- "credentialsConfigDisabled": {
- "description": "Whether configuring user credentials is disabled.",
- "type": "boolean"
- },
- "autoTimeRequired": {
- "description": "Whether auto time is required, which prevents the user from manually setting the date and time.",
- "type": "boolean"
- },
- "smsDisabled": {
- "description": "Whether sending or receiving SMS messages is disabled.",
- "type": "boolean"
- },
- "permittedInputMethods": {
- "description": "If present, only 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.",
- "$ref": "PackageNameList"
- },
- "adjustVolumeDisabled": {
- "description": "Whether adjusting the master volume is disabled.",
- "type": "boolean"
- },
- "accountTypesWithManagementDisabled": {
- "description": "Account types that cannot be managed by the user.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "vpnConfigDisabled": {
- "description": "Whether configuring VPN is disabled.",
- "type": "boolean"
- },
- "frpAdminEmails": {
- "description": "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 will not provide factory reset protection.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "alwaysOnVpnPackage": {
- "description": "Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting.",
- "$ref": "AlwaysOnVpnPackage"
- },
- "tetheringConfigDisabled": {
- "description": "Whether configuring tethering and portable hotspots is disabled.",
- "type": "boolean"
- },
- "name": {
- "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}",
+ "description": "Maximum time in milliseconds for user activity until the device locks. A value of 0 means there is no restriction.",
+ "format": "int64",
"type": "string"
},
- "uninstallAppsDisabled": {
- "description": "Whether user uninstallation of applications is disabled.",
+ "mobileNetworksConfigDisabled": {
+ "description": "Whether configuring mobile networks is disabled.",
"type": "boolean"
},
- "funDisabled": {
- "description": "Whether the user is allowed to have fun. Controls whether the Easter egg game in Settings is disabled.",
- "type": "boolean"
- },
- "openNetworkConfiguration": {
- "description": "Network configuration for the device. See configure networks for more information.",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "type": "object"
- },
- "unmuteMicrophoneDisabled": {
- "description": "Whether the microphone is muted and adjusting microphone volume is disabled.",
- "type": "boolean"
- },
- "systemUpdate": {
- "description": "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.",
- "$ref": "SystemUpdate"
- },
- "keyguardDisabled": {
- "description": "Whether the keyguard is disabled.",
+ "modifyAccountsDisabled": {
+ "description": "Whether adding or removing accounts is disabled.",
"type": "boolean"
},
"mountPhysicalMediaDisabled": {
"description": "Whether the user mounting physical external media is disabled.",
"type": "boolean"
},
- "ensureVerifyAppsEnabled": {
- "description": "Whether application verification is forced to be enabled.",
+ "name": {
+ "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.",
+ "type": "string"
+ },
+ "networkEscapeHatchEnabled": {
+ "description": "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.",
"type": "boolean"
},
- "kioskCustomLauncherEnabled": {
- "description": "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.",
+ "networkResetDisabled": {
+ "description": "Whether resetting network settings is disabled.",
"type": "boolean"
},
- "mobileNetworksConfigDisabled": {
- "description": "Whether configuring mobile networks is disabled.",
+ "openNetworkConfiguration": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Network configuration for the device. See configure networks for more information.",
+ "type": "object"
+ },
+ "outgoingBeamDisabled": {
+ "description": "Whether using NFC to beam data from apps is disabled.",
"type": "boolean"
},
- "dataRoamingDisabled": {
- "description": "Whether roaming data services are disabled.",
- "type": "boolean"
- },
- "statusBarDisabled": {
- "description": "Whether the status bar is disabled. This disables notifications, quick settings and other screen overlays that allow escape from full-screen mode.",
- "type": "boolean"
- },
- "longSupportMessage": {
- "description": "A message displayed to the user in the device administators settings screen.",
- "$ref": "UserFacingMessage"
- },
- "cameraDisabled": {
- "description": "Whether all cameras on the device are disabled.",
+ "outgoingCallsDisabled": {
+ "description": "Whether outgoing calls are disabled.",
"type": "boolean"
},
"passwordRequirements": {
- "description": "Password requirements.",
- "$ref": "PasswordRequirements"
+ "$ref": "PasswordRequirements",
+ "description": "Password requirements."
+ },
+ "permittedInputMethods": {
+ "$ref": "PackageNameList",
+ "description": "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."
+ },
+ "persistentPreferredActivities": {
+ "description": "Default intent handler activities.",
+ "items": {
+ "$ref": "PersistentPreferredActivity"
+ },
+ "type": "array"
+ },
+ "recommendedGlobalProxy": {
+ "$ref": "ProxyInfo",
+ "description": "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."
+ },
+ "removeUserDisabled": {
+ "description": "Whether removing other users is disabled.",
+ "type": "boolean"
+ },
+ "safeBootDisabled": {
+ "description": "Whether rebooting the device into safe boot is disabled.",
+ "type": "boolean"
+ },
+ "screenCaptureDisabled": {
+ "description": "Whether screen capture is disabled.",
+ "type": "boolean"
+ },
+ "setUserIconDisabled": {
+ "description": "Whether changing the user icon is disabled.",
+ "type": "boolean"
},
"setWallpaperDisabled": {
"description": "Whether changing the wallpaper is disabled.",
"type": "boolean"
},
- "version": {
- "description": "The version of the policy. This is a read-only field. The version is incremented each time the policy is updated.",
- "type": "string",
- "format": "int64"
+ "shareLocationDisabled": {
+ "description": "Whether location sharing is disabled.",
+ "type": "boolean"
},
- "complianceRules": {
- "description": "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.",
- "type": "array",
- "items": {
- "$ref": "ComplianceRule"
- }
+ "shortSupportMessage": {
+ "$ref": "UserFacingMessage",
+ "description": "A message displayed to the user in the settings screen wherever functionality has been disabled by the admin."
+ },
+ "skipFirstUseHintsEnabled": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "smsDisabled": {
+ "description": "Whether sending and receiving SMS messages is disabled.",
+ "type": "boolean"
+ },
+ "statusBarDisabled": {
+ "description": "Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode.",
+ "type": "boolean"
},
"statusReportingSettings": {
- "description": "Status reporting settings",
- "$ref": "StatusReportingSettings"
+ "$ref": "StatusReportingSettings",
+ "description": "Status reporting settings"
},
- "addUserDisabled": {
- "description": "Whether adding new users and profiles is disabled.",
+ "stayOnPluggedModes": {
+ "description": "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.",
+ "enumDescriptions": [
+ "This value is ignored.",
+ "Power source is an AC charger.",
+ "Power source is a USB port.",
+ "Power source is wireless."
+ ],
+ "items": {
+ "enum": [
+ "BATTERY_PLUGGED_MODE_UNSPECIFIED",
+ "AC",
+ "USB",
+ "WIRELESS"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "systemUpdate": {
+ "$ref": "SystemUpdate",
+ "description": "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."
+ },
+ "tetheringConfigDisabled": {
+ "description": "Whether configuring tethering and portable hotspots is disabled.",
"type": "boolean"
},
- "bluetoothContactSharingDisabled": {
- "description": "Whether bluetooth contact sharing is disabled.",
+ "uninstallAppsDisabled": {
+ "description": "Whether user uninstallation of applications is disabled.",
"type": "boolean"
},
- "bluetoothConfigDisabled": {
- "description": "Whether configuring bluetooth is disabled.",
- "type": "boolean"
- },
- "cellBroadcastsConfigDisabled": {
- "description": "Whether configuring cell broadcast is disabled.",
+ "unmuteMicrophoneDisabled": {
+ "description": "Whether the microphone is muted and adjusting microphone volume is disabled.",
"type": "boolean"
},
"usbFileTransferDisabled": {
"description": "Whether transferring files over USB is disabled.",
"type": "boolean"
},
- "removeUserDisabled": {
- "description": "Whether removing other users is disabled.",
+ "usbMassStorageEnabled": {
+ "description": "Allows admins to toggle whether USB storge is enabled or disabled on user's devices. Next ID: 113",
+ "type": "boolean"
+ },
+ "version": {
+ "description": "The version of the policy. This is a read-only field. The version is incremented each time the policy is updated.",
+ "format": "int64",
+ "type": "string"
+ },
+ "vpnConfigDisabled": {
+ "description": "Whether configuring VPN is disabled.",
+ "type": "boolean"
+ },
+ "wifiConfigDisabled": {
+ "description": "Whether configuring Wi-Fi access points is disabled.",
"type": "boolean"
},
"wifiConfigsLockdownEnabled": {
- "description": "Whether WiFi networks defined in Open Network Configuration are locked so they cannot be edited by the user.",
- "type": "boolean"
- },
- "createWindowsDisabled": {
- "description": "Whether creating windows besides app windows is disabled.",
- "type": "boolean"
- },
- "persistentPreferredActivities": {
- "description": "Default intent handler activities.",
- "type": "array",
- "items": {
- "$ref": "PersistentPreferredActivity"
- }
- },
- "blockApplicationsEnabled": {
- "description": "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.",
- "type": "boolean"
- },
- "debuggingFeaturesAllowed": {
- "description": "Whether the user is allowed to enable debugging features.",
+ "description": "Whether Wi-Fi networks defined in Open Network Configuration are locked so they can't be edited by the user.",
"type": "boolean"
}
},
- "id": "Policy"
- },
- "Command": {
- "description": "A command.",
- "type": "object",
- "properties": {
- "duration": {
- "description": "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.",
- "type": "string",
- "format": "google-duration"
- },
- "newPassword": {
- "description": "For commands of type RESET_PASSWORD, optionally specifies the new password.",
- "type": "string"
- },
- "type": {
- "description": "The type of the command.",
- "enum": [
- "COMMAND_TYPE_UNSPECIFIED",
- "LOCK",
- "RESET_PASSWORD",
- "REBOOT"
- ],
- "enumDescriptions": [
- "This value is disallowed.",
- "Lock the device, as if the lock screen timeout had expired.",
- "Reset the user's password.",
- "Reboot the device. Only supported on API level 24+."
- ],
- "type": "string"
- },
- "createTime": {
- "description": "The timestamp at which the command was created. The timestamp is automatically generated by the server.",
- "type": "string",
- "format": "google-datetime"
- },
- "resetPasswordFlags": {
- "description": "For commands of type RESET_PASSWORD, optionally specifies flags.",
- "enumDescriptions": [
- "This value is ignored.",
- "Don't allow other admins to change the password again until the user has entered it.",
- "Don't ask for user credentials on device boot.",
- "Lock the device after password reset."
- ],
- "type": "array",
- "items": {
- "enum": [
- "RESET_PASSWORD_FLAG_UNSPECIFIED",
- "REQUIRE_ENTRY",
- "DO_NOT_ASK_CREDENTIALS_ON_BOOT",
- "LOCK_NOW"
- ],
- "type": "string"
- }
- }
- },
- "id": "Command"
- },
- "ComplianceRule": {
- "description": "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.",
- "type": "object",
- "properties": {
- "nonComplianceDetailCondition": {
- "description": "A condition which is satisfied if there exists any matching NonComplianceDetail for the device.",
- "$ref": "NonComplianceDetailCondition"
- },
- "disableApps": {
- "description": "If set to true, the rule includes a mitigating action to disable applications so that the device is effectively disabled, but application 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.",
- "type": "boolean"
- },
- "apiLevelCondition": {
- "description": "A condition which is satisfied if the Android Framework API level on the device does not meet a minimum requirement.",
- "$ref": "ApiLevelCondition"
- }
- },
- "id": "ComplianceRule"
- },
- "ListPoliciesResponse": {
- "description": "Response to a request to list policies for a given enterprise.",
- "type": "object",
- "properties": {
- "policies": {
- "description": "The list of policies.",
- "type": "array",
- "items": {
- "$ref": "Policy"
- }
- },
- "nextPageToken": {
- "description": "If there are more results, a token to retrieve next page of results.",
- "type": "string"
- }
- },
- "id": "ListPoliciesResponse"
- },
- "StatusReportingSettings": {
- "description": "Settings controlling the behavior of status reports.",
- "type": "object",
- "properties": {
- "displayInfoEnabled": {
- "description": "Whether displays reporting is enabled.",
- "type": "boolean"
- },
- "hardwareStatusEnabled": {
- "description": "Whether hardware status reporting is enabled.",
- "type": "boolean"
- },
- "deviceSettingsEnabled": {
- "description": "Whether device settings reporting is enabled.",
- "type": "boolean"
- },
- "softwareInfoEnabled": {
- "description": "Whether software info reporting is enabled.",
- "type": "boolean"
- },
- "memoryInfoEnabled": {
- "description": "Whether memory info reporting is enabled.",
- "type": "boolean"
- },
- "powerManagementEventsEnabled": {
- "description": "Whether power management event reporting is enabled.",
- "type": "boolean"
- },
- "networkInfoEnabled": {
- "description": "Whether network info reporting is enabled.",
- "type": "boolean"
- }
- },
- "id": "StatusReportingSettings"
- },
- "Display": {
- "description": "Device display information.",
- "type": "object",
- "properties": {
- "refreshRate": {
- "description": "Refresh rate of the display in frames per second.",
- "type": "integer",
- "format": "int32"
- },
- "state": {
- "description": "State of the display.",
- "enum": [
- "DISPLAY_STATE_UNSPECIFIED",
- "OFF",
- "ON",
- "DOZE",
- "SUSPENDED"
- ],
- "enumDescriptions": [
- "This value is disallowed.",
- "Display is off.",
- "Display is on.",
- "Display is dozing in a low power state",
- "Display is dozing in a suspended low power state."
- ],
- "type": "string"
- },
- "width": {
- "description": "Display width in pixels.",
- "type": "integer",
- "format": "int32"
- },
- "displayId": {
- "description": "Unique display id.",
- "type": "integer",
- "format": "int32"
- },
- "name": {
- "description": "Name of the display.",
- "type": "string"
- },
- "density": {
- "description": "Display density expressed as dots-per-inch.",
- "type": "integer",
- "format": "int32"
- },
- "height": {
- "description": "Display height in pixels.",
- "type": "integer",
- "format": "int32"
- }
- },
- "id": "Display"
- },
- "SignupUrl": {
- "description": "An enterprise signup URL.",
- "type": "object",
- "properties": {
- "url": {
- "description": "A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe.",
- "type": "string"
- },
- "name": {
- "description": "The name of the resource. This must be included in the create enterprise request at the end of the signup flow.",
- "type": "string"
- }
- },
- "id": "SignupUrl"
- },
- "EnrollmentToken": {
- "description": "An enrollment token.",
- "type": "object",
- "properties": {
- "expirationTimestamp": {
- "description": "The expiration time of the token. This is a read-only field generated by the server.",
- "type": "string",
- "format": "google-datetime"
- },
- "policyName": {
- "description": "The name of the policy that will be initially applied to the enrolled device in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the user that owns the device is applied. If user_name also isn't specified, the policy defaults to enterprises/{enterpriseId}/policies/default. It is permissible to only specify the policyId when updating this field as long as the policyId contains no slashes since the rest of the policy name can be inferred from context.",
- "type": "string"
- },
- "name": {
- "description": "The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}",
- "type": "string"
- },
- "duration": {
- "description": "The duration of the token. If not specified, the duration will be 1 hour. The allowed range is 1 minute to 30 days.",
- "type": "string",
- "format": "google-duration"
- },
- "value": {
- "description": "The token value which is passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.",
- "type": "string"
- },
- "additionalData": {
- "description": "Optional, arbitrary data associated with the enrollment token. This could contain, for example, the id of an org unit to which the device is assigned 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.",
- "type": "string"
- },
- "qrCode": {
- "description": "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.",
- "type": "string"
- }
- },
- "id": "EnrollmentToken"
- },
- "SoftwareInfo": {
- "description": "Information about device software.",
- "type": "object",
- "properties": {
- "androidVersion": {
- "description": "The user visible Android version string, e.g. 6.0.1.",
- "type": "string"
- },
- "androidBuildNumber": {
- "description": "Android build Id string meant for displaying to the user, e.g. shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.",
- "type": "string"
- },
- "androidDevicePolicyVersionName": {
- "description": "The Android Device Policy app version as displayed to the user.",
- "type": "string"
- },
- "androidBuildTime": {
- "description": "Build time.",
- "type": "string",
- "format": "google-datetime"
- },
- "bootloaderVersion": {
- "description": "The system bootloader version number, e.g. 0.6.7.",
- "type": "string"
- },
- "securityPatchLevel": {
- "description": "Security patch level, e.g. 2016-05-01.",
- "type": "string"
- },
- "deviceKernelVersion": {
- "description": "Kernel version, e.g. 2.6.32.9-g103d848.",
- "type": "string"
- },
- "androidDevicePolicyVersionCode": {
- "description": "The Android Device Policy app version code.",
- "type": "integer",
- "format": "int32"
- }
- },
- "id": "SoftwareInfo"
- },
- "ManagedPropertyEntry": {
- "description": "An entry of a managed property.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The machine-readable value of the entry, which should be used in the configuration. Not localized.",
- "type": "string"
- },
- "name": {
- "description": "The human-readable name of the value. Localized.",
- "type": "string"
- }
- },
- "id": "ManagedPropertyEntry"
- },
- "WebToken": {
- "description": "A web token used to access an embeddable managed Google Play web UI.",
- "type": "object",
- "properties": {
- "value": {
- "description": "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.",
- "type": "string"
- },
- "permissions": {
- "description": "Permissions the admin may exercise in the embedded UI. The admin must have all of these permissions in order to view the UI.",
- "enumDescriptions": [
- "This value is ignored.",
- "The permission to approve apps for the enterprise."
- ],
- "type": "array",
- "items": {
- "enum": [
- "WEB_TOKEN_PERMISSION_UNSPECIFIED",
- "APPROVE_APPS"
- ],
- "type": "string"
- }
- },
- "name": {
- "description": "The name of the web token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/webTokens/{webTokenId}.",
- "type": "string"
- },
- "parentFrameUrl": {
- "description": "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.",
- "type": "string"
- }
- },
- "id": "WebToken"
- },
- "Enterprise": {
- "description": "The configuration applied to an enterprise.",
- "type": "object",
- "properties": {
- "pubsubTopic": {
- "description": "When Cloud Pub/Sub notifications are enabled, this field is required to indicate the topic to which the notifications will be published. The format of this field is projects/{project}/topics/{topic}. You must have granted the publish permission on this topic to android-cloud-policy@system.gserviceaccount.com",
- "type": "string"
- },
- "logo": {
- "description": "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.",
- "$ref": "ExternalData"
- },
- "enabledNotificationTypes": {
- "description": "The notification types to enable via Google Cloud Pub/Sub.",
- "enumDescriptions": [
- "This value is ignored.",
- "A notification sent when a device enrolls.",
- "A notification sent when a device issues a policy compliance report.",
- "A notification sent when a device issues a status report.",
- "A notification sent when a device command has completed."
- ],
- "type": "array",
- "items": {
- "enum": [
- "NOTIFICATION_TYPE_UNSPECIFIED",
- "ENROLLMENT",
- "COMPLIANCE_REPORT",
- "STATUS_REPORT",
- "COMMAND"
- ],
- "type": "string"
- }
- },
- "name": {
- "description": "The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}",
- "type": "string"
- },
- "primaryColor": {
- "description": "A color in RGB format indicating the predominant color to display in the device management app UI. The color components are stored as follows: (red \u003c\u003c 16) | (green \u003c\u003c 8) | blue, where each component may take a value between 0 and 255 inclusive.",
- "type": "integer",
- "format": "int32"
- },
- "appAutoApprovalEnabled": {
- "description": "Whether app auto-approval is enabled. When enabled, apps installed via policy for this enterprise have all permissions automatically approved. When enabled, it is the caller's responsibility to display the permissions required by an app to the enterprise admin before setting the app to be installed in a policy.",
- "type": "boolean"
- },
- "enterpriseDisplayName": {
- "description": "The name of the enterprise as it will appear to users.",
- "type": "string"
- }
- },
- "id": "Enterprise"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "MemoryEvent": {
- "description": "An event related to memory and storage measurements.",
- "type": "object",
- "properties": {
- "byteCount": {
- "description": "The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium.",
- "type": "string",
- "format": "int64"
- },
- "eventType": {
- "description": "Event type.",
- "enum": [
- "MEMORY_EVENT_TYPE_UNSPECIFIED",
- "RAM_MEASURED",
- "INTERNAL_STORAGE_MEASURED",
- "EXTERNAL_STORAGE_DETECTED",
- "EXTERNAL_STORAGE_REMOVED",
- "EXTERNAL_STORAGE_MEASURED"
- ],
- "enumDescriptions": [
- "Unspecified. No events have this type.",
- "Free space in RAM was measured.",
- "Free space in internal storage was measured.",
- "A new external storage medium was detected. The reported byte count is the total capacity of the storage medium.",
- "An external storage medium was removed. The reported byte count is zero.",
- "Free space in an external storage medium was measured."
- ],
- "type": "string"
- },
- "createTime": {
- "description": "The creation time of the event.",
- "type": "string",
- "format": "google-datetime"
- }
- },
- "id": "MemoryEvent"
- },
- "ExternalData": {
- "description": "Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The absolute URL to the data, which must use either the http or https scheme. Android Device Policy does not 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.",
- "type": "string"
- },
- "sha256Hash": {
- "description": "The base-64 encoded SHA-256 hash of the content hosted at url. If the content does not match this hash, Android Device Policy will not use the data.",
- "type": "string"
- }
- },
- "id": "ExternalData"
- },
- "UserFacingMessage": {
- "description": "Provides user facing message with locale info. The maximum message length is 4096 characters.",
- "type": "object",
- "properties": {
- "localizedMessages": {
- "description": "A map which contains \u003clocale, message\u003e pairs. The locale is a BCP 47 language code, e.g. en-US, es-ES, fr.",
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "defaultMessage": {
- "description": "The default message that gets displayed if no localized message is specified, or the user's locale does not match with any of the localized messages. A default message must be provided if any localized messages are provided.",
- "type": "string"
- }
- },
- "id": "UserFacingMessage"
+ "type": "object"
},
"PowerManagementEvent": {
"description": "A power management event.",
- "type": "object",
+ "id": "PowerManagementEvent",
"properties": {
"batteryLevel": {
"description": "For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.",
- "type": "number",
- "format": "float"
+ "format": "float",
+ "type": "number"
+ },
+ "createTime": {
+ "description": "The creation time of the event.",
+ "format": "google-datetime",
+ "type": "string"
},
"eventType": {
"description": "Event type.",
@@ -2136,302 +2532,172 @@
"The device shut down."
],
"type": "string"
- },
- "createTime": {
- "description": "The creation time of the event.",
- "type": "string",
- "format": "google-datetime"
}
},
- "id": "PowerManagementEvent"
+ "type": "object"
},
- "PasswordRequirements": {
- "description": "Requirements for the password used to unlock a device.",
- "type": "object",
+ "ProxyInfo": {
+ "description": "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.",
+ "id": "ProxyInfo",
"properties": {
- "passwordMinimumNumeric": {
- "description": "Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.",
- "type": "integer",
- "format": "int32"
+ "excludedHosts": {
+ "description": "For a direct proxy, the hosts for which the proxy is bypassed. The host names may contain wildcards such as *.example.com.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "passwordMinimumNonLetter": {
- "description": "Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.",
- "type": "integer",
- "format": "int32"
- },
- "maximumFailedPasswordsForWipe": {
- "description": "A device will be wiped after too many incorrect device-unlock passwords have been entered. A value of 0 means there is no restriction.",
- "type": "integer",
- "format": "int32"
- },
- "passwordMinimumLetters": {
- "description": "Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.",
- "type": "integer",
- "format": "int32"
- },
- "passwordMinimumUpperCase": {
- "description": "Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.",
- "type": "integer",
- "format": "int32"
- },
- "passwordQuality": {
- "description": "The required password quality.",
- "enum": [
- "PASSWORD_QUALITY_UNSPECIFIED",
- "BIOMETRIC_WEAK",
- "SOMETHING",
- "NUMERIC",
- "NUMERIC_COMPLEX",
- "ALPHABETIC",
- "ALPHANUMERIC",
- "COMPLEX"
- ],
- "enumDescriptions": [
- "There are no requirements for the password.",
- "There must be at least low-security biometric recognition technology to secure the device. This includes technologies that can recognize the identity of an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).",
- "There must be a password, but there are no restrictions on its characters.",
- "The password must contain numeric characters.",
- "The password must contain numeric characters with no repeating (4444) or ordered (1234, 4321, 2468) sequences.",
- "The password must contain alphabetic (or symbol) characters.",
- "The password must contain at both numeric and alphabetic (or symbol) characters.",
- "The password must contain at least a letter, a numerical digit and a special symbol. Other password constraints, for example, password_minimum_letters are enforced."
- ],
+ "host": {
+ "description": "The host of the direct proxy.",
"type": "string"
},
- "passwordMinimumLength": {
- "description": "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.",
- "type": "integer",
- "format": "int32"
+ "pacUri": {
+ "description": "The URI of the PAC script used to configure the proxy.",
+ "type": "string"
},
- "passwordExpirationTimeout": {
- "description": "Password expiration timeout.",
- "type": "string",
- "format": "google-duration"
- },
- "passwordMinimumSymbols": {
- "description": "Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.",
- "type": "integer",
- "format": "int32"
- },
- "passwordHistoryLength": {
- "description": "The length of the password history. After setting this, the user will not 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.",
- "type": "integer",
- "format": "int32"
- },
- "passwordMinimumLowerCase": {
- "description": "Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.",
- "type": "integer",
- "format": "int32"
+ "port": {
+ "description": "The port of the direct proxy.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "PasswordRequirements"
+ "type": "object"
},
- "HardwareInfo": {
- "description": "Information about device hardware. The fields related to temperature thresholds are only available when hardwareStatusEnabled is true in the device's policy.",
- "type": "object",
+ "SignupUrl": {
+ "description": "An enterprise signup URL.",
+ "id": "SignupUrl",
"properties": {
- "gpuThrottlingTemperatures": {
- "description": "GPU throttling temperature thresholds in Celsius for each GPU on the device.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "cpuShutdownTemperatures": {
- "description": "CPU shutdown temperature thresholds in Celsius for each CPU on the device.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "gpuShutdownTemperatures": {
- "description": "GPU shutdown temperature thresholds in Celsius for each GPU on the device.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "manufacturer": {
- "description": "Manufacturer, e.g. Motorola.",
+ "name": {
+ "description": "The name of the resource. Use this value in the signupUrl field when calling enterprises.create to complete the enterprise signup flow.",
"type": "string"
},
- "model": {
- "description": "The model of the device, e.g. Asus Nexus 7.",
- "type": "string"
- },
- "serialNumber": {
- "description": "The device serial number.",
- "type": "string"
- },
- "brand": {
- "description": "Brand of the device, e.g. Google.",
- "type": "string"
- },
- "cpuThrottlingTemperatures": {
- "description": "CPU throttling temperature thresholds in Celsius for each CPU on the device.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "skinThrottlingTemperatures": {
- "description": "Device skin throttling temperature thresholds in Celsius.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "deviceBasebandVersion": {
- "description": "Baseband version, e.g. MDM9625_104662.22.05.34p.",
- "type": "string"
- },
- "hardware": {
- "description": "Name of the hardware, e.g. Angler.",
- "type": "string"
- },
- "skinShutdownTemperatures": {
- "description": "Device skin shutdown temperature thresholds in Celsius.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "batteryShutdownTemperatures": {
- "description": "Battery shutdown temperature thresholds in Celsius for each battery on the device.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "batteryThrottlingTemperatures": {
- "description": "Battery throttling temperature thresholds in Celsius for each battery on the device.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- }
- },
- "id": "HardwareInfo"
- },
- "Empty": {
- "description": "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "NetworkInfo": {
- "description": "Device network info.",
- "type": "object",
- "properties": {
- "meid": {
- "description": "MEID number of the CDMA device, e.g. A00000292788E1.",
- "type": "string"
- },
- "wifiMacAddress": {
- "description": "WiFi MAC address of the device, e.g. 7c:11:11:11:11:11.",
- "type": "string"
- },
- "imei": {
- "description": "IMEI number of the GSM device, e.g. A1000031212.",
+ "url": {
+ "description": "A URL where an enterprise admin can register their enterprise. The page can't be rendered in an iframe.",
"type": "string"
}
},
- "id": "NetworkInfo"
+ "type": "object"
},
- "MemoryInfo": {
- "description": "Information about device memory and storage.",
- "type": "object",
+ "SoftwareInfo": {
+ "description": "Information about device software.",
+ "id": "SoftwareInfo",
"properties": {
- "totalRam": {
- "description": "Total RAM on device in bytes.",
- "type": "string",
- "format": "int64"
+ "androidBuildNumber": {
+ "description": "Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.",
+ "type": "string"
},
- "totalInternalStorage": {
- "description": "Total internal storage on device in bytes.",
- "type": "string",
- "format": "int64"
+ "androidBuildTime": {
+ "description": "Build time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "androidDevicePolicyVersionCode": {
+ "description": "The Android Device Policy app version code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "androidDevicePolicyVersionName": {
+ "description": "The Android Device Policy app version as displayed to the user.",
+ "type": "string"
+ },
+ "androidVersion": {
+ "description": "The user-visible Android version string. For example, 6.0.1.",
+ "type": "string"
+ },
+ "bootloaderVersion": {
+ "description": "The system bootloader version number, e.g. 0.6.7.",
+ "type": "string"
+ },
+ "deviceBuildSignature": {
+ "description": "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.",
+ "type": "string"
+ },
+ "deviceKernelVersion": {
+ "description": "Kernel version, for example, 2.6.32.9-g103d848.",
+ "type": "string"
+ },
+ "securityPatchLevel": {
+ "description": "Security patch level, e.g. 2016-05-01.",
+ "type": "string"
}
},
- "id": "MemoryInfo"
+ "type": "object"
},
- "ApiLevelCondition": {
- "description": "A compliance rule condition which is satisfied if the Android Framework API level on the device does not meet a minimum requirement. There can only be one rule with this type of condition per policy.",
- "type": "object",
+ "Status": {
+ "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
"properties": {
- "minApiLevel": {
- "description": "The minimum desired Android Framework API level. If the device does not meet the minimum requirement, this condition is satisfied. Must be greater than zero.",
- "type": "integer",
- "format": "int32"
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "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.",
+ "type": "string"
}
},
- "id": "ApiLevelCondition"
+ "type": "object"
},
- "DeviceSettings": {
- "description": "Information about security related device settings on device.",
- "type": "object",
+ "StatusReportingSettings": {
+ "description": "Settings controlling the behavior of status reports.",
+ "id": "StatusReportingSettings",
"properties": {
- "developmentSettingsEnabled": {
- "description": "If the developer mode is enabled Settings.Global.DEVELOPMENT_SETTINGS_ENABLED.",
+ "deviceSettingsEnabled": {
+ "description": "Whether device settings reporting is enabled.",
"type": "boolean"
},
- "adbEnabled": {
- "description": "If the ADB is enabled Settings.Global.ADB_ENABLED.",
+ "displayInfoEnabled": {
+ "description": "Whether displays reporting is enabled.",
"type": "boolean"
},
- "isDeviceSecure": {
- "description": "Device secured with PIN/password.",
+ "hardwareStatusEnabled": {
+ "description": "Whether hardware status reporting is enabled.",
"type": "boolean"
},
- "isEncrypted": {
- "description": "Whether the storage encryption is enabled DevicePolicyManager.ENCRYPTION_STATUS_ACTIVE or DevicePolicyManager.ENCRYPTION_STATUS_ACTIVE_PER_USER in N+ devices.",
+ "memoryInfoEnabled": {
+ "description": "Whether memory info reporting is enabled.",
"type": "boolean"
},
- "unknownSourcesEnabled": {
- "description": "If installing apps from unknown sources is enabled. Settings.Secure.INSTALL_NON_MARKET_APPS.",
+ "networkInfoEnabled": {
+ "description": "Whether network info reporting is enabled.",
"type": "boolean"
},
- "encryptionStatus": {
- "description": "Encryption status from DevicePolicyManager.",
- "enum": [
- "ENCRYPTION_STATUS_UNSPECIFIED",
- "UNSUPPORTED",
- "INACTIVE",
- "ACTIVATING",
- "ACTIVE",
- "ACTIVE_DEFAULT_KEY",
- "ACTIVE_PER_USER"
- ],
- "enumDescriptions": [
- "Unspecified. No device should have this type.",
- "Encryption is not supported by the device.",
- "Encryption is supported by the device, but not currently active.",
- "Encryption is not currently active, but is currently being activated.",
- "Encryption is active",
- "Encryption is active, but an encryption key is not set by the user",
- "Encrpyiton is active, and the encryption key is tied to the user profile."
- ],
- "type": "string"
+ "powerManagementEventsEnabled": {
+ "description": "Whether power management event reporting is enabled.",
+ "type": "boolean"
+ },
+ "softwareInfoEnabled": {
+ "description": "Whether software info reporting is enabled.",
+ "type": "boolean"
}
},
- "id": "DeviceSettings"
+ "type": "object"
},
"SystemUpdate": {
"description": "Configuration for managing system updates",
- "type": "object",
+ "id": "SystemUpdate",
"properties": {
+ "endMinutes": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
"startMinutes": {
- "description": "If the type is WINDOWED, the start of the maintenance window, measured as the number of minutes after midnight in device local time. This value must be between 0 and 1439, inclusive.",
- "type": "integer",
- "format": "int32"
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
},
"type": {
"description": "The type of system update to configure.",
@@ -2448,182 +2714,65 @@
"Postpone automatic install up to a maximum of 30 days."
],
"type": "string"
- },
- "endMinutes": {
- "description": "If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device 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.",
- "type": "integer",
- "format": "int32"
}
},
- "id": "SystemUpdate"
+ "type": "object"
},
- "HardwareStatus": {
- "description": "Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.",
- "type": "object",
+ "UserFacingMessage": {
+ "description": "Provides a user-facing message with locale info. The maximum message length is 4096 characters.",
+ "id": "UserFacingMessage",
"properties": {
- "fanSpeeds": {
- "description": "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.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
+ "defaultMessage": {
+ "description": "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.",
+ "type": "string"
},
- "skinTemperatures": {
- "description": "Current device skin temperatures in Celsius.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "createTime": {
- "description": "The time the measurements were taken.",
- "type": "string",
- "format": "google-datetime"
- },
- "batteryTemperatures": {
- "description": "Current battery temperatures in Celsius for each battery on the device.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "cpuTemperatures": {
- "description": "Current CPU temperatures in Celsius for each CPU on the device.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "gpuTemperatures": {
- "description": "Current GPU temperatures in Celsius for each GPU on the device.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- },
- "cpuUsages": {
- "description": "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.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
+ "localizedMessages": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A map containing \u003clocale, message\u003e 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.",
+ "type": "object"
}
},
- "id": "HardwareStatus"
+ "type": "object"
+ },
+ "WebToken": {
+ "description": "A web token used to access the managed Google Play iframe.",
+ "id": "WebToken",
+ "properties": {
+ "name": {
+ "description": "The name of the web token, which is generated by the server during creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}.",
+ "type": "string"
+ },
+ "parentFrameUrl": {
+ "description": "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.",
+ "type": "string"
+ },
+ "permissions": {
+ "description": "Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI.",
+ "enumDescriptions": [
+ "This value is ignored.",
+ "The permission to approve apps for the enterprise."
+ ],
+ "items": {
+ "enum": [
+ "WEB_TOKEN_PERMISSION_UNSPECIFIED",
+ "APPROVE_APPS"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "value": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
},
- "revision": "20180108",
- "basePath": "",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "version_module": true,
- "canonicalName": "Android Management",
- "discoveryVersion": "v1",
- "fullyEncodeReservedExpansion": true,
- "baseUrl": "https://androidmanagement.googleapis.com/",
- "name": "androidmanagement",
- "parameters": {
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "location": "query",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- }
- },
- "documentationLink": "https://developers.google.com/android/management",
- "ownerDomain": "google.com",
- "batchPath": "batch",
"servicePath": "",
- "ownerName": "Google",
+ "title": "Android Management API",
"version": "v1",
- "rootUrl": "https://androidmanagement.googleapis.com/",
- "kind": "discovery#restDescription"
-}
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/androidmanagement/v1/androidmanagement-gen.go b/vendor/google.golang.org/api/androidmanagement/v1/androidmanagement-gen.go
index c33d00f5e..3a6b6635d 100644
--- a/vendor/google.golang.org/api/androidmanagement/v1/androidmanagement-gen.go
+++ b/vendor/google.golang.org/api/androidmanagement/v1/androidmanagement-gen.go
@@ -201,12 +201,12 @@ func (s *AlwaysOnVpnPackage) MarshalJSON() ([]byte, error) {
}
// ApiLevelCondition: A compliance rule condition which is satisfied if
-// the Android Framework API level on the device does not meet a minimum
+// 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.
type ApiLevelCondition struct {
// MinApiLevel: The minimum desired Android Framework API level. If the
- // device does not meet the minimum requirement, this condition is
+ // device doesn't meet the minimum requirement, this condition is
// satisfied. Must be greater than zero.
MinApiLevel int64 `json:"minApiLevel,omitempty"`
@@ -233,20 +233,20 @@ func (s *ApiLevelCondition) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Application: Application information.
+// Application: Information about an app.
type Application struct {
// ManagedProperties: The set of managed properties available to be
- // pre-configured for the application.
+ // pre-configured for the app.
ManagedProperties []*ManagedProperty `json:"managedProperties,omitempty"`
- // Name: The name of the application in the form
- // enterprises/{enterpriseId}/applications/{package_name}
+ // Name: The name of the app in the form
+ // enterprises/{enterpriseId}/applications/{package_name}.
Name string `json:"name,omitempty"`
// Permissions: The permissions required by the app.
Permissions []*ApplicationPermission `json:"permissions,omitempty"`
- // Title: The title of the application. Localized.
+ // Title: The title of the app. Localized.
Title string `json:"title,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -277,10 +277,10 @@ func (s *Application) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// ApplicationPermission: Application permission.
+// ApplicationPermission: A permission required by the app.
type ApplicationPermission struct {
- // Description: A longer description of the permission, giving more
- // details of what it affects. Localized.
+ // Description: A longer description of the permission, providing more
+ // detail on what it affects. Localized.
Description string `json:"description,omitempty"`
// Name: The name of the permission. Localized.
@@ -328,19 +328,35 @@ type ApplicationPolicy struct {
// "DENY" - Automatically deny a permission.
DefaultPermissionPolicy string `json:"defaultPermissionPolicy,omitempty"`
+ // DelegatedScopes: The scopes delegated to the app from Android Device
+ // Policy.
+ //
+ // Possible values:
+ // "DELEGATED_SCOPE_UNSPECIFIED" - No delegation scope specified.
+ // "CERT_INSTALL" - Grants access to certificate installation and
+ // management.
+ // "MANAGED_CONFIGURATIONS" - Grants access to managed configurations
+ // management.
+ // "BLOCK_UNINSTALL" - Grants access to blocking uninstallation.
+ // "PERMISSION_GRANT" - Grants access to permission policy and
+ // permission grant state.
+ // "PACKAGE_ACCESS" - Grants access to package access state.
+ // "ENABLE_SYSTEM_APP" - Grants access for enabling system apps.
+ DelegatedScopes []string `json:"delegatedScopes,omitempty"`
+
// InstallType: The type of installation to perform.
//
// Possible values:
// "INSTALL_TYPE_UNSPECIFIED" - No automatic installation is
// performed. Any other app policies will be applied if the user
// installs the app.
- // "PREINSTALLED" - The application is automatically installed and can
- // be removed by the user.
- // "FORCE_INSTALLED" - The application is automatically installed and
- // cannot be removed by the user.
+ // "PREINSTALLED" - The app is automatically installed and can be
+ // removed by the user.
+ // "FORCE_INSTALLED" - The app is automatically installed and can't be
+ // removed by the user.
InstallType string `json:"installType,omitempty"`
- // LockTaskAllowed: Whether the application is allowed to lock itself in
+ // LockTaskAllowed: Whether the app is allowed to lock itself in
// full-screen mode.
LockTaskAllowed bool `json:"lockTaskAllowed,omitempty"`
@@ -359,7 +375,16 @@ type ApplicationPolicy struct {
// | BUNDLE_ARRAY | array of objects |
ManagedConfiguration googleapi.RawMessage `json:"managedConfiguration,omitempty"`
- // PackageName: The package name of the app, e.g.
+ // MinimumVersionCode: 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 int64 `json:"minimumVersionCode,omitempty"`
+
+ // PackageName: The package name of the app. For example,
// com.google.android.youtube for the YouTube app.
PackageName string `json:"packageName,omitempty"`
@@ -404,6 +429,21 @@ type Command struct {
// duration.
Duration string `json:"duration,omitempty"`
+ // ErrorCode: If the command failed, an error code explaining the
+ // failure. This is not set when the command is cancelled by the caller.
+ //
+ // Possible values:
+ // "COMMAND_ERROR_CODE_UNSPECIFIED" - There was no error.
+ // "UNKNOWN" - An unknown error occurred.
+ // "API_LEVEL" - The API level of the device does not support this
+ // command.
+ // "MANAGEMENT_MODE" - The management mode (profile owner, device
+ // owner, etc.) does not support the command.
+ // "INVALID_VALUE" - The command has an invalid parameter value.
+ // "UNSUPPORTED" - The device doesn't support the command. Updating
+ // Android Device Policy to the latest version may resolve the issue.
+ ErrorCode string `json:"errorCode,omitempty"`
+
// NewPassword: For commands of type RESET_PASSWORD, optionally
// specifies the new password.
NewPassword string `json:"newPassword,omitempty"`
@@ -430,6 +470,11 @@ type Command struct {
// "REBOOT" - Reboot the device. Only supported on API level 24+.
Type string `json:"type,omitempty"`
+ // UserName: 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 `json:"userName,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -462,15 +507,14 @@ func (s *Command) MarshalJSON() ([]byte, error) {
// field values in the rule.
type ComplianceRule struct {
// ApiLevelCondition: A condition which is satisfied if the Android
- // Framework API level on the device does not meet a minimum
- // requirement.
+ // Framework API level on the device doesn't meet a minimum requirement.
ApiLevelCondition *ApiLevelCondition `json:"apiLevelCondition,omitempty"`
// DisableApps: If set to true, the rule includes a mitigating action to
- // disable applications so that the device is effectively disabled, but
- // application 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.
+ // 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 bool `json:"disableApps,omitempty"`
// NonComplianceDetailCondition: A condition which is satisfied if there
@@ -502,56 +546,57 @@ func (s *ComplianceRule) MarshalJSON() ([]byte, error) {
}
// Device: A device owned by an enterprise. Unless otherwise noted, all
-// fields are read-only and cannot be modified by an update device
-// request.
+// fields are read-only and can't be modified by
+// enterprises.devices.patch.
type Device struct {
// ApiLevel: The API level of the Android platform version running on
// the device.
ApiLevel int64 `json:"apiLevel,omitempty"`
- // AppliedPolicyName: The name of the policy that is currently applied
- // by the device.
+ // AppliedPolicyName: The name of the policy currently applied to the
+ // device.
AppliedPolicyName string `json:"appliedPolicyName,omitempty"`
- // AppliedPolicyVersion: The version of the policy that is currently
- // applied by the device.
+ // AppliedPolicyVersion: The version of the policy currently applied to
+ // the device.
AppliedPolicyVersion int64 `json:"appliedPolicyVersion,omitempty,string"`
- // AppliedState: The state that is currently applied by the device.
+ // AppliedState: The state currently applied to the device.
//
// Possible values:
// "DEVICE_STATE_UNSPECIFIED" - This value is disallowed.
// "ACTIVE" - The device is active.
// "DISABLED" - The device is disabled.
// "DELETED" - The device was deleted. This state will never be
- // returned by an API call, but will be used in the final policy
- // compliance report published to Cloud Pub/Sub when the device
- // acknowledges the deletion.
+ // returned by an API call, but is used in the final policy compliance
+ // report published to Cloud Pub/Sub when the device acknowledges the
+ // deletion.
// "PROVISIONING" - The device is being provisioned. Newly enrolled
- // devices will be in this state until they have applied policy.
+ // devices are in this state until they have a policy applied.
AppliedState string `json:"appliedState,omitempty"`
// DeviceSettings: Device settings information. This information is only
- // available when deviceSettingsEnabled is true in the device's policy.
+ // available if deviceSettingsEnabled is true in the device's policy.
DeviceSettings *DeviceSettings `json:"deviceSettings,omitempty"`
// DisabledReason: If the device state is DISABLED, an optional message
// that is displayed on the device indicating the reason the device is
- // disabled. This field may be modified by an update request.
+ // disabled. This field can be modified by a patch request.
DisabledReason *UserFacingMessage `json:"disabledReason,omitempty"`
- // Displays: Displays on the device. This information is only available
- // when displayInfoEnabled is true in the device's policy.
+ // Displays: Detailed information about displays on the device. This
+ // information is only available if displayInfoEnabled is true in the
+ // device's policy.
Displays []*Display `json:"displays,omitempty"`
// EnrollmentTime: The time of device enrollment.
EnrollmentTime string `json:"enrollmentTime,omitempty"`
- // EnrollmentTokenData: If this device was enrolled with an enrollment
+ // EnrollmentTokenData: If the device was enrolled with an enrollment
// token with additional data provided, this field contains that data.
EnrollmentTokenData string `json:"enrollmentTokenData,omitempty"`
- // EnrollmentTokenName: If this device was enrolled with an enrollment
+ // EnrollmentTokenName: If the device was enrolled with an enrollment
// token, this field contains the name of the token.
EnrollmentTokenName string `json:"enrollmentTokenName,omitempty"`
@@ -559,8 +604,8 @@ type Device struct {
HardwareInfo *HardwareInfo `json:"hardwareInfo,omitempty"`
// HardwareStatusSamples: Hardware status samples in chronological
- // order. This information is only available when hardwareStatusEnabled
- // is true in the device's policy.
+ // order. This information is only available if hardwareStatusEnabled is
+ // true in the device's policy.
HardwareStatusSamples []*HardwareStatus `json:"hardwareStatusSamples,omitempty"`
// LastPolicyComplianceReportTime: The last time the device sent a
@@ -574,71 +619,70 @@ type Device struct {
LastStatusReportTime string `json:"lastStatusReportTime,omitempty"`
// MemoryEvents: Events related to memory and storage measurements in
- // chronological order. This information is only available when
+ // chronological order. This information is only available if
// memoryInfoEnabled is true in the device's policy.
MemoryEvents []*MemoryEvent `json:"memoryEvents,omitempty"`
- // MemoryInfo: Memory information. This information is only available
- // when memoryInfoEnabled is true in the device's policy.
+ // MemoryInfo: Memory information. This information is only available if
+ // memoryInfoEnabled is true in the device's policy.
MemoryInfo *MemoryInfo `json:"memoryInfo,omitempty"`
// Name: The name of the device in the form
- // enterprises/{enterpriseId}/devices/{deviceId}
+ // enterprises/{enterpriseId}/devices/{deviceId}.
Name string `json:"name,omitempty"`
// NetworkInfo: Device network information. This information is only
- // available when networkInfoEnabled is true in the device's policy.
+ // available if networkInfoEnabled is true in the device's policy.
NetworkInfo *NetworkInfo `json:"networkInfo,omitempty"`
- // NonComplianceDetails: Details about policy settings for which the
- // device is not in compliance.
+ // NonComplianceDetails: Details about policy settings that the device
+ // is not compliant with.
NonComplianceDetails []*NonComplianceDetail `json:"nonComplianceDetails,omitempty"`
// PolicyCompliant: Whether the device is compliant with its policy.
PolicyCompliant bool `json:"policyCompliant,omitempty"`
- // PolicyName: The name of the policy that is intended to be applied to
- // the device. If empty, the policy_name for the user that owns this
- // device is applied. This field may be modified by an update request.
- // The name of the policy is in the form
- // enterprises/{enterpriseId}/policies/{policyId}. It is also
- // permissible to only specify the policyId when updating this field as
- // long as the policyId contains no slashes since the rest of the policy
- // name can be inferred from context.
+ // PolicyName: 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 `json:"policyName,omitempty"`
// PowerManagementEvents: Power management events on the device in
- // chronological order. This information is only available when
+ // chronological order. This information is only available if
// powerManagementEventsEnabled is true in the device's policy.
PowerManagementEvents []*PowerManagementEvent `json:"powerManagementEvents,omitempty"`
- // PreviousDeviceNames: The previous device names used for the same
- // physical device when it has been enrolled multiple times. The serial
- // number is used as the unique identifier to determine if the same
- // physical device has enrolled previously. The names are in
+ // PreviousDeviceNames: 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 `json:"previousDeviceNames,omitempty"`
// SoftwareInfo: Detailed information about the device software. This
- // information is only available when softwareInfoEnabled is true in the
+ // information is only available if softwareInfoEnabled is true in the
// device's policy.
SoftwareInfo *SoftwareInfo `json:"softwareInfo,omitempty"`
- // State: The state that is intended to be applied to the device. This
- // field may be modified by an update request. Note that UpdateDevice
- // only handles toggling between ACTIVE and DISABLED states. Use the
- // delete device method to cause the device to enter the DELETED state.
+ // State: 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.
//
// Possible values:
// "DEVICE_STATE_UNSPECIFIED" - This value is disallowed.
// "ACTIVE" - The device is active.
// "DISABLED" - The device is disabled.
// "DELETED" - The device was deleted. This state will never be
- // returned by an API call, but will be used in the final policy
- // compliance report published to Cloud Pub/Sub when the device
- // acknowledges the deletion.
+ // returned by an API call, but is used in the final policy compliance
+ // report published to Cloud Pub/Sub when the device acknowledges the
+ // deletion.
// "PROVISIONING" - The device is being provisioned. Newly enrolled
- // devices will be in this state until they have applied policy.
+ // devices are in this state until they have a policy applied.
State string `json:"state,omitempty"`
// UserName: The resource name of the user that owns this device in the
@@ -675,11 +719,13 @@ func (s *Device) MarshalJSON() ([]byte, error) {
// DeviceSettings: Information about security related device settings on
// device.
type DeviceSettings struct {
- // AdbEnabled: If the ADB is enabled Settings.Global.ADB_ENABLED.
+ // AdbEnabled: Whether ADB
+ // (https://developer.android.com/studio/command-line/adb.html) is
+ // enabled on the device.
AdbEnabled bool `json:"adbEnabled,omitempty"`
- // DevelopmentSettingsEnabled: If the developer mode is enabled
- // Settings.Global.DEVELOPMENT_SETTINGS_ENABLED.
+ // DevelopmentSettingsEnabled: Whether developer mode is enabled on the
+ // device.
DevelopmentSettingsEnabled bool `json:"developmentSettingsEnabled,omitempty"`
// EncryptionStatus: Encryption status from DevicePolicyManager.
@@ -688,29 +734,32 @@ type DeviceSettings struct {
// "ENCRYPTION_STATUS_UNSPECIFIED" - Unspecified. No device should
// have this type.
// "UNSUPPORTED" - Encryption is not supported by the device.
- // "INACTIVE" - Encryption is supported by the device, but not
+ // "INACTIVE" - Encryption is supported by the device, but is not
// currently active.
// "ACTIVATING" - Encryption is not currently active, but is currently
// being activated.
- // "ACTIVE" - Encryption is active
+ // "ACTIVE" - Encryption is active.
// "ACTIVE_DEFAULT_KEY" - Encryption is active, but an encryption key
- // is not set by the user
- // "ACTIVE_PER_USER" - Encrpyiton is active, and the encryption key is
+ // is not set by the user.
+ // "ACTIVE_PER_USER" - Encryption is active, and the encryption key is
// tied to the user profile.
EncryptionStatus string `json:"encryptionStatus,omitempty"`
- // IsDeviceSecure: Device secured with PIN/password.
+ // IsDeviceSecure: Whether the device is secured with PIN/password.
IsDeviceSecure bool `json:"isDeviceSecure,omitempty"`
- // IsEncrypted: Whether the storage encryption is enabled
- // DevicePolicyManager.ENCRYPTION_STATUS_ACTIVE or
- // DevicePolicyManager.ENCRYPTION_STATUS_ACTIVE_PER_USER in N+ devices.
+ // IsEncrypted: Whether the storage encryption is enabled.
IsEncrypted bool `json:"isEncrypted,omitempty"`
- // UnknownSourcesEnabled: If installing apps from unknown sources is
- // enabled. Settings.Secure.INSTALL_NON_MARKET_APPS.
+ // UnknownSourcesEnabled: Whether installing apps from unknown sources
+ // is enabled.
UnknownSourcesEnabled bool `json:"unknownSourcesEnabled,omitempty"`
+ // VerifyAppsEnabled: Whether Verify Apps (Google Play Protect
+ // (https://support.google.com/googleplay/answer/2812853)) is enabled on
+ // the device.
+ VerifyAppsEnabled bool `json:"verifyAppsEnabled,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "AdbEnabled") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -805,15 +854,16 @@ type Empty struct {
// EnrollmentToken: An enrollment token.
type EnrollmentToken struct {
// AdditionalData: Optional, arbitrary data associated with the
- // enrollment token. This could contain, for example, the id of an org
- // unit to which the device is assigned after enrollment. After a device
+ // 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 `json:"additionalData,omitempty"`
- // Duration: The duration of the token. If not specified, the duration
- // will be 1 hour. The allowed range is 1 minute to 30 days.
+ // Duration: 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 `json:"duration,omitempty"`
// ExpirationTimestamp: The expiration time of the token. This is a
@@ -822,18 +872,17 @@ type EnrollmentToken struct {
// Name: The name of the enrollment token, which is generated by the
// server during creation, in the form
- // enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}
+ // enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
Name string `json:"name,omitempty"`
- // PolicyName: The name of the policy that will be initially applied to
- // the enrolled device in the form
- // enterprises/{enterpriseId}/policies/{policyId}. If not specified, the
- // policy_name for the user that owns the device is applied. If
- // user_name also isn't specified, the policy defaults to
- // enterprises/{enterpriseId}/policies/default. It is permissible to
- // only specify the policyId when updating this field as long as the
- // policyId contains no slashes since the rest of the policy name can be
- // inferred from context.
+ // PolicyName: 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 `json:"policyName,omitempty"`
// QrCode: A JSON string whose UTF-8 representation can be used to
@@ -842,9 +891,8 @@ type EnrollmentToken struct {
// java.util.Properties representation of the properties in the JSON.
QrCode string `json:"qrCode,omitempty"`
- // Value: The token value which is passed to the device and authorizes
- // the device to enroll. This is a read-only field generated by the
- // server.
+ // Value: 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 `json:"value,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -877,15 +925,14 @@ func (s *EnrollmentToken) MarshalJSON() ([]byte, error) {
// Enterprise: The configuration applied to an enterprise.
type Enterprise struct {
- // AppAutoApprovalEnabled: Whether app auto-approval is enabled. When
- // enabled, apps installed via policy for this enterprise have all
- // permissions automatically approved. When enabled, it is the caller's
- // responsibility to display the permissions required by an app to the
- // enterprise admin before setting the app to be installed in a policy.
+ // AppAutoApprovalEnabled: Whether permissions for apps installed via
+ // policy are automatically approved. If enabled, you must display an
+ // app's permissions to the enterprise admin before setting the app to
+ // be installed in a policy.
AppAutoApprovalEnabled bool `json:"appAutoApprovalEnabled,omitempty"`
- // EnabledNotificationTypes: The notification types to enable via Google
- // Cloud Pub/Sub.
+ // EnabledNotificationTypes: The types of Google Pub/Sub notifications
+ // enabled for the enterprise.
//
// Possible values:
// "NOTIFICATION_TYPE_UNSPECIFIED" - This value is ignored.
@@ -898,8 +945,7 @@ type Enterprise struct {
// completed.
EnabledNotificationTypes []string `json:"enabledNotificationTypes,omitempty"`
- // EnterpriseDisplayName: The name of the enterprise as it will appear
- // to users.
+ // EnterpriseDisplayName: The name of the enterprise displayed to users.
EnterpriseDisplayName string `json:"enterpriseDisplayName,omitempty"`
// Logo: An image displayed as a logo during device provisioning.
@@ -908,21 +954,18 @@ type Enterprise struct {
Logo *ExternalData `json:"logo,omitempty"`
// Name: The name of the enterprise which is generated by the server
- // during creation, in the form enterprises/{enterpriseId}
+ // during creation, in the form enterprises/{enterpriseId}.
Name string `json:"name,omitempty"`
- // PrimaryColor: A color in RGB format indicating the predominant color
- // to display in the device management app UI. The color components are
- // stored as follows: (red << 16) | (green << 8) | blue, where each
- // component may take a value between 0 and 255 inclusive.
+ // PrimaryColor: 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 int64 `json:"primaryColor,omitempty"`
- // PubsubTopic: When Cloud Pub/Sub notifications are enabled, this field
- // is required to indicate the topic to which the notifications will be
- // published. The format of this field is
- // projects/{project}/topics/{topic}. You must have granted the publish
- // permission on this topic to
- // android-cloud-policy@system.gserviceaccount.com
+ // PubsubTopic: 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 `json:"pubsubTopic,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -958,12 +1001,12 @@ func (s *Enterprise) MarshalJSON() ([]byte, error) {
// downloaded by Android Device Policy and verified against the hash.
type ExternalData struct {
// Sha256Hash: The base-64 encoded SHA-256 hash of the content hosted at
- // url. If the content does not match this hash, Android Device Policy
- // will not use the data.
+ // url. If the content doesn't match this hash, Android Device Policy
+ // won't use the data.
Sha256Hash string `json:"sha256Hash,omitempty"`
// Url: The absolute URL to the data, which must use either the http or
- // https scheme. Android Device Policy does not provide any credentials
+ // 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.
@@ -993,8 +1036,8 @@ func (s *ExternalData) MarshalJSON() ([]byte, error) {
}
// HardwareInfo: Information about device hardware. The fields related
-// to temperature thresholds are only available when
-// hardwareStatusEnabled is true in the device's policy.
+// to temperature thresholds are only available if hardwareStatusEnabled
+// is true in the device's policy.
type HardwareInfo struct {
// BatteryShutdownTemperatures: Battery shutdown temperature thresholds
// in Celsius for each battery on the device.
@@ -1004,7 +1047,7 @@ type HardwareInfo struct {
// thresholds in Celsius for each battery on the device.
BatteryThrottlingTemperatures []float64 `json:"batteryThrottlingTemperatures,omitempty"`
- // Brand: Brand of the device, e.g. Google.
+ // Brand: Brand of the device. For example, Google.
Brand string `json:"brand,omitempty"`
// CpuShutdownTemperatures: CPU shutdown temperature thresholds in
@@ -1015,7 +1058,7 @@ type HardwareInfo struct {
// Celsius for each CPU on the device.
CpuThrottlingTemperatures []float64 `json:"cpuThrottlingTemperatures,omitempty"`
- // DeviceBasebandVersion: Baseband version, e.g.
+ // DeviceBasebandVersion: Baseband version. For example,
// MDM9625_104662.22.05.34p.
DeviceBasebandVersion string `json:"deviceBasebandVersion,omitempty"`
@@ -1027,13 +1070,13 @@ type HardwareInfo struct {
// Celsius for each GPU on the device.
GpuThrottlingTemperatures []float64 `json:"gpuThrottlingTemperatures,omitempty"`
- // Hardware: Name of the hardware, e.g. Angler.
+ // Hardware: Name of the hardware. For example, Angler.
Hardware string `json:"hardware,omitempty"`
- // Manufacturer: Manufacturer, e.g. Motorola.
+ // Manufacturer: Manufacturer. For example, Motorola.
Manufacturer string `json:"manufacturer,omitempty"`
- // Model: The model of the device, e.g. Asus Nexus 7.
+ // Model: The model of the device. For example, Asus Nexus 7.
Model string `json:"model,omitempty"`
// SerialNumber: The device serial number.
@@ -1241,20 +1284,20 @@ func (s *ListPoliciesResponse) MarshalJSON() ([]byte, error) {
// ManagedProperty: Managed property.
type ManagedProperty struct {
- // DefaultValue: The default value of the properties. BUNDLE_ARRAY
- // properties never have a default value.
+ // DefaultValue: The default value of the property. BUNDLE_ARRAY
+ // properties don't have a default value.
DefaultValue interface{} `json:"defaultValue,omitempty"`
- // Description: A longer description of the property, giving more detail
- // of what it affects. Localized.
+ // Description: A longer description of the property, providing more
+ // detail of what it affects. Localized.
Description string `json:"description,omitempty"`
// Entries: For CHOICE or MULTISELECT properties, the list of possible
// entries.
Entries []*ManagedPropertyEntry `json:"entries,omitempty"`
- // Key: The unique key that the application uses to identify the
- // property, e.g. "com.google.android.gm.fieldname".
+ // Key: The unique key that the app uses to identify the property, e.g.
+ // "com.google.android.gm.fieldname".
Key string `json:"key,omitempty"`
// NestedProperties: For BUNDLE_ARRAY properties, the list of nested
@@ -1274,8 +1317,8 @@ type ManagedProperty struct {
// "CHOICE" - A choice of one item from a set.
// "MULTISELECT" - A choice of multiple items from a set.
// "HIDDEN" - A hidden restriction of string type (the default value
- // can be used to pass along information that cannot be modified, such
- // as a version code).
+ // can be used to pass along information that can't be modified, such as
+ // a version code).
// "BUNDLE_ARRAY" - An array of property bundles.
Type string `json:"type,omitempty"`
@@ -1419,13 +1462,17 @@ func (s *MemoryInfo) MarshalJSON() ([]byte, error) {
// NetworkInfo: Device network info.
type NetworkInfo struct {
- // Imei: IMEI number of the GSM device, e.g. A1000031212.
+ // Imei: IMEI number of the GSM device. For example, A1000031212.
Imei string `json:"imei,omitempty"`
- // Meid: MEID number of the CDMA device, e.g. A00000292788E1.
+ // Meid: MEID number of the CDMA device. For example, A00000292788E1.
Meid string `json:"meid,omitempty"`
- // WifiMacAddress: WiFi MAC address of the device, e.g.
+ // NetworkOperatorName: Alphabetic name of current registered operator.
+ // For example, Vodafone.
+ NetworkOperatorName string `json:"networkOperatorName,omitempty"`
+
+ // WifiMacAddress: Wi-Fi MAC address of the device. For example,
// 7c:11:11:11:11:11.
WifiMacAddress string `json:"wifiMacAddress,omitempty"`
@@ -1472,14 +1519,14 @@ type NonComplianceDetail struct {
// InstallationFailureReason: If package_name is set and the
// non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the
- // detailed reason the app cannot be installed or updated.
+ // detailed reason the app can't be installed or updated.
//
// Possible values:
// "INSTALLATION_FAILURE_REASON_UNSPECIFIED" - This value is
// disallowed.
// "INSTALLATION_FAILURE_REASON_UNKNOWN" - An unknown condition is
- // preventing the app from being installed. Some potential reaons are
- // that the device does not have enough storage, the device network
+ // preventing the app from being installed. Some potential reasons are
+ // that the device doesn't have enough storage, the device network
// connection is unreliable, or the installation is taking longer than
// expected. The installation will be retried automatically.
// "IN_PROGRESS" - The installation is still in progress.
@@ -1491,10 +1538,10 @@ type NonComplianceDetail struct {
// not been accepted by the admin.
// "NOT_AVAILABLE_IN_COUNTRY" - The app is not available in the user's
// country.
- // "NO_LICENSES_REMAINING" - There are no more licenses to assign to
- // the user.
- // "NOT_ENROLLED" - The enterprise is no longer enrolled with Play for
- // Work or Android Device Policy is not enabled for the enterprise.
+ // "NO_LICENSES_REMAINING" - There are no licenses available to assign
+ // to the user.
+ // "NOT_ENROLLED" - The enterprise is no longer enrolled with managed
+ // Play or Android Device Policy is not enabled for the enterprise.
// "USER_INVALID" - The user is no longer valid. The user may have
// been deleted or disabled.
InstallationFailureReason string `json:"installationFailureReason,omitempty"`
@@ -1504,28 +1551,28 @@ type NonComplianceDetail struct {
//
// Possible values:
// "NON_COMPLIANCE_REASON_UNSPECIFIED" - This value is disallowed.
- // "API_LEVEL" - The setting is not supported in the API level of
- // Android OS version the device is running.
- // "ADMIN_TYPE" - The admin type (profile owner, device owner, etc.)
- // does not support the setting.
+ // "API_LEVEL" - The setting is not supported in the API level of the
+ // Android version running on the device.
+ // "MANAGEMENT_MODE" - The management mode (profile owner, device
+ // owner, etc.) doesn't support the setting.
// "USER_ACTION" - The user has not taken required action to comply
// with the setting.
// "INVALID_VALUE" - The setting has an invalid value.
- // "APP_NOT_INSTALLED" - The application required to implement the
- // policy is not installed.
+ // "APP_NOT_INSTALLED" - The app required to implement the policy is
+ // not installed.
// "UNSUPPORTED" - The policy is not supported by the version of
// Android Device Policy on the device.
- // "APP_INSTALLED" - A blocked application is installed.
- // "PENDING" - The setting was not applied yet at the time of the
+ // "APP_INSTALLED" - A blocked app is installed.
+ // "PENDING" - The setting hasn't been applied at the time of the
// report, but is expected to be applied shortly.
- // "APP_INCOMPATIBLE" - The setting cannot be applied to the
- // application because the application doesn't support it, for example
- // because its target SDK version is not high enough.
- // "APP_NOT_UPDATED" - The application is installed but not updated to
- // the minimum version code specified by policy
+ // "APP_INCOMPATIBLE" - The setting can't be applied to the app
+ // because the app doesn't support it, for example because its target
+ // SDK version is not high enough.
+ // "APP_NOT_UPDATED" - The app is installed, but it hasn't been
+ // updated to the minimum version code specified by policy.
NonComplianceReason string `json:"nonComplianceReason,omitempty"`
- // PackageName: The package name indicating which application is out of
+ // PackageName: The package name indicating which app is out of
// compliance, if applicable.
PackageName string `json:"packageName,omitempty"`
@@ -1568,29 +1615,29 @@ type NonComplianceDetailCondition struct {
//
// Possible values:
// "NON_COMPLIANCE_REASON_UNSPECIFIED" - This value is disallowed.
- // "API_LEVEL" - The setting is not supported in the API level of
- // Android OS version the device is running.
- // "ADMIN_TYPE" - The admin type (profile owner, device owner, etc.)
- // does not support the setting.
+ // "API_LEVEL" - The setting is not supported in the API level of the
+ // Android version running on the device.
+ // "MANAGEMENT_MODE" - The management mode (profile owner, device
+ // owner, etc.) doesn't support the setting.
// "USER_ACTION" - The user has not taken required action to comply
// with the setting.
// "INVALID_VALUE" - The setting has an invalid value.
- // "APP_NOT_INSTALLED" - The application required to implement the
- // policy is not installed.
+ // "APP_NOT_INSTALLED" - The app required to implement the policy is
+ // not installed.
// "UNSUPPORTED" - The policy is not supported by the version of
// Android Device Policy on the device.
- // "APP_INSTALLED" - A blocked application is installed.
- // "PENDING" - The setting was not applied yet at the time of the
+ // "APP_INSTALLED" - A blocked app is installed.
+ // "PENDING" - The setting hasn't been applied at the time of the
// report, but is expected to be applied shortly.
- // "APP_INCOMPATIBLE" - The setting cannot be applied to the
- // application because the application doesn't support it, for example
- // because its target SDK version is not high enough.
- // "APP_NOT_UPDATED" - The application is installed but not updated to
- // the minimum version code specified by policy
+ // "APP_INCOMPATIBLE" - The setting can't be applied to the app
+ // because the app doesn't support it, for example because its target
+ // SDK version is not high enough.
+ // "APP_NOT_UPDATED" - The app is installed, but it hasn't been
+ // updated to the minimum version code specified by policy.
NonComplianceReason string `json:"nonComplianceReason,omitempty"`
- // PackageName: The package name indicating which application is out of
- // compliance. If not set, then this condition matches any package name.
+ // PackageName: The package name of the app that's out of compliance. If
+ // not set, then this condition matches any package name.
PackageName string `json:"packageName,omitempty"`
// SettingName: The name of the policy setting. This is the JSON field
@@ -1714,8 +1761,8 @@ func (s *PackageNameList) MarshalJSON() ([]byte, error) {
// PasswordRequirements: Requirements for the password used to unlock a
// device.
type PasswordRequirements struct {
- // MaximumFailedPasswordsForWipe: A device will be wiped after too many
- // incorrect device-unlock passwords have been entered. A value of 0
+ // MaximumFailedPasswordsForWipe: 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 int64 `json:"maximumFailedPasswordsForWipe,omitempty"`
@@ -1723,9 +1770,9 @@ type PasswordRequirements struct {
PasswordExpirationTimeout string `json:"passwordExpirationTimeout,omitempty"`
// PasswordHistoryLength: The length of the password history. After
- // setting this, the user will not 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.
+ // 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 int64 `json:"passwordHistoryLength,omitempty"`
// PasswordMinimumLength: The minimum allowed password length. A value
@@ -1764,20 +1811,21 @@ type PasswordRequirements struct {
// PasswordQuality: The required password quality.
//
// Possible values:
- // "PASSWORD_QUALITY_UNSPECIFIED" - There are no requirements for the
- // password.
- // "BIOMETRIC_WEAK" - There must be at least low-security biometric
- // recognition technology to secure the device. This includes
- // technologies that can recognize the identity of an individual to
- // about a 3 digit PIN (false detection is less than 1 in 1,000).
- // "SOMETHING" - There must be a password, but there are no
- // restrictions on its characters.
+ // "PASSWORD_QUALITY_UNSPECIFIED" - There are no password
+ // requirements.
+ // "BIOMETRIC_WEAK" - The device must be secured with a low-security
+ // biometric recognition technology, at minimum. This includes
+ // technologies that can recognize the identity of an individual that
+ // are roughly equivalent to a 3-digit PIN (false detection is less than
+ // 1 in 1,000).
+ // "SOMETHING" - A password is required, but there are no restrictions
+ // on what the password must contain.
// "NUMERIC" - The password must contain numeric characters.
// "NUMERIC_COMPLEX" - The password must contain numeric characters
// with no repeating (4444) or ordered (1234, 4321, 2468) sequences.
// "ALPHABETIC" - The password must contain alphabetic (or symbol)
// characters.
- // "ALPHANUMERIC" - The password must contain at both numeric and
+ // "ALPHANUMERIC" - The password must contain both numeric and
// alphabetic (or symbol) characters.
// "COMPLEX" - The password must contain at least a letter, a
// numerical digit and a special symbol. Other password constraints, for
@@ -1896,9 +1944,10 @@ func (s *PersistentPreferredActivity) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Policy: A policy, which governs behavior for a device.
+// Policy: A policy resources represents a group settings that govern
+// the behavior of a managed device and the apps installed on it.
type Policy struct {
- // AccountTypesWithManagementDisabled: Account types that cannot be
+ // AccountTypesWithManagementDisabled: Account types that can't be
// managed by the user.
AccountTypesWithManagementDisabled []string `json:"accountTypesWithManagementDisabled,omitempty"`
@@ -1913,6 +1962,31 @@ type Policy struct {
// Use with vpn_config_disabled to prevent modification of this setting.
AlwaysOnVpnPackage *AlwaysOnVpnPackage `json:"alwaysOnVpnPackage,omitempty"`
+ // AndroidDevicePolicyTracks: 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.
+ //
+ // Possible values:
+ // "APP_TRACK_UNSPECIFIED" - This value is ignored.
+ // "PRODUCTION" - The production track, which provides the latest
+ // stable release.
+ // "BETA" - The beta track, which provides the latest beta release.
+ AndroidDevicePolicyTracks []string `json:"androidDevicePolicyTracks,omitempty"`
+
+ // AppAutoUpdatePolicy: The app auto update policy, which controls when
+ // automatic app updates can be applied.
+ //
+ // Possible values:
+ // "APP_AUTO_UPDATE_POLICY_UNSPECIFIED" - The auto-update policy is
+ // not set. Equivalent to CHOICE_TO_THE_USER.
+ // "CHOICE_TO_THE_USER" - The user can control auto-updates.
+ // "NEVER" - Apps are never auto-updated.
+ // "WIFI_ONLY" - Apps are auto-updated over Wi-Fi only.
+ // "ALWAYS" - Apps are auto-updated at any time. Data charges may
+ // apply.
+ AppAutoUpdatePolicy string `json:"appAutoUpdatePolicy,omitempty"`
+
// Applications: Policy applied to apps.
Applications []*ApplicationPolicy `json:"applications,omitempty"`
@@ -1966,8 +2040,8 @@ type Policy struct {
// debugging features.
DebuggingFeaturesAllowed bool `json:"debuggingFeaturesAllowed,omitempty"`
- // DefaultPermissionPolicy: The default permission policy for requests
- // for runtime permissions.
+ // DefaultPermissionPolicy: The default permission policy for runtime
+ // permission requests.
//
// Possible values:
// "PERMISSION_POLICY_UNSPECIFIED" - Policy not specified. If no
@@ -1978,8 +2052,22 @@ type Policy struct {
// "DENY" - Automatically deny a permission.
DefaultPermissionPolicy string `json:"defaultPermissionPolicy,omitempty"`
- // EnsureVerifyAppsEnabled: Whether application verification is forced
- // to be enabled.
+ // DeviceOwnerLockScreenInfo: The device owner information to be shown
+ // on the lock screen.
+ DeviceOwnerLockScreenInfo *UserFacingMessage `json:"deviceOwnerLockScreenInfo,omitempty"`
+
+ // EncryptionPolicy: Whether encryption is enabled
+ //
+ // Possible values:
+ // "ENCRYPTION_POLICY_UNSPECIFIED" - This value is ignored, i.e. no
+ // encryption required
+ // "ENABLED_WITHOUT_PASSWORD" - Encryption required but no password
+ // required to boot
+ // "ENABLED_WITH_PASSWORD" - Encryption required with password
+ // required to boot
+ EncryptionPolicy string `json:"encryptionPolicy,omitempty"`
+
+ // EnsureVerifyAppsEnabled: Whether app verification is force-enabled.
EnsureVerifyAppsEnabled bool `json:"ensureVerifyAppsEnabled,omitempty"`
// FactoryResetDisabled: Whether factory resetting from settings is
@@ -1990,7 +2078,7 @@ type Policy struct {
// 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
- // will not provide factory reset protection.
+ // won't provide factory reset protection.
FrpAdminEmails []string `json:"frpAdminEmails,omitempty"`
// FunDisabled: Whether the user is allowed to have fun. Controls
@@ -2037,13 +2125,26 @@ type Policy struct {
// settings.
KioskCustomLauncherEnabled bool `json:"kioskCustomLauncherEnabled,omitempty"`
+ // LocationMode: The degree of location detection enabled. The user may
+ // change the value unless the user is otherwise blocked from accessing
+ // device settings.
+ //
+ // Possible values:
+ // "LOCATION_MODE_UNSPECIFIED" - The current device value is not
+ // modified.
+ // "HIGH_ACCURACY" - All location detection methods are enabled,
+ // including GPS, networks, and other sensors.
+ // "SENSORS_ONLY" - Only GPS and other sensors are enabled.
+ // "BATTERY_SAVING" - Only the network location provider is enabled.
+ // "OFF" - Location detection is disabled.
+ LocationMode string `json:"locationMode,omitempty"`
+
// LongSupportMessage: A message displayed to the user in the device
// administators settings screen.
LongSupportMessage *UserFacingMessage `json:"longSupportMessage,omitempty"`
// MaximumTimeToLock: Maximum time in milliseconds for user activity
- // until the device will lock. A value of 0 means there is no
- // restriction.
+ // until the device locks. A value of 0 means there is no restriction.
MaximumTimeToLock int64 `json:"maximumTimeToLock,omitempty,string"`
// MobileNetworksConfigDisabled: Whether configuring mobile networks is
@@ -2059,7 +2160,7 @@ type Policy struct {
MountPhysicalMediaDisabled bool `json:"mountPhysicalMediaDisabled,omitempty"`
// Name: The name of the policy in the form
- // enterprises/{enterpriseId}/policies/{policyId}
+ // enterprises/{enterpriseId}/policies/{policyId}.
Name string `json:"name,omitempty"`
// NetworkEscapeHatchEnabled: Whether the network escape hatch is
@@ -2080,7 +2181,7 @@ type Policy struct {
// configure networks for more information.
OpenNetworkConfiguration googleapi.RawMessage `json:"openNetworkConfiguration,omitempty"`
- // OutgoingBeamDisabled: Whether using NFC to beam out data from apps is
+ // OutgoingBeamDisabled: Whether using NFC to beam data from apps is
// disabled.
OutgoingBeamDisabled bool `json:"outgoingBeamDisabled,omitempty"`
@@ -2090,7 +2191,7 @@ type Policy struct {
// PasswordRequirements: Password requirements.
PasswordRequirements *PasswordRequirements `json:"passwordRequirements,omitempty"`
- // PermittedInputMethods: If present, only input methods provided by
+ // PermittedInputMethods: 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 *PackageNameList `json:"permittedInputMethods,omitempty"`
@@ -2122,15 +2223,24 @@ type Policy struct {
// SetWallpaperDisabled: Whether changing the wallpaper is disabled.
SetWallpaperDisabled bool `json:"setWallpaperDisabled,omitempty"`
+ // ShareLocationDisabled: Whether location sharing is disabled.
+ ShareLocationDisabled bool `json:"shareLocationDisabled,omitempty"`
+
// ShortSupportMessage: A message displayed to the user in the settings
// screen wherever functionality has been disabled by the admin.
ShortSupportMessage *UserFacingMessage `json:"shortSupportMessage,omitempty"`
- // SmsDisabled: Whether sending or receiving SMS messages is disabled.
+ // SkipFirstUseHintsEnabled: 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 bool `json:"skipFirstUseHintsEnabled,omitempty"`
+
+ // SmsDisabled: Whether sending and receiving SMS messages is disabled.
SmsDisabled bool `json:"smsDisabled,omitempty"`
// StatusBarDisabled: Whether the status bar is disabled. This disables
- // notifications, quick settings and other screen overlays that allow
+ // notifications, quick settings, and other screen overlays that allow
// escape from full-screen mode.
StatusBarDisabled bool `json:"statusBarDisabled,omitempty"`
@@ -2170,6 +2280,10 @@ type Policy struct {
// disabled.
UsbFileTransferDisabled bool `json:"usbFileTransferDisabled,omitempty"`
+ // UsbMassStorageEnabled: Allows admins to toggle whether USB storge is
+ // enabled or disabled on user's devices. Next ID: 113
+ UsbMassStorageEnabled bool `json:"usbMassStorageEnabled,omitempty"`
+
// Version: The version of the policy. This is a read-only field. The
// version is incremented each time the policy is updated.
Version int64 `json:"version,omitempty,string"`
@@ -2177,13 +2291,12 @@ type Policy struct {
// VpnConfigDisabled: Whether configuring VPN is disabled.
VpnConfigDisabled bool `json:"vpnConfigDisabled,omitempty"`
- // WifiConfigDisabled: Whether configuring WiFi access points is
+ // WifiConfigDisabled: Whether configuring Wi-Fi access points is
// disabled.
WifiConfigDisabled bool `json:"wifiConfigDisabled,omitempty"`
- // WifiConfigsLockdownEnabled: Whether WiFi networks defined in Open
- // Network Configuration are locked so they cannot be edited by the
- // user.
+ // WifiConfigsLockdownEnabled: Whether Wi-Fi networks defined in Open
+ // Network Configuration are locked so they can't be edited by the user.
WifiConfigsLockdownEnabled bool `json:"wifiConfigsLockdownEnabled,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -2317,12 +2430,13 @@ func (s *ProxyInfo) MarshalJSON() ([]byte, error) {
// SignupUrl: An enterprise signup URL.
type SignupUrl struct {
- // Name: The name of the resource. This must be included in the create
- // enterprise request at the end of the signup flow.
+ // Name: The name of the resource. Use this value in the signupUrl field
+ // when calling enterprises.create to complete the enterprise signup
+ // flow.
Name string `json:"name,omitempty"`
- // Url: A URL under which the Admin can sign up for an enterprise. The
- // page pointed to cannot be rendered in an iframe.
+ // Url: A URL where an enterprise admin can register their enterprise.
+ // The page can't be rendered in an iframe.
Url string `json:"url,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -2354,8 +2468,8 @@ func (s *SignupUrl) MarshalJSON() ([]byte, error) {
// SoftwareInfo: Information about device software.
type SoftwareInfo struct {
- // AndroidBuildNumber: Android build Id string meant for displaying to
- // the user, e.g. shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
+ // AndroidBuildNumber: Android build ID string meant for displaying to
+ // the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
AndroidBuildNumber string `json:"androidBuildNumber,omitempty"`
// AndroidBuildTime: Build time.
@@ -2369,13 +2483,20 @@ type SoftwareInfo struct {
// as displayed to the user.
AndroidDevicePolicyVersionName string `json:"androidDevicePolicyVersionName,omitempty"`
- // AndroidVersion: The user visible Android version string, e.g. 6.0.1.
+ // AndroidVersion: The user-visible Android version string. For example,
+ // 6.0.1.
AndroidVersion string `json:"androidVersion,omitempty"`
// BootloaderVersion: The system bootloader version number, e.g. 0.6.7.
BootloaderVersion string `json:"bootloaderVersion,omitempty"`
- // DeviceKernelVersion: Kernel version, e.g. 2.6.32.9-g103d848.
+ // DeviceBuildSignature: 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 `json:"deviceBuildSignature,omitempty"`
+
+ // DeviceKernelVersion: Kernel version, for example, 2.6.32.9-g103d848.
DeviceKernelVersion string `json:"deviceKernelVersion,omitempty"`
// SecurityPatchLevel: Security patch level, e.g. 2016-05-01.
@@ -2534,7 +2655,7 @@ func (s *StatusReportingSettings) MarshalJSON() ([]byte, error) {
// SystemUpdate: Configuration for managing system updates
type SystemUpdate struct {
// EndMinutes: If the type is WINDOWED, the end of the maintenance
- // window, measured as the number of minutes after midnight in device
+ // 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
@@ -2543,8 +2664,9 @@ type SystemUpdate struct {
EndMinutes int64 `json:"endMinutes,omitempty"`
// StartMinutes: If the type is WINDOWED, the start of the maintenance
- // window, measured as the number of minutes after midnight in device
- // local time. This value must be between 0 and 1439, inclusive.
+ // 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 int64 `json:"startMinutes,omitempty"`
// Type: The type of system update to configure.
@@ -2586,17 +2708,19 @@ func (s *SystemUpdate) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// UserFacingMessage: Provides user facing message with locale info. The
-// maximum message length is 4096 characters.
+// UserFacingMessage: Provides a user-facing message with locale info.
+// The maximum message length is 4096 characters.
type UserFacingMessage struct {
- // DefaultMessage: The default message that gets displayed if no
- // localized message is specified, or the user's locale does not match
- // with any of the localized messages. A default message must be
- // provided if any localized messages are provided.
+ // DefaultMessage: 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 `json:"defaultMessage,omitempty"`
- // LocalizedMessages: A map which contains pairs. The
- // locale is a BCP 47 language code, e.g. en-US, es-ES, fr.
+ // LocalizedMessages: A map containing 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 map[string]string `json:"localizedMessages,omitempty"`
// ForceSendFields is a list of field names (e.g. "DefaultMessage") to
@@ -2623,11 +2747,10 @@ func (s *UserFacingMessage) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// WebToken: A web token used to access an embeddable managed Google
-// Play web UI.
+// WebToken: A web token used to access the managed Google Play iframe.
type WebToken struct {
// Name: The name of the web token, which is generated by the server
- // during creation, in the form
+ // during creation in the form
// enterprises/{enterpriseId}/webTokens/{webTokenId}.
Name string `json:"name,omitempty"`
@@ -2636,8 +2759,8 @@ type WebToken struct {
// other URLs. The URL must use the https scheme.
ParentFrameUrl string `json:"parentFrameUrl,omitempty"`
- // Permissions: Permissions the admin may exercise in the embedded UI.
- // The admin must have all of these permissions in order to view the UI.
+ // Permissions: Permissions available to an admin in the embedded UI. An
+ // admin must have all of these permissions in order to view the UI.
//
// Possible values:
// "WEB_TOKEN_PERMISSION_UNSPECIFIED" - This value is ignored.
@@ -2686,8 +2809,8 @@ type EnterprisesCreateCall struct {
header_ http.Header
}
-// Create: Creates an enterprise by completing the enterprise signup
-// flow.
+// Create: Creates an enterprise. This is the last step in the
+// enterprise signup flow.
func (r *EnterprisesService) Create(enterprise *Enterprise) *EnterprisesCreateCall {
c := &EnterprisesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.enterprise = enterprise
@@ -2701,7 +2824,7 @@ func (c *EnterprisesCreateCall) EnterpriseToken(enterpriseToken string) *Enterpr
return c
}
-// ProjectId sets the optional parameter "projectId": The id of the
+// ProjectId sets the optional parameter "projectId": The ID of the
// Google Cloud Platform project which will own the enterprise.
func (c *EnterprisesCreateCall) ProjectId(projectId string) *EnterprisesCreateCall {
c.urlParams_.Set("projectId", projectId)
@@ -2798,7 +2921,7 @@ func (c *EnterprisesCreateCall) Do(opts ...googleapi.CallOption) (*Enterprise, e
}
return ret, nil
// {
- // "description": "Creates an enterprise by completing the enterprise signup flow.",
+ // "description": "Creates an enterprise. This is the last step in the enterprise signup flow.",
// "flatPath": "v1/enterprises",
// "httpMethod": "POST",
// "id": "androidmanagement.enterprises.create",
@@ -2810,7 +2933,7 @@ func (c *EnterprisesCreateCall) Do(opts ...googleapi.CallOption) (*Enterprise, e
// "type": "string"
// },
// "projectId": {
- // "description": "The id of the Google Cloud Platform project which will own the enterprise.",
+ // "description": "The ID of the Google Cloud Platform project which will own the enterprise.",
// "location": "query",
// "type": "string"
// },
@@ -2955,7 +3078,7 @@ func (c *EnterprisesGetCall) Do(opts ...googleapi.CallOption) (*Enterprise, erro
// ],
// "parameters": {
// "name": {
- // "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
+ // "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+$",
// "required": true,
@@ -3095,7 +3218,7 @@ func (c *EnterprisesPatchCall) Do(opts ...googleapi.CallOption) (*Enterprise, er
// ],
// "parameters": {
// "name": {
- // "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
+ // "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+$",
// "required": true,
@@ -3257,7 +3380,7 @@ func (c *EnterprisesApplicationsGetCall) Do(opts ...googleapi.CallOption) (*Appl
// "type": "string"
// },
// "name": {
- // "description": "The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}",
+ // "description": "The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+/applications/[^/]+$",
// "required": true,
@@ -3285,7 +3408,7 @@ type EnterprisesDevicesDeleteCall struct {
header_ http.Header
}
-// Delete: Deletes a device, which causes the device to be wiped.
+// Delete: Deletes a device. This operation wipes the device.
func (r *EnterprisesDevicesService) Delete(name string) *EnterprisesDevicesDeleteCall {
c := &EnterprisesDevicesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -3373,7 +3496,7 @@ func (c *EnterprisesDevicesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty,
}
return ret, nil
// {
- // "description": "Deletes a device, which causes the device to be wiped.",
+ // "description": "Deletes a device. This operation wipes the device.",
// "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}",
// "httpMethod": "DELETE",
// "id": "androidmanagement.enterprises.devices.delete",
@@ -3382,7 +3505,7 @@ func (c *EnterprisesDevicesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty,
// ],
// "parameters": {
// "name": {
- // "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}",
+ // "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+/devices/[^/]+$",
// "required": true,
@@ -3521,7 +3644,7 @@ func (c *EnterprisesDevicesGetCall) Do(opts ...googleapi.CallOption) (*Device, e
// ],
// "parameters": {
// "name": {
- // "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}",
+ // "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+/devices/[^/]+$",
// "required": true,
@@ -3655,7 +3778,7 @@ func (c *EnterprisesDevicesIssueCommandCall) Do(opts ...googleapi.CallOption) (*
// ],
// "parameters": {
// "name": {
- // "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}",
+ // "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+/devices/[^/]+$",
// "required": true,
@@ -3702,7 +3825,7 @@ func (c *EnterprisesDevicesListCall) PageSize(pageSize int64) *EnterprisesDevice
}
// PageToken sets the optional parameter "pageToken": A token
-// identifying a page of results the server should return.
+// identifying a page of results returned by the server.
func (c *EnterprisesDevicesListCall) PageToken(pageToken string) *EnterprisesDevicesListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
@@ -3817,12 +3940,12 @@ func (c *EnterprisesDevicesListCall) Do(opts ...googleapi.CallOption) (*ListDevi
// "type": "integer"
// },
// "pageToken": {
- // "description": "A token identifying a page of results the server should return.",
+ // "description": "A token identifying a page of results returned by the server.",
// "location": "query",
// "type": "string"
// },
// "parent": {
- // "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
+ // "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+$",
// "required": true,
@@ -3983,7 +4106,7 @@ func (c *EnterprisesDevicesPatchCall) Do(opts ...googleapi.CallOption) (*Device,
// ],
// "parameters": {
// "name": {
- // "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}",
+ // "description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+/devices/[^/]+$",
// "required": true,
@@ -4733,7 +4856,7 @@ func (c *EnterprisesEnrollmentTokensCreateCall) Do(opts ...googleapi.CallOption)
// ],
// "parameters": {
// "parent": {
- // "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
+ // "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+$",
// "required": true,
@@ -4764,8 +4887,8 @@ type EnterprisesEnrollmentTokensDeleteCall struct {
header_ http.Header
}
-// Delete: Deletes an enrollment token, which prevents future use of the
-// token.
+// Delete: Deletes an enrollment token. This operation invalidates the
+// token, preventing its future use.
func (r *EnterprisesEnrollmentTokensService) Delete(name string) *EnterprisesEnrollmentTokensDeleteCall {
c := &EnterprisesEnrollmentTokensDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -4853,7 +4976,7 @@ func (c *EnterprisesEnrollmentTokensDeleteCall) Do(opts ...googleapi.CallOption)
}
return ret, nil
// {
- // "description": "Deletes an enrollment token, which prevents future use of the token.",
+ // "description": "Deletes an enrollment token. This operation invalidates the token, preventing its future use.",
// "flatPath": "v1/enterprises/{enterprisesId}/enrollmentTokens/{enrollmentTokensId}",
// "httpMethod": "DELETE",
// "id": "androidmanagement.enterprises.enrollmentTokens.delete",
@@ -4862,7 +4985,7 @@ func (c *EnterprisesEnrollmentTokensDeleteCall) Do(opts ...googleapi.CallOption)
// ],
// "parameters": {
// "name": {
- // "description": "The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}",
+ // "description": "The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+/enrollmentTokens/[^/]+$",
// "required": true,
@@ -4988,7 +5111,7 @@ func (c *EnterprisesPoliciesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty
// ],
// "parameters": {
// "name": {
- // "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}",
+ // "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+/policies/[^/]+$",
// "required": true,
@@ -5127,7 +5250,7 @@ func (c *EnterprisesPoliciesGetCall) Do(opts ...googleapi.CallOption) (*Policy,
// ],
// "parameters": {
// "name": {
- // "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}",
+ // "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+/policies/[^/]+$",
// "required": true,
@@ -5171,7 +5294,7 @@ func (c *EnterprisesPoliciesListCall) PageSize(pageSize int64) *EnterprisesPolic
}
// PageToken sets the optional parameter "pageToken": A token
-// identifying a page of results the server should return.
+// identifying a page of results returned by the server.
func (c *EnterprisesPoliciesListCall) PageToken(pageToken string) *EnterprisesPoliciesListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
@@ -5286,12 +5409,12 @@ func (c *EnterprisesPoliciesListCall) Do(opts ...googleapi.CallOption) (*ListPol
// "type": "integer"
// },
// "pageToken": {
- // "description": "A token identifying a page of results the server should return.",
+ // "description": "A token identifying a page of results returned by the server.",
// "location": "query",
// "type": "string"
// },
// "parent": {
- // "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
+ // "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+$",
// "required": true,
@@ -5452,7 +5575,7 @@ func (c *EnterprisesPoliciesPatchCall) Do(opts ...googleapi.CallOption) (*Policy
// ],
// "parameters": {
// "name": {
- // "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}",
+ // "description": "The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+/policies/[^/]+$",
// "required": true,
@@ -5594,7 +5717,7 @@ func (c *EnterprisesWebTokensCreateCall) Do(opts ...googleapi.CallOption) (*WebT
// ],
// "parameters": {
// "parent": {
- // "description": "The name of the enterprise in the form enterprises/{enterpriseId}",
+ // "description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
// "location": "path",
// "pattern": "^enterprises/[^/]+$",
// "required": true,
@@ -5631,7 +5754,7 @@ func (r *SignupUrlsService) Create() *SignupUrlsCreateCall {
}
// CallbackUrl sets the optional parameter "callbackUrl": The callback
-// URL to which the admin will be redirected after successfully creating
+// 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
@@ -5642,7 +5765,7 @@ func (c *SignupUrlsCreateCall) CallbackUrl(callbackUrl string) *SignupUrlsCreate
return c
}
-// ProjectId sets the optional parameter "projectId": The id of the
+// ProjectId sets the optional parameter "projectId": The ID of the
// Google Cloud Platform project which will own the enterprise.
func (c *SignupUrlsCreateCall) ProjectId(projectId string) *SignupUrlsCreateCall {
c.urlParams_.Set("projectId", projectId)
@@ -5734,12 +5857,12 @@ func (c *SignupUrlsCreateCall) Do(opts ...googleapi.CallOption) (*SignupUrl, err
// "parameterOrder": [],
// "parameters": {
// "callbackUrl": {
- // "description": "The callback URL to which the admin will be redirected 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.",
+ // "description": "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.",
// "location": "query",
// "type": "string"
// },
// "projectId": {
- // "description": "The id of the Google Cloud Platform project which will own the enterprise.",
+ // "description": "The ID of the Google Cloud Platform project which will own the enterprise.",
// "location": "query",
// "type": "string"
// }
diff --git a/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-api.json b/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-api.json
index 15667e9eb..9cd2a5b4a 100644
--- a/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-api.json
+++ b/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-api.json
@@ -1,265 +1,265 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/jjPNPRw3vV3kPmpQDcyXQEJTSyY\"",
- "discoveryVersion": "v1",
- "id": "androidpublisher:v1.1",
- "name": "androidpublisher",
- "canonicalName": "Android Publisher",
- "version": "v1.1",
- "revision": "20171207",
- "title": "Google Play Developer API",
- "description": "Lets Android application developers access their Google Play accounts.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android-publisher",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/androidpublisher/v1.1/applications/",
- "basePath": "/androidpublisher/v1.1/applications/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "androidpublisher/v1.1/applications/",
- "batchPath": "batch/androidpublisher/v1.1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/androidpublisher": {
- "description": "View and manage your Google Play Developer account"
- }
- }
- }
- },
- "schemas": {
- "InappPurchase": {
- "id": "InappPurchase",
- "type": "object",
- "description": "An InappPurchase resource indicates the status of a user's inapp product purchase.",
- "properties": {
- "consumptionState": {
- "type": "integer",
- "description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed",
- "format": "int32"
- },
- "developerPayload": {
- "type": "string",
- "description": "A developer-specified string that contains supplemental information about an order."
- },
- "kind": {
- "type": "string",
- "description": "This kind represents an inappPurchase object in the androidpublisher service.",
- "default": "androidpublisher#inappPurchase"
- },
- "orderId": {
- "type": "string",
- "description": "The order id associated with the purchase of the inapp product."
- },
- "purchaseState": {
- "type": "integer",
- "description": "The purchase state of the order. Possible values are: \n- Purchased \n- Cancelled",
- "format": "int32"
- },
- "purchaseTime": {
- "type": "string",
- "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
- "format": "int64"
- },
- "purchaseType": {
- "type": "integer",
- "description": "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: \n- Test (i.e. purchased from a license testing account)",
- "format": "int32"
- }
- }
- },
- "SubscriptionPurchase": {
- "id": "SubscriptionPurchase",
- "type": "object",
- "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
- "properties": {
- "autoRenewing": {
- "type": "boolean",
- "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time."
- },
- "initiationTimestampMsec": {
- "type": "string",
- "description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
- "default": "androidpublisher#subscriptionPurchase"
- },
- "validUntilTimestampMsec": {
- "type": "string",
- "description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
- "format": "int64"
- }
- }
- }
- },
- "resources": {
- "inapppurchases": {
- "methods": {
- "get": {
- "id": "androidpublisher.inapppurchases.get",
- "path": "{packageName}/inapp/{productId}/purchases/{token}",
- "httpMethod": "GET",
- "description": "Checks the purchase and consumption status of an inapp item.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the inapp product was purchased.",
- "required": true,
- "location": "path"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/androidpublisher": {
+ "description": "View and manage your Google Play Developer account"
+ }
}
- },
- "parameterOrder": [
- "packageName",
- "productId",
- "token"
- ],
- "response": {
- "$ref": "InappPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
}
- }
},
- "purchases": {
- "methods": {
- "cancel": {
- "id": "androidpublisher.purchases.cancel",
- "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
- "httpMethod": "POST",
- "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
+ "basePath": "/androidpublisher/v1.1/applications/",
+ "baseUrl": "https://www.googleapis.com/androidpublisher/v1.1/applications/",
+ "batchPath": "batch/androidpublisher/v1.1",
+ "canonicalName": "Android Publisher",
+ "description": "Lets Android application developers access their Google Play accounts.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/android-publisher",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/Xvb720kj6kaUU3p6XJECzzWJnek\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/android-16.png",
+ "x32": "https://www.google.com/images/icons/product/android-32.png"
+ },
+ "id": "androidpublisher:v1.1",
+ "kind": "discovery#restDescription",
+ "name": "androidpublisher",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "get": {
- "id": "androidpublisher.purchases.get",
- "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
- "httpMethod": "GET",
- "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "response": {
- "$ref": "SubscriptionPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
- }
- }
-}
+ },
+ "protocol": "rest",
+ "resources": {
+ "inapppurchases": {
+ "methods": {
+ "get": {
+ "description": "Checks the purchase and consumption status of an inapp item.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.inapppurchases.get",
+ "parameterOrder": [
+ "packageName",
+ "productId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the inapp product was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/inapp/{productId}/purchases/{token}",
+ "response": {
+ "$ref": "InappPurchase"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ },
+ "purchases": {
+ "methods": {
+ "cancel": {
+ "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.purchases.cancel",
+ "parameterOrder": [
+ "packageName",
+ "subscriptionId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "The purchased subscription ID (for example, 'monthly001').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the subscription was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "get": {
+ "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.purchases.get",
+ "parameterOrder": [
+ "packageName",
+ "subscriptionId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "The purchased subscription ID (for example, 'monthly001').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the subscription was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
+ "response": {
+ "$ref": "SubscriptionPurchase"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180211",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "InappPurchase": {
+ "description": "An InappPurchase resource indicates the status of a user's inapp product purchase.",
+ "id": "InappPurchase",
+ "properties": {
+ "consumptionState": {
+ "description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed",
+ "format": "int32",
+ "type": "integer"
+ },
+ "developerPayload": {
+ "description": "A developer-specified string that contains supplemental information about an order.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidpublisher#inappPurchase",
+ "description": "This kind represents an inappPurchase object in the androidpublisher service.",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The order id associated with the purchase of the inapp product.",
+ "type": "string"
+ },
+ "purchaseState": {
+ "description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled",
+ "format": "int32",
+ "type": "integer"
+ },
+ "purchaseTime": {
+ "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
+ "format": "int64",
+ "type": "string"
+ },
+ "purchaseType": {
+ "description": "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: \n- Test (i.e. purchased from a license testing account) \n- Promo (i.e. purchased using a promo code)",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "SubscriptionPurchase": {
+ "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
+ "id": "SubscriptionPurchase",
+ "properties": {
+ "autoRenewing": {
+ "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time.",
+ "type": "boolean"
+ },
+ "initiationTimestampMsec": {
+ "description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidpublisher#subscriptionPurchase",
+ "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
+ "type": "string"
+ },
+ "validUntilTimestampMsec": {
+ "description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "androidpublisher/v1.1/applications/",
+ "title": "Google Play Developer API",
+ "version": "v1.1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-gen.go b/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-gen.go
index 124e5ea18..07d0e247b 100644
--- a/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-gen.go
+++ b/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-gen.go
@@ -120,7 +120,7 @@ type InappPurchase struct {
// PurchaseState: The purchase state of the order. Possible values are:
//
// - Purchased
- // - Cancelled
+ // - Canceled
PurchaseState int64 `json:"purchaseState,omitempty"`
// PurchaseTime: The time the product was purchased, in milliseconds
@@ -131,6 +131,7 @@ type InappPurchase struct {
// 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)
PurchaseType int64 `json:"purchaseType,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
diff --git a/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-api.json b/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-api.json
index 6090f92a6..1f95aa161 100644
--- a/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-api.json
+++ b/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-api.json
@@ -1,184 +1,184 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/Ex2nsAPYjRP0NRWSGg4yyxwNJ18\"",
- "discoveryVersion": "v1",
- "id": "androidpublisher:v1",
- "name": "androidpublisher",
- "canonicalName": "Android Publisher",
- "version": "v1",
- "revision": "20170913",
- "title": "Google Play Developer API",
- "description": "Lets Android application developers access their Google Play accounts.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android-publisher",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/androidpublisher/v1/applications/",
- "basePath": "/androidpublisher/v1/applications/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "androidpublisher/v1/applications/",
- "batchPath": "batch/androidpublisher/v1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/androidpublisher": {
- "description": "View and manage your Google Play Developer account"
- }
- }
- }
- },
- "schemas": {
- "SubscriptionPurchase": {
- "id": "SubscriptionPurchase",
- "type": "object",
- "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
- "properties": {
- "autoRenewing": {
- "type": "boolean",
- "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time."
- },
- "initiationTimestampMsec": {
- "type": "string",
- "description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
- "default": "androidpublisher#subscriptionPurchase"
- },
- "validUntilTimestampMsec": {
- "type": "string",
- "description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
- "format": "int64"
- }
- }
- }
- },
- "resources": {
- "purchases": {
- "methods": {
- "cancel": {
- "id": "androidpublisher.purchases.cancel",
- "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
- "httpMethod": "POST",
- "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/androidpublisher": {
+ "description": "View and manage your Google Play Developer account"
+ }
}
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.purchases.get",
- "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
- "httpMethod": "GET",
- "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "response": {
- "$ref": "SubscriptionPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
}
- }
- }
- }
-}
+ },
+ "basePath": "/androidpublisher/v1/applications/",
+ "baseUrl": "https://www.googleapis.com/androidpublisher/v1/applications/",
+ "batchPath": "batch/androidpublisher/v1",
+ "canonicalName": "Android Publisher",
+ "description": "Lets Android application developers access their Google Play accounts.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/android-publisher",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/R8egrhZl5j6Tk7CLvSpuFNhpTLc\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/android-16.png",
+ "x32": "https://www.google.com/images/icons/product/android-32.png"
+ },
+ "id": "androidpublisher:v1",
+ "kind": "discovery#restDescription",
+ "name": "androidpublisher",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "purchases": {
+ "methods": {
+ "cancel": {
+ "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.purchases.cancel",
+ "parameterOrder": [
+ "packageName",
+ "subscriptionId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "The purchased subscription ID (for example, 'monthly001').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the subscription was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "get": {
+ "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.purchases.get",
+ "parameterOrder": [
+ "packageName",
+ "subscriptionId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "The purchased subscription ID (for example, 'monthly001').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the subscription was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
+ "response": {
+ "$ref": "SubscriptionPurchase"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180121",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "SubscriptionPurchase": {
+ "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
+ "id": "SubscriptionPurchase",
+ "properties": {
+ "autoRenewing": {
+ "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time.",
+ "type": "boolean"
+ },
+ "initiationTimestampMsec": {
+ "description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidpublisher#subscriptionPurchase",
+ "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
+ "type": "string"
+ },
+ "validUntilTimestampMsec": {
+ "description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "androidpublisher/v1/applications/",
+ "title": "Google Play Developer API",
+ "version": "v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-api.json b/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-api.json
index deca40660..057e8e0ee 100644
--- a/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-api.json
+++ b/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-api.json
@@ -1,3500 +1,3435 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/eg3_eCWxB9N1rGAK3E85za1viGs\"",
- "discoveryVersion": "v1",
- "id": "androidpublisher:v2",
- "name": "androidpublisher",
- "canonicalName": "Android Publisher",
- "version": "v2",
- "revision": "20180114",
- "title": "Google Play Developer API",
- "description": "Lets Android application developers access their Google Play accounts.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android-publisher",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/androidpublisher/v2/applications/",
- "basePath": "/androidpublisher/v2/applications/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "androidpublisher/v2/applications/",
- "batchPath": "batch/androidpublisher/v2",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/androidpublisher": {
- "description": "View and manage your Google Play Developer account"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/androidpublisher": {
+ "description": "View and manage your Google Play Developer account"
+ }
+ }
}
- }
- }
- },
- "schemas": {
- "Apk": {
- "id": "Apk",
- "type": "object",
- "properties": {
- "binary": {
- "$ref": "ApkBinary",
- "description": "Information about the binary payload of this APK."
- },
- "versionCode": {
- "type": "integer",
- "description": "The version code of the APK, as specified in the APK's manifest file.",
- "format": "int32"
- }
- }
},
- "ApkBinary": {
- "id": "ApkBinary",
- "type": "object",
- "description": "Represents the binary payload of an APK.",
- "properties": {
- "sha1": {
- "type": "string",
- "description": "A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command."
- },
- "sha256": {
- "type": "string",
- "description": "A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command."
- }
- }
+ "basePath": "/androidpublisher/v2/applications/",
+ "baseUrl": "https://www.googleapis.com/androidpublisher/v2/applications/",
+ "batchPath": "batch/androidpublisher/v2",
+ "canonicalName": "Android Publisher",
+ "description": "Lets Android application developers access their Google Play accounts.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/android-publisher",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/eJTlhAFjCoKr6Jd4MPFAfd8JyPA\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/android-16.png",
+ "x32": "https://www.google.com/images/icons/product/android-32.png"
},
- "ApkListing": {
- "id": "ApkListing",
- "type": "object",
- "properties": {
- "language": {
- "type": "string",
- "description": "The language code, in BCP 47 format (eg \"en-US\")."
- },
- "recentChanges": {
- "type": "string",
- "description": "Describe what's new in your APK."
- }
- }
- },
- "ApkListingsListResponse": {
- "id": "ApkListingsListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#apkListingsListResponse\".",
- "default": "androidpublisher#apkListingsListResponse"
- },
- "listings": {
- "type": "array",
- "items": {
- "$ref": "ApkListing"
- }
- }
- }
- },
- "ApksAddExternallyHostedRequest": {
- "id": "ApksAddExternallyHostedRequest",
- "type": "object",
- "properties": {
- "externallyHostedApk": {
- "$ref": "ExternallyHostedApk",
- "description": "The definition of the externally-hosted APK and where it is located."
- }
- }
- },
- "ApksAddExternallyHostedResponse": {
- "id": "ApksAddExternallyHostedResponse",
- "type": "object",
- "properties": {
- "externallyHostedApk": {
- "$ref": "ExternallyHostedApk",
- "description": "The definition of the externally-hosted APK and where it is located."
- }
- }
- },
- "ApksListResponse": {
- "id": "ApksListResponse",
- "type": "object",
- "properties": {
- "apks": {
- "type": "array",
- "items": {
- "$ref": "Apk"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#apksListResponse\".",
- "default": "androidpublisher#apksListResponse"
- }
- }
- },
- "AppDetails": {
- "id": "AppDetails",
- "type": "object",
- "properties": {
- "contactEmail": {
- "type": "string",
- "description": "The user-visible support email for this app."
- },
- "contactPhone": {
- "type": "string",
- "description": "The user-visible support telephone number for this app."
- },
- "contactWebsite": {
- "type": "string",
- "description": "The user-visible website for this app."
- },
- "defaultLanguage": {
- "type": "string",
- "description": "Default language code, in BCP 47 format (eg \"en-US\")."
- }
- }
- },
- "AppEdit": {
- "id": "AppEdit",
- "type": "object",
- "description": "Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.",
- "properties": {
- "expiryTimeSeconds": {
- "type": "string",
- "description": "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)."
- },
- "id": {
- "type": "string",
- "description": "The ID of the edit that can be used in subsequent API calls."
- }
- }
- },
- "Comment": {
- "id": "Comment",
- "type": "object",
- "properties": {
- "developerComment": {
- "$ref": "DeveloperComment",
- "description": "A comment from a developer."
- },
- "userComment": {
- "$ref": "UserComment",
- "description": "A comment from a user."
- }
- }
- },
- "DeobfuscationFile": {
- "id": "DeobfuscationFile",
- "type": "object",
- "description": "Represents a deobfuscation file.",
- "properties": {
- "symbolType": {
- "type": "string",
- "description": "The type of the deobfuscation file."
- }
- }
- },
- "DeobfuscationFilesUploadResponse": {
- "id": "DeobfuscationFilesUploadResponse",
- "type": "object",
- "properties": {
- "deobfuscationFile": {
- "$ref": "DeobfuscationFile"
- }
- }
- },
- "DeveloperComment": {
- "id": "DeveloperComment",
- "type": "object",
- "properties": {
- "lastModified": {
- "$ref": "Timestamp",
- "description": "The last time at which this comment was updated."
- },
- "text": {
- "type": "string",
- "description": "The content of the comment, i.e. reply body."
- }
- }
- },
- "DeviceMetadata": {
- "id": "DeviceMetadata",
- "type": "object",
- "properties": {
- "cpuMake": {
- "type": "string",
- "description": "Device CPU make e.g. \"Qualcomm\""
- },
- "cpuModel": {
- "type": "string",
- "description": "Device CPU model e.g. \"MSM8974\""
- },
- "deviceClass": {
- "type": "string",
- "description": "Device class (e.g. tablet)"
- },
- "glEsVersion": {
- "type": "integer",
- "description": "OpenGL version",
- "format": "int32"
- },
- "manufacturer": {
- "type": "string",
- "description": "Device manufacturer (e.g. Motorola)"
- },
- "nativePlatform": {
- "type": "string",
- "description": "Comma separated list of native platforms (e.g. \"arm\", \"arm7\")"
- },
- "productName": {
- "type": "string",
- "description": "Device model name (e.g. Droid)"
- },
- "ramMb": {
- "type": "integer",
- "description": "Device RAM in Megabytes e.g. \"2048\"",
- "format": "int32"
- },
- "screenDensityDpi": {
- "type": "integer",
- "description": "Screen density in DPI",
- "format": "int32"
- },
- "screenHeightPx": {
- "type": "integer",
- "description": "Screen height in pixels",
- "format": "int32"
- },
- "screenWidthPx": {
- "type": "integer",
- "description": "Screen width in pixels",
- "format": "int32"
- }
- }
- },
- "Entitlement": {
- "id": "Entitlement",
- "type": "object",
- "description": "An Entitlement resource indicates a user's current entitlement to an inapp item or subscription.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "This kind represents an entitlement object in the androidpublisher service.",
- "default": "androidpublisher#entitlement"
- },
- "productId": {
- "type": "string",
- "description": "The SKU of the product."
- },
- "productType": {
- "type": "string",
- "description": "The type of the inapp product. Possible values are: \n- In-app item: \"inapp\" \n- Subscription: \"subs\""
- },
- "token": {
- "type": "string",
- "description": "The token which can be verified using the subscriptions or products API."
- }
- }
- },
- "EntitlementsListResponse": {
- "id": "EntitlementsListResponse",
- "type": "object",
- "properties": {
- "pageInfo": {
- "$ref": "PageInfo"
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "Entitlement"
- }
- },
- "tokenPagination": {
- "$ref": "TokenPagination"
- }
- }
- },
- "ExpansionFile": {
- "id": "ExpansionFile",
- "type": "object",
- "properties": {
- "fileSize": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "referencesVersion": {
- "type": "integer",
- "description": "If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.",
- "format": "int32"
- }
- }
- },
- "ExpansionFilesUploadResponse": {
- "id": "ExpansionFilesUploadResponse",
- "type": "object",
- "properties": {
- "expansionFile": {
- "$ref": "ExpansionFile"
- }
- }
- },
- "ExternallyHostedApk": {
- "id": "ExternallyHostedApk",
- "type": "object",
- "description": "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",
- "properties": {
- "applicationLabel": {
- "type": "string",
- "description": "The application label."
- },
- "certificateBase64s": {
- "type": "array",
- "description": "A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.",
- "items": {
+ "id": "androidpublisher:v2",
+ "kind": "discovery#restDescription",
+ "name": "androidpublisher",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
},
- "externallyHostedUrl": {
- "type": "string",
- "description": "The URL at which the APK is hosted. This must be an https URL."
- },
- "fileSha1Base64": {
- "type": "string",
- "description": "The SHA1 checksum of this APK, represented as a base64 encoded byte array."
- },
- "fileSha256Base64": {
- "type": "string",
- "description": "The SHA256 checksum of this APK, represented as a base64 encoded byte array."
- },
- "fileSize": {
- "type": "string",
- "description": "The file size in bytes of this APK.",
- "format": "int64"
- },
- "iconBase64": {
- "type": "string",
- "description": "The icon image from the APK, as a base64 encoded byte array."
- },
- "maximumSdk": {
- "type": "integer",
- "description": "The maximum SDK supported by this APK (optional).",
- "format": "int32"
- },
- "minimumSdk": {
- "type": "integer",
- "description": "The minimum SDK targeted by this APK.",
- "format": "int32"
- },
- "nativeCodes": {
- "type": "array",
- "description": "The native code environments supported by this APK (optional).",
- "items": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
},
- "packageName": {
- "type": "string",
- "description": "The package name."
- },
- "usesFeatures": {
- "type": "array",
- "description": "The features required by this APK (optional).",
- "items": {
+ "key": {
+ "description": "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.",
+ "location": "query",
"type": "string"
- }
},
- "usesPermissions": {
- "type": "array",
- "description": "The permissions requested by this APK.",
- "items": {
- "$ref": "ExternallyHostedApkUsesPermission"
- }
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "versionCode": {
- "type": "integer",
- "description": "The version code of this APK.",
- "format": "int32"
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
},
- "versionName": {
- "type": "string",
- "description": "The version name of this APK."
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "ExternallyHostedApkUsesPermission": {
- "id": "ExternallyHostedApkUsesPermission",
- "type": "object",
- "description": "A permission used by this APK.",
- "properties": {
- "maxSdkVersion": {
- "type": "integer",
- "description": "Optionally, the maximum SDK version for which the permission is required.",
- "format": "int32"
+ "protocol": "rest",
+ "resources": {
+ "edits": {
+ "methods": {
+ "commit": {
+ "description": "Commits/applies the changes made in this edit back to the app.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.edits.commit",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}:commit",
+ "response": {
+ "$ref": "AppEdit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "delete": {
+ "description": "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.",
+ "httpMethod": "DELETE",
+ "id": "androidpublisher.edits.delete",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "get": {
+ "description": "Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.get",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}",
+ "response": {
+ "$ref": "AppEdit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "insert": {
+ "description": "Creates a new edit for an app, populated with the app's current state.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.edits.insert",
+ "parameterOrder": [
+ "packageName"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits",
+ "request": {
+ "$ref": "AppEdit"
+ },
+ "response": {
+ "$ref": "AppEdit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "validate": {
+ "description": "Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.edits.validate",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}:validate",
+ "response": {
+ "$ref": "AppEdit"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ },
+ "resources": {
+ "apklistings": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the APK-specific localized listing for a specified APK and language code.",
+ "httpMethod": "DELETE",
+ "id": "androidpublisher.edits.apklistings.delete",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode",
+ "language"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The APK version code whose APK-specific listings should be read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "deleteall": {
+ "description": "Deletes all the APK-specific localized listings for a specified APK.",
+ "httpMethod": "DELETE",
+ "id": "androidpublisher.edits.apklistings.deleteall",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The APK version code whose APK-specific listings should be read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "get": {
+ "description": "Fetches the APK-specific localized listing for a specified APK and language code.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.apklistings.get",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode",
+ "language"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The APK version code whose APK-specific listings should be read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
+ "response": {
+ "$ref": "ApkListing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "list": {
+ "description": "Lists all the APK-specific localized listings for a specified APK.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.apklistings.list",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The APK version code whose APK-specific listings should be read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings",
+ "response": {
+ "$ref": "ApkListingsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "patch": {
+ "description": "Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidpublisher.edits.apklistings.patch",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode",
+ "language"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The APK version code whose APK-specific listings should be read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
+ "request": {
+ "$ref": "ApkListing"
+ },
+ "response": {
+ "$ref": "ApkListing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "update": {
+ "description": "Updates or creates the APK-specific localized listing for a specified APK and language code.",
+ "httpMethod": "PUT",
+ "id": "androidpublisher.edits.apklistings.update",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode",
+ "language"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The APK version code whose APK-specific listings should be read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
+ "request": {
+ "$ref": "ApkListing"
+ },
+ "response": {
+ "$ref": "ApkListing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ },
+ "apks": {
+ "methods": {
+ "addexternallyhosted": {
+ "description": "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.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.edits.apks.addexternallyhosted",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/externallyHosted",
+ "request": {
+ "$ref": "ApksAddExternallyHostedRequest"
+ },
+ "response": {
+ "$ref": "ApksAddExternallyHostedResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "list": {
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.apks.list",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks",
+ "response": {
+ "$ref": "ApksListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "upload": {
+ "httpMethod": "POST",
+ "id": "androidpublisher.edits.apks.upload",
+ "mediaUpload": {
+ "accept": [
+ "application/octet-stream",
+ "application/vnd.android.package-archive"
+ ],
+ "maxSize": "1GB",
+ "protocols": {
+ "resumable": {
+ "multipart": true,
+ "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks"
+ },
+ "simple": {
+ "multipart": true,
+ "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks"
+ }
+ }
+ },
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks",
+ "response": {
+ "$ref": "Apk"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ],
+ "supportsMediaUpload": true
+ }
+ }
+ },
+ "deobfuscationfiles": {
+ "methods": {
+ "upload": {
+ "description": "Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.edits.deobfuscationfiles.upload",
+ "mediaUpload": {
+ "accept": [
+ "application/octet-stream"
+ ],
+ "maxSize": "300MB",
+ "protocols": {
+ "resumable": {
+ "multipart": true,
+ "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}"
+ },
+ "simple": {
+ "multipart": true,
+ "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}"
+ }
+ }
+ },
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode",
+ "deobfuscationFileType"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The version code of the APK whose deobfuscation file is being uploaded.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "deobfuscationFileType": {
+ "enum": [
+ "proguard"
+ ],
+ "enumDescriptions": [
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}",
+ "response": {
+ "$ref": "DeobfuscationFilesUploadResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ],
+ "supportsMediaUpload": true
+ }
+ }
+ },
+ "details": {
+ "methods": {
+ "get": {
+ "description": "Fetches app details for this edit. This includes the default language and developer support contact information.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.details.get",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/details",
+ "response": {
+ "$ref": "AppDetails"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "patch": {
+ "description": "Updates app details for this edit. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidpublisher.edits.details.patch",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/details",
+ "request": {
+ "$ref": "AppDetails"
+ },
+ "response": {
+ "$ref": "AppDetails"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "update": {
+ "description": "Updates app details for this edit.",
+ "httpMethod": "PUT",
+ "id": "androidpublisher.edits.details.update",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/details",
+ "request": {
+ "$ref": "AppDetails"
+ },
+ "response": {
+ "$ref": "AppDetails"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ },
+ "expansionfiles": {
+ "methods": {
+ "get": {
+ "description": "Fetches the Expansion File configuration for the APK specified.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.expansionfiles.get",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode",
+ "expansionFileType"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "expansionFileType": {
+ "enum": [
+ "main",
+ "patch"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
+ "response": {
+ "$ref": "ExpansionFile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "httpMethod": "PATCH",
+ "id": "androidpublisher.edits.expansionfiles.patch",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode",
+ "expansionFileType"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "expansionFileType": {
+ "enum": [
+ "main",
+ "patch"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
+ "request": {
+ "$ref": "ExpansionFile"
+ },
+ "response": {
+ "$ref": "ExpansionFile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "update": {
+ "description": "Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.",
+ "httpMethod": "PUT",
+ "id": "androidpublisher.edits.expansionfiles.update",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode",
+ "expansionFileType"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "expansionFileType": {
+ "enum": [
+ "main",
+ "patch"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
+ "request": {
+ "$ref": "ExpansionFile"
+ },
+ "response": {
+ "$ref": "ExpansionFile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "upload": {
+ "description": "Uploads and attaches a new Expansion File to the APK specified.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.edits.expansionfiles.upload",
+ "mediaUpload": {
+ "accept": [
+ "application/octet-stream"
+ ],
+ "maxSize": "2048MB",
+ "protocols": {
+ "resumable": {
+ "multipart": true,
+ "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}"
+ },
+ "simple": {
+ "multipart": true,
+ "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}"
+ }
+ }
+ },
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "apkVersionCode",
+ "expansionFileType"
+ ],
+ "parameters": {
+ "apkVersionCode": {
+ "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "expansionFileType": {
+ "enum": [
+ "main",
+ "patch"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
+ "response": {
+ "$ref": "ExpansionFilesUploadResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ],
+ "supportsMediaUpload": true
+ }
+ }
+ },
+ "images": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the image (specified by id) from the edit.",
+ "httpMethod": "DELETE",
+ "id": "androidpublisher.edits.images.delete",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "language",
+ "imageType",
+ "imageId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "imageId": {
+ "description": "Unique identifier an image within the set of images attached to this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "imageType": {
+ "enum": [
+ "featureGraphic",
+ "icon",
+ "phoneScreenshots",
+ "promoGraphic",
+ "sevenInchScreenshots",
+ "tenInchScreenshots",
+ "tvBanner",
+ "tvScreenshots",
+ "wearScreenshots"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "deleteall": {
+ "description": "Deletes all images for the specified language and image type.",
+ "httpMethod": "DELETE",
+ "id": "androidpublisher.edits.images.deleteall",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "language",
+ "imageType"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "imageType": {
+ "enum": [
+ "featureGraphic",
+ "icon",
+ "phoneScreenshots",
+ "promoGraphic",
+ "sevenInchScreenshots",
+ "tenInchScreenshots",
+ "tvBanner",
+ "tvScreenshots",
+ "wearScreenshots"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
+ "response": {
+ "$ref": "ImagesDeleteAllResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "list": {
+ "description": "Lists all images for the specified language and image type.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.images.list",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "language",
+ "imageType"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "imageType": {
+ "enum": [
+ "featureGraphic",
+ "icon",
+ "phoneScreenshots",
+ "promoGraphic",
+ "sevenInchScreenshots",
+ "tenInchScreenshots",
+ "tvBanner",
+ "tvScreenshots",
+ "wearScreenshots"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
+ "response": {
+ "$ref": "ImagesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "upload": {
+ "description": "Uploads a new image and adds it to the list of images for the specified language and image type.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.edits.images.upload",
+ "mediaUpload": {
+ "accept": [
+ "image/*"
+ ],
+ "maxSize": "15MB",
+ "protocols": {
+ "resumable": {
+ "multipart": true,
+ "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}"
+ },
+ "simple": {
+ "multipart": true,
+ "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}"
+ }
+ }
+ },
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "language",
+ "imageType"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "imageType": {
+ "enum": [
+ "featureGraphic",
+ "icon",
+ "phoneScreenshots",
+ "promoGraphic",
+ "sevenInchScreenshots",
+ "tenInchScreenshots",
+ "tvBanner",
+ "tvScreenshots",
+ "wearScreenshots"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
+ "response": {
+ "$ref": "ImagesUploadResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ],
+ "supportsMediaUpload": true
+ }
+ }
+ },
+ "listings": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified localized store listing from an edit.",
+ "httpMethod": "DELETE",
+ "id": "androidpublisher.edits.listings.delete",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "language"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings/{language}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "deleteall": {
+ "description": "Deletes all localized listings from an edit.",
+ "httpMethod": "DELETE",
+ "id": "androidpublisher.edits.listings.deleteall",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "get": {
+ "description": "Fetches information about a localized store listing.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.listings.get",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "language"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings/{language}",
+ "response": {
+ "$ref": "Listing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "list": {
+ "description": "Returns all of the localized store listings attached to this edit.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.listings.list",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings",
+ "response": {
+ "$ref": "ListingsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "patch": {
+ "description": "Creates or updates a localized store listing. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidpublisher.edits.listings.patch",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "language"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings/{language}",
+ "request": {
+ "$ref": "Listing"
+ },
+ "response": {
+ "$ref": "Listing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "update": {
+ "description": "Creates or updates a localized store listing.",
+ "httpMethod": "PUT",
+ "id": "androidpublisher.edits.listings.update",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "language"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "language": {
+ "description": "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\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/listings/{language}",
+ "request": {
+ "$ref": "Listing"
+ },
+ "response": {
+ "$ref": "Listing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ },
+ "testers": {
+ "methods": {
+ "get": {
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.testers.get",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "track"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "track": {
+ "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
+ "location": "path",
+ "pattern": "(alpha|beta|production|rollout|internal)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/testers/{track}",
+ "response": {
+ "$ref": "Testers"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "id": "androidpublisher.edits.testers.patch",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "track"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "track": {
+ "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
+ "location": "path",
+ "pattern": "(alpha|beta|production|rollout|internal)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/testers/{track}",
+ "request": {
+ "$ref": "Testers"
+ },
+ "response": {
+ "$ref": "Testers"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "id": "androidpublisher.edits.testers.update",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "track"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "track": {
+ "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
+ "location": "path",
+ "pattern": "(alpha|beta|production|rollout|internal)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/testers/{track}",
+ "request": {
+ "$ref": "Testers"
+ },
+ "response": {
+ "$ref": "Testers"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ },
+ "tracks": {
+ "methods": {
+ "get": {
+ "description": "Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.tracks.get",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "track"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "track": {
+ "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
+ "location": "path",
+ "pattern": "(alpha|beta|production|rollout|internal)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/tracks/{track}",
+ "response": {
+ "$ref": "Track"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "list": {
+ "description": "Lists all the track configurations for this edit.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.edits.tracks.list",
+ "parameterOrder": [
+ "packageName",
+ "editId"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/tracks",
+ "response": {
+ "$ref": "TracksListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "patch": {
+ "description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidpublisher.edits.tracks.patch",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "track"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "track": {
+ "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
+ "location": "path",
+ "pattern": "(alpha|beta|production|rollout|internal)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/tracks/{track}",
+ "request": {
+ "$ref": "Track"
+ },
+ "response": {
+ "$ref": "Track"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "update": {
+ "description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.",
+ "httpMethod": "PUT",
+ "id": "androidpublisher.edits.tracks.update",
+ "parameterOrder": [
+ "packageName",
+ "editId",
+ "track"
+ ],
+ "parameters": {
+ "editId": {
+ "description": "Unique identifier for this edit.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "track": {
+ "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
+ "location": "path",
+ "pattern": "(alpha|beta|production|rollout|internal)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/edits/{editId}/tracks/{track}",
+ "request": {
+ "$ref": "Track"
+ },
+ "response": {
+ "$ref": "Track"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ }
+ }
},
- "name": {
- "type": "string",
- "description": "The name of the permission requested."
- }
- }
- },
- "Image": {
- "id": "Image",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "A unique id representing this image."
+ "inappproducts": {
+ "methods": {
+ "delete": {
+ "description": "Delete an in-app product for an app.",
+ "httpMethod": "DELETE",
+ "id": "androidpublisher.inappproducts.delete",
+ "parameterOrder": [
+ "packageName",
+ "sku"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sku": {
+ "description": "Unique identifier for the in-app product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/inappproducts/{sku}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "get": {
+ "description": "Returns information about the in-app product specified.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.inappproducts.get",
+ "parameterOrder": [
+ "packageName",
+ "sku"
+ ],
+ "parameters": {
+ "packageName": {
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sku": {
+ "description": "Unique identifier for the in-app product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/inappproducts/{sku}",
+ "response": {
+ "$ref": "InAppProduct"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "insert": {
+ "description": "Creates a new in-app product for an app.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.inappproducts.insert",
+ "parameterOrder": [
+ "packageName"
+ ],
+ "parameters": {
+ "autoConvertMissingPrices": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/inappproducts",
+ "request": {
+ "$ref": "InAppProduct"
+ },
+ "response": {
+ "$ref": "InAppProduct"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "list": {
+ "description": "List all the in-app products for an Android app, both subscriptions and managed in-app products..",
+ "httpMethod": "GET",
+ "id": "androidpublisher.inappproducts.list",
+ "parameterOrder": [
+ "packageName"
+ ],
+ "parameters": {
+ "maxResults": {
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app with in-app products; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "token": {
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/inappproducts",
+ "response": {
+ "$ref": "InappproductsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "patch": {
+ "description": "Updates the details of an in-app product. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidpublisher.inappproducts.patch",
+ "parameterOrder": [
+ "packageName",
+ "sku"
+ ],
+ "parameters": {
+ "autoConvertMissingPrices": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sku": {
+ "description": "Unique identifier for the in-app product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/inappproducts/{sku}",
+ "request": {
+ "$ref": "InAppProduct"
+ },
+ "response": {
+ "$ref": "InAppProduct"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "update": {
+ "description": "Updates the details of an in-app product.",
+ "httpMethod": "PUT",
+ "id": "androidpublisher.inappproducts.update",
+ "parameterOrder": [
+ "packageName",
+ "sku"
+ ],
+ "parameters": {
+ "autoConvertMissingPrices": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sku": {
+ "description": "Unique identifier for the in-app product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/inappproducts/{sku}",
+ "request": {
+ "$ref": "InAppProduct"
+ },
+ "response": {
+ "$ref": "InAppProduct"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
},
- "sha1": {
- "type": "string",
- "description": "A sha1 hash of the image that was uploaded."
- },
- "url": {
- "type": "string",
- "description": "A URL that will serve a preview of the image."
- }
- }
- },
- "ImagesDeleteAllResponse": {
- "id": "ImagesDeleteAllResponse",
- "type": "object",
- "properties": {
- "deleted": {
- "type": "array",
- "items": {
- "$ref": "Image"
- }
- }
- }
- },
- "ImagesListResponse": {
- "id": "ImagesListResponse",
- "type": "object",
- "properties": {
- "images": {
- "type": "array",
- "items": {
- "$ref": "Image"
- }
- }
- }
- },
- "ImagesUploadResponse": {
- "id": "ImagesUploadResponse",
- "type": "object",
- "properties": {
- "image": {
- "$ref": "Image"
- }
- }
- },
- "InAppProduct": {
- "id": "InAppProduct",
- "type": "object",
- "properties": {
- "defaultLanguage": {
- "type": "string",
- "description": "The default language of the localized data, as defined by BCP 47. e.g. \"en-US\", \"en-GB\"."
- },
- "defaultPrice": {
- "$ref": "Price",
- "description": "Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency."
- },
- "listings": {
- "type": "object",
- "description": "List of localized title and description data.",
- "additionalProperties": {
- "$ref": "InAppProductListing",
- "description": "The language of the localized data, as defined by BCP 47. i.e.: \"en-US\", \"en-GB\"."
- }
- },
- "packageName": {
- "type": "string",
- "description": "The package name of the parent app."
- },
- "prices": {
- "type": "object",
- "description": "Prices per buyer region. None of these prices should be zero. In-app products can never be free.",
- "additionalProperties": {
- "$ref": "Price",
- "description": "Region code, as defined by ISO 3166-2."
- }
- },
- "purchaseType": {
- "type": "string",
- "description": "Purchase type enum value. Unmodifiable after creation."
- },
- "season": {
- "$ref": "Season",
- "description": "Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions."
- },
- "sku": {
- "type": "string",
- "description": "The stock-keeping-unit (SKU) of the product, unique within an app."
- },
- "status": {
- "type": "string"
- },
- "subscriptionPeriod": {
- "type": "string",
- "description": "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)."
- },
- "trialPeriod": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "InAppProductListing": {
- "id": "InAppProductListing",
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- }
- },
- "InappproductsListResponse": {
- "id": "InappproductsListResponse",
- "type": "object",
- "properties": {
- "inappproduct": {
- "type": "array",
- "items": {
- "$ref": "InAppProduct"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#inappproductsListResponse\".",
- "default": "androidpublisher#inappproductsListResponse"
- },
- "pageInfo": {
- "$ref": "PageInfo"
- },
- "tokenPagination": {
- "$ref": "TokenPagination"
- }
- }
- },
- "Listing": {
- "id": "Listing",
- "type": "object",
- "properties": {
- "fullDescription": {
- "type": "string",
- "description": "Full description of the app; this may be up to 4000 characters in length."
- },
- "language": {
- "type": "string",
- "description": "Language localization code (for example, \"de-AT\" for Austrian German)."
- },
- "shortDescription": {
- "type": "string",
- "description": "Short description of the app (previously known as promo text); this may be up to 80 characters in length."
- },
- "title": {
- "type": "string",
- "description": "App's localized title."
- },
- "video": {
- "type": "string",
- "description": "URL of a promotional YouTube video for the app."
- }
- }
- },
- "ListingsListResponse": {
- "id": "ListingsListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#listingsListResponse\".",
- "default": "androidpublisher#listingsListResponse"
- },
- "listings": {
- "type": "array",
- "items": {
- "$ref": "Listing"
- }
- }
- }
- },
- "MonthDay": {
- "id": "MonthDay",
- "type": "object",
- "properties": {
- "day": {
- "type": "integer",
- "description": "Day of a month, value in [1, 31] range. Valid range depends on the specified month.",
- "format": "uint32"
- },
- "month": {
- "type": "integer",
- "description": "Month of a year. e.g. 1 = JAN, 2 = FEB etc.",
- "format": "uint32"
- }
- }
- },
- "PageInfo": {
- "id": "PageInfo",
- "type": "object",
- "properties": {
- "resultPerPage": {
- "type": "integer",
- "format": "int32"
- },
- "startIndex": {
- "type": "integer",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "Price": {
- "id": "Price",
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "3 letter Currency code, as defined by ISO 4217."
- },
- "priceMicros": {
- "type": "string",
- "description": "The price in millionths of the currency base unit represented as a string."
- }
- }
- },
- "ProductPurchase": {
- "id": "ProductPurchase",
- "type": "object",
- "description": "A ProductPurchase resource indicates the status of a user's inapp product purchase.",
- "properties": {
- "consumptionState": {
- "type": "integer",
- "description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed",
- "format": "int32"
- },
- "developerPayload": {
- "type": "string",
- "description": "A developer-specified string that contains supplemental information about an order."
- },
- "kind": {
- "type": "string",
- "description": "This kind represents an inappPurchase object in the androidpublisher service.",
- "default": "androidpublisher#productPurchase"
- },
- "orderId": {
- "type": "string",
- "description": "The order id associated with the purchase of the inapp product."
- },
- "purchaseState": {
- "type": "integer",
- "description": "The purchase state of the order. Possible values are: \n- Purchased \n- Cancelled",
- "format": "int32"
- },
- "purchaseTimeMillis": {
- "type": "string",
- "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
- "format": "int64"
- },
- "purchaseType": {
- "type": "integer",
- "description": "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: \n- Test (i.e. purchased from a license testing account)",
- "format": "int32"
- }
- }
- },
- "Prorate": {
- "id": "Prorate",
- "type": "object",
- "properties": {
- "defaultPrice": {
- "$ref": "Price",
- "description": "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."
- },
- "start": {
- "$ref": "MonthDay",
- "description": "Defines the first day on which the price takes effect."
- }
- }
- },
- "Review": {
- "id": "Review",
- "type": "object",
- "properties": {
- "authorName": {
- "type": "string",
- "description": "The name of the user who wrote the review."
- },
- "comments": {
- "type": "array",
- "description": "A repeated field containing comments for the review.",
- "items": {
- "$ref": "Comment"
- }
- },
- "reviewId": {
- "type": "string",
- "description": "Unique identifier for this review."
- }
- }
- },
- "ReviewReplyResult": {
- "id": "ReviewReplyResult",
- "type": "object",
- "properties": {
- "lastEdited": {
- "$ref": "Timestamp",
- "description": "The time at which the reply took effect."
- },
- "replyText": {
- "type": "string",
- "description": "The reply text that was applied."
- }
- }
- },
- "ReviewsListResponse": {
- "id": "ReviewsListResponse",
- "type": "object",
- "properties": {
- "pageInfo": {
- "$ref": "PageInfo"
+ "purchases": {
+ "resources": {
+ "products": {
+ "methods": {
+ "get": {
+ "description": "Checks the purchase and consumption status of an inapp item.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.purchases.products.get",
+ "parameterOrder": [
+ "packageName",
+ "productId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the inapp product was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/purchases/products/{productId}/tokens/{token}",
+ "response": {
+ "$ref": "ProductPurchase"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ },
+ "subscriptions": {
+ "methods": {
+ "cancel": {
+ "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.purchases.subscriptions.cancel",
+ "parameterOrder": [
+ "packageName",
+ "subscriptionId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "The purchased subscription ID (for example, 'monthly001').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the subscription was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "defer": {
+ "description": "Defers a user's subscription purchase until a specified future expiration time.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.purchases.subscriptions.defer",
+ "parameterOrder": [
+ "packageName",
+ "subscriptionId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "The purchased subscription ID (for example, 'monthly001').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the subscription was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer",
+ "request": {
+ "$ref": "SubscriptionPurchasesDeferRequest"
+ },
+ "response": {
+ "$ref": "SubscriptionPurchasesDeferResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "get": {
+ "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.purchases.subscriptions.get",
+ "parameterOrder": [
+ "packageName",
+ "subscriptionId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "The purchased subscription ID (for example, 'monthly001').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the subscription was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}",
+ "response": {
+ "$ref": "SubscriptionPurchase"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "refund": {
+ "description": "Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.purchases.subscriptions.refund",
+ "parameterOrder": [
+ "packageName",
+ "subscriptionId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "The purchased subscription ID (for example, 'monthly001').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the subscription was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "revoke": {
+ "description": "Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.purchases.subscriptions.revoke",
+ "parameterOrder": [
+ "packageName",
+ "subscriptionId",
+ "token"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "The purchased subscription ID (for example, 'monthly001').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "token": {
+ "description": "The token provided to the user's device when the subscription was purchased.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ },
+ "voidedpurchases": {
+ "methods": {
+ "list": {
+ "description": "Lists the purchases that were canceled, refunded or charged-back.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.purchases.voidedpurchases.list",
+ "parameterOrder": [
+ "packageName"
+ ],
+ "parameters": {
+ "endTime": {
+ "description": "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.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "packageName": {
+ "description": "The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "startTime": {
+ "description": "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.",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "token": {
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/purchases/voidedpurchases",
+ "response": {
+ "$ref": "VoidedPurchasesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ }
+ }
},
"reviews": {
- "type": "array",
- "items": {
- "$ref": "Review"
- }
- },
- "tokenPagination": {
- "$ref": "TokenPagination"
- }
- }
- },
- "ReviewsReplyRequest": {
- "id": "ReviewsReplyRequest",
- "type": "object",
- "properties": {
- "replyText": {
- "type": "string",
- "description": "The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped."
- }
- }
- },
- "ReviewsReplyResponse": {
- "id": "ReviewsReplyResponse",
- "type": "object",
- "properties": {
- "result": {
- "$ref": "ReviewReplyResult"
- }
- }
- },
- "Season": {
- "id": "Season",
- "type": "object",
- "properties": {
- "end": {
- "$ref": "MonthDay",
- "description": "Inclusive end date of the recurrence period."
- },
- "prorations": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "Prorate"
- }
- },
- "start": {
- "$ref": "MonthDay",
- "description": "Inclusive start date of the recurrence period."
- }
- }
- },
- "SubscriptionDeferralInfo": {
- "id": "SubscriptionDeferralInfo",
- "type": "object",
- "description": "A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time.",
- "properties": {
- "desiredExpiryTimeMillis": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "expectedExpiryTimeMillis": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- }
- }
- },
- "SubscriptionPurchase": {
- "id": "SubscriptionPurchase",
- "type": "object",
- "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
- "properties": {
- "autoRenewing": {
- "type": "boolean",
- "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time."
- },
- "cancelReason": {
- "type": "integer",
- "description": "The reason why a subscription was cancelled or is not auto-renewing. Possible values are: \n- User cancelled the subscription \n- Subscription was cancelled by the system, for example because of a billing problem \n- Subscription was replaced with a new subscription \n- Subscription was cancelled by the developer",
- "format": "int32"
- },
- "countryCode": {
- "type": "string",
- "description": "ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted."
- },
- "developerPayload": {
- "type": "string",
- "description": "A developer-specified string that contains supplemental information about an order."
- },
- "expiryTimeMillis": {
- "type": "string",
- "description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
- "default": "androidpublisher#subscriptionPurchase"
- },
- "linkedPurchaseToken": {
- "type": "string",
- "description": "The purchase token of the originating purchase if this subscription is one of the following: \n- Re-signup of a canceled but non-lapsed subscription \n- 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."
- },
- "orderId": {
- "type": "string",
- "description": "The order id of the latest recurring order associated with the purchase of the subscription."
- },
- "paymentState": {
- "type": "integer",
- "description": "The payment state of the subscription. Possible values are: \n- Payment pending \n- Payment received \n- Free trial",
- "format": "int32"
- },
- "priceAmountMicros": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "priceCurrencyCode": {
- "type": "string",
- "description": "ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is \"GBP\"."
- },
- "purchaseType": {
- "type": "integer",
- "description": "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: \n- Test (i.e. purchased from a license testing account)",
- "format": "int32"
- },
- "startTimeMillis": {
- "type": "string",
- "description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
- "format": "int64"
- },
- "userCancellationTimeMillis": {
- "type": "string",
- "description": "The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.",
- "format": "int64"
- }
- }
- },
- "SubscriptionPurchasesDeferRequest": {
- "id": "SubscriptionPurchasesDeferRequest",
- "type": "object",
- "properties": {
- "deferralInfo": {
- "$ref": "SubscriptionDeferralInfo",
- "description": "The information about the new desired expiry time for the subscription."
- }
- }
- },
- "SubscriptionPurchasesDeferResponse": {
- "id": "SubscriptionPurchasesDeferResponse",
- "type": "object",
- "properties": {
- "newExpiryTimeMillis": {
- "type": "string",
- "description": "The new expiry time for the subscription in milliseconds since the Epoch.",
- "format": "int64"
- }
- }
- },
- "Testers": {
- "id": "Testers",
- "type": "object",
- "properties": {
- "googleGroups": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "googlePlusCommunities": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Timestamp": {
- "id": "Timestamp",
- "type": "object",
- "properties": {
- "nanos": {
- "type": "integer",
- "format": "int32"
- },
- "seconds": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "TokenPagination": {
- "id": "TokenPagination",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string"
- },
- "previousPageToken": {
- "type": "string"
- }
- }
- },
- "Track": {
- "id": "Track",
- "type": "object",
- "properties": {
- "track": {
- "type": "string",
- "description": "Identifier for this track. One of \"alpha\", \"beta\", \"production\" or \"rollout\"."
- },
- "userFraction": {
- "type": "number",
- "format": "double"
- },
- "versionCodes": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- }
- }
- },
- "TracksListResponse": {
- "id": "TracksListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#tracksListResponse\".",
- "default": "androidpublisher#tracksListResponse"
- },
- "tracks": {
- "type": "array",
- "items": {
- "$ref": "Track"
- }
- }
- }
- },
- "UserComment": {
- "id": "UserComment",
- "type": "object",
- "properties": {
- "androidOsVersion": {
- "type": "integer",
- "description": "Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.",
- "format": "int32"
- },
- "appVersionCode": {
- "type": "integer",
- "description": "Integer version code of the app as installed at the time the review was written. May be absent.",
- "format": "int32"
- },
- "appVersionName": {
- "type": "string",
- "description": "String version name of the app as installed at the time the review was written. May be absent."
- },
- "device": {
- "type": "string",
- "description": "Codename for the reviewer's device, e.g. klte, flounder. May be absent."
- },
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "Some information about the characteristics of the user's device"
- },
- "lastModified": {
- "$ref": "Timestamp",
- "description": "The last time at which this comment was updated."
- },
- "originalText": {
- "type": "string",
- "description": "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."
- },
- "reviewerLanguage": {
- "type": "string",
- "description": "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."
- },
- "starRating": {
- "type": "integer",
- "description": "The star rating associated with the review, from 1 to 5.",
- "format": "int32"
- },
- "text": {
- "type": "string",
- "description": "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."
- },
- "thumbsDownCount": {
- "type": "integer",
- "description": "Number of users who have given this review a thumbs down",
- "format": "int32"
- },
- "thumbsUpCount": {
- "type": "integer",
- "description": "Number of users who have given this review a thumbs up",
- "format": "int32"
- }
- }
- },
- "VoidedPurchase": {
- "id": "VoidedPurchase",
- "type": "object",
- "description": "A VoidedPurchase resource indicates a purchase that was either cancelled/refunded/charged-back.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "This kind represents a voided purchase object in the androidpublisher service.",
- "default": "androidpublisher#voidedPurchase"
- },
- "purchaseTimeMillis": {
- "type": "string",
- "description": "The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).",
- "format": "int64"
- },
- "purchaseToken": {
- "type": "string",
- "description": "The token that was generated when a purchase was made. This uniquely identifies a purchase."
- },
- "voidedTimeMillis": {
- "type": "string",
- "description": "The time at which the purchase was cancelled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).",
- "format": "int64"
- }
- }
- },
- "VoidedPurchasesListResponse": {
- "id": "VoidedPurchasesListResponse",
- "type": "object",
- "properties": {
- "pageInfo": {
- "$ref": "PageInfo"
- },
- "tokenPagination": {
- "$ref": "TokenPagination"
- },
- "voidedPurchases": {
- "type": "array",
- "items": {
- "$ref": "VoidedPurchase"
- }
- }
- }
- }
- },
- "resources": {
- "edits": {
- "methods": {
- "commit": {
- "id": "androidpublisher.edits.commit",
- "path": "{packageName}/edits/{editId}:commit",
- "httpMethod": "POST",
- "description": "Commits/applies the changes made in this edit back to the app.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "AppEdit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "delete": {
- "id": "androidpublisher.edits.delete",
- "path": "{packageName}/edits/{editId}",
- "httpMethod": "DELETE",
- "description": "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.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.edits.get",
- "path": "{packageName}/edits/{editId}",
- "httpMethod": "GET",
- "description": "Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "AppEdit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "insert": {
- "id": "androidpublisher.edits.insert",
- "path": "{packageName}/edits",
- "httpMethod": "POST",
- "description": "Creates a new edit for an app, populated with the app's current state.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName"
- ],
- "request": {
- "$ref": "AppEdit"
- },
- "response": {
- "$ref": "AppEdit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "validate": {
- "id": "androidpublisher.edits.validate",
- "path": "{packageName}/edits/{editId}:validate",
- "httpMethod": "POST",
- "description": "Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "AppEdit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- },
- "resources": {
- "apklistings": {
- "methods": {
- "delete": {
- "id": "androidpublisher.edits.apklistings.delete",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- "httpMethod": "DELETE",
- "description": "Deletes the APK-specific localized listing for a specified APK and language code.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
+ "methods": {
+ "get": {
+ "description": "Returns a single review.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.reviews.get",
+ "parameterOrder": [
+ "packageName",
+ "reviewId"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "Unique identifier for the Android app for which we want reviews; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reviewId": {
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "translationLanguage": {
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/reviews/{reviewId}",
+ "response": {
+ "$ref": "Review"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
},
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
+ "list": {
+ "description": "Returns a list of reviews. Only reviews from last week will be returned.",
+ "httpMethod": "GET",
+ "id": "androidpublisher.reviews.list",
+ "parameterOrder": [
+ "packageName"
+ ],
+ "parameters": {
+ "maxResults": {
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "packageName": {
+ "description": "Unique identifier for the Android app for which we want reviews; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "token": {
+ "location": "query",
+ "type": "string"
+ },
+ "translationLanguage": {
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/reviews",
+ "response": {
+ "$ref": "ReviewsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ },
+ "reply": {
+ "description": "Reply to a single review, or update an existing reply.",
+ "httpMethod": "POST",
+ "id": "androidpublisher.reviews.reply",
+ "parameterOrder": [
+ "packageName",
+ "reviewId"
+ ],
+ "parameters": {
+ "packageName": {
+ "description": "Unique identifier for the Android app for which we want reviews; for example, \"com.spiffygame\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "reviewId": {
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{packageName}/reviews/{reviewId}:reply",
+ "request": {
+ "$ref": "ReviewsReplyRequest"
+ },
+ "response": {
+ "$ref": "ReviewsReplyResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidpublisher"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180327",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Apk": {
+ "id": "Apk",
+ "properties": {
+ "binary": {
+ "$ref": "ApkBinary",
+ "description": "Information about the binary payload of this APK."
+ },
+ "versionCode": {
+ "description": "The version code of the APK, as specified in the APK's manifest file.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ApkBinary": {
+ "description": "Represents the binary payload of an APK.",
+ "id": "ApkBinary",
+ "properties": {
+ "sha1": {
+ "description": "A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command.",
+ "type": "string"
+ },
+ "sha256": {
+ "description": "A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ApkListing": {
+ "id": "ApkListing",
+ "properties": {
+ "language": {
+ "description": "The language code, in BCP 47 format (eg \"en-US\").",
+ "type": "string"
+ },
+ "recentChanges": {
+ "description": "Describe what's new in your APK.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ApkListingsListResponse": {
+ "id": "ApkListingsListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidpublisher#apkListingsListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#apkListingsListResponse\".",
+ "type": "string"
+ },
+ "listings": {
+ "items": {
+ "$ref": "ApkListing"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ApksAddExternallyHostedRequest": {
+ "id": "ApksAddExternallyHostedRequest",
+ "properties": {
+ "externallyHostedApk": {
+ "$ref": "ExternallyHostedApk",
+ "description": "The definition of the externally-hosted APK and where it is located."
+ }
+ },
+ "type": "object"
+ },
+ "ApksAddExternallyHostedResponse": {
+ "id": "ApksAddExternallyHostedResponse",
+ "properties": {
+ "externallyHostedApk": {
+ "$ref": "ExternallyHostedApk",
+ "description": "The definition of the externally-hosted APK and where it is located."
+ }
+ },
+ "type": "object"
+ },
+ "ApksListResponse": {
+ "id": "ApksListResponse",
+ "properties": {
+ "apks": {
+ "items": {
+ "$ref": "Apk"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "androidpublisher#apksListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#apksListResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AppDetails": {
+ "id": "AppDetails",
+ "properties": {
+ "contactEmail": {
+ "description": "The user-visible support email for this app.",
+ "type": "string"
+ },
+ "contactPhone": {
+ "description": "The user-visible support telephone number for this app.",
+ "type": "string"
+ },
+ "contactWebsite": {
+ "description": "The user-visible website for this app.",
+ "type": "string"
+ },
+ "defaultLanguage": {
+ "description": "Default language code, in BCP 47 format (eg \"en-US\").",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AppEdit": {
+ "description": "Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.",
+ "id": "AppEdit",
+ "properties": {
+ "expiryTimeSeconds": {
+ "description": "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).",
+ "type": "string"
+ },
+ "id": {
+ "description": "The ID of the edit that can be used in subsequent API calls.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Comment": {
+ "id": "Comment",
+ "properties": {
+ "developerComment": {
+ "$ref": "DeveloperComment",
+ "description": "A comment from a developer."
+ },
+ "userComment": {
+ "$ref": "UserComment",
+ "description": "A comment from a user."
+ }
+ },
+ "type": "object"
+ },
+ "DeobfuscationFile": {
+ "description": "Represents a deobfuscation file.",
+ "id": "DeobfuscationFile",
+ "properties": {
+ "symbolType": {
+ "description": "The type of the deobfuscation file.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeobfuscationFilesUploadResponse": {
+ "id": "DeobfuscationFilesUploadResponse",
+ "properties": {
+ "deobfuscationFile": {
+ "$ref": "DeobfuscationFile"
+ }
+ },
+ "type": "object"
+ },
+ "DeveloperComment": {
+ "id": "DeveloperComment",
+ "properties": {
+ "lastModified": {
+ "$ref": "Timestamp",
+ "description": "The last time at which this comment was updated."
+ },
+ "text": {
+ "description": "The content of the comment, i.e. reply body.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeviceMetadata": {
+ "id": "DeviceMetadata",
+ "properties": {
+ "cpuMake": {
+ "description": "Device CPU make e.g. \"Qualcomm\"",
+ "type": "string"
+ },
+ "cpuModel": {
+ "description": "Device CPU model e.g. \"MSM8974\"",
+ "type": "string"
+ },
+ "deviceClass": {
+ "description": "Device class (e.g. tablet)",
+ "type": "string"
+ },
+ "glEsVersion": {
+ "description": "OpenGL version",
+ "format": "int32",
+ "type": "integer"
+ },
+ "manufacturer": {
+ "description": "Device manufacturer (e.g. Motorola)",
+ "type": "string"
+ },
+ "nativePlatform": {
+ "description": "Comma separated list of native platforms (e.g. \"arm\", \"arm7\")",
+ "type": "string"
+ },
+ "productName": {
+ "description": "Device model name (e.g. Droid)",
+ "type": "string"
+ },
+ "ramMb": {
+ "description": "Device RAM in Megabytes e.g. \"2048\"",
+ "format": "int32",
+ "type": "integer"
+ },
+ "screenDensityDpi": {
+ "description": "Screen density in DPI",
+ "format": "int32",
+ "type": "integer"
+ },
+ "screenHeightPx": {
+ "description": "Screen height in pixels",
+ "format": "int32",
+ "type": "integer"
+ },
+ "screenWidthPx": {
+ "description": "Screen width in pixels",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ExpansionFile": {
+ "id": "ExpansionFile",
+ "properties": {
+ "fileSize": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "referencesVersion": {
+ "description": "If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ExpansionFilesUploadResponse": {
+ "id": "ExpansionFilesUploadResponse",
+ "properties": {
+ "expansionFile": {
+ "$ref": "ExpansionFile"
+ }
+ },
+ "type": "object"
+ },
+ "ExternallyHostedApk": {
+ "description": "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",
+ "id": "ExternallyHostedApk",
+ "properties": {
+ "applicationLabel": {
+ "description": "The application label.",
+ "type": "string"
+ },
+ "certificateBase64s": {
+ "description": "A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "externallyHostedUrl": {
+ "description": "The URL at which the APK is hosted. This must be an https URL.",
+ "type": "string"
+ },
+ "fileSha1Base64": {
+ "description": "The SHA1 checksum of this APK, represented as a base64 encoded byte array.",
+ "type": "string"
+ },
+ "fileSha256Base64": {
+ "description": "The SHA256 checksum of this APK, represented as a base64 encoded byte array.",
+ "type": "string"
+ },
+ "fileSize": {
+ "description": "The file size in bytes of this APK.",
+ "format": "int64",
+ "type": "string"
+ },
+ "iconBase64": {
+ "description": "The icon image from the APK, as a base64 encoded byte array.",
+ "type": "string"
+ },
+ "maximumSdk": {
+ "description": "The maximum SDK supported by this APK (optional).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minimumSdk": {
+ "description": "The minimum SDK targeted by this APK.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nativeCodes": {
+ "description": "The native code environments supported by this APK (optional).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "packageName": {
+ "description": "The package name.",
+ "type": "string"
+ },
+ "usesFeatures": {
+ "description": "The features required by this APK (optional).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "usesPermissions": {
+ "description": "The permissions requested by this APK.",
+ "items": {
+ "$ref": "ExternallyHostedApkUsesPermission"
+ },
+ "type": "array"
+ },
+ "versionCode": {
+ "description": "The version code of this APK.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "versionName": {
+ "description": "The version name of this APK.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ExternallyHostedApkUsesPermission": {
+ "description": "A permission used by this APK.",
+ "id": "ExternallyHostedApkUsesPermission",
+ "properties": {
+ "maxSdkVersion": {
+ "description": "Optionally, the maximum SDK version for which the permission is required.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the permission requested.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Image": {
+ "id": "Image",
+ "properties": {
+ "id": {
+ "description": "A unique id representing this image.",
+ "type": "string"
+ },
+ "sha1": {
+ "description": "A sha1 hash of the image that was uploaded.",
+ "type": "string"
+ },
+ "url": {
+ "description": "A URL that will serve a preview of the image.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ImagesDeleteAllResponse": {
+ "id": "ImagesDeleteAllResponse",
+ "properties": {
+ "deleted": {
+ "items": {
+ "$ref": "Image"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ImagesListResponse": {
+ "id": "ImagesListResponse",
+ "properties": {
+ "images": {
+ "items": {
+ "$ref": "Image"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ImagesUploadResponse": {
+ "id": "ImagesUploadResponse",
+ "properties": {
+ "image": {
+ "$ref": "Image"
+ }
+ },
+ "type": "object"
+ },
+ "InAppProduct": {
+ "id": "InAppProduct",
+ "properties": {
+ "defaultLanguage": {
+ "description": "The default language of the localized data, as defined by BCP 47. e.g. \"en-US\", \"en-GB\".",
+ "type": "string"
+ },
+ "defaultPrice": {
+ "$ref": "Price",
+ "description": "Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency."
+ },
+ "listings": {
+ "additionalProperties": {
+ "$ref": "InAppProductListing",
+ "description": "The language of the localized data, as defined by BCP 47. i.e.: \"en-US\", \"en-GB\"."
+ },
+ "description": "List of localized title and description data.",
+ "type": "object"
+ },
+ "packageName": {
+ "description": "The package name of the parent app.",
+ "type": "string"
+ },
+ "prices": {
+ "additionalProperties": {
+ "$ref": "Price",
+ "description": "Region code, as defined by ISO 3166-2."
+ },
+ "description": "Prices per buyer region. None of these prices should be zero. In-app products can never be free.",
+ "type": "object"
+ },
+ "purchaseType": {
+ "description": "Purchase type enum value. Unmodifiable after creation.",
+ "type": "string"
+ },
+ "season": {
+ "$ref": "Season",
+ "description": "Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions."
+ },
+ "sku": {
+ "description": "The stock-keeping-unit (SKU) of the product, unique within an app.",
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "subscriptionPeriod": {
+ "description": "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).",
+ "type": "string"
+ },
+ "trialPeriod": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InAppProductListing": {
+ "id": "InAppProductListing",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InappproductsListResponse": {
+ "id": "InappproductsListResponse",
+ "properties": {
+ "inappproduct": {
+ "items": {
+ "$ref": "InAppProduct"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "androidpublisher#inappproductsListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#inappproductsListResponse\".",
+ "type": "string"
+ },
+ "pageInfo": {
+ "$ref": "PageInfo"
+ },
+ "tokenPagination": {
+ "$ref": "TokenPagination"
+ }
+ },
+ "type": "object"
+ },
+ "Listing": {
+ "id": "Listing",
+ "properties": {
+ "fullDescription": {
+ "description": "Full description of the app; this may be up to 4000 characters in length.",
+ "type": "string"
},
"language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
+ "description": "Language localization code (for example, \"de-AT\" for Austrian German).",
+ "type": "string"
},
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
+ "shortDescription": {
+ "description": "Short description of the app (previously known as promo text); this may be up to 80 characters in length.",
+ "type": "string"
+ },
+ "title": {
+ "description": "App's localized title.",
+ "type": "string"
+ },
+ "video": {
+ "description": "URL of a promotional YouTube video for the app.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "language"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
},
- "deleteall": {
- "id": "androidpublisher.edits.apklistings.deleteall",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings",
- "httpMethod": "DELETE",
- "description": "Deletes all the APK-specific localized listings for a specified APK.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.edits.apklistings.get",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- "httpMethod": "GET",
- "description": "Fetches the APK-specific localized listing for a specified APK and language code.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "language"
- ],
- "response": {
- "$ref": "ApkListing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.edits.apklistings.list",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings",
- "httpMethod": "GET",
- "description": "Lists all the APK-specific localized listings for a specified APK.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode"
- ],
- "response": {
- "$ref": "ApkListingsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.apklistings.patch",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- "httpMethod": "PATCH",
- "description": "Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "language"
- ],
- "request": {
- "$ref": "ApkListing"
- },
- "response": {
- "$ref": "ApkListing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.apklistings.update",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- "httpMethod": "PUT",
- "description": "Updates or creates the APK-specific localized listing for a specified APK and language code.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "language"
- ],
- "request": {
- "$ref": "ApkListing"
- },
- "response": {
- "$ref": "ApkListing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
+ "type": "object"
},
- "apks": {
- "methods": {
- "addexternallyhosted": {
- "id": "androidpublisher.edits.apks.addexternallyhosted",
- "path": "{packageName}/edits/{editId}/apks/externallyHosted",
- "httpMethod": "POST",
- "description": "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.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
+ "ListingsListResponse": {
+ "id": "ListingsListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidpublisher#listingsListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#listingsListResponse\".",
+ "type": "string"
},
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
+ "listings": {
+ "items": {
+ "$ref": "Listing"
+ },
+ "type": "array"
}
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "request": {
- "$ref": "ApksAddExternallyHostedRequest"
- },
- "response": {
- "$ref": "ApksAddExternallyHostedResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
},
- "list": {
- "id": "androidpublisher.edits.apks.list",
- "path": "{packageName}/edits/{editId}/apks",
- "httpMethod": "GET",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "ApksListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "upload": {
- "id": "androidpublisher.edits.apks.upload",
- "path": "{packageName}/edits/{editId}/apks",
- "httpMethod": "POST",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "Apk"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "application/octet-stream",
- "application/vnd.android.package-archive"
- ],
- "maxSize": "1GB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks"
- }
- }
- }
- }
- }
+ "type": "object"
},
- "deobfuscationfiles": {
- "methods": {
- "upload": {
- "id": "androidpublisher.edits.deobfuscationfiles.upload",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}",
- "httpMethod": "POST",
- "description": "Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The version code of the APK whose deobfuscation file is being uploaded.",
- "required": true,
- "format": "int32",
- "location": "path"
+ "MonthDay": {
+ "id": "MonthDay",
+ "properties": {
+ "day": {
+ "description": "Day of a month, value in [1, 31] range. Valid range depends on the specified month.",
+ "format": "uint32",
+ "type": "integer"
},
- "deobfuscationFileType": {
- "type": "string",
- "required": true,
- "enum": [
- "proguard"
- ],
- "enumDescriptions": [
- ""
- ],
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
+ "month": {
+ "description": "Month of a year. e.g. 1 = JAN, 2 = FEB etc.",
+ "format": "uint32",
+ "type": "integer"
}
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "deobfuscationFileType"
- ],
- "response": {
- "$ref": "DeobfuscationFilesUploadResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "application/octet-stream"
- ],
- "maxSize": "300MB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}"
- }
- }
- }
- }
- }
+ },
+ "type": "object"
},
- "details": {
- "methods": {
- "get": {
- "id": "androidpublisher.edits.details.get",
- "path": "{packageName}/edits/{editId}/details",
- "httpMethod": "GET",
- "description": "Fetches app details for this edit. This includes the default language and developer support contact information.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "AppDetails"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.details.patch",
- "path": "{packageName}/edits/{editId}/details",
- "httpMethod": "PATCH",
- "description": "Updates app details for this edit. This method supports patch semantics.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "request": {
- "$ref": "AppDetails"
- },
- "response": {
- "$ref": "AppDetails"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.details.update",
- "path": "{packageName}/edits/{editId}/details",
- "httpMethod": "PUT",
- "description": "Updates app details for this edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "request": {
- "$ref": "AppDetails"
- },
- "response": {
- "$ref": "AppDetails"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "expansionfiles": {
- "methods": {
- "get": {
- "id": "androidpublisher.edits.expansionfiles.get",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- "httpMethod": "GET",
- "description": "Fetches the Expansion File configuration for the APK specified.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "expansionFileType": {
- "type": "string",
- "required": true,
- "enum": [
- "main",
- "patch"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "expansionFileType"
- ],
- "response": {
- "$ref": "ExpansionFile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.expansionfiles.patch",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- "httpMethod": "PATCH",
- "description": "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.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "expansionFileType": {
- "type": "string",
- "required": true,
- "enum": [
- "main",
- "patch"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "expansionFileType"
- ],
- "request": {
- "$ref": "ExpansionFile"
- },
- "response": {
- "$ref": "ExpansionFile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.expansionfiles.update",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- "httpMethod": "PUT",
- "description": "Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "expansionFileType": {
- "type": "string",
- "required": true,
- "enum": [
- "main",
- "patch"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "expansionFileType"
- ],
- "request": {
- "$ref": "ExpansionFile"
- },
- "response": {
- "$ref": "ExpansionFile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "upload": {
- "id": "androidpublisher.edits.expansionfiles.upload",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- "httpMethod": "POST",
- "description": "Uploads and attaches a new Expansion File to the APK specified.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "expansionFileType": {
- "type": "string",
- "required": true,
- "enum": [
- "main",
- "patch"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "expansionFileType"
- ],
- "response": {
- "$ref": "ExpansionFilesUploadResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "application/octet-stream"
- ],
- "maxSize": "2048MB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}"
- }
- }
- }
- }
- }
- },
- "images": {
- "methods": {
- "delete": {
- "id": "androidpublisher.edits.images.delete",
- "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}",
- "httpMethod": "DELETE",
- "description": "Deletes the image (specified by id) from the edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "imageId": {
- "type": "string",
- "description": "Unique identifier an image within the set of images attached to this edit.",
- "required": true,
- "location": "path"
- },
- "imageType": {
- "type": "string",
- "required": true,
- "enum": [
- "featureGraphic",
- "icon",
- "phoneScreenshots",
- "promoGraphic",
- "sevenInchScreenshots",
- "tenInchScreenshots",
- "tvBanner",
- "tvScreenshots",
- "wearScreenshots"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language",
- "imageType",
- "imageId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "deleteall": {
- "id": "androidpublisher.edits.images.deleteall",
- "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
- "httpMethod": "DELETE",
- "description": "Deletes all images for the specified language and image type.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "imageType": {
- "type": "string",
- "required": true,
- "enum": [
- "featureGraphic",
- "icon",
- "phoneScreenshots",
- "promoGraphic",
- "sevenInchScreenshots",
- "tenInchScreenshots",
- "tvBanner",
- "tvScreenshots",
- "wearScreenshots"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language",
- "imageType"
- ],
- "response": {
- "$ref": "ImagesDeleteAllResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.edits.images.list",
- "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
- "httpMethod": "GET",
- "description": "Lists all images for the specified language and image type.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "imageType": {
- "type": "string",
- "required": true,
- "enum": [
- "featureGraphic",
- "icon",
- "phoneScreenshots",
- "promoGraphic",
- "sevenInchScreenshots",
- "tenInchScreenshots",
- "tvBanner",
- "tvScreenshots",
- "wearScreenshots"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language",
- "imageType"
- ],
- "response": {
- "$ref": "ImagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "upload": {
- "id": "androidpublisher.edits.images.upload",
- "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
- "httpMethod": "POST",
- "description": "Uploads a new image and adds it to the list of images for the specified language and image type.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "imageType": {
- "type": "string",
- "required": true,
- "enum": [
- "featureGraphic",
- "icon",
- "phoneScreenshots",
- "promoGraphic",
- "sevenInchScreenshots",
- "tenInchScreenshots",
- "tvBanner",
- "tvScreenshots",
- "wearScreenshots"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language",
- "imageType"
- ],
- "response": {
- "$ref": "ImagesUploadResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "image/*"
- ],
- "maxSize": "15MB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}"
- }
- }
- }
- }
- }
- },
- "listings": {
- "methods": {
- "delete": {
- "id": "androidpublisher.edits.listings.delete",
- "path": "{packageName}/edits/{editId}/listings/{language}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified localized store listing from an edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "deleteall": {
- "id": "androidpublisher.edits.listings.deleteall",
- "path": "{packageName}/edits/{editId}/listings",
- "httpMethod": "DELETE",
- "description": "Deletes all localized listings from an edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.edits.listings.get",
- "path": "{packageName}/edits/{editId}/listings/{language}",
- "httpMethod": "GET",
- "description": "Fetches information about a localized store listing.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language"
- ],
- "response": {
- "$ref": "Listing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.edits.listings.list",
- "path": "{packageName}/edits/{editId}/listings",
- "httpMethod": "GET",
- "description": "Returns all of the localized store listings attached to this edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "ListingsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.listings.patch",
- "path": "{packageName}/edits/{editId}/listings/{language}",
- "httpMethod": "PATCH",
- "description": "Creates or updates a localized store listing. This method supports patch semantics.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language"
- ],
- "request": {
- "$ref": "Listing"
- },
- "response": {
- "$ref": "Listing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.listings.update",
- "path": "{packageName}/edits/{editId}/listings/{language}",
- "httpMethod": "PUT",
- "description": "Creates or updates a localized store listing.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "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\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language"
- ],
- "request": {
- "$ref": "Listing"
- },
- "response": {
- "$ref": "Listing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "testers": {
- "methods": {
- "get": {
- "id": "androidpublisher.edits.testers.get",
- "path": "{packageName}/edits/{editId}/testers/{track}",
- "httpMethod": "GET",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
- "required": true,
- "pattern": "(alpha|beta|production|rollout)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "response": {
- "$ref": "Testers"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.testers.patch",
- "path": "{packageName}/edits/{editId}/testers/{track}",
- "httpMethod": "PATCH",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
- "required": true,
- "pattern": "(alpha|beta|production|rollout)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "request": {
- "$ref": "Testers"
- },
- "response": {
- "$ref": "Testers"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.testers.update",
- "path": "{packageName}/edits/{editId}/testers/{track}",
- "httpMethod": "PUT",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
- "required": true,
- "pattern": "(alpha|beta|production|rollout)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "request": {
- "$ref": "Testers"
- },
- "response": {
- "$ref": "Testers"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "tracks": {
- "methods": {
- "get": {
- "id": "androidpublisher.edits.tracks.get",
- "path": "{packageName}/edits/{editId}/tracks/{track}",
- "httpMethod": "GET",
- "description": "Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
- "required": true,
- "pattern": "(alpha|beta|production|rollout)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "response": {
- "$ref": "Track"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.edits.tracks.list",
- "path": "{packageName}/edits/{editId}/tracks",
- "httpMethod": "GET",
- "description": "Lists all the track configurations for this edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "TracksListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.tracks.patch",
- "path": "{packageName}/edits/{editId}/tracks/{track}",
- "httpMethod": "PATCH",
- "description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
- "required": true,
- "pattern": "(alpha|beta|production|rollout)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "request": {
- "$ref": "Track"
- },
- "response": {
- "$ref": "Track"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.tracks.update",
- "path": "{packageName}/edits/{editId}/tracks/{track}",
- "httpMethod": "PUT",
- "description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
- "required": true,
- "pattern": "(alpha|beta|production|rollout)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "request": {
- "$ref": "Track"
- },
- "response": {
- "$ref": "Track"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- }
- }
- },
- "entitlements": {
- "methods": {
- "list": {
- "id": "androidpublisher.entitlements.list",
- "path": "{packageName}/entitlements",
- "httpMethod": "GET",
- "description": "Lists the user's current inapp item or subscription entitlements",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The product id of the inapp product (for example, 'sku1'). This can be used to restrict the result set.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "token": {
- "type": "string",
- "location": "query"
- }
- },
- "parameterOrder": [
- "packageName"
- ],
- "response": {
- "$ref": "EntitlementsListResponse"
- }
- }
- }
- },
- "inappproducts": {
- "methods": {
- "delete": {
- "id": "androidpublisher.inappproducts.delete",
- "path": "{packageName}/inappproducts/{sku}",
- "httpMethod": "DELETE",
- "description": "Delete an in-app product for an app.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "sku": {
- "type": "string",
- "description": "Unique identifier for the in-app product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "sku"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.inappproducts.get",
- "path": "{packageName}/inappproducts/{sku}",
- "httpMethod": "GET",
- "description": "Returns information about the in-app product specified.",
- "parameters": {
- "packageName": {
- "type": "string",
- "required": true,
- "location": "path"
- },
- "sku": {
- "type": "string",
- "description": "Unique identifier for the in-app product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "sku"
- ],
- "response": {
- "$ref": "InAppProduct"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "insert": {
- "id": "androidpublisher.inappproducts.insert",
- "path": "{packageName}/inappproducts",
- "httpMethod": "POST",
- "description": "Creates a new in-app product for an app.",
- "parameters": {
- "autoConvertMissingPrices": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName"
- ],
- "request": {
- "$ref": "InAppProduct"
- },
- "response": {
- "$ref": "InAppProduct"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.inappproducts.list",
- "path": "{packageName}/inappproducts",
- "httpMethod": "GET",
- "description": "List all the in-app products for an Android app, both subscriptions and managed in-app products..",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app with in-app products; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "token": {
- "type": "string",
- "location": "query"
- }
- },
- "parameterOrder": [
- "packageName"
- ],
- "response": {
- "$ref": "InappproductsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.inappproducts.patch",
- "path": "{packageName}/inappproducts/{sku}",
- "httpMethod": "PATCH",
- "description": "Updates the details of an in-app product. This method supports patch semantics.",
- "parameters": {
- "autoConvertMissingPrices": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "sku": {
- "type": "string",
- "description": "Unique identifier for the in-app product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "sku"
- ],
- "request": {
- "$ref": "InAppProduct"
- },
- "response": {
- "$ref": "InAppProduct"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.inappproducts.update",
- "path": "{packageName}/inappproducts/{sku}",
- "httpMethod": "PUT",
- "description": "Updates the details of an in-app product.",
- "parameters": {
- "autoConvertMissingPrices": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "sku": {
- "type": "string",
- "description": "Unique identifier for the in-app product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "sku"
- ],
- "request": {
- "$ref": "InAppProduct"
- },
- "response": {
- "$ref": "InAppProduct"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "purchases": {
- "resources": {
- "products": {
- "methods": {
- "get": {
- "id": "androidpublisher.purchases.products.get",
- "path": "{packageName}/purchases/products/{productId}/tokens/{token}",
- "httpMethod": "GET",
- "description": "Checks the purchase and consumption status of an inapp item.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the inapp product was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "productId",
- "token"
- ],
- "response": {
- "$ref": "ProductPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "subscriptions": {
- "methods": {
- "cancel": {
- "id": "androidpublisher.purchases.subscriptions.cancel",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel",
- "httpMethod": "POST",
- "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "defer": {
- "id": "androidpublisher.purchases.subscriptions.defer",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer",
- "httpMethod": "POST",
- "description": "Defers a user's subscription purchase until a specified future expiration time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "request": {
- "$ref": "SubscriptionPurchasesDeferRequest"
- },
- "response": {
- "$ref": "SubscriptionPurchasesDeferResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.purchases.subscriptions.get",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}",
- "httpMethod": "GET",
- "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "response": {
- "$ref": "SubscriptionPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "refund": {
- "id": "androidpublisher.purchases.subscriptions.refund",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund",
- "httpMethod": "POST",
- "description": "Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "revoke": {
- "id": "androidpublisher.purchases.subscriptions.revoke",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke",
- "httpMethod": "POST",
- "description": "Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "voidedpurchases": {
- "methods": {
- "list": {
- "id": "androidpublisher.purchases.voidedpurchases.list",
- "path": "{packageName}/purchases/voidedpurchases",
- "httpMethod": "GET",
- "description": "Lists the purchases that were cancelled, refunded or charged-back.",
- "parameters": {
- "endTime": {
- "type": "string",
- "description": "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.",
- "format": "int64",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
+ "PageInfo": {
+ "id": "PageInfo",
+ "properties": {
+ "resultPerPage": {
+ "format": "int32",
+ "type": "integer"
},
"startIndex": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
+ "format": "int32",
+ "type": "integer"
},
- "startTime": {
- "type": "string",
- "description": "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.",
- "format": "int64",
- "location": "query"
- },
- "token": {
- "type": "string",
- "location": "query"
+ "totalResults": {
+ "format": "int32",
+ "type": "integer"
}
- },
- "parameterOrder": [
- "packageName"
- ],
- "response": {
- "$ref": "VoidedPurchasesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
+ },
+ "type": "object"
+ },
+ "Price": {
+ "id": "Price",
+ "properties": {
+ "currency": {
+ "description": "3 letter Currency code, as defined by ISO 4217.",
+ "type": "string"
+ },
+ "priceMicros": {
+ "description": "The price in millionths of the currency base unit represented as a string.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductPurchase": {
+ "description": "A ProductPurchase resource indicates the status of a user's inapp product purchase.",
+ "id": "ProductPurchase",
+ "properties": {
+ "consumptionState": {
+ "description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed",
+ "format": "int32",
+ "type": "integer"
+ },
+ "developerPayload": {
+ "description": "A developer-specified string that contains supplemental information about an order.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidpublisher#productPurchase",
+ "description": "This kind represents an inappPurchase object in the androidpublisher service.",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The order id associated with the purchase of the inapp product.",
+ "type": "string"
+ },
+ "purchaseState": {
+ "description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled",
+ "format": "int32",
+ "type": "integer"
+ },
+ "purchaseTimeMillis": {
+ "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
+ "format": "int64",
+ "type": "string"
+ },
+ "purchaseType": {
+ "description": "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: \n- Test (i.e. purchased from a license testing account) \n- Promo (i.e. purchased using a promo code)",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Prorate": {
+ "id": "Prorate",
+ "properties": {
+ "defaultPrice": {
+ "$ref": "Price",
+ "description": "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."
+ },
+ "start": {
+ "$ref": "MonthDay",
+ "description": "Defines the first day on which the price takes effect."
+ }
+ },
+ "type": "object"
+ },
+ "Review": {
+ "id": "Review",
+ "properties": {
+ "authorName": {
+ "description": "The name of the user who wrote the review.",
+ "type": "string"
+ },
+ "comments": {
+ "description": "A repeated field containing comments for the review.",
+ "items": {
+ "$ref": "Comment"
+ },
+ "type": "array"
+ },
+ "reviewId": {
+ "description": "Unique identifier for this review.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReviewReplyResult": {
+ "id": "ReviewReplyResult",
+ "properties": {
+ "lastEdited": {
+ "$ref": "Timestamp",
+ "description": "The time at which the reply took effect."
+ },
+ "replyText": {
+ "description": "The reply text that was applied.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReviewsListResponse": {
+ "id": "ReviewsListResponse",
+ "properties": {
+ "pageInfo": {
+ "$ref": "PageInfo"
+ },
+ "reviews": {
+ "items": {
+ "$ref": "Review"
+ },
+ "type": "array"
+ },
+ "tokenPagination": {
+ "$ref": "TokenPagination"
+ }
+ },
+ "type": "object"
+ },
+ "ReviewsReplyRequest": {
+ "id": "ReviewsReplyRequest",
+ "properties": {
+ "replyText": {
+ "description": "The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReviewsReplyResponse": {
+ "id": "ReviewsReplyResponse",
+ "properties": {
+ "result": {
+ "$ref": "ReviewReplyResult"
+ }
+ },
+ "type": "object"
+ },
+ "Season": {
+ "id": "Season",
+ "properties": {
+ "end": {
+ "$ref": "MonthDay",
+ "description": "Inclusive end date of the recurrence period."
+ },
+ "prorations": {
+ "description": "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.",
+ "items": {
+ "$ref": "Prorate"
+ },
+ "type": "array"
+ },
+ "start": {
+ "$ref": "MonthDay",
+ "description": "Inclusive start date of the recurrence period."
+ }
+ },
+ "type": "object"
+ },
+ "SubscriptionDeferralInfo": {
+ "description": "A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time.",
+ "id": "SubscriptionDeferralInfo",
+ "properties": {
+ "desiredExpiryTimeMillis": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "expectedExpiryTimeMillis": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SubscriptionPurchase": {
+ "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
+ "id": "SubscriptionPurchase",
+ "properties": {
+ "autoRenewing": {
+ "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time.",
+ "type": "boolean"
+ },
+ "cancelReason": {
+ "description": "The reason why a subscription was canceled or is not auto-renewing. Possible values are: \n- User canceled the subscription \n- Subscription was canceled by the system, for example because of a billing problem \n- Subscription was replaced with a new subscription \n- Subscription was canceled by the developer",
+ "format": "int32",
+ "type": "integer"
+ },
+ "countryCode": {
+ "description": "ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.",
+ "type": "string"
+ },
+ "developerPayload": {
+ "description": "A developer-specified string that contains supplemental information about an order.",
+ "type": "string"
+ },
+ "emailAddress": {
+ "description": "The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
+ "type": "string"
+ },
+ "expiryTimeMillis": {
+ "description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "familyName": {
+ "description": "The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
+ "type": "string"
+ },
+ "givenName": {
+ "description": "The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidpublisher#subscriptionPurchase",
+ "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
+ "type": "string"
+ },
+ "linkedPurchaseToken": {
+ "description": "The purchase token of the originating purchase if this subscription is one of the following: \n- Re-signup of a canceled but non-lapsed subscription \n- 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.",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "The order id of the latest recurring order associated with the purchase of the subscription.",
+ "type": "string"
+ },
+ "paymentState": {
+ "description": "The payment state of the subscription. Possible values are: \n- Payment pending \n- Payment received \n- Free trial",
+ "format": "int32",
+ "type": "integer"
+ },
+ "priceAmountMicros": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "priceCurrencyCode": {
+ "description": "ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is \"GBP\".",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
+ "type": "string"
+ },
+ "profileName": {
+ "description": "The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
+ "type": "string"
+ },
+ "purchaseType": {
+ "description": "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: \n- Test (i.e. purchased from a license testing account)",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startTimeMillis": {
+ "description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "userCancellationTimeMillis": {
+ "description": "The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SubscriptionPurchasesDeferRequest": {
+ "id": "SubscriptionPurchasesDeferRequest",
+ "properties": {
+ "deferralInfo": {
+ "$ref": "SubscriptionDeferralInfo",
+ "description": "The information about the new desired expiry time for the subscription."
+ }
+ },
+ "type": "object"
+ },
+ "SubscriptionPurchasesDeferResponse": {
+ "id": "SubscriptionPurchasesDeferResponse",
+ "properties": {
+ "newExpiryTimeMillis": {
+ "description": "The new expiry time for the subscription in milliseconds since the Epoch.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Testers": {
+ "id": "Testers",
+ "properties": {
+ "googleGroups": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "googlePlusCommunities": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Timestamp": {
+ "id": "Timestamp",
+ "properties": {
+ "nanos": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "seconds": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TokenPagination": {
+ "id": "TokenPagination",
+ "properties": {
+ "nextPageToken": {
+ "type": "string"
+ },
+ "previousPageToken": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Track": {
+ "id": "Track",
+ "properties": {
+ "track": {
+ "description": "Identifier for this track. One of \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
+ "type": "string"
+ },
+ "userFraction": {
+ "format": "double",
+ "type": "number"
+ },
+ "versionCodes": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TracksListResponse": {
+ "id": "TracksListResponse",
+ "properties": {
+ "kind": {
+ "default": "androidpublisher#tracksListResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#tracksListResponse\".",
+ "type": "string"
+ },
+ "tracks": {
+ "items": {
+ "$ref": "Track"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UserComment": {
+ "id": "UserComment",
+ "properties": {
+ "androidOsVersion": {
+ "description": "Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appVersionCode": {
+ "description": "Integer version code of the app as installed at the time the review was written. May be absent.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appVersionName": {
+ "description": "String version name of the app as installed at the time the review was written. May be absent.",
+ "type": "string"
+ },
+ "device": {
+ "description": "Codename for the reviewer's device, e.g. klte, flounder. May be absent.",
+ "type": "string"
+ },
+ "deviceMetadata": {
+ "$ref": "DeviceMetadata",
+ "description": "Some information about the characteristics of the user's device"
+ },
+ "lastModified": {
+ "$ref": "Timestamp",
+ "description": "The last time at which this comment was updated."
+ },
+ "originalText": {
+ "description": "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.",
+ "type": "string"
+ },
+ "reviewerLanguage": {
+ "description": "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.",
+ "type": "string"
+ },
+ "starRating": {
+ "description": "The star rating associated with the review, from 1 to 5.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "text": {
+ "description": "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.",
+ "type": "string"
+ },
+ "thumbsDownCount": {
+ "description": "Number of users who have given this review a thumbs down",
+ "format": "int32",
+ "type": "integer"
+ },
+ "thumbsUpCount": {
+ "description": "Number of users who have given this review a thumbs up",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "VoidedPurchase": {
+ "description": "A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.",
+ "id": "VoidedPurchase",
+ "properties": {
+ "kind": {
+ "default": "androidpublisher#voidedPurchase",
+ "description": "This kind represents a voided purchase object in the androidpublisher service.",
+ "type": "string"
+ },
+ "purchaseTimeMillis": {
+ "description": "The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).",
+ "format": "int64",
+ "type": "string"
+ },
+ "purchaseToken": {
+ "description": "The token that was generated when a purchase was made. This uniquely identifies a purchase.",
+ "type": "string"
+ },
+ "voidedTimeMillis": {
+ "description": "The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "VoidedPurchasesListResponse": {
+ "id": "VoidedPurchasesListResponse",
+ "properties": {
+ "pageInfo": {
+ "$ref": "PageInfo"
+ },
+ "tokenPagination": {
+ "$ref": "TokenPagination"
+ },
+ "voidedPurchases": {
+ "items": {
+ "$ref": "VoidedPurchase"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
}
- }
},
- "reviews": {
- "methods": {
- "get": {
- "id": "androidpublisher.reviews.get",
- "path": "{packageName}/reviews/{reviewId}",
- "httpMethod": "GET",
- "description": "Returns a single review.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app for which we want reviews; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "reviewId": {
- "type": "string",
- "required": true,
- "location": "path"
- },
- "translationLanguage": {
- "type": "string",
- "location": "query"
- }
- },
- "parameterOrder": [
- "packageName",
- "reviewId"
- ],
- "response": {
- "$ref": "Review"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.reviews.list",
- "path": "{packageName}/reviews",
- "httpMethod": "GET",
- "description": "Returns a list of reviews. Only reviews from last week will be returned.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app for which we want reviews; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "token": {
- "type": "string",
- "location": "query"
- },
- "translationLanguage": {
- "type": "string",
- "location": "query"
- }
- },
- "parameterOrder": [
- "packageName"
- ],
- "response": {
- "$ref": "ReviewsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "reply": {
- "id": "androidpublisher.reviews.reply",
- "path": "{packageName}/reviews/{reviewId}:reply",
- "httpMethod": "POST",
- "description": "Reply to a single review, or update an existing reply.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app for which we want reviews; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "reviewId": {
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "reviewId"
- ],
- "request": {
- "$ref": "ReviewsReplyRequest"
- },
- "response": {
- "$ref": "ReviewsReplyResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "androidpublisher/v2/applications/",
+ "title": "Google Play Developer API",
+ "version": "v2"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-gen.go b/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-gen.go
index ae5cb0f77..b5008e567 100644
--- a/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-gen.go
+++ b/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-gen.go
@@ -57,7 +57,6 @@ func New(client *http.Client) (*Service, error) {
}
s := &Service{client: client, BasePath: basePath}
s.Edits = NewEditsService(s)
- s.Entitlements = NewEntitlementsService(s)
s.Inappproducts = NewInappproductsService(s)
s.Purchases = NewPurchasesService(s)
s.Reviews = NewReviewsService(s)
@@ -71,8 +70,6 @@ type Service struct {
Edits *EditsService
- Entitlements *EntitlementsService
-
Inappproducts *InappproductsService
Purchases *PurchasesService
@@ -204,15 +201,6 @@ type EditsTracksService struct {
s *Service
}
-func NewEntitlementsService(s *Service) *EntitlementsService {
- rs := &EntitlementsService{s: s}
- return rs
-}
-
-type EntitlementsService struct {
- s *Service
-}
-
func NewInappproductsService(s *Service) *InappproductsService {
rs := &InappproductsService{s: s}
return rs
@@ -766,82 +754,6 @@ func (s *DeviceMetadata) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Entitlement: An Entitlement resource indicates a user's current
-// entitlement to an inapp item or subscription.
-type Entitlement struct {
- // Kind: This kind represents an entitlement object in the
- // androidpublisher service.
- Kind string `json:"kind,omitempty"`
-
- // ProductId: The SKU of the product.
- ProductId string `json:"productId,omitempty"`
-
- // ProductType: The type of the inapp product. Possible values are:
- // - In-app item: "inapp"
- // - Subscription: "subs"
- ProductType string `json:"productType,omitempty"`
-
- // Token: The token which can be verified using the subscriptions or
- // products API.
- Token string `json:"token,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-
- // NullFields is a list of field names (e.g. "Kind") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
- NullFields []string `json:"-"`
-}
-
-func (s *Entitlement) MarshalJSON() ([]byte, error) {
- type NoMethod Entitlement
- raw := NoMethod(*s)
- return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
-}
-
-type EntitlementsListResponse struct {
- PageInfo *PageInfo `json:"pageInfo,omitempty"`
-
- Resources []*Entitlement `json:"resources,omitempty"`
-
- TokenPagination *TokenPagination `json:"tokenPagination,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "PageInfo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-
- // NullFields is a list of field names (e.g. "PageInfo") to include in
- // API requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
- NullFields []string `json:"-"`
-}
-
-func (s *EntitlementsListResponse) MarshalJSON() ([]byte, error) {
- type NoMethod EntitlementsListResponse
- raw := NoMethod(*s)
- return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
-}
-
type ExpansionFile struct {
// FileSize: If set this field indicates that this APK has an Expansion
// File uploaded to it: this APK does not reference another APK's
@@ -1481,7 +1393,7 @@ type ProductPurchase struct {
// PurchaseState: The purchase state of the order. Possible values are:
//
// - Purchased
- // - Cancelled
+ // - Canceled
PurchaseState int64 `json:"purchaseState,omitempty"`
// PurchaseTimeMillis: The time the product was purchased, in
@@ -1492,6 +1404,7 @@ type ProductPurchase struct {
// 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)
PurchaseType int64 `json:"purchaseType,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -1797,13 +1710,13 @@ type SubscriptionPurchase struct {
// when it reaches its current expiry time.
AutoRenewing bool `json:"autoRenewing,omitempty"`
- // CancelReason: The reason why a subscription was cancelled or is not
+ // CancelReason: The reason why a subscription was canceled or is not
// auto-renewing. Possible values are:
- // - User cancelled the subscription
- // - Subscription was cancelled by the system, for example because of a
+ // - 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 cancelled by the developer
+ // - Subscription was canceled by the developer
CancelReason *int64 `json:"cancelReason,omitempty"`
// CountryCode: ISO 3166-1 alpha-2 billing country/region code of the
@@ -1814,10 +1727,25 @@ type SubscriptionPurchase struct {
// supplemental information about an order.
DeveloperPayload string `json:"developerPayload,omitempty"`
+ // EmailAddress: The email address of the user when the subscription was
+ // purchased. Only present for purchases made with 'Subscribe with
+ // Google'.
+ EmailAddress string `json:"emailAddress,omitempty"`
+
// ExpiryTimeMillis: Time at which the subscription will expire, in
// milliseconds since the Epoch.
ExpiryTimeMillis int64 `json:"expiryTimeMillis,omitempty,string"`
+ // FamilyName: The family name of the user when the subscription was
+ // purchased. Only present for purchases made with 'Subscribe with
+ // Google'.
+ FamilyName string `json:"familyName,omitempty"`
+
+ // GivenName: The given name of the user when the subscription was
+ // purchased. Only present for purchases made with 'Subscribe with
+ // Google'.
+ GivenName string `json:"givenName,omitempty"`
+
// Kind: This kind represents a subscriptionPurchase object in the
// androidpublisher service.
Kind string `json:"kind,omitempty"`
@@ -1858,6 +1786,16 @@ type SubscriptionPurchase struct {
// price_currency_code is "GBP".
PriceCurrencyCode string `json:"priceCurrencyCode,omitempty"`
+ // ProfileId: The profile id of the user when the subscription was
+ // purchased. Only present for purchases made with 'Subscribe with
+ // Google'.
+ ProfileId string `json:"profileId,omitempty"`
+
+ // ProfileName: The profile name of the user when the subscription was
+ // purchased. Only present for purchases made with 'Subscribe with
+ // Google'.
+ ProfileName string `json:"profileName,omitempty"`
+
// PurchaseType: 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:
@@ -2051,7 +1989,7 @@ func (s *TokenPagination) MarshalJSON() ([]byte, error) {
type Track struct {
// Track: Identifier for this track. One of "alpha", "beta",
- // "production" or "rollout".
+ // "production", "rollout" or "internal".
Track string `json:"track,omitempty"`
UserFraction float64 `json:"userFraction,omitempty"`
@@ -2209,7 +2147,7 @@ func (s *UserComment) MarshalJSON() ([]byte, error) {
}
// VoidedPurchase: A VoidedPurchase resource indicates a purchase that
-// was either cancelled/refunded/charged-back.
+// was either canceled/refunded/charged-back.
type VoidedPurchase struct {
// Kind: This kind represents a voided purchase object in the
// androidpublisher service.
@@ -2224,7 +2162,7 @@ type VoidedPurchase struct {
PurchaseToken string `json:"purchaseToken,omitempty"`
// VoidedTimeMillis: The time at which the purchase was
- // cancelled/refunded/charged-back, in milliseconds since the epoch (Jan
+ // canceled/refunded/charged-back, in milliseconds since the epoch (Jan
// 1, 1970).
VoidedTimeMillis int64 `json:"voidedTimeMillis,omitempty,string"`
@@ -4240,11 +4178,12 @@ func (c *EditsApksUploadCall) doRequest(alt string) (*http.Response, error) {
body = new(bytes.Buffer)
reqHeaders.Set("Content-Type", "application/json")
}
- body, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
+ body, getBody, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
defer cleanup()
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
+ gensupport.SetGetBody(req, getBody)
googleapi.Expand(req.URL, map[string]string{
"packageName": c.packageNameid,
"editId": c.editId,
@@ -4462,11 +4401,12 @@ func (c *EditsDeobfuscationfilesUploadCall) doRequest(alt string) (*http.Respons
body = new(bytes.Buffer)
reqHeaders.Set("Content-Type", "application/json")
}
- body, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
+ body, getBody, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
defer cleanup()
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
+ gensupport.SetGetBody(req, getBody)
googleapi.Expand(req.URL, map[string]string{
"packageName": c.packageNameid,
"editId": c.editId,
@@ -5662,11 +5602,12 @@ func (c *EditsExpansionfilesUploadCall) doRequest(alt string) (*http.Response, e
body = new(bytes.Buffer)
reqHeaders.Set("Content-Type", "application/json")
}
- body, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
+ body, getBody, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
defer cleanup()
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
+ gensupport.SetGetBody(req, getBody)
googleapi.Expand(req.URL, map[string]string{
"packageName": c.packageNameid,
"editId": c.editId,
@@ -6427,11 +6368,12 @@ func (c *EditsImagesUploadCall) doRequest(alt string) (*http.Response, error) {
body = new(bytes.Buffer)
reqHeaders.Set("Content-Type", "application/json")
}
- body, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
+ body, getBody, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
defer cleanup()
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
+ gensupport.SetGetBody(req, getBody)
googleapi.Expand(req.URL, map[string]string{
"packageName": c.packageNameid,
"editId": c.editId,
@@ -7551,9 +7493,9 @@ func (c *EditsTestersGetCall) Do(opts ...googleapi.CallOption) (*Testers, error)
// "type": "string"
// },
// "track": {
- // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
+ // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
// "location": "path",
- // "pattern": "(alpha|beta|production|rollout)",
+ // "pattern": "(alpha|beta|production|rollout|internal)",
// "required": true,
// "type": "string"
// }
@@ -7701,9 +7643,9 @@ func (c *EditsTestersPatchCall) Do(opts ...googleapi.CallOption) (*Testers, erro
// "type": "string"
// },
// "track": {
- // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
+ // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
// "location": "path",
- // "pattern": "(alpha|beta|production|rollout)",
+ // "pattern": "(alpha|beta|production|rollout|internal)",
// "required": true,
// "type": "string"
// }
@@ -7854,9 +7796,9 @@ func (c *EditsTestersUpdateCall) Do(opts ...googleapi.CallOption) (*Testers, err
// "type": "string"
// },
// "track": {
- // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
+ // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
// "location": "path",
- // "pattern": "(alpha|beta|production|rollout)",
+ // "pattern": "(alpha|beta|production|rollout|internal)",
// "required": true,
// "type": "string"
// }
@@ -8016,9 +7958,9 @@ func (c *EditsTracksGetCall) Do(opts ...googleapi.CallOption) (*Track, error) {
// "type": "string"
// },
// "track": {
- // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
+ // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
// "location": "path",
- // "pattern": "(alpha|beta|production|rollout)",
+ // "pattern": "(alpha|beta|production|rollout|internal)",
// "required": true,
// "type": "string"
// }
@@ -8317,9 +8259,9 @@ func (c *EditsTracksPatchCall) Do(opts ...googleapi.CallOption) (*Track, error)
// "type": "string"
// },
// "track": {
- // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
+ // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
// "location": "path",
- // "pattern": "(alpha|beta|production|rollout)",
+ // "pattern": "(alpha|beta|production|rollout|internal)",
// "required": true,
// "type": "string"
// }
@@ -8473,9 +8415,9 @@ func (c *EditsTracksUpdateCall) Do(opts ...googleapi.CallOption) (*Track, error)
// "type": "string"
// },
// "track": {
- // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\" or \"rollout\".",
+ // "description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
// "location": "path",
- // "pattern": "(alpha|beta|production|rollout)",
+ // "pattern": "(alpha|beta|production|rollout|internal)",
// "required": true,
// "type": "string"
// }
@@ -8494,186 +8436,6 @@ func (c *EditsTracksUpdateCall) Do(opts ...googleapi.CallOption) (*Track, error)
}
-// method id "androidpublisher.entitlements.list":
-
-type EntitlementsListCall struct {
- s *Service
- packageName string
- urlParams_ gensupport.URLParams
- ifNoneMatch_ string
- ctx_ context.Context
- header_ http.Header
-}
-
-// List: Lists the user's current inapp item or subscription
-// entitlements
-func (r *EntitlementsService) List(packageName string) *EntitlementsListCall {
- c := &EntitlementsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
- c.packageName = packageName
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults":
-func (c *EntitlementsListCall) MaxResults(maxResults int64) *EntitlementsListCall {
- c.urlParams_.Set("maxResults", fmt.Sprint(maxResults))
- return c
-}
-
-// ProductId sets the optional parameter "productId": The product id of
-// the inapp product (for example, 'sku1'). This can be used to restrict
-// the result set.
-func (c *EntitlementsListCall) ProductId(productId string) *EntitlementsListCall {
- c.urlParams_.Set("productId", productId)
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex":
-func (c *EntitlementsListCall) StartIndex(startIndex int64) *EntitlementsListCall {
- c.urlParams_.Set("startIndex", fmt.Sprint(startIndex))
- return c
-}
-
-// Token sets the optional parameter "token":
-func (c *EntitlementsListCall) Token(token string) *EntitlementsListCall {
- c.urlParams_.Set("token", token)
- return c
-}
-
-// Fields allows partial responses to be retrieved. See
-// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EntitlementsListCall) Fields(s ...googleapi.Field) *EntitlementsListCall {
- c.urlParams_.Set("fields", googleapi.CombineFields(s))
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EntitlementsListCall) IfNoneMatch(entityTag string) *EntitlementsListCall {
- c.ifNoneMatch_ = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method. Any
-// pending HTTP request will be aborted if the provided context is
-// canceled.
-func (c *EntitlementsListCall) Context(ctx context.Context) *EntitlementsListCall {
- c.ctx_ = ctx
- return c
-}
-
-// Header returns an http.Header that can be modified by the caller to
-// add HTTP headers to the request.
-func (c *EntitlementsListCall) Header() http.Header {
- if c.header_ == nil {
- c.header_ = make(http.Header)
- }
- return c.header_
-}
-
-func (c *EntitlementsListCall) doRequest(alt string) (*http.Response, error) {
- reqHeaders := make(http.Header)
- for k, v := range c.header_ {
- reqHeaders[k] = v
- }
- reqHeaders.Set("User-Agent", c.s.userAgent())
- if c.ifNoneMatch_ != "" {
- reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
- }
- var body io.Reader = nil
- c.urlParams_.Set("alt", alt)
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/entitlements")
- urls += "?" + c.urlParams_.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- req.Header = reqHeaders
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- })
- return gensupport.SendRequest(c.ctx_, c.s.client, req)
-}
-
-// Do executes the "androidpublisher.entitlements.list" call.
-// Exactly one of *EntitlementsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *EntitlementsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EntitlementsListCall) Do(opts ...googleapi.CallOption) (*EntitlementsListResponse, error) {
- gensupport.SetOptions(c.urlParams_, opts...)
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntitlementsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- target := &ret
- if err := gensupport.DecodeResponse(target, res); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the user's current inapp item or subscription entitlements",
- // "httpMethod": "GET",
- // "id": "androidpublisher.entitlements.list",
- // "parameterOrder": [
- // "packageName"
- // ],
- // "parameters": {
- // "maxResults": {
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "packageName": {
- // "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The product id of the inapp product (for example, 'sku1'). This can be used to restrict the result set.",
- // "location": "query",
- // "type": "string"
- // },
- // "startIndex": {
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "token": {
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/entitlements",
- // "response": {
- // "$ref": "EntitlementsListResponse"
- // }
- // }
-
-}
-
// method id "androidpublisher.inappproducts.delete":
type InappproductsDeleteCall struct {
@@ -10391,7 +10153,7 @@ type PurchasesVoidedpurchasesListCall struct {
header_ http.Header
}
-// List: Lists the purchases that were cancelled, refunded or
+// List: Lists the purchases that were canceled, refunded or
// charged-back.
func (r *PurchasesVoidedpurchasesService) List(packageName string) *PurchasesVoidedpurchasesListCall {
c := &PurchasesVoidedpurchasesListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -10537,7 +10299,7 @@ func (c *PurchasesVoidedpurchasesListCall) Do(opts ...googleapi.CallOption) (*Vo
}
return ret, nil
// {
- // "description": "Lists the purchases that were cancelled, refunded or charged-back.",
+ // "description": "Lists the purchases that were canceled, refunded or charged-back.",
// "httpMethod": "GET",
// "id": "androidpublisher.purchases.voidedpurchases.list",
// "parameterOrder": [
diff --git a/vendor/google.golang.org/api/api-list.json b/vendor/google.golang.org/api/api-list.json
index ef1242c10..bc496878b 100644
--- a/vendor/google.golang.org/api/api-list.json
+++ b/vendor/google.golang.org/api/api-list.json
@@ -590,6 +590,21 @@
"documentationLink": "https://developers.google.com/google-apps/calendar/firstapp",
"preferred": true
},
+ {
+ "kind": "discovery#directoryItem",
+ "id": "chat:v1",
+ "name": "chat",
+ "version": "v1",
+ "title": "Hangouts Chat API",
+ "description": "Create bots and extend the new Hangouts Chat.",
+ "discoveryRestUrl": "https://chat.googleapis.com/$discovery/rest?version=v1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://developers.google.com/hangouts/chat",
+ "preferred": true
+ },
{
"kind": "discovery#directoryItem",
"id": "civicinfo:v2",
@@ -626,7 +641,7 @@
"id": "cloudbilling:v1",
"name": "cloudbilling",
"version": "v1",
- "title": "Google Cloud Billing API",
+ "title": "Cloud Billing API",
"description": "Allows developers to manage billing for their Google Cloud Platform projects programmatically.",
"discoveryRestUrl": "https://cloudbilling.googleapis.com/$discovery/rest?version=v1",
"icons": {
@@ -641,7 +656,7 @@
"id": "cloudbuild:v1",
"name": "cloudbuild",
"version": "v1",
- "title": "Google Cloud Container Builder API",
+ "title": "Cloud Container Builder API",
"description": "Builds container images in the cloud.",
"discoveryRestUrl": "https://cloudbuild.googleapis.com/$discovery/rest?version=v1",
"icons": {
@@ -681,6 +696,21 @@
"documentationLink": "https://cloud.google.com/error-reporting/",
"preferred": true
},
+ {
+ "kind": "discovery#directoryItem",
+ "id": "cloudfunctions:v2alpha1",
+ "name": "cloudfunctions",
+ "version": "v2alpha1",
+ "title": "Google Cloud Functions API",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v2alpha1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/functions",
+ "preferred": false
+ },
{
"kind": "discovery#directoryItem",
"id": "cloudfunctions:v1",
@@ -716,7 +746,7 @@
"id": "cloudiot:v1",
"name": "cloudiot",
"version": "v1",
- "title": "Google Cloud IoT API",
+ "title": "Cloud IoT API",
"description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.",
"discoveryRestUrl": "https://cloudiot.googleapis.com/$discovery/rest?version=v1",
"icons": {
@@ -731,7 +761,7 @@
"id": "cloudiot:v1beta1",
"name": "cloudiot",
"version": "v1beta1",
- "title": "Google Cloud IoT API",
+ "title": "Cloud IoT API",
"description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.",
"discoveryRestUrl": "https://cloudiot.googleapis.com/$discovery/rest?version=v1beta1",
"icons": {
@@ -761,7 +791,7 @@
"id": "cloudresourcemanager:v1",
"name": "cloudresourcemanager",
"version": "v1",
- "title": "Google Cloud Resource Manager API",
+ "title": "Cloud Resource Manager API",
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v1",
"icons": {
@@ -769,14 +799,14 @@
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"documentationLink": "https://cloud.google.com/resource-manager",
- "preferred": true
+ "preferred": false
},
{
"kind": "discovery#directoryItem",
"id": "cloudresourcemanager:v1beta1",
"name": "cloudresourcemanager",
"version": "v1beta1",
- "title": "Google Cloud Resource Manager API",
+ "title": "Cloud Resource Manager API",
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v1beta1",
"icons": {
@@ -786,12 +816,27 @@
"documentationLink": "https://cloud.google.com/resource-manager",
"preferred": false
},
+ {
+ "kind": "discovery#directoryItem",
+ "id": "cloudresourcemanager:v2",
+ "name": "cloudresourcemanager",
+ "version": "v2",
+ "title": "Cloud Resource Manager API",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "preferred": true
+ },
{
"kind": "discovery#directoryItem",
"id": "cloudresourcemanager:v2beta1",
"name": "cloudresourcemanager",
"version": "v2beta1",
- "title": "Google Cloud Resource Manager API",
+ "title": "Cloud Resource Manager API",
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2beta1",
"icons": {
@@ -876,70 +921,6 @@
"documentationLink": "https://cloud.google.com/trace",
"preferred": true
},
- {
- "kind": "discovery#directoryItem",
- "id": "clouduseraccounts:alpha",
- "name": "clouduseraccounts",
- "version": "alpha",
- "title": "Cloud User Accounts API",
- "description": "Creates and manages users and groups for accessing Google Compute Engine virtual machines.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/clouduseraccounts/alpha/rest",
- "discoveryLink": "./apis/clouduseraccounts/alpha/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "clouduseraccounts:beta",
- "name": "clouduseraccounts",
- "version": "beta",
- "title": "Cloud User Accounts API",
- "description": "Creates and manages users and groups for accessing Google Compute Engine virtual machines.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/clouduseraccounts/beta/rest",
- "discoveryLink": "./apis/clouduseraccounts/beta/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "clouduseraccounts:vm_alpha",
- "name": "clouduseraccounts",
- "version": "vm_alpha",
- "title": "Cloud User Accounts API",
- "description": "Creates and manages users and groups for accessing Google Compute Engine virtual machines.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/clouduseraccounts/vm_alpha/rest",
- "discoveryLink": "./apis/clouduseraccounts/vm_alpha/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "clouduseraccounts:vm_beta",
- "name": "clouduseraccounts",
- "version": "vm_beta",
- "title": "Cloud User Accounts API",
- "description": "Creates and manages users and groups for accessing Google Compute Engine virtual machines.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/clouduseraccounts/vm_beta/rest",
- "discoveryLink": "./apis/clouduseraccounts/vm_beta/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "preferred": false
- },
{
"kind": "discovery#directoryItem",
"id": "compute:alpha",
@@ -1071,7 +1052,7 @@
"id": "dataflow:v1b3",
"name": "dataflow",
"version": "v1b3",
- "title": "Google Dataflow API",
+ "title": "Dataflow API",
"description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.",
"discoveryRestUrl": "https://dataflow.googleapis.com/$discovery/rest?version=v1b3",
"icons": {
@@ -1236,6 +1217,21 @@
"documentationLink": "https://developers.google.com/doubleclick-advertisers/",
"preferred": true
},
+ {
+ "kind": "discovery#directoryItem",
+ "id": "dialogflow:v2",
+ "name": "dialogflow",
+ "version": "v2",
+ "title": "Dialogflow API",
+ "description": "An end-to-end development suite for conversational interfaces (e.g., chatbots, voice-powered apps and devices).",
+ "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v2",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/dialogflow-enterprise/",
+ "preferred": true
+ },
{
"kind": "discovery#directoryItem",
"id": "dialogflow:v2beta1",
@@ -1249,7 +1245,7 @@
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"documentationLink": "https://cloud.google.com/dialogflow-enterprise/",
- "preferred": true
+ "preferred": false
},
{
"kind": "discovery#directoryItem",
@@ -1282,13 +1278,28 @@
"documentationLink": "https://developers.google.com/discovery/",
"preferred": true
},
+ {
+ "kind": "discovery#directoryItem",
+ "id": "dlp:v2",
+ "name": "dlp",
+ "version": "v2",
+ "title": "Cloud Data Loss Prevention (DLP) API",
+ "description": "Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
+ "discoveryRestUrl": "https://dlp.googleapis.com/$discovery/rest?version=v2",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/dlp/docs/",
+ "preferred": true
+ },
{
"kind": "discovery#directoryItem",
"id": "dlp:v2beta1",
"name": "dlp",
"version": "v2beta1",
- "title": "DLP API",
- "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
+ "title": "Cloud Data Loss Prevention (DLP) API",
+ "description": "Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
"discoveryRestUrl": "https://dlp.googleapis.com/$discovery/rest?version=v2beta1",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
@@ -1302,15 +1313,15 @@
"id": "dlp:v2beta2",
"name": "dlp",
"version": "v2beta2",
- "title": "DLP API",
- "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
+ "title": "Cloud Data Loss Prevention (DLP) API",
+ "description": "Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
"discoveryRestUrl": "https://dlp.googleapis.com/$discovery/rest?version=v2beta2",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"documentationLink": "https://cloud.google.com/dlp/docs/",
- "preferred": true
+ "preferred": false
},
{
"kind": "discovery#directoryItem",
@@ -1442,21 +1453,6 @@
"documentationLink": "https://firebase.google.com/docs/dynamic-links/",
"preferred": true
},
- {
- "kind": "discovery#directoryItem",
- "id": "firebaseremoteconfig:v1",
- "name": "firebaseremoteconfig",
- "version": "v1",
- "title": "Firebase Remote Config API",
- "description": "Firebase Remote Config API allows the 3P clients to manage Remote Config conditions and parameters for Firebase applications.",
- "discoveryRestUrl": "https://firebaseremoteconfig.googleapis.com/$discovery/rest?version=v1",
- "icons": {
- "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
- "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
- },
- "documentationLink": "https://firebase.google.com/docs/remote-config/",
- "preferred": true
- },
{
"kind": "discovery#directoryItem",
"id": "firebaserules:v1",
@@ -1598,6 +1594,21 @@
"documentationLink": "https://cloud.google.com/genomics",
"preferred": false
},
+ {
+ "kind": "discovery#directoryItem",
+ "id": "genomics:v2alpha1",
+ "name": "genomics",
+ "version": "v2alpha1",
+ "title": "Genomics API",
+ "description": "Upload, process, query, and search Genomics data in the cloud.",
+ "discoveryRestUrl": "https://genomics.googleapis.com/$discovery/rest?version=v2alpha1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/genomics",
+ "preferred": false
+ },
{
"kind": "discovery#directoryItem",
"id": "genomics:v1",
@@ -1712,7 +1723,7 @@
"id": "language:v1",
"name": "language",
"version": "v1",
- "title": "Google Cloud Natural Language API",
+ "title": "Cloud Natural Language API",
"description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
"discoveryRestUrl": "https://language.googleapis.com/$discovery/rest?version=v1",
"icons": {
@@ -1727,7 +1738,7 @@
"id": "language:v1beta1",
"name": "language",
"version": "v1beta1",
- "title": "Google Cloud Natural Language API",
+ "title": "Cloud Natural Language API",
"description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
"discoveryRestUrl": "https://language.googleapis.com/$discovery/rest?version=v1beta1",
"icons": {
@@ -1742,7 +1753,7 @@
"id": "language:v1beta2",
"name": "language",
"version": "v1beta2",
- "title": "Google Cloud Natural Language API",
+ "title": "Cloud Natural Language API",
"description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
"discoveryRestUrl": "https://language.googleapis.com/$discovery/rest?version=v1beta2",
"icons": {
@@ -1969,6 +1980,22 @@
"x32": "https://www.google.com/images/icons/product/pagespeed-32.png"
},
"documentationLink": "https://developers.google.com/speed/docs/insights/v2/getting-started",
+ "preferred": false
+ },
+ {
+ "kind": "discovery#directoryItem",
+ "id": "pagespeedonline:v4",
+ "name": "pagespeedonline",
+ "version": "v4",
+ "title": "PageSpeed Insights API",
+ "description": "Analyzes the performance of a web page and provides tailored suggestions to make that page faster.",
+ "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/pagespeedonline/v4/rest",
+ "discoveryLink": "./apis/pagespeedonline/v4/rest",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/pagespeed-16.png",
+ "x32": "https://www.google.com/images/icons/product/pagespeed-32.png"
+ },
+ "documentationLink": "https://developers.google.com/speed/docs/insights/v4/getting-started",
"preferred": true
},
{
@@ -1991,7 +2018,7 @@
"id": "people:v1",
"name": "people",
"version": "v1",
- "title": "Google People API",
+ "title": "People API",
"description": "Provides access to information about profiles and contacts.",
"discoveryRestUrl": "https://people.googleapis.com/$discovery/rest?version=v1",
"icons": {
@@ -2368,7 +2395,7 @@
"id": "script:v1",
"name": "script",
"version": "v1",
- "title": "Google Apps Script API",
+ "title": "Apps Script API",
"description": "An API for managing and executing Google Apps Script projects.",
"discoveryRestUrl": "https://script.googleapis.com/$discovery/rest?version=v1",
"icons": {
@@ -2438,6 +2465,21 @@
"documentationLink": "https://cloud.google.com/service-management/",
"preferred": true
},
+ {
+ "kind": "discovery#directoryItem",
+ "id": "serviceusage:v1beta1",
+ "name": "serviceusage",
+ "version": "v1beta1",
+ "title": "Service Usage API",
+ "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
+ "discoveryRestUrl": "https://serviceusage.googleapis.com/$discovery/rest?version=v1beta1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/service-usage/",
+ "preferred": true
+ },
{
"kind": "discovery#directoryItem",
"id": "serviceuser:v1",
@@ -2550,7 +2592,7 @@
"id": "speech:v1",
"name": "speech",
"version": "v1",
- "title": "Google Cloud Speech API",
+ "title": "Cloud Speech API",
"description": "Converts audio to text by applying powerful neural network models.",
"discoveryRestUrl": "https://speech.googleapis.com/$discovery/rest?version=v1",
"icons": {
@@ -2565,7 +2607,7 @@
"id": "speech:v1beta1",
"name": "speech",
"version": "v1beta1",
- "title": "Google Cloud Speech API",
+ "title": "Cloud Speech API",
"description": "Converts audio to text by applying powerful neural network models.",
"discoveryRestUrl": "https://speech.googleapis.com/$discovery/rest?version=v1beta1",
"icons": {
@@ -2804,6 +2846,21 @@
"documentationLink": "https://developers.google.com/cloud-test-lab/",
"preferred": true
},
+ {
+ "kind": "discovery#directoryItem",
+ "id": "texttospeech:v1beta1",
+ "name": "texttospeech",
+ "version": "v1beta1",
+ "title": "Cloud Text-to-Speech API",
+ "description": "Cloud Text-to-Speech API.",
+ "discoveryRestUrl": "https://texttospeech.googleapis.com/$discovery/rest?version=v1beta1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "http://cloud.google.com/speech/text-to-speech/",
+ "preferred": true
+ },
{
"kind": "discovery#directoryItem",
"id": "toolresults:v1beta3",
@@ -2901,7 +2958,7 @@
"id": "vision:v1p1beta1",
"name": "vision",
"version": "v1p1beta1",
- "title": "Google Cloud Vision API",
+ "title": "Cloud Vision API",
"description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
"discoveryRestUrl": "https://vision.googleapis.com/$discovery/rest?version=v1p1beta1",
"icons": {
@@ -2911,12 +2968,27 @@
"documentationLink": "https://cloud.google.com/vision/",
"preferred": false
},
+ {
+ "kind": "discovery#directoryItem",
+ "id": "vision:v1p2beta1",
+ "name": "vision",
+ "version": "v1p2beta1",
+ "title": "Cloud Vision API",
+ "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
+ "discoveryRestUrl": "https://vision.googleapis.com/$discovery/rest?version=v1p2beta1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/vision/",
+ "preferred": false
+ },
{
"kind": "discovery#directoryItem",
"id": "vision:v1",
"name": "vision",
"version": "v1",
- "title": "Google Cloud Vision API",
+ "title": "Cloud Vision API",
"description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
"discoveryRestUrl": "https://vision.googleapis.com/$discovery/rest?version=v1",
"icons": {
diff --git a/vendor/google.golang.org/api/appengine/v1/appengine-api.json b/vendor/google.golang.org/api/appengine/v1/appengine-api.json
index 54049f410..8edec6885 100644
--- a/vendor/google.golang.org/api/appengine/v1/appengine-api.json
+++ b/vendor/google.golang.org/api/appengine/v1/appengine-api.json
@@ -1,1186 +1,1669 @@
{
- "schemas": {
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
},
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Beta"
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
},
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://appengine.googleapis.com/",
+ "batchPath": "batch",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "appengine:v1",
+ "kind": "discovery#restDescription",
+ "name": "appengine",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "apps": {
+ "methods": {
+ "create": {
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/).",
+ "flatPath": "v1/apps",
+ "httpMethod": "POST",
+ "id": "appengine.apps.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/apps",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets information about an application.",
+ "flatPath": "v1/apps/{appsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.get",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}",
+ "response": {
+ "$ref": "Application"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
+ "flatPath": "v1/apps/{appsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.patch",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "repair": {
+ "description": "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.",
+ "flatPath": "v1/apps/{appsId}:repair",
+ "httpMethod": "POST",
+ "id": "appengine.apps.repair",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}:repair",
+ "request": {
+ "$ref": "RepairApplicationRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "authorizedCertificates": {
+ "methods": {
+ "create": {
+ "description": "Uploads the specified SSL certificate.",
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates",
+ "httpMethod": "POST",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/authorizedCertificates",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified SSL certificate.",
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified SSL certificate.",
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the GET response.",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists all SSL certificates the user is authorized to administer.",
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the LIST response.",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/authorizedCertificates",
+ "response": {
+ "$ref": "ListAuthorizedCertificatesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.authorizedCertificates.patch",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
}
},
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta"
- },
- "ListIngressRulesResponse": {
- "description": "Response message for Firewall.ListIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "The ingress FirewallRules for this application.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "description": "Lists all domains the user is authorized to administer.",
+ "flatPath": "v1/apps/{appsId}/authorizedDomains",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedDomains.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/authorizedDomains",
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
}
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListIngressRulesResponse"
- },
- "ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "type": "object",
- "properties": {
- "services": {
- "description": "The services belonging to the requested application.",
- "type": "array",
- "items": {
- "$ref": "Service"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListServicesResponse"
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "volumes": {
- "description": "User specified volumes.",
- "type": "array",
- "items": {
- "$ref": "Volume"
- }
- },
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
- },
- "cpu": {
- "description": "Number of CPU cores needed.",
- "format": "double",
- "type": "number"
- },
- "memoryGb": {
- "description": "Memory (GB) needed.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Resources"
- },
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
- "properties": {
- "zip": {
- "$ref": "ZipInfo",
- "description": "The zip file for this deployment, if this is a zip deployment."
- },
- "container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
- },
- "files": {
- "description": "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.",
- "type": "object",
- "additionalProperties": {
- "$ref": "FileInfo"
- }
- }
- },
- "id": "Deployment"
- },
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "sizeGb": {
- "description": "Volume size in gigabytes.",
- "format": "double",
- "type": "number"
- },
- "name": {
- "description": "Unique name for the volume.",
- "type": "string"
- },
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
- }
- },
- "id": "Volume"
- },
- "BatchUpdateIngressRulesResponse": {
- "description": "Response message for Firewall.UpdateAllIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "The full list of ingress FirewallRules for this application.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
- }
- },
- "id": "BatchUpdateIngressRulesResponse"
- },
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
- "properties": {
- "instances": {
- "description": "The instances belonging to the requested version.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListInstancesResponse"
- },
- "ListDomainMappingsResponse": {
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
"domainMappings": {
- "description": "The domain mappings for the application.",
- "type": "array",
- "items": {
- "$ref": "DomainMapping"
- }
- }
- },
- "id": "ListDomainMappingsResponse"
- },
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
+ "methods": {
+ "create": {
+ "description": "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.",
+ "flatPath": "v1/apps/{appsId}/domainMappings",
+ "httpMethod": "POST",
+ "id": "appengine.apps.domainMappings.create",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "overrideStrategy": {
+ "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
+ "enum": [
+ "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
+ "STRICT",
+ "OVERRIDE"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/domainMappings",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.domainMappings.delete",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified domain mapping.",
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.domainMappings.get",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "response": {
+ "$ref": "DomainMapping"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the domain mappings on an application.",
+ "flatPath": "v1/apps/{appsId}/domainMappings",
+ "httpMethod": "GET",
+ "id": "appengine.apps.domainMappings.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/domainMappings",
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.domainMappings.patch",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
}
},
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Alpha"
- }
- },
- "id": "OperationMetadataV1Alpha"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- },
- "path": {
- "description": "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.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
- "type": "array",
- "items": {
- "$ref": "Version"
+ "firewall": {
+ "resources": {
+ "ingressRules": {
+ "methods": {
+ "batchUpdate": {
+ "description": "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.",
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "httpMethod": "POST",
+ "id": "appengine.apps.firewall.ingressRules.batchUpdate",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "request": {
+ "$ref": "BatchUpdateIngressRulesRequest"
+ },
+ "response": {
+ "$ref": "BatchUpdateIngressRulesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "description": "Creates a firewall rule for the application.",
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
+ "httpMethod": "POST",
+ "id": "appengine.apps.firewall.ingressRules.create",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/firewall/ingressRules",
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified firewall rule.",
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.firewall.ingressRules.delete",
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified firewall rule.",
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.firewall.ingressRules.get",
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the firewall rules of an application.",
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
+ "httpMethod": "GET",
+ "id": "appengine.apps.firewall.ingressRules.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "matchingAddress": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/firewall/ingressRules",
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "Updates the specified firewall rule.",
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.firewall.ingressRules.patch",
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
}
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse"
- },
- "ListAuthorizedDomainsResponse": {
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedDomain"
- }
- }
- },
- "id": "ListAuthorizedDomainsResponse"
- },
- "DomainMapping": {
- "description": "A domain serving an App Engine application.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- },
- "sslSettings": {
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
- "$ref": "SslSettings"
- },
- "id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
- "type": "string"
- },
- "resourceRecords": {
- "description": "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",
- "type": "array",
- "items": {
- "$ref": "ResourceRecord"
- }
- }
- },
- "id": "DomainMapping"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "Empty": {
- "description": "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
- "properties": {
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "standardSchedulerSettings": {
- "description": "Scheduler settings for standard environment.",
- "$ref": "StandardSchedulerSettings"
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
- "format": "int32",
- "type": "integer"
- },
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.",
- "format": "google-duration",
- "type": "string"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
- },
- "diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "DiskUtilization"
- }
- },
- "id": "AutomaticScaling"
- },
- "ZipInfo": {
- "description": "The zip file information for a zip deployment.",
- "type": "object",
- "properties": {
- "sourceUrl": {
- "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
- "filesCount": {
- "description": "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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ZipInfo"
- },
- "AuthorizedCertificate": {
- "description": "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.",
- "type": "object",
- "properties": {
- "expireTime": {
- "description": "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",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
- "type": "string"
- },
- "domainMappingsCount": {
- "description": "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",
- "format": "int32",
- "type": "integer"
- },
- "domainNames": {
- "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
- "type": "string"
- },
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
- "type": "string"
- },
- "certificateRawData": {
- "$ref": "CertificateRawData",
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
- },
- "visibleDomainMappings": {
- "description": "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",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AuthorizedCertificate"
- },
- "ResourceRecord": {
- "description": "A DNS resource record.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "An unknown resource record.",
- "An A resource record. Data is an IPv4 address.",
- "An AAAA resource record. Data is an IPv6 address.",
- "A CNAME resource record. Data is a domain name to be aliased."
- ],
- "enum": [
- "RECORD_TYPE_UNSPECIFIED",
- "A",
- "AAAA",
- "CNAME"
- ],
- "description": "Resource record type. Example: AAAA.",
- "type": "string"
- },
- "rrdata": {
- "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
- "type": "string"
- }
- },
- "id": "ResourceRecord"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- },
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- }
- },
- "id": "Library"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
"locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
+ "methods": {
+ "get": {
+ "description": "Gets information about a location.",
+ "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.get",
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/locations/{locationsId}",
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v1/apps/{appsId}/locations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/locations",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
}
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "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.",
+ "flatPath": "v1/apps/{appsId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.get",
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/operations/{operationsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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.",
+ "flatPath": "v1/apps/{appsId}/operations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/operations",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
+ "services": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified service and all enclosed versions.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the current configuration of the specified service.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.get",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "response": {
+ "$ref": "Service"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists all the services in the application.",
+ "flatPath": "v1/apps/{appsId}/services",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services",
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "Updates the configuration of the specified service.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.services.patch",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "migrateTraffic": {
+ "description": "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).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "request": {
+ "$ref": "Service"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "versions": {
+ "methods": {
+ "create": {
+ "description": "Deploys code and resource files to a new version.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.create",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an existing Version resource.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.get",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the Get response.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "response": {
+ "$ref": "Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the versions of a service.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.list",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the List response.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.services.versions.patch",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "debug": {
+ "description": "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.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Stops a running instance.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.instances.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets instance information.",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.instances.get",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "response": {
+ "$ref": "Instance"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "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).",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.instances.list",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
}
- },
- "id": "ListLocationsResponse"
- },
- "ContainerInfo": {
- "description": "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.",
- "type": "object",
- "properties": {
- "image": {
- "description": "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\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo"
- },
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
- },
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RequestUtilization"
- },
- "UrlMap": {
- "description": "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.",
- "type": "object",
- "properties": {
- "redirectHttpResponseCode": {
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ],
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ],
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string"
- },
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ]
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "description": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
- },
- "urlRegex": {
- "description": "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.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string"
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- },
- "staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
- }
- },
- "id": "UrlMap"
- },
- "EndpointsApiService": {
- "description": "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.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).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
- },
+ }
+ }
+ },
+ "revision": "20180320",
+ "rootUrl": "https://appengine.googleapis.com/",
+ "schemas": {
"ApiConfigHandler": {
"description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
+ "id": "ApiConfigHandler",
"properties": {
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ]
- },
"authFailAction": {
"description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
"Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
"Rejects request with a 401 HTTP status code and an error message."
],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
- },
- "script": {
- "description": "Path to the script from the application root directory.",
"type": "string"
},
"login": {
"description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string",
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
"enumDescriptions": [
"Not specified. LOGIN_OPTIONAL is assumed.",
"Does not require that the user is signed in.",
"If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
"If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
],
+ "type": "string"
+ },
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
"enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "type": "string"
},
"url": {
"description": "URL to serve the endpoint at.",
"type": "string"
}
},
- "id": "ApiConfigHandler"
+ "type": "object"
},
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "id": "ApiEndpointHandler",
"properties": {
- "done": {
- "description": "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.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "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.",
- "type": "object"
- },
- "name": {
- "description": "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.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "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.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "StaticFilesHandler": {
- "description": "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.",
- "type": "object",
- "properties": {
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "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.",
- "type": "string"
- },
- "mimeType": {
- "description": "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.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "format": "google-duration",
- "type": "string"
- },
- "applicationReadable": {
- "description": "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.",
- "type": "boolean"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- }
- },
- "id": "StaticFilesHandler"
- },
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "targetWriteOpsPerSecond": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteBytesPerSecond": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadBytesPerSecond": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadOpsPerSecond": {
- "description": "Target ops read per seconds.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
- "BasicScaling": {
- "description": "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.",
- "type": "object",
- "properties": {
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
- },
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "format": "google-duration",
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
}
},
- "id": "BasicScaling"
- },
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
- "properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
- "format": "google-duration",
- "type": "string"
- },
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "CpuUtilization"
- },
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "type": "object",
- "properties": {
- "enabled": {
- "description": "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.",
- "type": "boolean"
- },
- "oauth2ClientSecret": {
- "description": "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",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- }
- },
- "id": "IdentityAwareProxy"
- },
- "Status": {
- "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "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.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "ManualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object",
- "properties": {
- "instances": {
- "description": "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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ManualScaling"
- },
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
- "properties": {
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata"
- },
- "Service": {
- "description": "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.",
- "type": "object",
- "properties": {
- "split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
- "$ref": "TrafficSplit"
- },
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Service"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "FirewallRule": {
- "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
- "type": "object",
- "properties": {
- "sourceRange": {
- "description": "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.\u003cp\u003eTruncation 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.",
- "type": "string"
- },
- "priority": {
- "description": "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.",
- "format": "int32",
- "type": "integer"
- },
- "action": {
- "description": "The action to take on matched requests.",
- "type": "string",
- "enumDescriptions": [
- "",
- "Matching requests are allowed.",
- "Matching requests are denied."
- ],
- "enum": [
- "UNSPECIFIED_ACTION",
- "ALLOW",
- "DENY"
- ]
- },
- "description": {
- "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
- "type": "string"
- }
- },
- "id": "FirewallRule"
- },
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "ListAuthorizedCertificatesResponse": {
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "type": "object",
- "properties": {
- "certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedCertificate"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListAuthorizedCertificatesResponse"
- },
- "CreateVersionMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Beta"
- },
- "FeatureSettings": {
- "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
- "type": "object",
- "properties": {
- "splitHealthChecks": {
- "description": "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.",
- "type": "boolean"
- }
- },
- "id": "FeatureSettings"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "errorCode": {
- "description": "Error condition this handler applies to.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ]
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
- "type": "string"
- }
- },
- "id": "SslSettings"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
+ "type": "object"
},
"Application": {
"description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
+ "id": "Application",
"properties": {
- "featureSettings": {
- "description": "The feature specific settings to be used in the application.",
- "$ref": "FeatureSettings"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
"authDomain": {
"description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
"type": "string"
@@ -1193,106 +1676,621 @@
"description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
"type": "string"
},
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
"dispatchRules": {
"description": "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.@OutputOnly",
- "type": "array",
"items": {
"$ref": "UrlDispatchRule"
- }
+ },
+ "type": "array"
+ },
+ "featureSettings": {
+ "$ref": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application."
},
"gcrDomain": {
"description": "The Google Container Registry domain used for storing managed build docker images for this application.",
"type": "string"
},
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "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).",
+ "type": "string"
+ },
"name": {
"description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"type": "string"
},
- "id": {
- "description": "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.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "locationId": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
"servingStatus": {
- "enumDescriptions": [
- "Serving status is unspecified.",
- "Application is serving.",
- "Application has been disabled by the user.",
- "Application has been disabled by the system."
- ],
+ "description": "Serving status of this application.",
"enum": [
"UNSPECIFIED",
"SERVING",
"USER_DISABLED",
"SYSTEM_DISABLED"
],
- "description": "Serving status of this application.",
- "type": "string"
- },
- "defaultHostname": {
- "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "enumDescriptions": [
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
+ ],
"type": "string"
}
},
- "id": "Application"
+ "type": "object"
},
- "Network": {
- "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
- "type": "object",
+ "AuthorizedCertificate": {
+ "description": "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.",
+ "id": "AuthorizedCertificate",
"properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "certificateRawData": {
+ "$ref": "CertificateRawData",
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
},
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation. for Only applicable in the App Engine flexible environment.",
+ "displayName": {
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
"type": "string"
},
- "subnetworkName": {
- "description": "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.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM 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.\nIf the network the VM 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.",
+ "domainMappingsCount": {
+ "description": "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",
+ "format": "int32",
+ "type": "integer"
+ },
+ "domainNames": {
+ "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "expireTime": {
+ "description": "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",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
"type": "string"
},
"name": {
- "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
+ "type": "string"
+ },
+ "visibleDomainMappings": {
+ "description": "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",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AuthorizedDomain": {
+ "description": "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).",
+ "id": "AuthorizedDomain",
+ "properties": {
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
"type": "string"
}
},
- "id": "Network"
+ "type": "object"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "id": "AutomaticScaling",
+ "properties": {
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ },
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of running instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "standardSchedulerSettings": {
+ "$ref": "StandardSchedulerSettings",
+ "description": "Scheduler settings for standard environment."
+ }
+ },
+ "type": "object"
+ },
+ "BasicScaling": {
+ "description": "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.",
+ "id": "BasicScaling",
+ "properties": {
+ "idleTimeout": {
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "BatchUpdateIngressRulesRequest": {
+ "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "id": "BatchUpdateIngressRulesRequest",
+ "properties": {
+ "ingressRules": {
+ "description": "A list of FirewallRules to replace the existing set.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "BatchUpdateIngressRulesResponse": {
+ "description": "Response message for Firewall.UpdateAllIngressRules.",
+ "id": "BatchUpdateIngressRulesResponse",
+ "properties": {
+ "ingressRules": {
+ "description": "The full list of ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CertificateRawData": {
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "id": "CertificateRawData",
+ "properties": {
+ "privateKey": {
+ "description": "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: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
+ "type": "string"
+ },
+ "publicCertificate": {
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CloudBuildOptions": {
+ "description": "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.",
+ "id": "CloudBuildOptions",
+ "properties": {
+ "appYamlPath": {
+ "description": "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.",
+ "type": "string"
+ },
+ "cloudBuildTimeout": {
+ "description": "The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContainerInfo": {
+ "description": "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.",
+ "id": "ContainerInfo",
+ "properties": {
+ "image": {
+ "description": "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\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "id": "CpuUtilization",
+ "properties": {
+ "aggregationWindowLength": {
+ "description": "Period of time over which CPU utilization is calculated.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "targetUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Alpha",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Beta",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "id": "DebugInstanceRequest",
+ "properties": {
+ "sshKey": {
+ "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[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).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "id": "Deployment",
+ "properties": {
+ "cloudBuildOptions": {
+ "$ref": "CloudBuildOptions",
+ "description": "Options for any Google Cloud Container Builder builds created as a part of this deployment.Note that this is orthogonal to the build parameter, where the deployment depends on an already existing cloud build. 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."
+ },
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ },
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "zip": {
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
+ }
+ },
+ "type": "object"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.",
+ "id": "DiskUtilization",
+ "properties": {
+ "targetReadBytesPerSecond": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadOpsPerSecond": {
+ "description": "Target ops read per seconds.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSecond": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSecond": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "id": "DomainMapping",
+ "properties": {
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "resourceRecords": {
+ "description": "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",
+ "items": {
+ "$ref": "ResourceRecord"
+ },
+ "type": "array"
+ },
+ "sslSettings": {
+ "$ref": "SslSettings",
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "EndpointsApiService": {
+ "description": "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).",
+ "id": "EndpointsApiService",
+ "properties": {
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "type": "string"
+ },
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "id": "ErrorHandler",
+ "properties": {
+ "errorCode": {
+ "description": "Error condition this handler applies to.",
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FeatureSettings": {
+ "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
+ "id": "FeatureSettings",
+ "properties": {
+ "splitHealthChecks": {
+ "description": "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.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "id": "FileInfo",
+ "properties": {
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
+ },
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FirewallRule": {
+ "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
+ "id": "FirewallRule",
+ "properties": {
+ "action": {
+ "description": "The action to take on matched requests.",
+ "enum": [
+ "UNSPECIFIED_ACTION",
+ "ALLOW",
+ "DENY"
+ ],
+ "enumDescriptions": [
+ "",
+ "Matching requests are allowed.",
+ "Matching requests are denied."
+ ],
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
+ "type": "string"
+ },
+ "priority": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceRange": {
+ "description": "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.\u003cp\u003eTruncation 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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HealthCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "id": "HealthCheck",
+ "properties": {
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ },
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "timeout": {
+ "description": "Time before the health check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "IdentityAwareProxy": {
+ "description": "Identity-Aware Proxy",
+ "id": "IdentityAwareProxy",
+ "properties": {
+ "enabled": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
+ "type": "string"
+ },
+ "oauth2ClientSecret": {
+ "description": "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",
+ "type": "string"
+ },
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"Instance": {
"description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
+ "id": "Instance",
"properties": {
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
"type": "string"
},
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
"type": "string"
},
"averageLatency": {
@@ -1300,8 +2298,13 @@
"format": "int32",
"type": "integer"
},
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
"type": "string"
},
"memoryUsage": {
@@ -1309,33 +2312,20 @@
"format": "int64",
"type": "string"
},
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
"type": "string"
},
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
"format": "int32",
"type": "integer"
},
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "availability": {
- "description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ]
- },
"startTime": {
"description": "Time that this instance was started.@OutputOnly",
"format": "google-datetime",
@@ -1345,46 +2335,224 @@
"description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "boolean"
},
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
},
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
}
},
- "id": "Instance"
+ "type": "object"
+ },
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "id": "Library",
+ "properties": {
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListAuthorizedCertificatesResponse": {
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
+ "id": "ListAuthorizedCertificatesResponse",
+ "properties": {
+ "certificates": {
+ "description": "The SSL certificates the user is authorized to administer.",
+ "items": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListAuthorizedDomainsResponse": {
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "id": "ListAuthorizedDomainsResponse",
+ "properties": {
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListDomainMappingsResponse": {
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "id": "ListDomainMappingsResponse",
+ "properties": {
+ "domainMappings": {
+ "description": "The domain mappings for the application.",
+ "items": {
+ "$ref": "DomainMapping"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListIngressRulesResponse": {
+ "description": "Response message for Firewall.ListIngressRules.",
+ "id": "ListIngressRulesResponse",
+ "properties": {
+ "ingressRules": {
+ "description": "The ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "id": "ListInstancesResponse",
+ "properties": {
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "id": "ListServicesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "id": "ListVersionsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"LivenessCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object",
+ "id": "LivenessCheck",
"properties": {
- "successThreshold": {
- "description": "Number of consecutive successful checks required before considering the VM healthy.",
- "format": "uint32",
- "type": "integer"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
"checkInterval": {
"description": "Interval between health checks.",
"format": "google-duration",
"type": "string"
},
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
"failureThreshold": {
"description": "Number of consecutive failed checks required before considering the VM unhealthy.",
"format": "uint32",
"type": "integer"
},
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
"initialDelay": {
"description": "The initial delay before starting to execute the checks.",
"format": "google-duration",
@@ -1393,28 +2561,35 @@
"path": {
"description": "The request path.",
"type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
}
},
- "id": "LivenessCheck"
- },
- "BatchUpdateIngressRulesRequest": {
- "description": "Request message for Firewall.BatchUpdateIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "A list of FirewallRules to replace the existing set.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
- }
- },
- "id": "BatchUpdateIngressRulesRequest"
+ "type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
+ "id": "Location",
"properties": {
+ "displayName": {
+ "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
"locationId": {
"description": "The canonical id for this location. For example: \"us-east1\".",
"type": "string"
@@ -1427,34 +2602,70 @@
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- },
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
"type": "string"
}
},
- "id": "Location"
+ "type": "object"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "id": "LocationMetadata",
+ "properties": {
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine flexible environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine standard environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ManualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "id": "ManualScaling",
+ "properties": {
+ "instances": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Network": {
+ "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
+ "id": "Network",
+ "properties": {
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ },
+ "subnetworkName": {
+ "description": "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.\nIf the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf 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.\nIf 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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"NetworkUtilization": {
"description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
- "type": "object",
+ "id": "NetworkUtilization",
"properties": {
- "targetSentBytesPerSecond": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentPacketsPerSecond": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- },
"targetReceivedBytesPerSecond": {
"description": "Target bytes received per second.",
"format": "int32",
@@ -1464,54 +2675,255 @@
"description": "Target packets received per second.",
"format": "int32",
"type": "integer"
- }
- },
- "id": "NetworkUtilization"
- },
- "HealthCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object",
- "properties": {
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
},
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
"type": "integer"
},
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
+ "targetSentPacketsPerSecond": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
+ "properties": {
+ "done": {
+ "description": "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.",
"type": "boolean"
},
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "name": {
+ "description": "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.",
"type": "string"
},
- "healthyThreshold": {
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "format": "uint32",
- "type": "integer"
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
+ "type": "object"
}
},
- "id": "HealthCheck"
+ "type": "object"
+ },
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadata",
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Alpha",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Alpha"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Beta"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta5",
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"ReadinessCheck": {
"description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "type": "object",
+ "id": "ReadinessCheck",
"properties": {
+ "appStartTimeout": {
+ "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
+ "format": "google-duration",
+ "type": "string"
+ },
"checkInterval": {
"description": "Interval between health checks.",
"format": "google-duration",
@@ -1522,36 +2934,165 @@
"format": "uint32",
"type": "integer"
},
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "appStartTimeout": {
- "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
- "format": "google-duration",
+ "host": {
+ "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
"type": "string"
},
"path": {
"description": "The request path.",
"type": "string"
},
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
"successThreshold": {
"description": "Number of consecutive successful checks required before receiving traffic.",
"format": "uint32",
"type": "integer"
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
}
},
- "id": "ReadinessCheck"
+ "type": "object"
+ },
+ "RepairApplicationRequest": {
+ "description": "Request message for 'Applications.RepairApplication'.",
+ "id": "RepairApplicationRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.",
+ "id": "RequestUtilization",
+ "properties": {
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetRequestCountPerSecond": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ResourceRecord": {
+ "description": "A DNS resource record.",
+ "id": "ResourceRecord",
+ "properties": {
+ "name": {
+ "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "type": "string"
+ },
+ "rrdata": {
+ "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource record type. Example: AAAA.",
+ "enum": [
+ "RECORD_TYPE_UNSPECIFIED",
+ "A",
+ "AAAA",
+ "CNAME"
+ ],
+ "enumDescriptions": [
+ "An unknown resource record.",
+ "An A resource record. Data is an IPv4 address.",
+ "An AAAA resource record. Data is an IPv6 address.",
+ "A CNAME resource record. Data is a domain name to be aliased."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Resources": {
+ "description": "Machine resources for a version.",
+ "id": "Resources",
+ "properties": {
+ "cpu": {
+ "description": "Number of CPU cores needed.",
+ "format": "double",
+ "type": "number"
+ },
+ "diskGb": {
+ "description": "Disk size (GB) needed.",
+ "format": "double",
+ "type": "number"
+ },
+ "memoryGb": {
+ "description": "Memory (GB) needed.",
+ "format": "double",
+ "type": "number"
+ },
+ "volumes": {
+ "description": "User specified volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "id": "ScriptHandler",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Service": {
+ "description": "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.",
+ "id": "Service",
+ "properties": {
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "split": {
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ }
+ },
+ "type": "object"
+ },
+ "SslSettings": {
+ "description": "SSL configuration for a DomainMapping resource.",
+ "id": "SslSettings",
+ "properties": {
+ "certificateId": {
+ "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"StandardSchedulerSettings": {
"description": "Scheduler settings for standard environment.",
- "type": "object",
+ "id": "StandardSchedulerSettings",
"properties": {
+ "maxInstances": {
+ "description": "Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minInstances": {
+ "description": "Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.",
+ "format": "int32",
+ "type": "integer"
+ },
"targetCpuUtilization": {
"description": "Target CPU utilization ratio to maintain when scaling.",
"format": "double",
@@ -1561,106 +3102,231 @@
"description": "Target throughput utilization ratio to maintain when scaling",
"format": "double",
"type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "StaticFilesHandler": {
+ "description": "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.",
+ "id": "StaticFilesHandler",
+ "properties": {
+ "applicationReadable": {
+ "description": "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.",
+ "type": "boolean"
},
- "maxInstances": {
- "description": "Maximum number of instances for an app version. Set to zero to disable max_instances configuration.",
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "mimeType": {
+ "description": "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.",
+ "type": "string"
+ },
+ "path": {
+ "description": "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.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
- "minInstances": {
- "description": "Minimum number of instances for an app version. Set to zero to disable min_instances configuration.",
- "format": "int32",
- "type": "integer"
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "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.",
+ "type": "string"
}
},
- "id": "StandardSchedulerSettings"
+ "type": "object"
},
- "DebugInstanceRequest": {
- "description": "Request message for Instances.DebugInstance.",
- "type": "object",
+ "TrafficSplit": {
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "id": "TrafficSplit",
"properties": {
- "sshKey": {
- "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[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).",
+ "allocations": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "shardBy": {
+ "description": "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.",
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP",
+ "RANDOM"
+ ],
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
+ "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
+ ],
"type": "string"
}
},
- "id": "DebugInstanceRequest"
+ "type": "object"
},
- "OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "id": "UrlDispatchRule",
"properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
"type": "string"
},
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
+ "path": {
+ "description": "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.",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "service": {
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
"type": "string"
}
},
- "id": "OperationMetadataV1Beta5"
+ "type": "object"
},
- "CreateVersionMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
- "type": "object",
+ "UrlMap": {
+ "description": "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.",
+ "id": "UrlMap",
"properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "apiEndpoint": {
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
+ },
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "type": "string"
+ },
+ "login": {
+ "description": "Level of login required to access this resource.",
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "type": "string"
+ },
+ "redirectHttpResponseCode": {
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ],
+ "type": "string"
+ },
+ "script": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "type": "string"
+ },
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
+ },
+ "urlRegex": {
+ "description": "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.",
"type": "string"
}
},
- "id": "CreateVersionMetadataV1Alpha"
+ "type": "object"
},
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
- "type": "object",
+ "id": "Version",
"properties": {
+ "apiConfig": {
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
+ },
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
+ },
"basicScaling": {
"$ref": "BasicScaling",
"description": "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."
},
- "runtime": {
- "description": "Desired runtime. Example: python27.",
- "type": "string"
- },
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "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-\".",
- "type": "string"
- },
- "envVariables": {
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "livenessCheck": {
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
- "$ref": "LivenessCheck"
- },
- "network": {
- "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
- "$ref": "Network"
- },
"betaSettings": {
"additionalProperties": {
"type": "string"
@@ -1668,101 +3334,68 @@
"description": "Metadata settings that are supplied to this version to enable beta runtime features.",
"type": "object"
},
- "env": {
- "description": "App Engine execution environment for this version.Defaults to standard.",
+ "createTime": {
+ "description": "Time that this version was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "handlers": {
- "description": "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.",
- "type": "array",
- "items": {
- "$ref": "UrlMap"
- }
- },
- "zones": {
- "description": "The choice of gce zones to use for this App Engine Flexible version.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "automaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "$ref": "AutomaticScaling"
- },
- "diskUsageBytes": {
- "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly",
- "format": "int64",
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
"type": "string"
},
- "healthCheck": {
- "description": "Configures health checking for VM 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.",
- "$ref": "HealthCheck"
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "readinessCheck": {
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.",
- "$ref": "ReadinessCheck"
- },
- "manualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "$ref": "ManualScaling"
- },
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
- "type": "string"
- },
- "apiConfig": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
- },
- "endpointsApiService": {
- "description": "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.",
- "$ref": "EndpointsApiService"
- },
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
- "type": "string"
- },
- "instanceClass": {
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
- "type": "string"
- },
- "servingStatus": {
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ],
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ],
- "description": "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.",
- "type": "string"
- },
- "runtimeApiVersion": {
- "description": "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/\u003clanguage\u003e/config/appref",
+ "defaultExpiration": {
+ "description": "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.",
+ "format": "google-duration",
"type": "string"
},
"deployment": {
"$ref": "Deployment",
"description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
},
- "createTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
+ "diskUsageBytes": {
+ "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "endpointsApiService": {
+ "$ref": "EndpointsApiService",
+ "description": "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."
+ },
+ "env": {
+ "description": "App Engine execution environment for this version.Defaults to standard.",
+ "type": "string"
+ },
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
+ },
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "ErrorHandler"
+ },
+ "type": "array"
+ },
+ "handlers": {
+ "description": "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.",
+ "items": {
+ "$ref": "UrlMap"
+ },
+ "type": "array"
+ },
+ "healthCheck": {
+ "$ref": "HealthCheck",
+ "description": "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."
+ },
+ "id": {
+ "description": "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-\".",
"type": "string"
},
"inboundServices": {
+ "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"enumDescriptions": [
"Not specified.",
"Allows an application to receive mail.",
@@ -1774,10 +3407,7 @@
"Registers an application for notifications when a client connects or disconnects from a channel.",
"Enables warmup requests."
],
- "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
- "type": "array",
"items": {
- "type": "string",
"enum": [
"INBOUND_SERVICE_UNSPECIFIED",
"INBOUND_SERVICE_MAIL",
@@ -1788,1725 +3418,137 @@
"INBOUND_SERVICE_XMPP_PRESENCE",
"INBOUND_SERVICE_CHANNEL_PRESENCE",
"INBOUND_SERVICE_WARMUP"
- ]
- }
+ ],
+ "type": "string"
+ },
+ "type": "array"
},
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "ErrorHandler"
- }
- },
- "defaultExpiration": {
- "description": "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.",
- "format": "google-duration",
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
"type": "string"
},
"libraries": {
"description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
- "type": "array",
"items": {
"$ref": "Library"
- }
+ },
+ "type": "array"
+ },
+ "livenessCheck": {
+ "$ref": "LivenessCheck",
+ "description": "Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
+ },
+ "manualScaling": {
+ "$ref": "ManualScaling",
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ },
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
+ "type": "string"
+ },
+ "network": {
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable in the App Engine flexible environment."
},
"nobuildFilesRegex": {
"description": "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.",
"type": "string"
- }
- },
- "id": "Version"
- },
- "RepairApplicationRequest": {
- "description": "Request message for 'Applications.RepairApplication'.",
- "type": "object",
- "properties": {},
- "id": "RepairApplicationRequest"
- },
- "CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
- "properties": {
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
+ },
+ "readinessCheck": {
+ "$ref": "ReadinessCheck",
+ "description": "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."
+ },
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable in the App Engine flexible environment."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
"type": "string"
},
- "privateKey": {
- "description": "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: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
- "type": "string"
- }
- },
- "id": "CertificateRawData"
- },
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "runtimeApiVersion": {
+ "description": "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/\u003clanguage\u003e/config/appref",
"type": "string"
},
- "sourceUrl": {
- "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "runtimeChannel": {
+ "description": "The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.",
"type": "string"
},
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
+ "servingStatus": {
+ "description": "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.",
+ "enum": [
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING",
+ "STOPPED"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ],
"type": "string"
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "type": "string"
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
+ },
+ "zones": {
+ "description": "The Google Compute Engine zones that are supported by this version in the App Engine flexible environment.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "FileInfo"
+ "type": "object"
},
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ScriptHandler"
- },
- "AuthorizedDomain": {
- "description": "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).",
- "type": "object",
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable in the App Engine flexible environment.",
+ "id": "Volume",
"properties": {
"name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "description": "Unique name for the volume.",
"type": "string"
},
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "sizeGb": {
+ "description": "Volume size in gigabytes.",
+ "format": "double",
+ "type": "number"
+ },
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
"type": "string"
}
},
- "id": "AuthorizedDomain"
+ "type": "object"
},
- "TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
- "type": "object",
+ "ZipInfo": {
+ "description": "The zip file information for a zip deployment.",
+ "id": "ZipInfo",
"properties": {
- "shardBy": {
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
- "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
- ],
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP",
- "RANDOM"
- ],
- "description": "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.",
- "type": "string"
+ "filesCount": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
},
- "allocations": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
- "description": "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.",
- "type": "object"
+ "sourceUrl": {
+ "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
}
},
- "id": "TrafficSplit"
- }
- },
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "version": "v1",
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- }
- }
+ "type": "object"
}
},
"servicePath": "",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "kind": "discovery#restDescription",
- "rootUrl": "https://appengine.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "appengine",
- "batchPath": "batch",
- "revision": "20180112",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "id": "appengine:v1",
- "title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "version_module": true,
- "resources": {
- "apps": {
- "methods": {
- "repair": {
- "description": "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.",
- "request": {
- "$ref": "RepairApplicationRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}:repair",
- "path": "v1/apps/{appsId}:repair",
- "id": "appengine.apps.repair"
- },
- "get": {
- "description": "Gets information about an application.",
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}",
- "path": "v1/apps/{appsId}",
- "id": "appengine.apps.get"
- },
- "patch": {
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
- "request": {
- "$ref": "Application"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}",
- "path": "v1/apps/{appsId}",
- "id": "appengine.apps.patch"
- },
- "create": {
- "flatPath": "v1/apps",
- "id": "appengine.apps.create",
- "path": "v1/apps",
- "request": {
- "$ref": "Application"
- },
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/python/console/).",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "firewall": {
- "resources": {
- "ingressRules": {
- "methods": {
- "get": {
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string"
- },
- "ingressRulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get",
- "description": "Gets the specified firewall rule."
- },
- "patch": {
- "description": "Updates the specified firewall rule.",
- "request": {
- "$ref": "FirewallRule"
- },
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string"
- },
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.patch"
- },
- "batchUpdate": {
- "description": "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.",
- "request": {
- "$ref": "BatchUpdateIngressRulesRequest"
- },
- "response": {
- "$ref": "BatchUpdateIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "id": "appengine.apps.firewall.ingressRules.batchUpdate"
- },
- "delete": {
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.delete",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "description": "Deletes the specified firewall rule.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string"
- },
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "description": "Lists the firewall rules of an application.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
- "matchingAddress": {
- "description": "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.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.list",
- "path": "v1/apps/{appsId}/firewall/ingressRules"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "FirewallRule"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.create",
- "path": "v1/apps/{appsId}/firewall/ingressRules",
- "request": {
- "$ref": "FirewallRule"
- },
- "description": "Creates a firewall rule for the application."
- }
- }
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "path": "v1/apps/{appsId}/locations"
- },
- "get": {
- "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
- "path": "v1/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string"
- },
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- }
- }
- }
- },
- "authorizedCertificates": {
- "methods": {
- "list": {
- "flatPath": "v1/apps/{appsId}/authorizedCertificates",
- "path": "v1/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "description": "Lists all SSL certificates the user is authorized to administer.",
- "response": {
- "$ref": "ListAuthorizedCertificatesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the LIST response.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "get": {
- "description": "Gets the specified SSL certificate.",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the GET response.",
- "type": "string"
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get"
- },
- "patch": {
- "description": "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.",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch"
- },
- "create": {
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate.",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/authorizedCertificates",
- "path": "v1/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create"
- },
- "delete": {
- "description": "Deletes the specified SSL certificate.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "parameters": {
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
- }
- }
- },
- "services": {
- "methods": {
- "delete": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete",
- "description": "Deletes the specified service and all enclosed versions.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "description": "Lists all the services in the application.",
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/services",
- "path": "v1/apps/{appsId}/services",
- "id": "appengine.apps.services.list"
- },
- "get": {
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get",
- "description": "Gets the current configuration of the specified service."
- },
- "patch": {
- "description": "Updates the configuration of the specified service.",
- "request": {
- "$ref": "Service"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- },
- "migrateTraffic": {
- "description": "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).",
- "type": "boolean",
- "location": "query"
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch"
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "delete": {
- "description": "Deletes an existing Version resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete"
- },
- "list": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list",
- "description": "Lists the versions of a service.",
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "view": {
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
- },
- "patch": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch",
- "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "create": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "description": "Deploys code and resource files to a new version.",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- }
- },
- "resources": {
- "instances": {
- "methods": {
- "delete": {
- "description": "Stops a running instance.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete"
- },
- "list": {
- "description": "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).",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list"
- },
- "get": {
- "description": "Gets instance information.",
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get"
- },
- "debug": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "description": "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.",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "authorizedDomains": {
- "methods": {
- "list": {
- "flatPath": "v1/apps/{appsId}/authorizedDomains",
- "path": "v1/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list",
- "description": "Lists all domains the user is authorized to administer.",
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/apps/{appsId}/operations",
- "path": "v1/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list"
- },
- "get": {
- "flatPath": "v1/apps/{appsId}/operations/{operationsId}",
- "path": "v1/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "description": "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- }
- }
- },
- "domainMappings": {
- "methods": {
- "delete": {
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete",
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "response": {
- "$ref": "ListDomainMappingsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/apps/{appsId}/domainMappings",
- "path": "v1/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "description": "Lists the domain mappings on an application."
- },
- "get": {
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get",
- "description": "Gets the specified domain mapping.",
- "response": {
- "$ref": "DomainMapping"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "patch": {
- "description": "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.",
- "request": {
- "$ref": "DomainMapping"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch"
- },
- "create": {
- "flatPath": "v1/apps/{appsId}/domainMappings",
- "path": "v1/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
- "description": "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.",
- "request": {
- "$ref": "DomainMapping"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "overrideStrategy": {
- "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
- "type": "string",
- "location": "query",
- "enum": [
- "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
- "STRICT",
- "OVERRIDE"
- ]
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- }
- }
-}
+ "title": "App Engine Admin API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/appengine/v1/appengine-gen.go b/vendor/google.golang.org/api/appengine/v1/appengine-gen.go
index bcc75eb7a..2b6e973d0 100644
--- a/vendor/google.golang.org/api/appengine/v1/appengine-gen.go
+++ b/vendor/google.golang.org/api/appengine/v1/appengine-gen.go
@@ -1,4 +1,4 @@
-// Package appengine provides access to the Google App Engine Admin API.
+// Package appengine provides access to the App Engine Admin API.
//
// See https://cloud.google.com/appengine/docs/admin-api/
//
@@ -366,11 +366,11 @@ type Application struct {
// where you want to deploy your application. Example: myapp.
Id string `json:"id,omitempty"`
- // LocationId: Location from which this application will be run.
- // Application instances will run out of data centers in the chosen
- // location, which is also where all of the application's end user
- // content is stored.Defaults to us-central.Options are:us-central -
- // Central USeurope-west - Western Europeus-east1 - Eastern US
+ // LocationId: 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 `json:"locationId,omitempty"`
// Name: Full path to the Application resource in the API. Example:
@@ -556,7 +556,7 @@ type AutomaticScaling struct {
MaxPendingLatency string `json:"maxPendingLatency,omitempty"`
// MaxTotalInstances: Maximum number of instances that should be started
- // to handle requests.
+ // to handle requests for this version.
MaxTotalInstances int64 `json:"maxTotalInstances,omitempty"`
// MinIdleInstances: Minimum number of idle instances that should be
@@ -568,7 +568,7 @@ type AutomaticScaling struct {
// the pending queue before starting a new instance to handle it.
MinPendingLatency string `json:"minPendingLatency,omitempty"`
- // MinTotalInstances: Minimum number of instances that should be
+ // MinTotalInstances: Minimum number of running instances that should be
// maintained for this version.
MinTotalInstances int64 `json:"minTotalInstances,omitempty"`
@@ -744,6 +744,46 @@ func (s *CertificateRawData) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// CloudBuildOptions: 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.
+type CloudBuildOptions struct {
+ // AppYamlPath: 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 `json:"appYamlPath,omitempty"`
+
+ // CloudBuildTimeout: The Cloud Build timeout used as part of any
+ // dependent builds performed by version creation. Defaults to 10
+ // minutes.
+ CloudBuildTimeout string `json:"cloudBuildTimeout,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AppYamlPath") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "AppYamlPath") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *CloudBuildOptions) MarshalJSON() ([]byte, error) {
+ type NoMethod CloudBuildOptions
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// ContainerInfo: 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.
@@ -826,6 +866,37 @@ func (s *CpuUtilization) UnmarshalJSON(data []byte) error {
return nil
}
+// CreateVersionMetadataV1: Metadata for the given
+// google.longrunning.Operation during a
+// google.appengine.v1.CreateVersionRequest.
+type CreateVersionMetadataV1 struct {
+ // CloudBuildId: The Cloud Build ID if one was created as part of the
+ // version create. @OutputOnly
+ CloudBuildId string `json:"cloudBuildId,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CloudBuildId") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "CloudBuildId") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *CreateVersionMetadataV1) MarshalJSON() ([]byte, error) {
+ type NoMethod CreateVersionMetadataV1
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// CreateVersionMetadataV1Alpha: Metadata for the given
// google.longrunning.Operation during a
// google.appengine.v1alpha.CreateVersionRequest.
@@ -926,6 +997,14 @@ func (s *DebugInstanceRequest) MarshalJSON() ([]byte, error) {
// Deployment: Code and application artifacts used to deploy a version
// to App Engine.
type Deployment struct {
+ // CloudBuildOptions: Options for any Google Cloud Container Builder
+ // builds created as a part of this deployment.Note that this is
+ // orthogonal to the build parameter, where the deployment depends on an
+ // already existing cloud build. 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 *CloudBuildOptions `json:"cloudBuildOptions,omitempty"`
+
// Container: The Docker image for the container that runs the version.
// Only applicable for instances running in the App Engine flexible
// environment.
@@ -939,20 +1018,21 @@ type Deployment struct {
// Zip: The zip file for this deployment, if this is a zip deployment.
Zip *ZipInfo `json:"zip,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Container") to
- // unconditionally include in API requests. By default, fields with
+ // ForceSendFields is a list of field names (e.g. "CloudBuildOptions")
+ // to unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Container") to include in
- // API requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
+ // NullFields is a list of field names (e.g. "CloudBuildOptions") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
NullFields []string `json:"-"`
}
@@ -1067,8 +1147,9 @@ type Empty struct {
// EndpointsApiService: 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.The fields here refer to the name and configuration id
-// of a "service" resource in the Service Management API
+// 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).
type EndpointsApiService struct {
// ConfigId: Endpoints service configuration id as specified by the
@@ -1910,6 +1991,10 @@ func (s *LivenessCheck) MarshalJSON() ([]byte, error) {
// Location: A resource that represents Google Cloud Platform location.
type Location struct {
+ // DisplayName: The friendly name for this location, typically a nearby
+ // city name. For example, "Tokyo".
+ DisplayName string `json:"displayName,omitempty"`
+
// Labels: Cross-service attributes for the location. For
// example
// {"cloud.googleapis.com/region": "us-east1"}
@@ -1933,7 +2018,7 @@ type Location struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Labels") to
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -1941,10 +2026,10 @@ type Location struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Labels") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
@@ -1959,11 +2044,11 @@ func (s *Location) MarshalJSON() ([]byte, error) {
// LocationMetadata: Metadata for the given
// google.cloud.location.Location.
type LocationMetadata struct {
- // FlexibleEnvironmentAvailable: App Engine Flexible Environment is
+ // FlexibleEnvironmentAvailable: App Engine flexible environment is
// available in the given location.@OutputOnly
FlexibleEnvironmentAvailable bool `json:"flexibleEnvironmentAvailable,omitempty"`
- // StandardEnvironmentAvailable: App Engine Standard Environment is
+ // StandardEnvironmentAvailable: App Engine standard environment is
// available in the given location.@OutputOnly
StandardEnvironmentAvailable bool `json:"standardEnvironmentAvailable,omitempty"`
@@ -2033,8 +2118,8 @@ type Network struct {
// App Engine flexible environment.
ForwardedPorts []string `json:"forwardedPorts,omitempty"`
- // InstanceTag: Tag to apply to the VM instance during creation. for
- // Only applicable in the App Engine flexible environment.
+ // InstanceTag: Tag to apply to the instance during creation. Only
+ // applicable in the App Engine flexible environment.
InstanceTag string `json:"instanceTag,omitempty"`
// Name: Google Compute Engine network where the virtual machines are
@@ -2046,15 +2131,16 @@ type Network struct {
// 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 the VM instance is being created in is a Legacy
+ // 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 the VM 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 the VM 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
+ // 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 `json:"subnetworkName,omitempty"`
@@ -2234,6 +2320,8 @@ func (s *OperationMetadata) MarshalJSON() ([]byte, error) {
// OperationMetadataV1: Metadata for the given
// google.longrunning.Operation.
type OperationMetadataV1 struct {
+ CreateVersionMetadata *CreateVersionMetadataV1 `json:"createVersionMetadata,omitempty"`
+
// EndTime: Time that this operation completed.@OutputOnly
EndTime string `json:"endTime,omitempty"`
@@ -2259,20 +2347,22 @@ type OperationMetadataV1 struct {
// @OutputOnly
Warning []string `json:"warning,omitempty"`
- // ForceSendFields is a list of field names (e.g. "EndTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
+ // ForceSendFields is a list of field names (e.g.
+ // "CreateVersionMetadata") to unconditionally include in API requests.
+ // By default, fields with empty values are omitted from API requests.
+ // However, any non-pointer, non-interface field appearing in
+ // ForceSendFields will be sent to the server regardless of whether the
+ // field is empty or not. This may be used to include empty fields in
+ // Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "EndTime") to include in
- // API requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
+ // NullFields is a list of field names (e.g. "CreateVersionMetadata") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
NullFields []string `json:"-"`
}
@@ -2734,12 +2824,12 @@ func (s *SslSettings) MarshalJSON() ([]byte, error) {
// StandardSchedulerSettings: Scheduler settings for standard
// environment.
type StandardSchedulerSettings struct {
- // MaxInstances: Maximum number of instances for an app version. Set to
- // zero to disable max_instances configuration.
+ // MaxInstances: Maximum number of instances to run for this version.
+ // Set to zero to disable max_instances configuration.
MaxInstances int64 `json:"maxInstances,omitempty"`
- // MinInstances: Minimum number of instances for an app version. Set to
- // zero to disable min_instances configuration.
+ // MinInstances: Minimum number of instances to run for this version.
+ // Set to zero to disable min_instances configuration.
MinInstances int64 `json:"minInstances,omitempty"`
// TargetCpuUtilization: Target CPU utilization ratio to maintain when
@@ -3193,7 +3283,7 @@ type Version struct {
// GET requests if view=FULL is set.
Handlers []*UrlMap `json:"handlers,omitempty"`
- // HealthCheck: Configures health checking for VM instances. Unhealthy
+ // HealthCheck: 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.
@@ -3238,7 +3328,7 @@ type Version struct {
// view=FULL is set.
Libraries []*Library `json:"libraries,omitempty"`
- // LivenessCheck: Configures liveness health checking for VM instances.
+ // LivenessCheck: 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 *LivenessCheck `json:"livenessCheck,omitempty"`
@@ -3261,13 +3351,13 @@ type Version struct {
// GET requests if view=FULL is set.
NobuildFilesRegex string `json:"nobuildFilesRegex,omitempty"`
- // ReadinessCheck: Configures readiness health checking for VM
- // instances. Unhealthy instances are not put into the backend traffic
+ // ReadinessCheck: 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 *ReadinessCheck `json:"readinessCheck,omitempty"`
- // Resources: Machine resources for this version. Only applicable for VM
- // runtimes.
+ // Resources: Machine resources for this version. Only applicable in the
+ // App Engine flexible environment.
Resources *Resources `json:"resources,omitempty"`
// Runtime: Desired runtime. Example: python27.
@@ -3278,6 +3368,10 @@ type Version struct {
// https://cloud.google.com/appengine/docs/standard//config/appref
RuntimeApiVersion string `json:"runtimeApiVersion,omitempty"`
+ // RuntimeChannel: The channel of the runtime to use. Only available for
+ // some runtimes. Defaults to the default channel.
+ RuntimeChannel string `json:"runtimeChannel,omitempty"`
+
// ServingStatus: 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
@@ -3304,8 +3398,8 @@ type Version struct {
// machine.
Vm bool `json:"vm,omitempty"`
- // Zones: The choice of gce zones to use for this App Engine Flexible
- // version.
+ // Zones: The Google Compute Engine zones that are supported by this
+ // version in the App Engine flexible environment.
Zones []string `json:"zones,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -3437,7 +3531,7 @@ type AppsCreateCall struct {
// (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/python/console/).
+// (https://cloud.google.com/appengine/docs/standard/python/console/).
func (r *AppsService) Create(application *Application) *AppsCreateCall {
c := &AppsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.application = application
@@ -3527,7 +3621,7 @@ func (c *AppsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
}
return ret, nil
// {
- // "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/python/console/).",
+ // "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/).",
// "flatPath": "v1/apps",
// "httpMethod": "POST",
// "id": "appengine.apps.create",
@@ -6689,7 +6783,7 @@ type AppsLocationsGetCall struct {
header_ http.Header
}
-// Get: Get information about a location.
+// Get: Gets information about a location.
func (r *AppsLocationsService) Get(appsId string, locationsId string) *AppsLocationsGetCall {
c := &AppsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -6792,7 +6886,7 @@ func (c *AppsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, erro
}
return ret, nil
// {
- // "description": "Get information about a location.",
+ // "description": "Gets information about a location.",
// "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
// "httpMethod": "GET",
// "id": "appengine.apps.locations.get",
@@ -8763,23 +8857,23 @@ type AppsServicesVersionsPatchCall struct {
// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/a
// pps.services.versions#Version.FIELDS.automatic_scaling): For Version
// resources that use automatic scaling and run in the App Engine
-// Flexible environment.
+// flexible environment.
// automatic_scaling.max_total_instances
// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/a
// pps.services.versions#Version.FIELDS.automatic_scaling): For Version
// resources that use automatic scaling and run in the App Engine
-// Flexible environment.
+// flexible environment.
// automatic_scaling.cool_down_period_sec
// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/a
// pps.services.versions#Version.FIELDS.automatic_scaling): For Version
// resources that use automatic scaling and run in the App Engine
-// Flexible
+// flexible
// environment.
// automatic_scaling.cpu_utilization.target_utilization
// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/a
// pps.services.versions#Version.FIELDS.automatic_scaling): For Version
// resources that use automatic scaling and run in the App Engine
-// Flexible environment.
+// flexible environment.
func (r *AppsServicesVersionsService) Patch(appsId string, servicesId string, versionsId string, version *Version) *AppsServicesVersionsPatchCall {
c := &AppsServicesVersionsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -8884,7 +8978,7 @@ func (c *AppsServicesVersionsPatchCall) Do(opts ...googleapi.CallOption) (*Opera
}
return ret, nil
// {
- // "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
+ // "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.",
// "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
// "httpMethod": "PATCH",
// "id": "appengine.apps.services.versions.patch",
diff --git a/vendor/google.golang.org/api/appengine/v1alpha/appengine-api.json b/vendor/google.golang.org/api/appengine/v1alpha/appengine-api.json
index ee3554f03..0e9e941be 100644
--- a/vendor/google.golang.org/api/appengine/v1alpha/appengine-api.json
+++ b/vendor/google.golang.org/api/appengine/v1alpha/appengine-api.json
@@ -1,889 +1,934 @@
{
- "resources": {
- "apps": {
- "resources": {
- "authorizedDomains": {
- "methods": {
- "list": {
- "path": "v1alpha/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list",
- "description": "Lists all domains the user is authorized to administer.",
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedDomains"
- }
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
},
- "operations": {
- "methods": {
- "list": {
- "path": "v1alpha/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/operations"
- },
- "get": {
- "description": "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
- "path": "v1alpha/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
- }
- }
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
},
- "locations": {
- "methods": {
- "list": {
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "path": "v1alpha/apps/{appsId}/locations",
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListLocationsResponse"
- }
- },
- "get": {
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string"
- },
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "description": "Get information about a location."
- }
- }
- },
- "domainMappings": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete",
- "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource."
- },
- "list": {
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "path": "v1alpha/apps/{appsId}/domainMappings",
- "description": "Lists the domain mappings on an application.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListDomainMappingsResponse"
- }
- },
- "get": {
- "description": "Gets the specified domain mapping.",
- "response": {
- "$ref": "DomainMapping"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get"
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "noManagedCertificate": {
- "description": "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.",
- "type": "boolean",
- "location": "query"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch",
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "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."
- },
- "create": {
- "id": "appengine.apps.domainMappings.create",
- "path": "v1alpha/apps/{appsId}/domainMappings",
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "overrideStrategy": {
- "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
- "type": "string",
- "location": "query",
- "enum": [
- "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
- "STRICT",
- "OVERRIDE"
- ]
- },
- "noManagedCertificate": {
- "location": "query",
- "description": "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.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings"
- }
- }
- },
- "authorizedCertificates": {
- "methods": {
- "delete": {
- "description": "Deletes the specified SSL certificate.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete"
- },
- "list": {
- "response": {
- "$ref": "ListAuthorizedCertificatesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the LIST response.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "description": "Lists all SSL certificates the user is authorized to administer."
- },
- "get": {
- "description": "Gets the specified SSL certificate.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the GET response.",
- "type": "string"
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
- },
- "patch": {
- "id": "appengine.apps.authorizedCertificates.patch",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "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.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
- },
- "create": {
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate.",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create"
- }
- }
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
}
}
}
},
+ "basePath": "",
+ "baseUrl": "https://appengine.googleapis.com/",
+ "batchPath": "batch",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "appengine:v1alpha",
+ "kind": "discovery#restDescription",
+ "name": "appengine",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
"parameters": {
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
"type": "string"
},
"alt": {
- "type": "string",
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "location": "query",
- "description": "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.",
"type": "string"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
"bearer_token": {
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
"type": "string"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
"type": "string"
}
},
- "schemas": {
- "OperationMetadataV1Beta5": {
- "id": "OperationMetadataV1Beta5",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
+ "protocol": "rest",
+ "resources": {
+ "apps": {
+ "resources": {
+ "authorizedCertificates": {
+ "methods": {
+ "create": {
+ "description": "Uploads the specified SSL certificate.",
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "httpMethod": "POST",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified SSL certificate.",
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified SSL certificate.",
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the GET response.",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists all SSL certificates the user is authorized to administer.",
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the LIST response.",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "response": {
+ "$ref": "ListAuthorizedCertificatesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.authorizedCertificates.patch",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
},
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "description": "Lists all domains the user is authorized to administer.",
+ "flatPath": "v1alpha/apps/{appsId}/authorizedDomains",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedDomains.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/authorizedDomains",
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
},
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "domainMappings": {
+ "methods": {
+ "create": {
+ "description": "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.",
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings",
+ "httpMethod": "POST",
+ "id": "appengine.apps.domainMappings.create",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "noManagedCertificate": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "overrideStrategy": {
+ "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
+ "enum": [
+ "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
+ "STRICT",
+ "OVERRIDE"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/domainMappings",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.domainMappings.delete",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified domain mapping.",
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.domainMappings.get",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "response": {
+ "$ref": "DomainMapping"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the domain mappings on an application.",
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings",
+ "httpMethod": "GET",
+ "id": "appengine.apps.domainMappings.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/domainMappings",
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.domainMappings.patch",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "noManagedCertificate": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
+ "locations": {
+ "methods": {
+ "get": {
+ "description": "Gets information about a location.",
+ "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.get",
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v1alpha/apps/{appsId}/locations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/locations",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "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.",
+ "flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.get",
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/operations/{operationsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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.",
+ "flatPath": "v1alpha/apps/{appsId}/operations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha/apps/{appsId}/operations",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
}
}
+ }
+ },
+ "revision": "20180320",
+ "rootUrl": "https://appengine.googleapis.com/",
+ "schemas": {
+ "AuthorizedCertificate": {
+ "description": "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.",
+ "id": "AuthorizedCertificate",
+ "properties": {
+ "certificateRawData": {
+ "$ref": "CertificateRawData",
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
+ },
+ "displayName": {
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "type": "string"
+ },
+ "domainMappingsCount": {
+ "description": "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",
+ "format": "int32",
+ "type": "integer"
+ },
+ "domainNames": {
+ "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "expireTime": {
+ "description": "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",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "type": "string"
+ },
+ "managedCertificate": {
+ "$ref": "ManagedCertificate",
+ "description": "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"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
+ "type": "string"
+ },
+ "visibleDomainMappings": {
+ "description": "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",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "CreateVersionMetadataV1Alpha": {
- "id": "CreateVersionMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
- "type": "object",
+ "AuthorizedDomain": {
+ "description": "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).",
+ "id": "AuthorizedDomain",
+ "properties": {
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CertificateRawData": {
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "id": "CertificateRawData",
+ "properties": {
+ "privateKey": {
+ "description": "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: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
+ "type": "string"
+ },
+ "publicCertificate": {
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1",
"properties": {
"cloudBuildId": {
"description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
"type": "string"
}
- }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Alpha",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Beta",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "id": "DomainMapping",
+ "properties": {
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "resourceRecords": {
+ "description": "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",
+ "items": {
+ "$ref": "ResourceRecord"
+ },
+ "type": "array"
+ },
+ "sslSettings": {
+ "$ref": "SslSettings",
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "ListAuthorizedCertificatesResponse": {
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
+ "id": "ListAuthorizedCertificatesResponse",
+ "properties": {
+ "certificates": {
+ "description": "The SSL certificates the user is authorized to administer.",
+ "items": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListAuthorizedDomainsResponse": {
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "id": "ListAuthorizedDomainsResponse",
+ "properties": {
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListDomainMappingsResponse": {
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "id": "ListDomainMappingsResponse",
+ "properties": {
+ "domainMappings": {
+ "description": "The domain mappings for the application.",
+ "items": {
+ "$ref": "DomainMapping"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"ListLocationsResponse": {
- "id": "ListLocationsResponse",
"description": "The response message for Locations.ListLocations.",
- "type": "object",
+ "id": "ListLocationsResponse",
"properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
- },
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- }
- }
- },
- "CertificateRawData": {
- "id": "CertificateRawData",
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
- "properties": {
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
- "type": "string"
- },
- "privateKey": {
- "description": "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: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
- "type": "string"
- }
- }
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "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.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "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.",
- "type": "object"
- },
- "name": {
- "description": "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.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "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.",
- "type": "object"
}
},
- "id": "Operation"
- },
- "Status": {
- "id": "Status",
- "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "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.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- }
- }
- },
- "AuthorizedDomain": {
- "description": "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).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
- "type": "string"
- }
- },
- "id": "AuthorizedDomain"
- },
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
- "properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata"
- },
- "OperationMetadataV1Beta": {
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Beta"
- }
- },
- "id": "OperationMetadataV1Beta",
- "description": "Metadata for the given google.longrunning.Operation.",
"type": "object"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -891,288 +936,29 @@
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
"items": {
"$ref": "Operation"
- }
+ },
+ "type": "array"
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
"type": "object"
},
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "ListAuthorizedCertificatesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedCertificate"
- }
- }
- },
- "id": "ListAuthorizedCertificatesResponse",
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "type": "object"
- },
- "CreateVersionMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Beta"
- },
- "ManagedCertificate": {
- "properties": {
- "lastRenewalTime": {
- "description": "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",
- "format": "google-datetime",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "",
- "Certificate was successfully obtained and inserted into the serving system.",
- "Certificate is under active attempts to acquire or renew.",
- "Most recent renewal failed due to a system failure and will be retried. System failure is likely transient, and subsequent renewal attempts may succeed. The last successfully provisioned certificate may still be serving.",
- "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
- "All renewal attempts have been exhausted. Most recent renewal failed due to an invalid DNS setup and will not be retried. The last successfully provisioned certificate may still be serving.",
- "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
- "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
- ],
- "enum": [
- "UNSPECIFIED_STATUS",
- "OK",
- "PENDING",
- "FAILED_RETRYING_INTERNAL",
- "FAILED_RETRYING_NOT_VISIBLE",
- "FAILED_PERMANENTLY_NOT_VISIBLE",
- "FAILED_RETRYING_CAA_FORBIDDEN",
- "FAILED_RETRYING_CAA_CHECKING"
- ],
- "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
- "type": "string"
- }
- },
- "id": "ManagedCertificate",
- "description": "A certificate managed by App Engine.",
- "type": "object"
- },
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "isManagedCertificate": {
- "description": "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",
- "type": "boolean"
- },
- "certificateId": {
- "description": "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.",
- "type": "string"
- }
- },
- "id": "SslSettings"
- },
- "OperationMetadataV1": {
- "id": "OperationMetadataV1",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "ListDomainMappingsResponse": {
- "id": "ListDomainMappingsResponse",
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "type": "object",
- "properties": {
- "domainMappings": {
- "description": "The domain mappings for the application.",
- "type": "array",
- "items": {
- "$ref": "DomainMapping"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- }
- },
- "OperationMetadataV1Alpha": {
- "id": "OperationMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Alpha"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- }
- }
- },
- "ListAuthorizedDomainsResponse": {
- "id": "ListAuthorizedDomainsResponse",
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "type": "object",
- "properties": {
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedDomain"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- }
- },
- "DomainMapping": {
- "id": "DomainMapping",
- "description": "A domain serving an App Engine application.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- },
- "sslSettings": {
- "$ref": "SslSettings",
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
- },
- "id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
- "type": "string"
- },
- "resourceRecords": {
- "description": "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",
- "type": "array",
- "items": {
- "$ref": "ResourceRecord"
- }
- }
- }
- },
- "Empty": {
- "id": "Empty",
- "description": "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {}
- },
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
+ "id": "Location",
"properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "displayName": {
+ "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
"locationId": {
"description": "The canonical id for this location. For example: \"us-east1\".",
"type": "string"
@@ -1185,131 +971,363 @@
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
- "labels": {
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "id": "LocationMetadata",
+ "properties": {
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine flexible environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine standard environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ManagedCertificate": {
+ "description": "A certificate managed by App Engine.",
+ "id": "ManagedCertificate",
+ "properties": {
+ "lastRenewalTime": {
+ "description": "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",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
+ "enum": [
+ "UNSPECIFIED_STATUS",
+ "OK",
+ "PENDING",
+ "FAILED_RETRYING_INTERNAL",
+ "FAILED_RETRYING_NOT_VISIBLE",
+ "FAILED_PERMANENTLY_NOT_VISIBLE",
+ "FAILED_RETRYING_CAA_FORBIDDEN",
+ "FAILED_RETRYING_CAA_CHECKING"
+ ],
+ "enumDescriptions": [
+ "",
+ "Certificate was successfully obtained and inserted into the serving system.",
+ "Certificate is under active attempts to acquire or renew.",
+ "Most recent renewal failed due to a system failure and will be retried. System failure is likely transient, and subsequent renewal attempts may succeed. The last successfully provisioned certificate may still be serving.",
+ "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
+ "All renewal attempts have been exhausted. Most recent renewal failed due to an invalid DNS setup and will not be retried. The last successfully provisioned certificate may still be serving.",
+ "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
+ "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
+ "properties": {
+ "done": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
"additionalProperties": {
- "type": "string"
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "description": "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.",
+ "type": "object"
+ },
+ "name": {
+ "description": "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.",
+ "type": "string"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
"type": "object"
}
},
- "id": "Location"
+ "type": "object"
},
- "AuthorizedCertificate": {
- "description": "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.",
- "type": "object",
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadata",
"properties": {
- "name": {
- "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
- "type": "string"
- },
- "domainMappingsCount": {
- "description": "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",
- "format": "int32",
- "type": "integer"
- },
- "domainNames": {
- "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
- "type": "string"
- },
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
- "type": "string"
- },
- "managedCertificate": {
- "description": "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",
- "$ref": "ManagedCertificate"
- },
- "certificateRawData": {
- "$ref": "CertificateRawData",
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
- },
- "visibleDomainMappings": {
- "description": "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",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "expireTime": {
- "description": "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",
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
}
},
- "id": "AuthorizedCertificate"
+ "type": "object"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Alpha",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Alpha"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Beta"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta5",
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"ResourceRecord": {
- "id": "ResourceRecord",
"description": "A DNS resource record.",
- "type": "object",
+ "id": "ResourceRecord",
"properties": {
"name": {
"description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
"type": "string"
},
+ "rrdata": {
+ "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
+ "type": "string"
+ },
"type": {
- "enumDescriptions": [
- "An A resource record. Data is an IPv4 address.",
- "An AAAA resource record. Data is an IPv6 address.",
- "A CNAME resource record. Data is a domain name to be aliased."
- ],
+ "description": "Resource record type. Example: AAAA.",
"enum": [
"A",
"AAAA",
"CNAME"
],
- "description": "Resource record type. Example: AAAA.",
- "type": "string"
- },
- "rrdata": {
- "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
+ "enumDescriptions": [
+ "An A resource record. Data is an IPv4 address.",
+ "An AAAA resource record. Data is an IPv6 address.",
+ "A CNAME resource record. Data is a domain name to be aliased."
+ ],
"type": "string"
}
- }
- }
- },
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest",
- "version": "v1alpha",
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "type": "object"
+ },
+ "SslSettings": {
+ "description": "SSL configuration for a DomainMapping resource.",
+ "id": "SslSettings",
+ "properties": {
+ "certificateId": {
+ "description": "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.",
+ "type": "string"
},
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
+ "isManagedCertificate": {
+ "description": "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",
+ "type": "boolean"
}
- }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
},
- "kind": "discovery#restDescription",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"servicePath": "",
- "rootUrl": "https://appengine.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "appengine",
- "batchPath": "batch",
- "id": "appengine:v1alpha",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20180112",
- "title": "Google App Engine Admin API",
- "ownerName": "Google",
- "discoveryVersion": "v1"
-}
+ "title": "App Engine Admin API",
+ "version": "v1alpha"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/appengine/v1alpha/appengine-gen.go b/vendor/google.golang.org/api/appengine/v1alpha/appengine-gen.go
index 750a40272..532db94fd 100644
--- a/vendor/google.golang.org/api/appengine/v1alpha/appengine-gen.go
+++ b/vendor/google.golang.org/api/appengine/v1alpha/appengine-gen.go
@@ -1,4 +1,4 @@
-// Package appengine provides access to the Google App Engine Admin API.
+// Package appengine provides access to the App Engine Admin API.
//
// See https://cloud.google.com/appengine/docs/admin-api/
//
@@ -311,6 +311,37 @@ func (s *CertificateRawData) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// CreateVersionMetadataV1: Metadata for the given
+// google.longrunning.Operation during a
+// google.appengine.v1.CreateVersionRequest.
+type CreateVersionMetadataV1 struct {
+ // CloudBuildId: The Cloud Build ID if one was created as part of the
+ // version create. @OutputOnly
+ CloudBuildId string `json:"cloudBuildId,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CloudBuildId") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "CloudBuildId") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *CreateVersionMetadataV1) MarshalJSON() ([]byte, error) {
+ type NoMethod CreateVersionMetadataV1
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// CreateVersionMetadataV1Alpha: Metadata for the given
// google.longrunning.Operation during a
// google.appengine.v1alpha.CreateVersionRequest.
@@ -624,6 +655,10 @@ func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) {
// Location: A resource that represents Google Cloud Platform location.
type Location struct {
+ // DisplayName: The friendly name for this location, typically a nearby
+ // city name. For example, "Tokyo".
+ DisplayName string `json:"displayName,omitempty"`
+
// Labels: Cross-service attributes for the location. For
// example
// {"cloud.googleapis.com/region": "us-east1"}
@@ -647,7 +682,7 @@ type Location struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Labels") to
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -655,10 +690,10 @@ type Location struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Labels") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
@@ -673,11 +708,11 @@ func (s *Location) MarshalJSON() ([]byte, error) {
// LocationMetadata: Metadata for the given
// google.cloud.location.Location.
type LocationMetadata struct {
- // FlexibleEnvironmentAvailable: App Engine Flexible Environment is
+ // FlexibleEnvironmentAvailable: App Engine flexible environment is
// available in the given location.@OutputOnly
FlexibleEnvironmentAvailable bool `json:"flexibleEnvironmentAvailable,omitempty"`
- // StandardEnvironmentAvailable: App Engine Standard Environment is
+ // StandardEnvironmentAvailable: App Engine standard environment is
// available in the given location.@OutputOnly
StandardEnvironmentAvailable bool `json:"standardEnvironmentAvailable,omitempty"`
@@ -885,6 +920,8 @@ func (s *OperationMetadata) MarshalJSON() ([]byte, error) {
// OperationMetadataV1: Metadata for the given
// google.longrunning.Operation.
type OperationMetadataV1 struct {
+ CreateVersionMetadata *CreateVersionMetadataV1 `json:"createVersionMetadata,omitempty"`
+
// EndTime: Time that this operation completed.@OutputOnly
EndTime string `json:"endTime,omitempty"`
@@ -910,20 +947,22 @@ type OperationMetadataV1 struct {
// @OutputOnly
Warning []string `json:"warning,omitempty"`
- // ForceSendFields is a list of field names (e.g. "EndTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
+ // ForceSendFields is a list of field names (e.g.
+ // "CreateVersionMetadata") to unconditionally include in API requests.
+ // By default, fields with empty values are omitted from API requests.
+ // However, any non-pointer, non-interface field appearing in
+ // ForceSendFields will be sent to the server regardless of whether the
+ // field is empty or not. This may be used to include empty fields in
+ // Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "EndTime") to include in
- // API requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
+ // NullFields is a list of field names (e.g. "CreateVersionMetadata") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
NullFields []string `json:"-"`
}
@@ -3077,7 +3116,7 @@ type AppsLocationsGetCall struct {
header_ http.Header
}
-// Get: Get information about a location.
+// Get: Gets information about a location.
func (r *AppsLocationsService) Get(appsId string, locationsId string) *AppsLocationsGetCall {
c := &AppsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -3180,7 +3219,7 @@ func (c *AppsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, erro
}
return ret, nil
// {
- // "description": "Get information about a location.",
+ // "description": "Gets information about a location.",
// "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
// "httpMethod": "GET",
// "id": "appengine.apps.locations.get",
diff --git a/vendor/google.golang.org/api/appengine/v1beta/appengine-api.json b/vendor/google.golang.org/api/appengine/v1beta/appengine-api.json
index 5eeed2c49..695c5e7de 100644
--- a/vendor/google.golang.org/api/appengine/v1beta/appengine-api.json
+++ b/vendor/google.golang.org/api/appengine/v1beta/appengine-api.json
@@ -1,204 +1,297 @@
{
- "id": "appengine:v1beta",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20180112",
- "title": "Google App Engine Admin API",
- "ownerName": "Google",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://appengine.googleapis.com/",
+ "batchPath": "batch",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "appengine:v1beta",
+ "kind": "discovery#restDescription",
+ "name": "appengine",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
"resources": {
"apps": {
"methods": {
"create": {
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/).",
+ "flatPath": "v1beta/apps",
+ "httpMethod": "POST",
+ "id": "appengine.apps.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1beta/apps",
"request": {
"$ref": "Application"
},
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/python/console/).",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "Operation"
},
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps",
- "id": "appengine.apps.create",
- "path": "v1beta/apps"
- },
- "repair": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}:repair",
- "path": "v1beta/apps/{appsId}:repair",
- "id": "appengine.apps.repair",
- "request": {
- "$ref": "RepairApplicationRequest"
- },
- "description": "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."
+ ]
},
"get": {
+ "description": "Gets information about an application.",
+ "flatPath": "v1beta/apps/{appsId}",
"httpMethod": "GET",
+ "id": "appengine.apps.get",
"parameterOrder": [
"appsId"
],
- "response": {
- "$ref": "Application"
- },
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "location": "path",
"required": true,
"type": "string"
}
},
+ "path": "v1beta/apps/{appsId}",
+ "response": {
+ "$ref": "Application"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1beta/apps/{appsId}",
- "description": "Gets information about an application."
+ ]
},
"patch": {
- "request": {
- "$ref": "Application"
- },
"description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
+ "flatPath": "v1beta/apps/{appsId}",
"httpMethod": "PATCH",
+ "id": "appengine.apps.patch",
"parameterOrder": [
"appsId"
],
- "response": {
- "$ref": "Operation"
- },
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "type": "string"
}
},
+ "path": "v1beta/apps/{appsId}",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "repair": {
+ "description": "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.",
+ "flatPath": "v1beta/apps/{appsId}:repair",
+ "httpMethod": "POST",
+ "id": "appengine.apps.repair",
+ "parameterOrder": [
+ "appsId"
],
- "flatPath": "v1beta/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1beta/apps/{appsId}"
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}:repair",
+ "request": {
+ "$ref": "RepairApplicationRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
},
"resources": {
"authorizedCertificates": {
"methods": {
- "delete": {
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "description": "Deletes the specified SSL certificate.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "authorizedCertificatesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
- },
- "list": {
- "description": "Lists all SSL certificates the user is authorized to administer.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListAuthorizedCertificatesResponse"
- },
+ "create": {
+ "description": "Uploads the specified SSL certificate.",
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
+ "httpMethod": "POST",
+ "id": "appengine.apps.authorizedCertificates.create",
"parameterOrder": [
"appsId"
],
"parameters": {
"appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the LIST response.",
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "path": "v1beta/apps/{appsId}/authorizedCertificates"
- },
- "get": {
- "description": "Gets the specified SSL certificate.",
- "httpMethod": "GET",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
"response": {
"$ref": "AuthorizedCertificate"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified SSL certificate.",
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified SSL certificate.",
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedCertificates.get",
"parameterOrder": [
"appsId",
"authorizedCertificatesId"
@@ -206,200 +299,75 @@
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"view": {
- "location": "query",
+ "description": "Controls the set of fields returned in the GET response.",
"enum": [
"BASIC_CERTIFICATE",
"FULL_CERTIFICATE"
],
- "description": "Controls the set of fields returned in the GET response.",
+ "location": "query",
"type": "string"
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
- },
- "patch": {
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "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."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create",
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate."
- }
- }
- },
- "services": {
- "methods": {
- "delete": {
- "description": "Deletes the specified service and all enclosed versions.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete"
+ ]
},
"list": {
- "description": "Lists all the services in the application.",
- "response": {
- "$ref": "ListServicesResponse"
- },
+ "description": "Lists all SSL certificates the user is authorized to administer.",
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedCertificates.list",
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
- "type": "integer",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
+ "location": "query",
+ "type": "integer"
},
"pageToken": {
- "location": "query",
"description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the LIST response.",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "location": "query",
"type": "string"
}
},
- "flatPath": "v1beta/apps/{appsId}/services",
- "path": "v1beta/apps/{appsId}/services",
- "id": "appengine.apps.services.list"
- },
- "get": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get",
- "description": "Gets the current configuration of the specified service.",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
"response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- }
+ "$ref": "ListAuthorizedCertificatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
@@ -408,473 +376,44 @@
]
},
"patch": {
- "response": {
- "$ref": "Operation"
- },
+ "description": "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.",
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.authorizedCertificates.patch",
"parameterOrder": [
"appsId",
- "servicesId"
+ "authorizedCertificatesId"
],
- "httpMethod": "PATCH",
"parameters": {
"appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
"location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
"required": true,
"type": "string"
},
- "migrateTraffic": {
- "description": "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).",
- "type": "boolean",
- "location": "query"
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
"format": "google-fieldmask",
+ "location": "query",
"type": "string"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
- "request": {
- "$ref": "Service"
- },
- "description": "Updates the configuration of the specified service."
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "delete": {
- "description": "Deletes an existing Version resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete"
- },
- "list": {
- "id": "appengine.apps.services.versions.list",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "description": "Lists the versions of a service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string"
- },
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
- },
- "patch": {
- "request": {
- "$ref": "Version"
- },
- "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version."
- }
- },
- "resources": {
- "instances": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "versionsId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "description": "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)."
- },
- "get": {
- "id": "appengine.apps.services.versions.instances.get",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Instance"
- },
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
- },
- "debug": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "description": "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."
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "description": "Stops a running instance."
- }
- }
- }
- }
+ ]
}
}
},
@@ -882,301 +421,222 @@
"methods": {
"list": {
"description": "Lists all domains the user is authorized to administer.",
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
+ "flatPath": "v1beta/apps/{appsId}/authorizedDomains",
+ "httpMethod": "GET",
+ "id": "appengine.apps.authorizedDomains.list",
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
"pageToken": {
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
"location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
+ "type": "string"
}
},
- "flatPath": "v1beta/apps/{appsId}/authorizedDomains",
"path": "v1beta/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list"
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "httpMethod": "GET",
"response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
+ "$ref": "ListAuthorizedDomainsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "path": "v1beta/apps/{appsId}/operations",
- "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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."
- },
- "get": {
- "path": "v1beta/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "description": "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/operations/{operationsId}"
+ ]
}
}
},
"domainMappings": {
"methods": {
"create": {
+ "description": "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.",
+ "flatPath": "v1beta/apps/{appsId}/domainMappings",
"httpMethod": "POST",
+ "id": "appengine.apps.domainMappings.create",
"parameterOrder": [
"appsId"
],
- "response": {
- "$ref": "Operation"
- },
"parameters": {
"appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"overrideStrategy": {
"description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
- "type": "string",
- "location": "query",
"enum": [
"UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
"STRICT",
"OVERRIDE"
- ]
+ ],
+ "location": "query",
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
"path": "v1beta/apps/{appsId}/domainMappings",
"request": {
"$ref": "DomainMapping"
},
- "description": "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."
- },
- "delete": {
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
"response": {
"$ref": "Operation"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.domainMappings.delete",
"parameterOrder": [
"appsId",
"domainMappingsId"
],
- "httpMethod": "DELETE",
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete"
- },
- "list": {
- "response": {
- "$ref": "ListDomainMappingsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
"location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"required": true,
"type": "string"
},
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified domain mapping.",
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.domainMappings.get",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "response": {
+ "$ref": "DomainMapping"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the domain mappings on an application.",
+ "flatPath": "v1beta/apps/{appsId}/domainMappings",
+ "httpMethod": "GET",
+ "id": "appengine.apps.domainMappings.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
}
},
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "description": "Lists the domain mappings on an application."
+ ]
},
- "get": {
- "response": {
- "$ref": "DomainMapping"
- },
+ "patch": {
+ "description": "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.",
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.domainMappings.patch",
"parameterOrder": [
"appsId",
"domainMappingsId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"domainMappingsId": {
"description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
"location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
"required": true,
"type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
}
},
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
"path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get",
- "description": "Gets the specified domain mapping."
- },
- "patch": {
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch",
- "description": "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.",
"request": {
"$ref": "DomainMapping"
},
"response": {
"$ref": "Operation"
},
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
- },
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}"
+ ]
}
}
},
@@ -1185,204 +645,204 @@
"ingressRules": {
"methods": {
"batchUpdate": {
- "response": {
- "$ref": "BatchUpdateIngressRulesResponse"
- },
+ "description": "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.",
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "httpMethod": "POST",
+ "id": "appengine.apps.firewall.ingressRules.batchUpdate",
"parameterOrder": [
"appsId"
],
- "httpMethod": "POST",
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
+ "location": "path",
"required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
"path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "id": "appengine.apps.firewall.ingressRules.batchUpdate",
"request": {
"$ref": "BatchUpdateIngressRulesRequest"
},
- "description": "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."
+ "response": {
+ "$ref": "BatchUpdateIngressRulesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "description": "Creates a firewall rule for the application.",
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "httpMethod": "POST",
+ "id": "appengine.apps.firewall.ingressRules.create",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"delete": {
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.delete",
"description": "Deletes the specified firewall rule.",
- "response": {
- "$ref": "Empty"
- },
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.firewall.ingressRules.delete",
"parameterOrder": [
"appsId",
"ingressRulesId"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
+ "location": "path",
"required": true,
"type": "string"
},
"ingressRulesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
- },
- "list": {
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.list",
- "description": "Lists the firewall rules of an application.",
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
- "matchingAddress": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
"location": "path",
- "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
"required": true,
"type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
}
- }
- },
- "create": {
- "request": {
- "$ref": "FirewallRule"
},
- "description": "Creates a firewall rule for the application.",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
"response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string",
- "location": "path"
- }
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.create"
+ ]
},
"get": {
- "response": {
- "$ref": "FirewallRule"
- },
+ "description": "Gets the specified firewall rule.",
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.firewall.ingressRules.get",
"parameterOrder": [
"appsId",
"ingressRulesId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"ingressRulesId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
"path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get",
- "description": "Gets the specified firewall rule."
- },
- "patch": {
- "request": {
- "$ref": "FirewallRule"
- },
- "description": "Updates the specified firewall rule.",
"response": {
"$ref": "FirewallRule"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the firewall rules of an application.",
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "httpMethod": "GET",
+ "id": "appengine.apps.firewall.ingressRules.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "matchingAddress": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "Updates the specified firewall rule.",
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.firewall.ingressRules.patch",
"parameterOrder": [
"appsId",
"ingressRulesId"
],
- "httpMethod": "PATCH",
"parameters": {
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
+ "location": "path",
"required": true,
"type": "string"
},
"ingressRulesId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
}
},
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "response": {
+ "$ref": "FirewallRule"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.patch"
+ ]
}
}
}
@@ -1390,552 +850,1590 @@
},
"locations": {
"methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/locations",
- "path": "v1beta/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "description": "Lists information about the supported locations for this service."
- },
"get": {
- "response": {
- "$ref": "Location"
- },
+ "description": "Gets information about a location.",
+ "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.get",
"parameterOrder": [
"appsId",
"locationsId"
],
- "httpMethod": "GET",
"parameters": {
- "locationsId": {
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
"location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
},
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1beta/apps/{appsId}/locations/{locationsId}",
+ "response": {
+ "$ref": "Location"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v1beta/apps/{appsId}/locations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.list",
+ "parameterOrder": [
+ "appsId"
],
- "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
- "path": "v1beta/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "description": "Get information about a location."
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/locations",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "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.",
+ "flatPath": "v1beta/apps/{appsId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.get",
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/operations/{operationsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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.",
+ "flatPath": "v1beta/apps/{appsId}/operations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/operations",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
+ "services": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified service and all enclosed versions.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the current configuration of the specified service.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.get",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "response": {
+ "$ref": "Service"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists all the services in the application.",
+ "flatPath": "v1beta/apps/{appsId}/services",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services",
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "Updates the configuration of the specified service.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.services.patch",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "migrateTraffic": {
+ "description": "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).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "request": {
+ "$ref": "Service"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "versions": {
+ "methods": {
+ "create": {
+ "description": "Deploys code and resource files to a new version.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.create",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an existing Version resource.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.get",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the Get response.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "response": {
+ "$ref": "Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the versions of a service.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.list",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the List response.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.services.versions.patch",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "debug": {
+ "description": "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.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Stops a running instance.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.instances.delete",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets instance information.",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.instances.get",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "response": {
+ "$ref": "Instance"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "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).",
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.instances.list",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ }
+ }
}
}
}
}
}
},
- "parameters": {
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- }
- },
+ "revision": "20180320",
+ "rootUrl": "https://appengine.googleapis.com/",
"schemas": {
- "ManagedCertificate": {
- "description": "A certificate managed by App Engine.",
- "type": "object",
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "id": "ApiConfigHandler",
"properties": {
- "lastRenewalTime": {
- "description": "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",
- "format": "google-datetime",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "",
- "Certificate was successfully obtained and inserted into the serving system.",
- "Certificate is under active attempts to acquire or renew.",
- "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
- "All renewal attempts have been exhausted, likely due to an invalid DNS setup.",
- "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
- "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
- ],
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
"enum": [
- "MANAGEMENT_STATUS_UNSPECIFIED",
- "OK",
- "PENDING",
- "FAILED_RETRYING_NOT_VISIBLE",
- "FAILED_PERMANENT",
- "FAILED_RETRYING_CAA_FORBIDDEN",
- "FAILED_RETRYING_CAA_CHECKING"
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
],
- "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "type": "string"
+ },
+ "login": {
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "type": "string"
+ },
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to serve the endpoint at.",
"type": "string"
}
},
- "id": "ManagedCertificate"
- },
- "ListInstancesResponse": {
- "properties": {
- "instances": {
- "description": "The instances belonging to the requested version.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListInstancesResponse",
- "description": "Response message for Instances.ListInstances.",
- "type": "object"
- },
- "ListDomainMappingsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domainMappings": {
- "description": "The domain mappings for the application.",
- "type": "array",
- "items": {
- "$ref": "DomainMapping"
- }
- }
- },
- "id": "ListDomainMappingsResponse",
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "type": "object"
- },
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Alpha"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Alpha"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "path": {
- "description": "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.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
- "type": "array",
- "items": {
- "$ref": "Version"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse"
- },
- "ListAuthorizedDomainsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedDomain"
- }
- }
- },
- "id": "ListAuthorizedDomainsResponse",
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
"type": "object"
},
"ApiEndpointHandler": {
"description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
+ "id": "ApiEndpointHandler",
"properties": {
"scriptPath": {
"description": "Path to the script from the application root directory.",
"type": "string"
}
},
- "id": "ApiEndpointHandler"
+ "type": "object"
},
- "DomainMapping": {
- "description": "A domain serving an App Engine application.",
- "type": "object",
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "id": "Application",
"properties": {
- "id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
"type": "string"
},
- "resourceRecords": {
- "description": "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",
- "type": "array",
- "items": {
- "$ref": "ResourceRecord"
- }
- },
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "codeBucket": {
+ "description": "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",
"type": "string"
},
- "sslSettings": {
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
- "$ref": "SslSettings"
- }
- },
- "id": "DomainMapping"
- },
- "Empty": {
- "description": "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ZipInfo": {
- "description": "The zip file information for a zip deployment.",
- "type": "object",
- "properties": {
- "filesCount": {
- "description": "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.",
- "format": "int32",
- "type": "integer"
- },
- "sourceUrl": {
- "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
"type": "string"
- }
- },
- "id": "ZipInfo"
- },
- "AutomaticScaling": {
- "properties": {
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ },
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
"format": "google-duration",
"type": "string"
},
- "standardSchedulerSettings": {
- "$ref": "StandardSchedulerSettings",
- "description": "Scheduler settings for standard environment."
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
},
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
+ "dispatchRules": {
+ "description": "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.@OutputOnly",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ },
+ "type": "array"
+ },
+ "featureSettings": {
+ "$ref": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application."
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "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).",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "servingStatus": {
+ "description": "Serving status of this application.",
+ "enum": [
+ "UNSPECIFIED",
+ "SERVING",
+ "USER_DISABLED",
+ "SYSTEM_DISABLED"
+ ],
+ "enumDescriptions": [
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthorizedCertificate": {
+ "description": "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.",
+ "id": "AuthorizedCertificate",
+ "properties": {
+ "certificateRawData": {
+ "$ref": "CertificateRawData",
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
+ },
+ "displayName": {
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "type": "string"
+ },
+ "domainMappingsCount": {
+ "description": "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",
"format": "int32",
"type": "integer"
},
- "requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
+ "domainNames": {
+ "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
- "format": "int32",
- "type": "integer"
+ "expireTime": {
+ "description": "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",
+ "format": "google-datetime",
+ "type": "string"
},
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
+ "id": {
+ "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "type": "string"
},
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
+ "managedCertificate": {
+ "$ref": "ManagedCertificate",
+ "description": "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"
},
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
+ "name": {
+ "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
+ "type": "string"
},
+ "visibleDomainMappings": {
+ "description": "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",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AuthorizedDomain": {
+ "description": "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).",
+ "id": "AuthorizedDomain",
+ "properties": {
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "id": "AutomaticScaling",
+ "properties": {
"coolDownPeriod": {
"description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.",
"format": "google-duration",
"type": "string"
},
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ },
+ "customMetrics": {
+ "description": "Target scaling by user-provided metrics.",
+ "items": {
+ "$ref": "CustomMetric"
+ },
+ "type": "array"
+ },
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
"maxConcurrentRequests": {
"description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
"format": "int32",
"type": "integer"
},
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
"maxPendingLatency": {
"description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
"format": "google-duration",
"type": "string"
},
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- }
- },
- "id": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object"
- },
- "AuthorizedCertificate": {
- "description": "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.",
- "type": "object",
- "properties": {
- "domainMappingsCount": {
- "description": "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",
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests for this version.",
"format": "int32",
"type": "integer"
},
- "domainNames": {
- "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
- "type": "array",
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of running instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "standardSchedulerSettings": {
+ "$ref": "StandardSchedulerSettings",
+ "description": "Scheduler settings for standard environment."
+ }
+ },
+ "type": "object"
+ },
+ "BasicScaling": {
+ "description": "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.",
+ "id": "BasicScaling",
+ "properties": {
+ "idleTimeout": {
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "BatchUpdateIngressRulesRequest": {
+ "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "id": "BatchUpdateIngressRulesRequest",
+ "properties": {
+ "ingressRules": {
+ "description": "A list of FirewallRules to replace the existing set.",
"items": {
- "type": "string"
- }
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "BatchUpdateIngressRulesResponse": {
+ "description": "Response message for Firewall.UpdateAllIngressRules.",
+ "id": "BatchUpdateIngressRulesResponse",
+ "properties": {
+ "ingressRules": {
+ "description": "The full list of ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "BuildInfo": {
+ "description": "Google Cloud Container Builder build information.",
+ "id": "BuildInfo",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CertificateRawData": {
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "id": "CertificateRawData",
+ "properties": {
+ "privateKey": {
+ "description": "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: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
+ "type": "string"
+ },
+ "publicCertificate": {
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CloudBuildOptions": {
+ "description": "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.",
+ "id": "CloudBuildOptions",
+ "properties": {
+ "appYamlPath": {
+ "description": "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.",
+ "type": "string"
+ },
+ "cloudBuildTimeout": {
+ "description": "The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContainerInfo": {
+ "description": "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.",
+ "id": "ContainerInfo",
+ "properties": {
+ "image": {
+ "description": "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\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "id": "CpuUtilization",
+ "properties": {
+ "aggregationWindowLength": {
+ "description": "Period of time over which CPU utilization is calculated.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "targetUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Alpha",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Beta",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomMetric": {
+ "description": "Allows autoscaling based on Stackdriver metrics.",
+ "id": "CustomMetric",
+ "properties": {
+ "filter": {
+ "description": "Allows filtering on the metric's fields.",
+ "type": "string"
+ },
+ "metricName": {
+ "description": "The name of the metric.",
+ "type": "string"
+ },
+ "singleInstanceAssignment": {
+ "description": "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.",
+ "format": "double",
+ "type": "number"
+ },
+ "targetType": {
+ "description": "The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.",
+ "type": "string"
+ },
+ "targetUtilization": {
+ "description": "The target value for the metric.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "id": "DebugInstanceRequest",
+ "properties": {
+ "sshKey": {
+ "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[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).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "id": "Deployment",
+ "properties": {
+ "build": {
+ "$ref": "BuildInfo",
+ "description": "Google Cloud Container Builder build information. Only applicable for instances running in the App Engine flexible environment."
+ },
+ "cloudBuildOptions": {
+ "$ref": "CloudBuildOptions",
+ "description": "Options for any Google Cloud Container Builder builds created as a part of this deployment.Note that this is orthogonal to the build parameter, where the deployment depends on an already existing cloud build. 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."
+ },
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ },
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "zip": {
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
+ }
+ },
+ "type": "object"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.",
+ "id": "DiskUtilization",
+ "properties": {
+ "targetReadBytesPerSecond": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadOpsPerSecond": {
+ "description": "Target ops read per seconds.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSecond": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSecond": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "id": "DomainMapping",
+ "properties": {
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "resourceRecords": {
+ "description": "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",
+ "items": {
+ "$ref": "ResourceRecord"
+ },
+ "type": "array"
+ },
+ "sslSettings": {
+ "$ref": "SslSettings",
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "EndpointsApiService": {
+ "description": "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).",
+ "id": "EndpointsApiService",
+ "properties": {
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ },
+ "rolloutStrategy": {
+ "description": "Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.",
+ "enum": [
+ "UNSPECIFIED_ROLLOUT_STRATEGY",
+ "FIXED",
+ "MANAGED"
+ ],
+ "enumDescriptions": [
+ "Not specified. Defaults to FIXED.",
+ "Endpoints service configuration id will be fixed to the configuration id specified by config_id.",
+ "Endpoints service configuration id will be updated with each rollout."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "id": "ErrorHandler",
+ "properties": {
+ "errorCode": {
+ "description": "Error condition this handler applies to.",
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FeatureSettings": {
+ "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
+ "id": "FeatureSettings",
+ "properties": {
+ "splitHealthChecks": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "useContainerOptimizedOs": {
+ "description": "If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "id": "FileInfo",
+ "properties": {
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
+ },
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FirewallRule": {
+ "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
+ "id": "FirewallRule",
+ "properties": {
+ "action": {
+ "description": "The action to take on matched requests.",
+ "enum": [
+ "UNSPECIFIED_ACTION",
+ "ALLOW",
+ "DENY"
+ ],
+ "enumDescriptions": [
+ "",
+ "Matching requests are allowed.",
+ "Matching requests are denied."
+ ],
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
+ "type": "string"
+ },
+ "priority": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceRange": {
+ "description": "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.\u003cp\u003eTruncation 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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HealthCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "id": "HealthCheck",
+ "properties": {
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ },
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "timeout": {
+ "description": "Time before the health check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "IdentityAwareProxy": {
+ "description": "Identity-Aware Proxy",
+ "id": "IdentityAwareProxy",
+ "properties": {
+ "enabled": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
+ "type": "string"
+ },
+ "oauth2ClientSecret": {
+ "description": "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",
+ "type": "string"
+ },
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "id": "Instance",
+ "properties": {
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
},
"id": {
- "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
"type": "string"
},
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
"type": "string"
},
- "managedCertificate": {
- "description": "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",
- "$ref": "ManagedCertificate"
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
},
- "certificateRawData": {
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
- "$ref": "CertificateRawData"
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
},
- "visibleDomainMappings": {
- "description": "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",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
},
- "expireTime": {
- "description": "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",
+ "startTime": {
+ "description": "Time that this instance was started.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "name": {
- "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
+ "vmDebugEnabled": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
}
},
- "id": "AuthorizedCertificate"
- },
- "ResourceRecord": {
- "description": "A DNS resource record.",
- "type": "object",
- "properties": {
- "rrdata": {
- "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
- "type": "string"
- },
- "name": {
- "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
- "type": "string"
- },
- "type": {
- "description": "Resource record type. Example: AAAA.",
- "type": "string",
- "enumDescriptions": [
- "An A resource record. Data is an IPv4 address.",
- "An AAAA resource record. Data is an IPv6 address.",
- "A CNAME resource record. Data is a domain name to be aliased."
- ],
- "enum": [
- "A",
- "AAAA",
- "CNAME"
- ]
- }
- },
- "id": "ResourceRecord"
+ "type": "object"
},
"Library": {
"description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
+ "id": "Library",
"properties": {
"name": {
"description": "Name of the library. Example: \"django\".",
@@ -1946,166 +2444,386 @@
"type": "string"
}
},
- "id": "Library"
+ "type": "object"
+ },
+ "ListAuthorizedCertificatesResponse": {
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
+ "id": "ListAuthorizedCertificatesResponse",
+ "properties": {
+ "certificates": {
+ "description": "The SSL certificates the user is authorized to administer.",
+ "items": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListAuthorizedDomainsResponse": {
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "id": "ListAuthorizedDomainsResponse",
+ "properties": {
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListDomainMappingsResponse": {
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "id": "ListDomainMappingsResponse",
+ "properties": {
+ "domainMappings": {
+ "description": "The domain mappings for the application.",
+ "items": {
+ "$ref": "DomainMapping"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListIngressRulesResponse": {
+ "description": "Response message for Firewall.ListIngressRules.",
+ "id": "ListIngressRulesResponse",
+ "properties": {
+ "ingressRules": {
+ "description": "The ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "id": "ListInstancesResponse",
+ "properties": {
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
- "type": "object",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
- "$ref": "Location"
- }
+ "$ref": "Operation"
+ },
+ "type": "array"
}
},
- "id": "ListLocationsResponse"
+ "type": "object"
},
- "ContainerInfo": {
- "description": "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.",
- "type": "object",
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "id": "ListServicesResponse",
"properties": {
- "image": {
- "description": "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\"",
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "id": "ListVersionsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LivenessCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
+ "id": "LivenessCheck",
+ "properties": {
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "initialDelay": {
+ "description": "The initial delay before starting to execute the checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
"type": "string"
}
},
- "id": "ContainerInfo"
+ "type": "object"
},
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.",
- "type": "object",
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
"properties": {
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
+ "displayName": {
+ "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
},
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RequestUtilization"
- },
- "EndpointsApiService": {
- "description": "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.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).",
- "type": "object",
- "properties": {
"name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
"type": "string"
}
},
- "id": "EndpointsApiService"
+ "type": "object"
},
- "UrlMap": {
- "description": "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.",
- "type": "object",
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "id": "LocationMetadata",
"properties": {
- "securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine flexible environment is available in the given location.@OutputOnly",
+ "type": "boolean"
},
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "description": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
- },
- "urlRegex": {
- "description": "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.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string"
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- },
- "staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
- },
- "redirectHttpResponseCode": {
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ],
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ]
+ "standardEnvironmentAvailable": {
+ "description": "App Engine standard environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
- "id": "UrlMap"
+ "type": "object"
+ },
+ "ManagedCertificate": {
+ "description": "A certificate managed by App Engine.",
+ "id": "ManagedCertificate",
+ "properties": {
+ "lastRenewalTime": {
+ "description": "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",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
+ "enum": [
+ "MANAGEMENT_STATUS_UNSPECIFIED",
+ "OK",
+ "PENDING",
+ "FAILED_RETRYING_NOT_VISIBLE",
+ "FAILED_PERMANENT",
+ "FAILED_RETRYING_CAA_FORBIDDEN",
+ "FAILED_RETRYING_CAA_CHECKING"
+ ],
+ "enumDescriptions": [
+ "",
+ "Certificate was successfully obtained and inserted into the serving system.",
+ "Certificate is under active attempts to acquire or renew.",
+ "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
+ "All renewal attempts have been exhausted, likely due to an invalid DNS setup.",
+ "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
+ "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ManualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "id": "ManualScaling",
+ "properties": {
+ "instances": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Network": {
+ "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
+ "id": "Network",
+ "properties": {
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ },
+ "sessionAffinity": {
+ "description": "Enable session affinity.",
+ "type": "boolean"
+ },
+ "subnetworkName": {
+ "description": "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.\nIf the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf 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.\nIf 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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
+ "id": "NetworkUtilization",
+ "properties": {
+ "targetReceivedBytesPerSecond": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSecond": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
+ "id": "Operation",
"properties": {
"done": {
"description": "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.",
"type": "boolean"
},
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "name": {
+ "description": "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.",
+ "type": "string"
+ },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -2113,93 +2831,412 @@
},
"description": "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.",
"type": "object"
- },
- "name": {
- "description": "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.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "description": "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.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
}
},
- "id": "Operation"
+ "type": "object"
},
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadata",
"properties": {
- "script": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Alpha",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Alpha"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Beta"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta5",
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReadinessCheck": {
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "id": "ReadinessCheck",
+ "properties": {
+ "appStartTimeout": {
+ "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "host": {
+ "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RepairApplicationRequest": {
+ "description": "Request message for 'Applications.RepairApplication'.",
+ "id": "RepairApplicationRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.",
+ "id": "RequestUtilization",
+ "properties": {
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetRequestCountPerSecond": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ResourceRecord": {
+ "description": "A DNS resource record.",
+ "id": "ResourceRecord",
+ "properties": {
+ "name": {
+ "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "type": "string"
+ },
+ "rrdata": {
+ "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource record type. Example: AAAA.",
+ "enum": [
+ "A",
+ "AAAA",
+ "CNAME"
+ ],
+ "enumDescriptions": [
+ "An A resource record. Data is an IPv4 address.",
+ "An AAAA resource record. Data is an IPv6 address.",
+ "A CNAME resource record. Data is a domain name to be aliased."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Resources": {
+ "description": "Machine resources for a version.",
+ "id": "Resources",
+ "properties": {
+ "cpu": {
+ "description": "Number of CPU cores needed.",
+ "format": "double",
+ "type": "number"
+ },
+ "diskGb": {
+ "description": "Disk size (GB) needed.",
+ "format": "double",
+ "type": "number"
+ },
+ "memoryGb": {
+ "description": "Memory (GB) needed.",
+ "format": "double",
+ "type": "number"
+ },
+ "volumes": {
+ "description": "User specified volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "id": "ScriptHandler",
+ "properties": {
+ "scriptPath": {
"description": "Path to the script from the application root directory.",
"type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string"
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- },
- "securityLevel": {
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ]
- },
- "authFailAction": {
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
}
},
- "id": "ApiConfigHandler"
+ "type": "object"
+ },
+ "Service": {
+ "description": "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.",
+ "id": "Service",
+ "properties": {
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "split": {
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ }
+ },
+ "type": "object"
+ },
+ "SslSettings": {
+ "description": "SSL configuration for a DomainMapping resource.",
+ "id": "SslSettings",
+ "properties": {
+ "certificateId": {
+ "description": "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.",
+ "type": "string"
+ },
+ "pendingManagedCertificateId": {
+ "description": "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",
+ "type": "string"
+ },
+ "sslManagementType": {
+ "description": "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.",
+ "enum": [
+ "AUTOMATIC",
+ "MANUAL"
+ ],
+ "enumDescriptions": [
+ "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.",
+ "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StandardSchedulerSettings": {
+ "description": "Scheduler settings for standard environment.",
+ "id": "StandardSchedulerSettings",
+ "properties": {
+ "maxInstances": {
+ "description": "Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minInstances": {
+ "description": "Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetCpuUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling.",
+ "format": "double",
+ "type": "number"
+ },
+ "targetThroughputUtilization": {
+ "description": "Target throughput utilization ratio to maintain when scaling",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
},
"StaticFilesHandler": {
+ "description": "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.",
+ "id": "StaticFilesHandler",
"properties": {
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "applicationReadable": {
+ "description": "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.",
"type": "boolean"
},
"expiration": {
@@ -2214,968 +3251,287 @@
"description": "HTTP headers to use for all responses from these URLs.",
"type": "object"
},
- "applicationReadable": {
- "description": "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.",
- "type": "boolean"
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "mimeType": {
+ "description": "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.",
"type": "string"
},
"path": {
"description": "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.",
"type": "string"
},
- "mimeType": {
- "description": "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.",
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
"type": "string"
}
},
- "id": "StaticFilesHandler",
- "description": "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.",
"type": "object"
},
- "BasicScaling": {
- "description": "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.",
- "type": "object",
- "properties": {
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
- },
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "BasicScaling"
- },
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "targetReadBytesPerSecond": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadOpsPerSecond": {
- "description": "Target ops read per seconds.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteOpsPerSecond": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteBytesPerSecond": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
- "properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
- "format": "google-duration",
- "type": "string"
- },
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "CpuUtilization"
- },
"Status": {
"description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
+ "id": "Status",
"properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "type": "array",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ },
+ "type": "array"
},
"message": {
"description": "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.",
"type": "string"
}
},
- "id": "Status"
- },
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "type": "object",
- "properties": {
- "enabled": {
- "description": "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.",
- "type": "boolean"
- },
- "oauth2ClientSecret": {
- "description": "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",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- }
- },
- "id": "IdentityAwareProxy"
- },
- "ManualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object",
- "properties": {
- "instances": {
- "description": "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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ManualScaling"
- },
- "LocationMetadata": {
- "properties": {
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata",
- "description": "Metadata for the given google.cloud.location.Location.",
"type": "object"
},
- "Service": {
- "description": "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.",
- "type": "object",
+ "TrafficSplit": {
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "id": "TrafficSplit",
"properties": {
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
+ "allocations": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "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.",
+ "type": "object"
},
- "split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
- "$ref": "TrafficSplit"
- },
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Service"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "FirewallRule": {
- "properties": {
- "sourceRange": {
- "description": "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.\u003cp\u003eTruncation 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.",
- "type": "string"
- },
- "priority": {
- "description": "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.",
- "format": "int32",
- "type": "integer"
- },
- "action": {
- "enum": [
- "UNSPECIFIED_ACTION",
- "ALLOW",
- "DENY"
- ],
- "description": "The action to take on matched requests.",
- "type": "string",
- "enumDescriptions": [
- "",
- "Matching requests are allowed.",
- "Matching requests are denied."
- ]
- },
- "description": {
- "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
- "type": "string"
- }
- },
- "id": "FirewallRule",
- "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
- "type": "object"
- },
- "ListAuthorizedCertificatesResponse": {
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedCertificate"
- }
- }
- },
- "id": "ListAuthorizedCertificatesResponse"
- },
- "CreateVersionMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Beta"
- },
- "FeatureSettings": {
- "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
- "type": "object",
- "properties": {
- "useContainerOptimizedOs": {
- "description": "If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.",
- "type": "boolean"
- },
- "splitHealthChecks": {
- "description": "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.",
- "type": "boolean"
- }
- },
- "id": "FeatureSettings"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
- },
- "SslSettings": {
- "properties": {
- "pendingManagedCertificateId": {
- "description": "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",
- "type": "string"
- },
- "certificateId": {
- "description": "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.",
- "type": "string"
- },
- "sslManagementType": {
- "description": "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.",
- "type": "string",
- "enumDescriptions": [
- "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.",
- "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain."
- ],
- "enum": [
- "AUTOMATIC",
- "MANUAL"
- ]
- }
- },
- "id": "SslSettings",
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object"
- },
- "ErrorHandler": {
- "properties": {
- "errorCode": {
- "description": "Error condition this handler applies to.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ]
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler",
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object"
- },
- "Network": {
- "properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation. for Only applicable in the App Engine flexible environment.",
- "type": "string"
- },
- "subnetworkName": {
- "description": "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.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM 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.\nIf the network the VM 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.",
- "type": "string"
- },
- "name": {
- "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network",
- "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
- "type": "object"
- },
- "Application": {
- "properties": {
- "featureSettings": {
- "description": "The feature specific settings to be used in the application.",
- "$ref": "FeatureSettings"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "codeBucket": {
- "description": "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",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "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.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "gcrDomain": {
- "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "id": {
- "description": "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.",
- "type": "string"
- },
- "locationId": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "servingStatus": {
- "description": "Serving status of this application.",
- "type": "string",
- "enumDescriptions": [
- "Serving status is unspecified.",
- "Application is serving.",
- "Application has been disabled by the user.",
- "Application has been disabled by the system."
- ],
+ "shardBy": {
+ "description": "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.",
"enum": [
"UNSPECIFIED",
- "SERVING",
- "USER_DISABLED",
- "SYSTEM_DISABLED"
- ]
- },
- "defaultHostname": {
- "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Application",
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object"
- },
- "Instance": {
- "properties": {
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "averageLatency": {
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "availability": {
+ "COOKIE",
+ "IP",
+ "RANDOM"
+ ],
"enumDescriptions": [
- "",
- "",
- ""
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
+ "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "startTime": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
}
},
- "id": "Instance",
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
"type": "object"
},
- "LivenessCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object",
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "id": "UrlDispatchRule",
"properties": {
- "host": {
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "successThreshold": {
- "description": "Number of consecutive successful checks required before considering the VM healthy.",
- "format": "uint32",
- "type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "format": "uint32",
- "type": "integer"
- },
- "initialDelay": {
- "description": "The initial delay before starting to execute the checks.",
- "format": "google-duration",
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
"type": "string"
},
"path": {
- "description": "The request path.",
+ "description": "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.",
+ "type": "string"
+ },
+ "service": {
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
"type": "string"
}
},
- "id": "LivenessCheck"
- },
- "BatchUpdateIngressRulesRequest": {
- "description": "Request message for Firewall.BatchUpdateIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "A list of FirewallRules to replace the existing set.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
- }
- },
- "id": "BatchUpdateIngressRulesRequest"
- },
- "CloudBuildOptions": {
- "description": "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.",
- "type": "object",
- "properties": {
- "appYamlPath": {
- "description": "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.",
- "type": "string"
- },
- "cloudBuildTimeout": {
- "description": "The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "CloudBuildOptions"
- },
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "targetSentBytesPerSecond": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentPacketsPerSecond": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedBytesPerSecond": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedPacketsPerSecond": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "HealthCheck": {
- "properties": {
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "format": "uint32",
- "type": "integer"
- },
- "healthyThreshold": {
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "id": "HealthCheck",
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"type": "object"
},
- "ReadinessCheck": {
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "type": "object",
+ "UrlMap": {
+ "description": "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.",
+ "id": "UrlMap",
"properties": {
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
+ "apiEndpoint": {
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
},
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
"type": "string"
},
- "appStartTimeout": {
- "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
- "format": "google-duration",
+ "login": {
+ "description": "Level of login required to access this resource.",
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
"type": "string"
},
- "path": {
- "description": "The request path.",
+ "redirectHttpResponseCode": {
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ],
"type": "string"
},
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
+ "script": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
"type": "string"
},
- "successThreshold": {
- "description": "Number of consecutive successful checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
},
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
+ "urlRegex": {
+ "description": "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.",
"type": "string"
}
},
- "id": "ReadinessCheck"
- },
- "DebugInstanceRequest": {
- "properties": {
- "sshKey": {
- "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[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).",
- "type": "string"
- }
- },
- "id": "DebugInstanceRequest",
- "description": "Request message for Instances.DebugInstance.",
"type": "object"
},
- "StandardSchedulerSettings": {
- "description": "Scheduler settings for standard environment.",
- "type": "object",
- "properties": {
- "targetThroughputUtilization": {
- "description": "Target throughput utilization ratio to maintain when scaling",
- "format": "double",
- "type": "number"
- },
- "maxInstances": {
- "description": "Maximum number of instances for an app version. Set to zero to disable max_instances configuration.",
- "format": "int32",
- "type": "integer"
- },
- "minInstances": {
- "description": "Minimum number of instances for an app version. Set to zero to disable min_instances configuration.",
- "format": "int32",
- "type": "integer"
- },
- "targetCpuUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "StandardSchedulerSettings"
- },
- "OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta5"
- },
- "CreateVersionMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Alpha"
- },
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
- "type": "object",
+ "id": "Version",
"properties": {
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "diskUsageBytes": {
- "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "healthCheck": {
- "description": "Configures health checking for VM 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.",
- "$ref": "HealthCheck"
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "readinessCheck": {
- "$ref": "ReadinessCheck",
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set."
- },
- "manualScaling": {
- "$ref": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
- },
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
- "type": "string"
- },
"apiConfig": {
"$ref": "ApiConfigHandler",
"description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
},
- "endpointsApiService": {
- "$ref": "EndpointsApiService",
- "description": "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."
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
},
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
- "type": "string"
+ "basicScaling": {
+ "$ref": "BasicScaling",
+ "description": "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."
},
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "instanceClass": {
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
- "type": "string"
- },
- "servingStatus": {
- "description": "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.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ],
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ]
- },
- "runtimeApiVersion": {
- "description": "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/\u003clanguage\u003e/config/appref",
- "type": "string"
- },
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
},
"createTime": {
"description": "Time that this version was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "defaultExpiration": {
+ "description": "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.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "deployment": {
+ "$ref": "Deployment",
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
+ },
+ "diskUsageBytes": {
+ "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "endpointsApiService": {
+ "$ref": "EndpointsApiService",
+ "description": "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."
+ },
+ "env": {
+ "description": "App Engine execution environment for this version.Defaults to standard.",
+ "type": "string"
+ },
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
+ },
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "ErrorHandler"
+ },
+ "type": "array"
+ },
+ "handlers": {
+ "description": "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.",
+ "items": {
+ "$ref": "UrlMap"
+ },
+ "type": "array"
+ },
+ "healthCheck": {
+ "$ref": "HealthCheck",
+ "description": "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."
+ },
+ "id": {
+ "description": "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-\".",
+ "type": "string"
+ },
"inboundServices": {
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
- "type": "array",
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ],
"items": {
"enum": [
"INBOUND_SERVICE_UNSPECIFIED",
@@ -3190,356 +3546,101 @@
],
"type": "string"
},
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ]
+ "type": "array"
},
- "resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
- },
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "ErrorHandler"
- }
- },
- "defaultExpiration": {
- "description": "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.",
- "format": "google-duration",
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
"type": "string"
},
"libraries": {
"description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
- "type": "array",
"items": {
"$ref": "Library"
- }
- },
- "nobuildFilesRegex": {
- "description": "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.",
- "type": "string"
- },
- "basicScaling": {
- "$ref": "BasicScaling",
- "description": "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."
- },
- "runtime": {
- "description": "Desired runtime. Example: python27.",
- "type": "string"
- },
- "id": {
- "description": "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-\".",
- "type": "string"
- },
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "envVariables": {
- "additionalProperties": {
- "type": "string"
},
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
+ "type": "array"
},
"livenessCheck": {
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
- "$ref": "LivenessCheck"
+ "$ref": "LivenessCheck",
+ "description": "Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
+ },
+ "manualScaling": {
+ "$ref": "ManualScaling",
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ },
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
+ "type": "string"
},
"network": {
"$ref": "Network",
"description": "Extra network settings. Only applicable in the App Engine flexible environment."
},
- "betaSettings": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object"
- },
- "env": {
- "description": "App Engine execution environment for this version.Defaults to standard.",
+ "nobuildFilesRegex": {
+ "description": "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.",
"type": "string"
},
- "handlers": {
- "description": "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.",
- "type": "array",
- "items": {
- "$ref": "UrlMap"
- }
+ "readinessCheck": {
+ "$ref": "ReadinessCheck",
+ "description": "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."
+ },
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable in the App Engine flexible environment."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
+ },
+ "runtimeApiVersion": {
+ "description": "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/\u003clanguage\u003e/config/appref",
+ "type": "string"
+ },
+ "runtimeChannel": {
+ "description": "The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.",
+ "type": "string"
+ },
+ "servingStatus": {
+ "description": "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.",
+ "enum": [
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING",
+ "STOPPED"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ],
+ "type": "string"
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "type": "string"
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
},
"zones": {
- "description": "The choice of gce zones to use for this App Engine Flexible version.",
- "type": "array",
+ "description": "The Google Compute Engine zones that are supported by this version in the App Engine flexible environment.",
"items": {
"type": "string"
- }
- }
- },
- "id": "Version"
- },
- "RepairApplicationRequest": {
- "description": "Request message for 'Applications.RepairApplication'.",
- "type": "object",
- "properties": {},
- "id": "RepairApplicationRequest"
- },
- "BuildInfo": {
- "description": "Google Cloud Container Builder build information.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"",
- "type": "string"
- }
- },
- "id": "BuildInfo"
- },
- "CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
- "properties": {
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
- "type": "string"
- },
- "privateKey": {
- "description": "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: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
- "type": "string"
- }
- },
- "id": "CertificateRawData"
- },
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "properties": {
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- },
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- },
- "sourceUrl": {
- "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- }
- },
- "id": "FileInfo"
- },
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ScriptHandler"
- },
- "AuthorizedDomain": {
- "properties": {
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
- "type": "string"
- }
- },
- "id": "AuthorizedDomain",
- "description": "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).",
- "type": "object"
- },
- "TrafficSplit": {
- "properties": {
- "shardBy": {
- "description": "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.",
- "type": "string",
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
- "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
- ],
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP",
- "RANDOM"
- ]
- },
- "allocations": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
},
- "description": "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.",
- "type": "object"
+ "type": "array"
}
},
- "id": "TrafficSplit",
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
"type": "object"
},
- "OperationMetadataV1Beta": {
- "properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Beta"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "ListIngressRulesResponse": {
- "description": "Response message for Firewall.ListIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "The ingress FirewallRules for this application.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListIngressRulesResponse"
- },
- "ListServicesResponse": {
- "properties": {
- "services": {
- "description": "The services belonging to the requested application.",
- "type": "array",
- "items": {
- "$ref": "Service"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListServicesResponse",
- "description": "Response message for Services.ListServices.",
- "type": "object"
- },
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
- "properties": {
- "zip": {
- "$ref": "ZipInfo",
- "description": "The zip file for this deployment, if this is a zip deployment."
- },
- "container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
- },
- "build": {
- "$ref": "BuildInfo",
- "description": "Google Cloud Container Builder build information. Only applicable for instances running in the App Engine flexible environment."
- },
- "files": {
- "additionalProperties": {
- "$ref": "FileInfo"
- },
- "description": "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.",
- "type": "object"
- },
- "cloudBuildOptions": {
- "description": "Options for any Google Cloud Container Builder builds created as a part of this deployment.Note that this is orthogonal to the build parameter, where the deployment depends on an already existing cloud build. 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.",
- "$ref": "CloudBuildOptions"
- }
- },
- "id": "Deployment"
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "volumes": {
- "description": "User specified volumes.",
- "type": "array",
- "items": {
- "$ref": "Volume"
- }
- },
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
- },
- "cpu": {
- "description": "Number of CPU cores needed.",
- "format": "double",
- "type": "number"
- },
- "memoryGb": {
- "description": "Memory (GB) needed.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Resources"
- },
"Volume": {
"description": "Volumes mounted within the app container. Only applicable in the App Engine flexible environment.",
- "type": "object",
+ "id": "Volume",
"properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "name": {
+ "description": "Unique name for the volume.",
"type": "string"
},
"sizeGb": {
@@ -3547,56 +3648,31 @@
"format": "double",
"type": "number"
},
- "name": {
- "description": "Unique name for the volume.",
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
"type": "string"
}
},
- "id": "Volume"
+ "type": "object"
},
- "BatchUpdateIngressRulesResponse": {
+ "ZipInfo": {
+ "description": "The zip file information for a zip deployment.",
+ "id": "ZipInfo",
"properties": {
- "ingressRules": {
- "description": "The full list of ingress FirewallRules for this application.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
+ "filesCount": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceUrl": {
+ "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
}
},
- "id": "BatchUpdateIngressRulesResponse",
- "description": "Response message for Firewall.UpdateAllIngressRules.",
"type": "object"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "version": "v1beta",
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"servicePath": "",
- "rootUrl": "https://appengine.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "appengine",
- "batchPath": "batch"
-}
+ "title": "App Engine Admin API",
+ "version": "v1beta"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/appengine/v1beta/appengine-gen.go b/vendor/google.golang.org/api/appengine/v1beta/appengine-gen.go
index 037286b28..61ab6ac2b 100644
--- a/vendor/google.golang.org/api/appengine/v1beta/appengine-gen.go
+++ b/vendor/google.golang.org/api/appengine/v1beta/appengine-gen.go
@@ -1,4 +1,4 @@
-// Package appengine provides access to the Google App Engine Admin API.
+// Package appengine provides access to the App Engine Admin API.
//
// See https://cloud.google.com/appengine/docs/admin-api/
//
@@ -366,11 +366,11 @@ type Application struct {
// where you want to deploy your application. Example: myapp.
Id string `json:"id,omitempty"`
- // LocationId: Location from which this application will be run.
- // Application instances will run out of data centers in the chosen
- // location, which is also where all of the application's end user
- // content is stored.Defaults to us-central.Options are:us-central -
- // Central USeurope-west - Western Europeus-east1 - Eastern US
+ // LocationId: 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 `json:"locationId,omitempty"`
// Name: Full path to the Application resource in the API. Example:
@@ -546,6 +546,9 @@ type AutomaticScaling struct {
// CpuUtilization: Target scaling by CPU usage.
CpuUtilization *CpuUtilization `json:"cpuUtilization,omitempty"`
+ // CustomMetrics: Target scaling by user-provided metrics.
+ CustomMetrics []*CustomMetric `json:"customMetrics,omitempty"`
+
// DiskUtilization: Target scaling by disk usage.
DiskUtilization *DiskUtilization `json:"diskUtilization,omitempty"`
@@ -563,7 +566,7 @@ type AutomaticScaling struct {
MaxPendingLatency string `json:"maxPendingLatency,omitempty"`
// MaxTotalInstances: Maximum number of instances that should be started
- // to handle requests.
+ // to handle requests for this version.
MaxTotalInstances int64 `json:"maxTotalInstances,omitempty"`
// MinIdleInstances: Minimum number of idle instances that should be
@@ -575,7 +578,7 @@ type AutomaticScaling struct {
// the pending queue before starting a new instance to handle it.
MinPendingLatency string `json:"minPendingLatency,omitempty"`
- // MinTotalInstances: Minimum number of instances that should be
+ // MinTotalInstances: Minimum number of running instances that should be
// maintained for this version.
MinTotalInstances int64 `json:"minTotalInstances,omitempty"`
@@ -902,6 +905,37 @@ func (s *CpuUtilization) UnmarshalJSON(data []byte) error {
return nil
}
+// CreateVersionMetadataV1: Metadata for the given
+// google.longrunning.Operation during a
+// google.appengine.v1.CreateVersionRequest.
+type CreateVersionMetadataV1 struct {
+ // CloudBuildId: The Cloud Build ID if one was created as part of the
+ // version create. @OutputOnly
+ CloudBuildId string `json:"cloudBuildId,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CloudBuildId") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "CloudBuildId") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *CreateVersionMetadataV1) MarshalJSON() ([]byte, error) {
+ type NoMethod CreateVersionMetadataV1
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// CreateVersionMetadataV1Alpha: Metadata for the given
// google.longrunning.Operation during a
// google.appengine.v1alpha.CreateVersionRequest.
@@ -964,6 +998,67 @@ func (s *CreateVersionMetadataV1Beta) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// CustomMetric: Allows autoscaling based on Stackdriver metrics.
+type CustomMetric struct {
+ // Filter: Allows filtering on the metric's fields.
+ Filter string `json:"filter,omitempty"`
+
+ // MetricName: The name of the metric.
+ MetricName string `json:"metricName,omitempty"`
+
+ // SingleInstanceAssignment: 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 float64 `json:"singleInstanceAssignment,omitempty"`
+
+ // TargetType: The type of the metric. Must be a string representing a
+ // Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.
+ TargetType string `json:"targetType,omitempty"`
+
+ // TargetUtilization: The target value for the metric.
+ TargetUtilization float64 `json:"targetUtilization,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Filter") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Filter") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *CustomMetric) MarshalJSON() ([]byte, error) {
+ type NoMethod CustomMetric
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+func (s *CustomMetric) UnmarshalJSON(data []byte) error {
+ type NoMethod CustomMetric
+ var s1 struct {
+ SingleInstanceAssignment gensupport.JSONFloat64 `json:"singleInstanceAssignment"`
+ TargetUtilization gensupport.JSONFloat64 `json:"targetUtilization"`
+ *NoMethod
+ }
+ s1.NoMethod = (*NoMethod)(s)
+ if err := json.Unmarshal(data, &s1); err != nil {
+ return err
+ }
+ s.SingleInstanceAssignment = float64(s1.SingleInstanceAssignment)
+ s.TargetUtilization = float64(s1.TargetUtilization)
+ return nil
+}
+
// DebugInstanceRequest: Request message for Instances.DebugInstance.
type DebugInstanceRequest struct {
// SshKey: Public SSH key to add to the instance.
@@ -1156,8 +1251,9 @@ type Empty struct {
// EndpointsApiService: 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.The fields here refer to the name and configuration id
-// of a "service" resource in the Service Management API
+// 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).
type EndpointsApiService struct {
// ConfigId: Endpoints service configuration id as specified by the
@@ -1173,6 +1269,17 @@ type EndpointsApiService struct {
// "myapi.endpoints.myproject.cloud.goog"
Name string `json:"name,omitempty"`
+ // RolloutStrategy: Endpoints rollout strategy. If FIXED, config_id must
+ // be specified. If MANAGED, config_id must be omitted.
+ //
+ // Possible values:
+ // "UNSPECIFIED_ROLLOUT_STRATEGY" - Not specified. Defaults to FIXED.
+ // "FIXED" - Endpoints service configuration id will be fixed to the
+ // configuration id specified by config_id.
+ // "MANAGED" - Endpoints service configuration id will be updated with
+ // each rollout.
+ RolloutStrategy string `json:"rolloutStrategy,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "ConfigId") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -2008,6 +2115,10 @@ func (s *LivenessCheck) MarshalJSON() ([]byte, error) {
// Location: A resource that represents Google Cloud Platform location.
type Location struct {
+ // DisplayName: The friendly name for this location, typically a nearby
+ // city name. For example, "Tokyo".
+ DisplayName string `json:"displayName,omitempty"`
+
// Labels: Cross-service attributes for the location. For
// example
// {"cloud.googleapis.com/region": "us-east1"}
@@ -2031,7 +2142,7 @@ type Location struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Labels") to
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -2039,10 +2150,10 @@ type Location struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Labels") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
@@ -2057,11 +2168,11 @@ func (s *Location) MarshalJSON() ([]byte, error) {
// LocationMetadata: Metadata for the given
// google.cloud.location.Location.
type LocationMetadata struct {
- // FlexibleEnvironmentAvailable: App Engine Flexible Environment is
+ // FlexibleEnvironmentAvailable: App Engine flexible environment is
// available in the given location.@OutputOnly
FlexibleEnvironmentAvailable bool `json:"flexibleEnvironmentAvailable,omitempty"`
- // StandardEnvironmentAvailable: App Engine Standard Environment is
+ // StandardEnvironmentAvailable: App Engine standard environment is
// available in the given location.@OutputOnly
StandardEnvironmentAvailable bool `json:"standardEnvironmentAvailable,omitempty"`
@@ -2193,8 +2304,8 @@ type Network struct {
// App Engine flexible environment.
ForwardedPorts []string `json:"forwardedPorts,omitempty"`
- // InstanceTag: Tag to apply to the VM instance during creation. for
- // Only applicable in the App Engine flexible environment.
+ // InstanceTag: Tag to apply to the instance during creation. Only
+ // applicable in the App Engine flexible environment.
InstanceTag string `json:"instanceTag,omitempty"`
// Name: Google Compute Engine network where the virtual machines are
@@ -2202,19 +2313,23 @@ type Network struct {
// default.
Name string `json:"name,omitempty"`
+ // SessionAffinity: Enable session affinity.
+ SessionAffinity bool `json:"sessionAffinity,omitempty"`
+
// SubnetworkName: 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 the VM instance is being created in is a Legacy
+ // 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 the VM 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 the VM 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
+ // 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 `json:"subnetworkName,omitempty"`
@@ -2394,6 +2509,8 @@ func (s *OperationMetadata) MarshalJSON() ([]byte, error) {
// OperationMetadataV1: Metadata for the given
// google.longrunning.Operation.
type OperationMetadataV1 struct {
+ CreateVersionMetadata *CreateVersionMetadataV1 `json:"createVersionMetadata,omitempty"`
+
// EndTime: Time that this operation completed.@OutputOnly
EndTime string `json:"endTime,omitempty"`
@@ -2419,20 +2536,22 @@ type OperationMetadataV1 struct {
// @OutputOnly
Warning []string `json:"warning,omitempty"`
- // ForceSendFields is a list of field names (e.g. "EndTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
+ // ForceSendFields is a list of field names (e.g.
+ // "CreateVersionMetadata") to unconditionally include in API requests.
+ // By default, fields with empty values are omitted from API requests.
+ // However, any non-pointer, non-interface field appearing in
+ // ForceSendFields will be sent to the server regardless of whether the
+ // field is empty or not. This may be used to include empty fields in
+ // Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "EndTime") to include in
- // API requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
+ // NullFields is a list of field names (e.g. "CreateVersionMetadata") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
NullFields []string `json:"-"`
}
@@ -2922,12 +3041,12 @@ func (s *SslSettings) MarshalJSON() ([]byte, error) {
// StandardSchedulerSettings: Scheduler settings for standard
// environment.
type StandardSchedulerSettings struct {
- // MaxInstances: Maximum number of instances for an app version. Set to
- // zero to disable max_instances configuration.
+ // MaxInstances: Maximum number of instances to run for this version.
+ // Set to zero to disable max_instances configuration.
MaxInstances int64 `json:"maxInstances,omitempty"`
- // MinInstances: Minimum number of instances for an app version. Set to
- // zero to disable min_instances configuration.
+ // MinInstances: Minimum number of instances to run for this version.
+ // Set to zero to disable min_instances configuration.
MinInstances int64 `json:"minInstances,omitempty"`
// TargetCpuUtilization: Target CPU utilization ratio to maintain when
@@ -3382,7 +3501,7 @@ type Version struct {
// GET requests if view=FULL is set.
Handlers []*UrlMap `json:"handlers,omitempty"`
- // HealthCheck: Configures health checking for VM instances. Unhealthy
+ // HealthCheck: 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.
@@ -3427,7 +3546,7 @@ type Version struct {
// view=FULL is set.
Libraries []*Library `json:"libraries,omitempty"`
- // LivenessCheck: Configures liveness health checking for VM instances.
+ // LivenessCheck: 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 *LivenessCheck `json:"livenessCheck,omitempty"`
@@ -3450,13 +3569,13 @@ type Version struct {
// GET requests if view=FULL is set.
NobuildFilesRegex string `json:"nobuildFilesRegex,omitempty"`
- // ReadinessCheck: Configures readiness health checking for VM
- // instances. Unhealthy instances are not put into the backend traffic
+ // ReadinessCheck: 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 *ReadinessCheck `json:"readinessCheck,omitempty"`
- // Resources: Machine resources for this version. Only applicable for VM
- // runtimes.
+ // Resources: Machine resources for this version. Only applicable in the
+ // App Engine flexible environment.
Resources *Resources `json:"resources,omitempty"`
// Runtime: Desired runtime. Example: python27.
@@ -3467,6 +3586,10 @@ type Version struct {
// https://cloud.google.com/appengine/docs/standard//config/appref
RuntimeApiVersion string `json:"runtimeApiVersion,omitempty"`
+ // RuntimeChannel: The channel of the runtime to use. Only available for
+ // some runtimes. Defaults to the default channel.
+ RuntimeChannel string `json:"runtimeChannel,omitempty"`
+
// ServingStatus: 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
@@ -3493,8 +3616,8 @@ type Version struct {
// machine.
Vm bool `json:"vm,omitempty"`
- // Zones: The choice of gce zones to use for this App Engine Flexible
- // version.
+ // Zones: The Google Compute Engine zones that are supported by this
+ // version in the App Engine flexible environment.
Zones []string `json:"zones,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -3626,7 +3749,7 @@ type AppsCreateCall struct {
// (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/python/console/).
+// (https://cloud.google.com/appengine/docs/standard/python/console/).
func (r *AppsService) Create(application *Application) *AppsCreateCall {
c := &AppsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.application = application
@@ -3716,7 +3839,7 @@ func (c *AppsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
}
return ret, nil
// {
- // "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/python/console/).",
+ // "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/).",
// "flatPath": "v1beta/apps",
// "httpMethod": "POST",
// "id": "appengine.apps.create",
@@ -6878,7 +7001,7 @@ type AppsLocationsGetCall struct {
header_ http.Header
}
-// Get: Get information about a location.
+// Get: Gets information about a location.
func (r *AppsLocationsService) Get(appsId string, locationsId string) *AppsLocationsGetCall {
c := &AppsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -6981,7 +7104,7 @@ func (c *AppsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, erro
}
return ret, nil
// {
- // "description": "Get information about a location.",
+ // "description": "Gets information about a location.",
// "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
// "httpMethod": "GET",
// "id": "appengine.apps.locations.get",
@@ -8953,23 +9076,23 @@ type AppsServicesVersionsPatchCall struct {
// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1be
// ta/apps.services.versions#Version.FIELDS.automatic_scaling): For
// Version resources that use automatic scaling and run in the App
-// Engine Flexible environment.
+// Engine flexible environment.
// automatic_scaling.max_total_instances
// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1be
// ta/apps.services.versions#Version.FIELDS.automatic_scaling): For
// Version resources that use automatic scaling and run in the App
-// Engine Flexible environment.
+// Engine flexible environment.
// automatic_scaling.cool_down_period_sec
// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1be
// ta/apps.services.versions#Version.FIELDS.automatic_scaling): For
// Version resources that use automatic scaling and run in the App
-// Engine Flexible
+// Engine flexible
// environment.
// automatic_scaling.cpu_utilization.target_utilization
// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1be
// ta/apps.services.versions#Version.FIELDS.automatic_scaling): For
// Version resources that use automatic scaling and run in the App
-// Engine Flexible environment.
+// Engine flexible environment.
func (r *AppsServicesVersionsService) Patch(appsId string, servicesId string, versionsId string, version *Version) *AppsServicesVersionsPatchCall {
c := &AppsServicesVersionsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -9074,7 +9197,7 @@ func (c *AppsServicesVersionsPatchCall) Do(opts ...googleapi.CallOption) (*Opera
}
return ret, nil
// {
- // "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
+ // "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine flexible environment.",
// "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
// "httpMethod": "PATCH",
// "id": "appengine.apps.services.versions.patch",
diff --git a/vendor/google.golang.org/api/appengine/v1beta4/appengine-api.json b/vendor/google.golang.org/api/appengine/v1beta4/appengine-api.json
index 6011cc60e..37ec8ac98 100644
--- a/vendor/google.golang.org/api/appengine/v1beta4/appengine-api.json
+++ b/vendor/google.golang.org/api/appengine/v1beta4/appengine-api.json
@@ -1,347 +1,762 @@
{
- "id": "appengine:v1beta4",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20180112",
- "title": "Google App Engine Admin API",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://appengine.googleapis.com/",
+ "batchPath": "batch",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "appengine:v1beta4",
+ "kind": "discovery#restDescription",
+ "name": "appengine",
+ "ownerDomain": "google.com",
"ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
"resources": {
"apps": {
"methods": {
- "get": {
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "ensureResourcesExist": {
- "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
- "type": "boolean",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}",
- "path": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.get",
- "description": "Gets information about an application."
- },
- "patch": {
- "id": "appengine.apps.patch",
- "path": "v1beta4/apps/{appsId}",
- "request": {
- "$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "mask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}"
- },
"create": {
"description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/python/console/).",
+ "flatPath": "v1beta4/apps",
+ "httpMethod": "POST",
+ "id": "appengine.apps.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1beta4/apps",
"request": {
"$ref": "Application"
},
"response": {
"$ref": "Operation"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets information about an application.",
+ "flatPath": "v1beta4/apps/{appsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.get",
+ "parameterOrder": [
+ "appsId"
],
- "parameters": {},
- "flatPath": "v1beta4/apps",
- "path": "v1beta4/apps",
- "id": "appengine.apps.create"
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ensureResourcesExist": {
+ "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}",
+ "response": {
+ "$ref": "Application"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)",
+ "flatPath": "v1beta4/apps/{appsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.patch",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "mask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
},
"resources": {
- "modules": {
+ "locations": {
"methods": {
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.delete",
- "description": "Deletes the specified module and all enclosed versions."
- },
"get": {
- "response": {
- "$ref": "Module"
- },
+ "description": "Gets information about a location.",
+ "flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.get",
"parameterOrder": [
"appsId",
- "modulesId"
+ "locationsId"
],
- "httpMethod": "GET",
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "description": "Part of `name`. Resource name for the location.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
- "modulesId": {
+ "locationsId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1beta4/apps/{appsId}/locations/{locationsId}",
+ "response": {
+ "$ref": "Location"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.get",
- "description": "Gets the current configuration of the specified module."
+ ]
},
"list": {
- "description": "Lists all the modules in the application.",
- "response": {
- "$ref": "ListModulesResponse"
- },
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v1beta4/apps/{appsId}/locations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.list",
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
"parameters": {
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
"required": true,
"type": "string"
},
- "pageToken": {
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
"location": "query",
- "description": "Continuation token for fetching the next page of results.",
"type": "string"
}
},
+ "path": "v1beta4/apps/{appsId}/locations",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules",
- "path": "v1beta4/apps/{appsId}/modules",
- "id": "appengine.apps.modules.list"
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
+ ]
+ }
+ }
+ },
+ "modules": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified module and all enclosed versions.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.modules.delete",
"parameterOrder": [
"appsId",
"modulesId"
],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the current configuration of the specified module.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.modules.get",
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "response": {
+ "$ref": "Module"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists all the modules in the application.",
+ "flatPath": "v1beta4/apps/{appsId}/modules",
+ "httpMethod": "GET",
+ "id": "appengine.apps.modules.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules",
+ "response": {
+ "$ref": "ListModulesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "Updates the configuration of the specified module.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
"httpMethod": "PATCH",
+ "id": "appengine.apps.modules.patch",
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
+ },
+ "mask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
},
"migrateTraffic": {
- "location": "query",
"description": "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/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module 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).",
+ "location": "query",
"type": "boolean"
},
"modulesId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
- },
- "mask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.patch",
"request": {
"$ref": "Module"
},
- "description": "Updates the configuration of the specified module."
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
},
"resources": {
"versions": {
+ "methods": {
+ "create": {
+ "description": "Deploys code and resource files to a new version.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "httpMethod": "POST",
+ "id": "appengine.apps.modules.versions.create",
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an existing version.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.modules.versions.delete",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.modules.versions.get",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the Get response.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "response": {
+ "$ref": "Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the versions of a module.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "httpMethod": "GET",
+ "id": "appengine.apps.modules.versions.list",
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the List response.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.modules.versions.patch",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default/versions/1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "mask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
"resources": {
"instances": {
"methods": {
"debug": {
+ "description": "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.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "httpMethod": "POST",
+ "id": "appengine.apps.modules.versions.instances.debug",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
"request": {
"$ref": "DebugInstanceRequest"
},
- "description": "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.",
"response": {
"$ref": "Operation"
},
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.modules.versions.instances.debug"
+ ]
},
"delete": {
"description": "Stops a running instance.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.modules.versions.instances.delete",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
"response": {
"$ref": "Operation"
},
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.delete"
+ ]
},
"get": {
+ "description": "Gets instance information.",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
"httpMethod": "GET",
- "response": {
- "$ref": "Instance"
- },
+ "id": "appengine.apps.modules.versions.instances.get",
"parameterOrder": [
"appsId",
"modulesId",
@@ -351,45 +766,44 @@
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"instancesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
"type": "string"
},
"modulesId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "response": {
+ "$ref": "Instance"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information."
+ ]
},
"list": {
"description": "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).",
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
"httpMethod": "GET",
- "response": {
- "$ref": "ListInstancesResponse"
- },
+ "id": "appengine.apps.modules.versions.instances.list",
"parameterOrder": [
"appsId",
"modulesId",
@@ -398,544 +812,419 @@
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "Maximum results to return per page.",
"format": "int32",
+ "location": "query",
"type": "integer"
},
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
"type": "string"
},
"versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.modules.versions.instances.list",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances"
+ ]
}
}
}
- },
- "methods": {
- "delete": {
- "description": "Deletes an existing version.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.delete"
- },
- "get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "required": true,
- "type": "string"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.get"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "parameters": {
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "id": "appengine.apps.modules.versions.list",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "description": "Lists the versions of a module."
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default/versions/1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "mask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.patch",
- "description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "request": {
- "$ref": "Version"
- }
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "id": "appengine.apps.modules.versions.create",
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version."
- }
}
}
}
},
"operations": {
"methods": {
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/operations",
- "path": "v1beta4/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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."
- },
"get": {
- "response": {
- "$ref": "Operation"
- },
+ "description": "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.",
+ "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.get",
"parameterOrder": [
"appsId",
"operationsId"
],
- "httpMethod": "GET",
"parameters": {
"appsId": {
"description": "Part of `name`. The name of the operation resource.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"operationsId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "description": "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."
- }
- }
- },
- "locations": {
- "methods": {
+ ]
+ },
"list": {
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
+ "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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.",
+ "flatPath": "v1beta4/apps/{appsId}/operations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.list",
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
"parameters": {
"appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
"location": "path",
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"required": true,
"type": "string"
},
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
"location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/locations",
- "path": "v1beta4/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list"
- },
- "get": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string"
+ "type": "integer"
},
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
}
},
+ "path": "v1beta4/apps/{appsId}/operations",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}",
- "path": "v1beta4/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
+ ]
}
}
}
}
}
},
- "parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- }
- },
+ "revision": "20180320",
+ "rootUrl": "https://appengine.googleapis.com/",
"schemas": {
- "ListModulesResponse": {
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "id": "ApiConfigHandler",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
"type": "string"
},
- "modules": {
- "description": "The modules belonging to the requested application.",
- "type": "array",
- "items": {
- "$ref": "Module"
- }
+ "login": {
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "type": "string"
+ },
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "id": "ApiEndpointHandler",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "id": "Application",
+ "properties": {
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "codeBucket": {
+ "description": "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",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent.@OutputOnly",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ },
+ "type": "array"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "id": "AutomaticScaling",
+ "properties": {
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ },
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ }
+ },
+ "type": "object"
+ },
+ "BasicScaling": {
+ "description": "A module 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.",
+ "id": "BasicScaling",
+ "properties": {
+ "idleTimeout": {
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ContainerInfo": {
+ "description": "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.",
+ "id": "ContainerInfo",
+ "properties": {
+ "image": {
+ "description": "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\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "id": "CpuUtilization",
+ "properties": {
+ "aggregationWindowLength": {
+ "description": "Period of time over which CPU utilization is calculated.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "targetUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Alpha",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Beta",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "id": "DebugInstanceRequest",
+ "properties": {
+ "sshKey": {
+ "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[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).",
+ "type": "string"
}
},
- "id": "ListModulesResponse",
- "description": "Response message for Modules.ListModules.",
"type": "object"
},
"Deployment": {
"description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
+ "id": "Deployment",
"properties": {
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ },
"files": {
"additionalProperties": {
"$ref": "FileInfo"
@@ -943,29 +1232,765 @@
"description": "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.",
"type": "object"
},
- "container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
- },
"sourceReferences": {
"description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
- "type": "array",
"items": {
"$ref": "SourceReference"
- }
+ },
+ "type": "array"
}
},
- "id": "Deployment"
+ "type": "object"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "id": "DiskUtilization",
+ "properties": {
+ "targetReadBytesPerSec": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadOpsPerSec": {
+ "description": "Target ops read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSec": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSec": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "EndpointsApiService": {
+ "description": "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).",
+ "id": "EndpointsApiService",
+ "properties": {
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ },
+ "rolloutStrategy": {
+ "description": "Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.",
+ "enum": [
+ "UNSPECIFIED_ROLLOUT_STRATEGY",
+ "FIXED",
+ "MANAGED"
+ ],
+ "enumDescriptions": [
+ "Not specified. Defaults to FIXED.",
+ "Endpoints service configuration id will be fixed to the configuration id specified by config_id.",
+ "Endpoints service configuration id will be updated with each rollout."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "id": "ErrorHandler",
+ "properties": {
+ "errorCode": {
+ "description": "Error condition this handler applies to.",
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "id": "FileInfo",
+ "properties": {
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
+ },
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HealthCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "id": "HealthCheck",
+ "properties": {
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ },
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "timeout": {
+ "description": "Time before the health check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "IdentityAwareProxy": {
+ "description": "Identity-Aware Proxy",
+ "id": "IdentityAwareProxy",
+ "properties": {
+ "enabled": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
+ "type": "string"
+ },
+ "oauth2ClientSecret": {
+ "description": "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",
+ "type": "string"
+ },
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "id": "Instance",
+ "properties": {
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startTimestamp": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmUnlocked": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "id": "Library",
+ "properties": {
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "id": "ListInstancesResponse",
+ "properties": {
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListModulesResponse": {
+ "description": "Response message for Modules.ListModules.",
+ "id": "ListModulesResponse",
+ "properties": {
+ "modules": {
+ "description": "The modules belonging to the requested application.",
+ "items": {
+ "$ref": "Module"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "id": "ListVersionsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "versions": {
+ "description": "The versions belonging to the requested module.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
+ "properties": {
+ "displayName": {
+ "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "id": "LocationMetadata",
+ "properties": {
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine flexible environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine standard environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ManualScaling": {
+ "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "id": "ManualScaling",
+ "properties": {
+ "instances": {
+ "description": "Number of instances to assign to the module 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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Module": {
+ "description": "A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.",
+ "id": "Module",
+ "properties": {
+ "id": {
+ "description": "Relative name of the module within the application. Example: default.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "split": {
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module."
+ }
+ },
+ "type": "object"
+ },
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "id": "Network",
+ "properties": {
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "id": "NetworkUtilization",
+ "properties": {
+ "targetReceivedBytesPerSec": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSec": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentBytesPerSec": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSec": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
+ "properties": {
+ "done": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "name": {
+ "description": "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.",
+ "type": "string"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadata",
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Alpha",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Alpha"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Beta"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta5",
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "id": "RequestUtilization",
+ "properties": {
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetRequestCountPerSec": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
"Resources": {
"description": "Machine resources for a version.",
- "type": "object",
+ "id": "Resources",
"properties": {
"cpu": {
"description": "Number of CPU cores needed.",
"format": "double",
"type": "number"
},
+ "diskGb": {
+ "description": "Disk size (GB) needed.",
+ "format": "double",
+ "type": "number"
+ },
"memoryGb": {
"description": "Memory (GB) needed.",
"format": "double",
@@ -973,103 +1998,173 @@
},
"volumes": {
"description": "User specified volumes.",
- "type": "array",
"items": {
"$ref": "Volume"
- }
- },
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
+ },
+ "type": "array"
}
},
- "id": "Resources"
+ "type": "object"
},
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "id": "ScriptHandler",
"properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
- },
- "sizeGb": {
- "description": "Volume size in gigabytes.",
- "format": "double",
- "type": "number"
- },
- "name": {
- "description": "Unique name for the volume.",
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
}
},
- "id": "Volume"
+ "type": "object"
},
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
+ "SourceReference": {
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
+ "id": "SourceReference",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "repository": {
+ "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
"type": "string"
},
- "instances": {
- "description": "The instances belonging to the requested version.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
+ "revisionId": {
+ "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
+ "type": "string"
}
},
- "id": "ListInstancesResponse"
+ "type": "object"
},
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
+ "StaticDirectoryHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.",
+ "id": "StaticDirectoryHandler",
"properties": {
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static directory 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.",
+ "type": "boolean"
+ },
+ "directory": {
+ "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached.",
+ "format": "google-duration",
"type": "string"
},
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Alpha"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
+ "httpHeaders": {
+ "additionalProperties": {
"type": "string"
- }
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
},
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "StaticFilesHandler": {
+ "description": "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.",
+ "id": "StaticFilesHandler",
+ "properties": {
+ "applicationReadable": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "mimeType": {
+ "description": "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.",
+ "type": "string"
+ },
+ "path": {
+ "description": "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.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
"type": "string"
}
},
- "id": "OperationMetadataV1Alpha"
+ "type": "object"
+ },
+ "Status": {
+ "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TrafficSplit": {
+ "description": "Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions.",
+ "id": "TrafficSplit",
+ "properties": {
+ "allocations": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module 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.",
+ "type": "object"
+ },
+ "shardBy": {
+ "description": "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.",
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP"
+ ],
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"UrlDispatchRule": {
"description": "Rules to match an HTTP request and dispatch that request to a module.",
- "type": "object",
+ "id": "UrlDispatchRule",
"properties": {
"domain": {
"description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
@@ -1084,230 +2179,55 @@
"type": "string"
}
},
- "id": "UrlDispatchRule"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "versions": {
- "description": "The versions belonging to the requested module.",
- "type": "array",
- "items": {
- "$ref": "Version"
- }
- }
- },
- "id": "ListVersionsResponse"
- },
- "Module": {
- "description": "A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.",
- "type": "object",
- "properties": {
- "split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module.",
- "$ref": "TrafficSplit"
- },
- "id": {
- "description": "Relative name of the module within the application. Example: default.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Module"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "StaticDirectoryHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.",
- "type": "object",
- "properties": {
- "expiration": {
- "description": "Time a static file served by this handler should be cached.",
- "format": "google-duration",
- "type": "string"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static directory 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.",
- "type": "boolean"
- },
- "directory": {
- "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- }
- },
- "id": "StaticDirectoryHandler"
- },
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
- "properties": {
- "diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "DiskUtilization"
- },
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
- "format": "int32",
- "type": "integer"
- },
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "format": "google-duration",
- "type": "string"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
- }
- },
- "id": "AutomaticScaling"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "properties": {
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- },
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- }
- },
- "id": "Library"
- },
- "ListLocationsResponse": {
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
- },
- "ContainerInfo": {
- "description": "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.",
- "type": "object",
- "properties": {
- "image": {
- "description": "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\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo"
- },
- "RequestUtilization": {
- "properties": {
- "targetRequestCountPerSec": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RequestUtilization",
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
"type": "object"
},
"UrlMap": {
"description": "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.",
- "type": "object",
+ "id": "UrlMap",
"properties": {
- "staticDirectory": {
- "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files.",
- "$ref": "StaticDirectoryHandler"
+ "apiEndpoint": {
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
},
- "staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "type": "string"
+ },
+ "login": {
+ "description": "Level of login required to access this resource.",
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "type": "string"
},
"redirectHttpResponseCode": {
"description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string",
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
"enumDescriptions": [
"Not specified. 302 is assumed.",
"301 Moved Permanently code.",
@@ -1315,15 +2235,14 @@
"303 See Other code.",
"307 Temporary Redirect code."
],
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ]
+ "type": "string"
+ },
+ "script": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
},
"securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
"enum": [
"SECURE_UNSPECIFIED",
"SECURE_DEFAULT",
@@ -1331,812 +2250,46 @@
"SECURE_OPTIONAL",
"SECURE_ALWAYS"
],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
"enumDescriptions": [
"Not specified.",
"Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
"Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
"Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
"Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ]
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
"type": "string"
},
- "script": {
- "description": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
+ "staticDirectory": {
+ "$ref": "StaticDirectoryHandler",
+ "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files."
+ },
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
},
"urlRegex": {
"description": "A 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.",
"type": "string"
- },
- "login": {
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ]
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
}
},
- "id": "UrlMap"
- },
- "EndpointsApiService": {
- "description": "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.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).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "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.",
- "type": "boolean"
- },
- "response": {
- "description": "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.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "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.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "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.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- },
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ]
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string"
- }
- },
- "id": "ApiConfigHandler"
- },
- "StaticFilesHandler": {
- "description": "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.",
- "type": "object",
- "properties": {
- "applicationReadable": {
- "description": "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.",
- "type": "boolean"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "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.",
- "type": "string"
- },
- "mimeType": {
- "description": "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.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "StaticFilesHandler"
- },
- "BasicScaling": {
- "description": "A module 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.",
- "type": "object",
- "properties": {
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "format": "google-duration",
- "type": "string"
- },
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "BasicScaling"
- },
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReadBytesPerSec": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteOpsPerSec": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteBytesPerSec": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadOpsPerSec": {
- "description": "Target ops read per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
- "properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
- "format": "google-duration",
- "type": "string"
- },
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "CpuUtilization"
- },
- "Status": {
- "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "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.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "type": "object",
- "properties": {
- "oauth2ClientSecret": {
- "description": "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",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- },
- "enabled": {
- "description": "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.",
- "type": "boolean"
- }
- },
- "id": "IdentityAwareProxy"
- },
- "ManualScaling": {
- "properties": {
- "instances": {
- "description": "Number of instances to assign to the module 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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ManualScaling",
- "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
"type": "object"
},
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
- "properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "CreateVersionMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Beta"
- },
- "OperationMetadataV1": {
- "properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "errorCode": {
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ],
- "description": "Error condition this handler applies to.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "id": {
- "description": "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.",
- "type": "string"
- },
- "codeBucket": {
- "description": "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",
- "type": "string"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- }
- },
- "id": "Application"
- },
- "Network": {
- "properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object"
- },
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
- "properties": {
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
- },
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "averageLatency": {
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "uint32",
- "type": "integer"
- },
- "availability": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "startTimestamp": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Instance"
- },
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetSentBytesPerSec": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedPacketsPerSec": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedBytesPerSec": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentPacketsPerSec": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization"
- },
- "Location": {
- "properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- }
- },
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
- },
- "HealthCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object",
- "properties": {
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "format": "uint32",
- "type": "integer"
- },
- "healthyThreshold": {
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "HealthCheck"
- },
- "SourceReference": {
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
- "type": "object",
- "properties": {
- "repository": {
- "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
- "type": "string"
- },
- "revisionId": {
- "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
- "type": "string"
- }
- },
- "id": "SourceReference"
- },
- "DebugInstanceRequest": {
- "description": "Request message for Instances.DebugInstance.",
- "type": "object",
- "properties": {
- "sshKey": {
- "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[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).",
- "type": "string"
- }
- },
- "id": "DebugInstanceRequest"
- },
- "CreateVersionMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Alpha"
- },
- "OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta5"
- },
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.",
- "type": "object",
+ "id": "Version",
"properties": {
+ "apiConfig": {
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
+ },
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
+ },
+ "basicScaling": {
+ "$ref": "BasicScaling",
+ "description": "A module 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."
+ },
"betaSettings": {
"additionalProperties": {
"type": "string"
@@ -2144,84 +2297,63 @@
"description": "Metadata settings that are supplied to this version to enable beta runtime features.",
"type": "object"
},
- "env": {
- "description": "App Engine execution environment to use for this version.Defaults to 1.",
+ "creationTime": {
+ "description": "Time that this version was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "handlers": {
- "description": "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.",
- "type": "array",
- "items": {
- "$ref": "UrlMap"
- }
+ "defaultExpiration": {
+ "description": "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.",
+ "format": "google-duration",
+ "type": "string"
},
"deployer": {
"description": "Email address of the user who created this version.@OutputOnly",
"type": "string"
},
- "automaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "$ref": "AutomaticScaling"
- },
- "healthCheck": {
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
- "$ref": "HealthCheck"
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "manualScaling": {
- "$ref": "ManualScaling",
- "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
- },
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/modules/default/versions/v1.@OutputOnly",
- "type": "string"
- },
- "apiConfig": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
+ "deployment": {
+ "$ref": "Deployment",
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
},
"endpointsApiService": {
"$ref": "EndpointsApiService",
"description": "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."
},
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "instanceClass": {
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
+ "env": {
+ "description": "App Engine execution environment to use for this version.Defaults to 1.",
"type": "string"
},
- "servingStatus": {
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ],
- "description": "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.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ]
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
},
- "runtimeApiVersion": {
- "description": "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/\u003clanguage\u003e/config/appref",
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "ErrorHandler"
+ },
+ "type": "array"
+ },
+ "handlers": {
+ "description": "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.",
+ "items": {
+ "$ref": "UrlMap"
+ },
+ "type": "array"
+ },
+ "healthCheck": {
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
+ },
+ "id": {
+ "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
"type": "string"
},
- "deployment": {
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
- "$ref": "Deployment"
- },
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
"inboundServices": {
+ "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"enumDescriptions": [
"Not specified.",
"Allows an application to receive mail.",
@@ -2233,10 +2365,7 @@
"Registers an application for notifications when a client connects or disconnects from a channel.",
"Enables warmup requests."
],
- "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
- "type": "array",
"items": {
- "type": "string",
"enum": [
"INBOUND_SERVICE_UNSPECIFIED",
"INBOUND_SERVICE_MAIL",
@@ -2247,194 +2376,97 @@
"INBOUND_SERVICE_XMPP_PRESENCE",
"INBOUND_SERVICE_CHANNEL_PRESENCE",
"INBOUND_SERVICE_WARMUP"
- ]
- }
+ ],
+ "type": "string"
+ },
+ "type": "array"
},
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "ErrorHandler"
- }
- },
- "defaultExpiration": {
- "description": "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.",
- "format": "google-duration",
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
"type": "string"
},
"libraries": {
"description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
- "type": "array",
"items": {
"$ref": "Library"
- }
+ },
+ "type": "array"
},
- "creationTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
+ "manualScaling": {
+ "$ref": "ManualScaling",
+ "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ },
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/modules/default/versions/v1.@OutputOnly",
"type": "string"
},
+ "network": {
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes."
+ },
"nobuildFilesRegex": {
"description": "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.",
"type": "string"
},
- "basicScaling": {
- "description": "A module 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.",
- "$ref": "BasicScaling"
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
},
"runtime": {
"description": "Desired runtime. Example: python27.",
"type": "string"
},
- "id": {
- "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "runtimeApiVersion": {
+ "description": "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/\u003clanguage\u003e/config/appref",
"type": "string"
},
- "envVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
- },
- "network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "$ref": "Network"
- }
- },
- "id": "Version"
- },
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "properties": {
- "sourceUrl": {
- "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- },
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- }
- },
- "id": "FileInfo"
- },
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ScriptHandler"
- },
- "TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions.",
- "type": "object",
- "properties": {
- "shardBy": {
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address."
- ],
+ "servingStatus": {
+ "description": "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.",
"enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP"
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING",
+ "STOPPED"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
],
- "description": "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.",
"type": "string"
},
- "allocations": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
- "description": "Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module 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.",
- "type": "object"
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
}
},
- "id": "TrafficSplit"
+ "type": "object"
},
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "id": "Volume",
"properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "name": {
+ "description": "Unique name for the volume.",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
+ "sizeGb": {
+ "description": "Volume size in gigabytes.",
+ "format": "double",
+ "type": "number"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
"type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Beta"
}
},
- "id": "OperationMetadataV1Beta"
+ "type": "object"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "version": "v1beta4",
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"servicePath": "",
- "rootUrl": "https://appengine.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "appengine",
- "batchPath": "batch"
-}
+ "title": "App Engine Admin API",
+ "version": "v1beta4"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/appengine/v1beta4/appengine-gen.go b/vendor/google.golang.org/api/appengine/v1beta4/appengine-gen.go
index 78514d50c..0a29d0ebd 100644
--- a/vendor/google.golang.org/api/appengine/v1beta4/appengine-gen.go
+++ b/vendor/google.golang.org/api/appengine/v1beta4/appengine-gen.go
@@ -1,4 +1,4 @@
-// Package appengine provides access to the Google App Engine Admin API.
+// Package appengine provides access to the App Engine Admin API.
//
// See https://cloud.google.com/appengine/docs/admin-api/
//
@@ -527,6 +527,37 @@ func (s *CpuUtilization) UnmarshalJSON(data []byte) error {
return nil
}
+// CreateVersionMetadataV1: Metadata for the given
+// google.longrunning.Operation during a
+// google.appengine.v1.CreateVersionRequest.
+type CreateVersionMetadataV1 struct {
+ // CloudBuildId: The Cloud Build ID if one was created as part of the
+ // version create. @OutputOnly
+ CloudBuildId string `json:"cloudBuildId,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CloudBuildId") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "CloudBuildId") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *CreateVersionMetadataV1) MarshalJSON() ([]byte, error) {
+ type NoMethod CreateVersionMetadataV1
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// CreateVersionMetadataV1Alpha: Metadata for the given
// google.longrunning.Operation during a
// google.appengine.v1alpha.CreateVersionRequest.
@@ -708,7 +739,8 @@ func (s *DiskUtilization) MarshalJSON() ([]byte, error) {
// EndpointsApiService: 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.The fields here refer to the name and configuration id
+// 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).
type EndpointsApiService struct {
@@ -725,6 +757,17 @@ type EndpointsApiService struct {
// "myapi.endpoints.myproject.cloud.goog"
Name string `json:"name,omitempty"`
+ // RolloutStrategy: Endpoints rollout strategy. If FIXED, config_id must
+ // be specified. If MANAGED, config_id must be omitted.
+ //
+ // Possible values:
+ // "UNSPECIFIED_ROLLOUT_STRATEGY" - Not specified. Defaults to FIXED.
+ // "FIXED" - Endpoints service configuration id will be fixed to the
+ // configuration id specified by config_id.
+ // "MANAGED" - Endpoints service configuration id will be updated with
+ // each rollout.
+ RolloutStrategy string `json:"rolloutStrategy,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "ConfigId") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -1257,6 +1300,10 @@ func (s *ListVersionsResponse) MarshalJSON() ([]byte, error) {
// Location: A resource that represents Google Cloud Platform location.
type Location struct {
+ // DisplayName: The friendly name for this location, typically a nearby
+ // city name. For example, "Tokyo".
+ DisplayName string `json:"displayName,omitempty"`
+
// Labels: Cross-service attributes for the location. For
// example
// {"cloud.googleapis.com/region": "us-east1"}
@@ -1280,7 +1327,7 @@ type Location struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Labels") to
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -1288,10 +1335,10 @@ type Location struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Labels") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
@@ -1306,11 +1353,11 @@ func (s *Location) MarshalJSON() ([]byte, error) {
// LocationMetadata: Metadata for the given
// google.cloud.location.Location.
type LocationMetadata struct {
- // FlexibleEnvironmentAvailable: App Engine Flexible Environment is
+ // FlexibleEnvironmentAvailable: App Engine flexible environment is
// available in the given location.@OutputOnly
FlexibleEnvironmentAvailable bool `json:"flexibleEnvironmentAvailable,omitempty"`
- // StandardEnvironmentAvailable: App Engine Standard Environment is
+ // StandardEnvironmentAvailable: App Engine standard environment is
// available in the given location.@OutputOnly
StandardEnvironmentAvailable bool `json:"standardEnvironmentAvailable,omitempty"`
@@ -1608,6 +1655,8 @@ func (s *OperationMetadata) MarshalJSON() ([]byte, error) {
// OperationMetadataV1: Metadata for the given
// google.longrunning.Operation.
type OperationMetadataV1 struct {
+ CreateVersionMetadata *CreateVersionMetadataV1 `json:"createVersionMetadata,omitempty"`
+
// EndTime: Time that this operation completed.@OutputOnly
EndTime string `json:"endTime,omitempty"`
@@ -1633,20 +1682,22 @@ type OperationMetadataV1 struct {
// @OutputOnly
Warning []string `json:"warning,omitempty"`
- // ForceSendFields is a list of field names (e.g. "EndTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
+ // ForceSendFields is a list of field names (e.g.
+ // "CreateVersionMetadata") to unconditionally include in API requests.
+ // By default, fields with empty values are omitted from API requests.
+ // However, any non-pointer, non-interface field appearing in
+ // ForceSendFields will be sent to the server regardless of whether the
+ // field is empty or not. This may be used to include empty fields in
+ // Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "EndTime") to include in
- // API requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
+ // NullFields is a list of field names (e.g. "CreateVersionMetadata") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
NullFields []string `json:"-"`
}
@@ -3040,7 +3091,7 @@ type AppsLocationsGetCall struct {
header_ http.Header
}
-// Get: Get information about a location.
+// Get: Gets information about a location.
func (r *AppsLocationsService) Get(appsId string, locationsId string) *AppsLocationsGetCall {
c := &AppsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -3143,7 +3194,7 @@ func (c *AppsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, erro
}
return ret, nil
// {
- // "description": "Get information about a location.",
+ // "description": "Gets information about a location.",
// "flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}",
// "httpMethod": "GET",
// "id": "appengine.apps.locations.get",
diff --git a/vendor/google.golang.org/api/appengine/v1beta5/appengine-api.json b/vendor/google.golang.org/api/appengine/v1beta5/appengine-api.json
index fb2dc4b95..1849dd3e9 100644
--- a/vendor/google.golang.org/api/appengine/v1beta5/appengine-api.json
+++ b/vendor/google.golang.org/api/appengine/v1beta5/appengine-api.json
@@ -1,660 +1,748 @@
{
- "version": "v1beta5",
- "baseUrl": "https://appengine.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/appengine.admin": {
"description": "View and manage your applications deployed on Google App Engine"
},
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
}
}
}
},
- "kind": "discovery#restDescription",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "servicePath": "",
- "rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
- "ownerDomain": "google.com",
- "name": "appengine",
+ "baseUrl": "https://appengine.googleapis.com/",
"batchPath": "batch",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "id": "appengine:v1beta5",
- "revision": "20180112",
- "title": "Google App Engine Admin API",
- "ownerName": "Google",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "appengine:v1beta5",
+ "kind": "discovery#restDescription",
+ "name": "appengine",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
"resources": {
"apps": {
"methods": {
- "get": {
- "httpMethod": "GET",
- "response": {
+ "create": {
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/python/console/).",
+ "flatPath": "v1beta5/apps",
+ "httpMethod": "POST",
+ "id": "appengine.apps.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1beta5/apps",
+ "request": {
"$ref": "Application"
},
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets information about an application.",
+ "flatPath": "v1beta5/apps/{appsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.get",
"parameterOrder": [
"appsId"
],
"parameters": {
- "ensureResourcesExist": {
- "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.",
- "type": "boolean",
- "location": "query"
- },
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
+ "location": "path",
"required": true,
"type": "string"
+ },
+ "ensureResourcesExist": {
+ "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.",
+ "location": "query",
+ "type": "boolean"
}
},
+ "path": "v1beta5/apps/{appsId}",
+ "response": {
+ "$ref": "Application"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1beta5/apps/{appsId}",
- "description": "Gets information about an application."
+ ]
},
"patch": {
- "response": {
- "$ref": "Operation"
- },
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)",
+ "flatPath": "v1beta5/apps/{appsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.patch",
"parameterOrder": [
"appsId"
],
- "httpMethod": "PATCH",
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"mask": {
- "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
+ "location": "query",
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}",
"path": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.patch",
"request": {
"$ref": "Application"
},
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)"
- },
- "create": {
- "request": {
- "$ref": "Application"
- },
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - 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/python/console/).",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "Operation"
},
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps",
- "id": "appengine.apps.create",
- "path": "v1beta5/apps"
+ ]
}
},
"resources": {
- "operations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/operations",
- "path": "v1beta5/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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."
- },
- "get": {
- "description": "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
- "path": "v1beta5/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
- }
- }
- },
"locations": {
"methods": {
- "list": {
- "id": "appengine.apps.locations.list",
- "path": "v1beta5/apps/{appsId}/locations",
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/locations"
- },
"get": {
- "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "description": "Gets information about a location.",
+ "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "httpMethod": "GET",
"id": "appengine.apps.locations.get",
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
"parameterOrder": [
"appsId",
"locationsId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Resource name for the location.",
+ "location": "path",
"required": true,
"type": "string"
},
"locationsId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}"
+ "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v1beta5/apps/{appsId}/locations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.locations.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/locations",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "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.",
+ "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.get",
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/operations/{operationsId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "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/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/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.",
+ "flatPath": "v1beta5/apps/{appsId}/operations",
+ "httpMethod": "GET",
+ "id": "appengine.apps.operations.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/operations",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
}
}
},
"services": {
"methods": {
- "get": {
- "description": "Gets the current configuration of the specified service.",
- "response": {
- "$ref": "Service"
- },
+ "delete": {
+ "description": "Deletes the specified service and all enclosed versions.",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.delete",
"parameterOrder": [
"appsId",
"servicesId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get"
- },
- "list": {
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
"location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
"required": true,
"type": "string"
},
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
},
- "flatPath": "v1beta5/apps/{appsId}/services",
- "path": "v1beta5/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
- "description": "Lists all the services in the application."
- },
- "patch": {
- "id": "appengine.apps.services.patch",
"path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "request": {
- "$ref": "Service"
+ "response": {
+ "$ref": "Operation"
},
- "description": "Updates the configuration of the specified service.",
- "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the current configuration of the specified service.",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.get",
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "Operation"
- },
"parameters": {
- "migrateTraffic": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "response": {
+ "$ref": "Service"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists all the services in the application.",
+ "flatPath": "v1beta5/apps/{appsId}/services",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.list",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
"location": "query",
- "description": "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/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/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).",
- "type": "boolean"
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/services",
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "Updates the configuration of the specified service.",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.services.patch",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"mask": {
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
+ "location": "query",
"type": "string"
},
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "migrateTraffic": {
+ "description": "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/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/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).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}"
- },
- "delete": {
- "description": "Deletes the specified service and all enclosed versions.",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "request": {
+ "$ref": "Service"
+ },
"response": {
"$ref": "Operation"
},
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete"
+ ]
}
},
"resources": {
"versions": {
"methods": {
"create": {
- "response": {
- "$ref": "Operation"
- },
+ "description": "Deploys new code and resource files to a new version.",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.create",
"parameterOrder": [
"appsId",
"servicesId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "servicesId": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".",
"location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
},
- "appsId": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
- "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".",
"required": true,
"type": "string"
}
},
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "description": "Deploys new code and resource files to a new version.",
"request": {
"$ref": "Version"
- }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"delete": {
"description": "Deletes an existing version.",
- "response": {
- "$ref": "Operation"
- },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.delete",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
"location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
}
},
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete"
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"get": {
"description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "response": {
- "$ref": "Version"
- },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.get",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
"location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
"required": true,
"type": "string"
},
"versionsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
"type": "string"
},
"view": {
+ "description": "Controls the set of fields returned in the Get response.",
"enum": [
"BASIC",
"FULL"
],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "type": "string"
}
},
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get"
+ "response": {
+ "$ref": "Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
"list": {
"description": "Lists the versions of a service.",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
"httpMethod": "GET",
- "response": {
- "$ref": "ListVersionsResponse"
- },
+ "id": "appengine.apps.services.versions.list",
"parameterOrder": [
"appsId",
"servicesId"
],
"parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "location": "path",
"required": true,
"type": "string"
},
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
"pageSize": {
- "location": "query",
"description": "Maximum results to return per page.",
"format": "int32",
+ "location": "query",
"type": "integer"
},
- "view": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
"location": "query",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the List response.",
"enum": [
"BASIC",
"FULL"
],
- "description": "Controls the set of fields returned in the List response.",
+ "location": "query",
"type": "string"
}
},
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions"
+ ]
},
"patch": {
"description": "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:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "httpMethod": "PATCH",
+ "id": "appengine.apps.services.versions.patch",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "mask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
"request": {
"$ref": "Version"
},
"response": {
"$ref": "Operation"
},
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "mask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch"
+ ]
}
},
"resources": {
"instances": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
+ "debug": {
+ "description": "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.",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "httpMethod": "POST",
+ "id": "appengine.apps.services.versions.instances.debug",
"parameterOrder": [
"appsId",
"servicesId",
@@ -662,184 +750,184 @@
"instancesId"
],
"parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"location": "path",
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\".",
"required": true,
"type": "string"
},
"instancesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
"type": "string"
},
"versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Stops a running instance."
+ ]
},
- "get": {
- "description": "Gets instance information.",
- "response": {
- "$ref": "Instance"
- },
+ "delete": {
+ "description": "Stops a running instance.",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "httpMethod": "DELETE",
+ "id": "appengine.apps.services.versions.instances.delete",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId",
"instancesId"
],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\".",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets instance information.",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
"httpMethod": "GET",
+ "id": "appengine.apps.services.versions.instances.get",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "response": {
+ "$ref": "Instance"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get"
+ ]
},
"list": {
"description": "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).",
- "response": {
- "$ref": "ListInstancesResponse"
- },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "httpMethod": "GET",
+ "id": "appengine.apps.services.versions.instances.list",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "httpMethod": "GET",
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
"type": "string"
},
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "location": "query",
+ "type": "integer"
},
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "location": "query",
"type": "string"
},
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
},
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list"
- },
- "debug": {
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "description": "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug"
+ ]
}
}
}
@@ -850,122 +938,445 @@
}
}
},
- "parameters": {
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- }
- },
+ "revision": "20180320",
+ "rootUrl": "https://appengine.googleapis.com/",
"schemas": {
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "id": "ApiConfigHandler",
+ "properties": {
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with an401 HTTP status code and an error message."
+ ],
+ "type": "string"
+ },
+ "login": {
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the action given in auth_fail_action is taken."
+ ],
+ "type": "string"
+ },
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "id": "ApiEndpointHandler",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "id": "Application",
+ "properties": {
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "codeBucket": {
+ "description": "A 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",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ },
+ "type": "array"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "id": "AutomaticScaling",
+ "properties": {
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ },
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ }
+ },
+ "type": "object"
+ },
+ "BasicScaling": {
+ "description": "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.",
+ "id": "BasicScaling",
+ "properties": {
+ "idleTimeout": {
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ContainerInfo": {
+ "description": "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.",
+ "id": "ContainerInfo",
+ "properties": {
+ "image": {
+ "description": "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\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "id": "CpuUtilization",
+ "properties": {
+ "aggregationWindowLength": {
+ "description": "Period of time over which CPU utilization is calculated.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "targetUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Alpha",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateVersionMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
+ "id": "CreateVersionMetadataV1Beta",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "id": "DebugInstanceRequest",
+ "properties": {
+ "sshKey": {
+ "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[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).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "id": "Deployment",
+ "properties": {
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ },
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "sourceReferences": {
+ "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
+ "items": {
+ "$ref": "SourceReference"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "id": "DiskUtilization",
+ "properties": {
+ "targetReadBytesPerSec": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadOpsPerSec": {
+ "description": "Target ops read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSec": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSec": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "EndpointsApiService": {
+ "description": "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).",
+ "id": "EndpointsApiService",
+ "properties": {
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ },
+ "rolloutStrategy": {
+ "description": "Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.",
+ "enum": [
+ "UNSPECIFIED_ROLLOUT_STRATEGY",
+ "FIXED",
+ "MANAGED"
+ ],
+ "enumDescriptions": [
+ "Not specified. Defaults to FIXED.",
+ "Endpoints service configuration id will be fixed to the configuration id specified by config_id.",
+ "Endpoints service configuration id will be updated with each rollout."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "id": "ErrorHandler",
+ "properties": {
+ "errorCode": {
+ "description": "Error condition this handler applies to.",
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "id": "FileInfo",
+ "properties": {
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
+ },
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"HealthCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object",
+ "id": "HealthCheck",
"properties": {
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
"disableHealthCheck": {
"description": "Whether to explicitly disable health checks for this instance.",
"type": "boolean"
},
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
"healthyThreshold": {
"description": "Number of consecutive successful health checks required before receiving traffic.",
"format": "uint32",
"type": "integer"
},
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
"restartThreshold": {
"description": "Number of consecutive failed health checks required before an instance is restarted.",
"format": "uint32",
"type": "integer"
},
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
"timeout": {
"description": "Time before the health check is considered failed.",
"format": "google-duration",
@@ -977,49 +1388,379 @@
"type": "integer"
}
},
- "id": "HealthCheck"
- },
- "DebugInstanceRequest": {
- "properties": {
- "sshKey": {
- "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[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).",
- "type": "string"
- }
- },
- "id": "DebugInstanceRequest",
- "description": "Request message for Instances.DebugInstance.",
"type": "object"
},
- "SourceReference": {
+ "IdentityAwareProxy": {
+ "description": "Identity-Aware Proxy",
+ "id": "IdentityAwareProxy",
"properties": {
- "revisionId": {
- "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
+ "enabled": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
"type": "string"
},
- "repository": {
- "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
+ "oauth2ClientSecret": {
+ "description": "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",
+ "type": "string"
+ },
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
"type": "string"
}
},
- "id": "SourceReference",
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
"type": "object"
},
- "CreateVersionMetadataV1Alpha": {
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "id": "Instance",
"properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startTimestamp": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmUnlocked": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
}
},
- "id": "CreateVersionMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
"type": "object"
},
- "OperationMetadataV1Beta5": {
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "id": "Library",
"properties": {
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "id": "ListInstancesResponse",
+ "properties": {
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "id": "ListServicesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "id": "ListVersionsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
+ "properties": {
+ "displayName": {
+ "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "id": "LocationMetadata",
+ "properties": {
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine flexible environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine standard environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ManualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "id": "ManualScaling",
+ "properties": {
+ "instances": {
+ "description": "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "id": "Network",
+ "properties": {
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ },
+ "subnetworkName": {
+ "description": "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.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM 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.\nIf the network the VM 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 Flex app.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "id": "NetworkUtilization",
+ "properties": {
+ "targetReceivedBytesPerSec": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSec": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentBytesPerSec": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSec": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
+ "properties": {
+ "done": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "name": {
+ "description": "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.",
+ "type": "string"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadata",
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
"insertTime": {
@@ -1027,82 +1768,529 @@
"format": "google-datetime",
"type": "string"
},
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1"
+ },
"endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
+ "description": "Time that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Alpha",
+ "properties": {
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Alpha"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "OperationMetadataV1Beta5",
- "description": "Metadata for the given google.longrunning.Operation.",
"type": "object"
},
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta",
"properties": {
- "version": {
- "description": "Version of the library to select, or \"latest\".",
+ "createVersionMetadata": {
+ "$ref": "CreateVersionMetadataV1Beta"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1Beta5",
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "id": "RequestUtilization",
+ "properties": {
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetRequestCountPerSec": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Resources": {
+ "description": "Machine resources for a version.",
+ "id": "Resources",
+ "properties": {
+ "cpu": {
+ "description": "Number of CPU cores needed.",
+ "format": "double",
+ "type": "number"
+ },
+ "diskGb": {
+ "description": "Disk size (GB) needed.",
+ "format": "double",
+ "type": "number"
+ },
+ "memoryGb": {
+ "description": "Memory (GB) needed.",
+ "format": "double",
+ "type": "number"
+ },
+ "volumes": {
+ "description": "Volumes mounted within the app container.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "id": "ScriptHandler",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Service": {
+ "description": "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 other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
+ "id": "Service",
+ "properties": {
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
},
"name": {
- "description": "Name of the library. Example: \"django\".",
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
- }
- },
- "id": "Library"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
+ "split": {
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
}
},
- "id": "ListLocationsResponse"
+ "type": "object"
},
- "ContainerInfo": {
+ "SourceReference": {
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
+ "id": "SourceReference",
"properties": {
- "image": {
- "description": "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\"",
+ "repository": {
+ "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StaticFilesHandler": {
+ "description": "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.",
+ "id": "StaticFilesHandler",
+ "properties": {
+ "applicationReadable": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "mimeType": {
+ "description": "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.",
+ "type": "string"
+ },
+ "path": {
+ "description": "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.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TrafficSplit": {
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "id": "TrafficSplit",
+ "properties": {
+ "allocations": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "shardBy": {
+ "description": "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.",
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP"
+ ],
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "id": "UrlDispatchRule",
+ "properties": {
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "path": {
+ "description": "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.",
+ "type": "string"
+ },
+ "service": {
+ "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlMap": {
+ "description": "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.",
+ "id": "UrlMap",
+ "properties": {
+ "apiEndpoint": {
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
+ },
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with an401 HTTP status code and an error message."
+ ],
+ "type": "string"
+ },
+ "login": {
+ "description": "Level of login required to access this resource.",
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the action given in auth_fail_action is taken."
+ ],
+ "type": "string"
+ },
+ "redirectHttpResponseCode": {
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ],
+ "type": "string"
+ },
+ "script": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "type": "string"
+ },
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
+ },
+ "urlRegex": {
+ "description": "A 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.",
"type": "string"
}
},
- "id": "ContainerInfo",
- "description": "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.",
"type": "object"
},
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
- "type": "object",
+ "id": "Version",
"properties": {
- "basicScaling": {
- "description": "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.",
- "$ref": "BasicScaling"
+ "apiConfig": {
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
},
- "runtime": {
- "description": "Desired runtime. Example: python27.",
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
+ },
+ "basicScaling": {
+ "$ref": "BasicScaling",
+ "description": "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."
+ },
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
+ },
+ "creationTime": {
+ "description": "Time that this version was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
- "id": {
- "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "defaultExpiration": {
+ "description": "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.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "deployer": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "deployment": {
+ "$ref": "Deployment",
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
+ },
+ "diskUsageBytes": {
+ "description": "Total size of version files hosted on App Engine disk in bytes.@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "endpointsApiService": {
+ "$ref": "EndpointsApiService",
+ "description": "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."
+ },
+ "env": {
+ "description": "App Engine execution environment to use for this version.Defaults to 1.",
"type": "string"
},
"envVariables": {
@@ -1112,98 +2300,41 @@
"description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
"type": "object"
},
- "network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "$ref": "Network"
- },
- "betaSettings": {
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "env": {
- "description": "App Engine execution environment to use for this version.Defaults to 1.",
- "type": "string"
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "ErrorHandler"
+ },
+ "type": "array"
},
"handlers": {
"description": "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.",
- "type": "array",
"items": {
"$ref": "UrlMap"
- }
- },
- "deployer": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "diskUsageBytes": {
- "description": "Total size of version files hosted on App Engine disk in bytes.@OutputOnly",
- "format": "int64",
- "type": "string"
+ },
+ "type": "array"
},
"healthCheck": {
"$ref": "HealthCheck",
"description": "Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
},
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "manualScaling": {
- "$ref": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
- },
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
+ "id": {
+ "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
"type": "string"
},
- "apiConfig": {
- "$ref": "ApiConfigHandler",
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
- },
- "endpointsApiService": {
- "$ref": "EndpointsApiService",
- "description": "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."
- },
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "instanceClass": {
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
- "type": "string"
- },
- "servingStatus": {
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ],
- "description": "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.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled from serving. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ]
- },
- "runtimeApiVersion": {
- "description": "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/\u003clanguage\u003e/config/appref",
- "type": "string"
- },
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
- },
"inboundServices": {
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
- "type": "array",
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ],
"items": {
"enum": [
"INBOUND_SERVICE_UNSPECIFIED",
@@ -1218,629 +2349,78 @@
],
"type": "string"
},
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ]
+ "type": "array"
},
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "ErrorHandler"
- }
- },
- "defaultExpiration": {
- "description": "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.",
- "format": "google-duration",
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
"type": "string"
},
"libraries": {
"description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
- "type": "array",
"items": {
"$ref": "Library"
- }
+ },
+ "type": "array"
+ },
+ "manualScaling": {
+ "$ref": "ManualScaling",
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ },
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
+ "type": "string"
+ },
+ "network": {
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes."
},
"nobuildFilesRegex": {
"description": "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.",
"type": "string"
},
- "creationTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Version"
- },
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetRequestCountPerSec": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
},
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RequestUtilization"
- },
- "EndpointsApiService": {
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
"type": "string"
},
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
+ "runtimeApiVersion": {
+ "description": "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/\u003clanguage\u003e/config/appref",
"type": "string"
- }
- },
- "id": "EndpointsApiService",
- "description": "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.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).",
- "type": "object"
- },
- "UrlMap": {
- "properties": {
- "securityLevel": {
+ },
+ "servingStatus": {
+ "description": "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.",
"enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING",
+ "STOPPED"
],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
"enumDescriptions": [
"Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ]
- },
- "authFailAction": {
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled from serving. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with an401 HTTP status code and an error message."
- ]
- },
- "script": {
- "description": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
- },
- "urlRegex": {
- "description": "A 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.",
"type": "string"
},
- "login": {
- "description": "Level of login required to access this resource.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the action given in auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
- },
- "apiEndpoint": {
- "$ref": "ApiEndpointHandler",
- "description": "Uses API Endpoints to handle requests."
- },
- "staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
- },
- "redirectHttpResponseCode": {
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ],
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ],
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string"
- }
- },
- "id": "UrlMap",
- "description": "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.",
- "type": "object"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "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.",
- "type": "object"
- },
- "done": {
- "description": "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.",
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
"type": "boolean"
},
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "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.",
- "type": "object"
- },
- "name": {
- "description": "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.",
- "type": "string"
- }
- },
- "id": "Operation"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with an401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the action given in auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string"
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- }
- },
- "id": "ApiConfigHandler"
- },
- "ScriptHandler": {
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ScriptHandler",
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object"
- },
- "StaticFilesHandler": {
- "properties": {
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "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.",
- "type": "string"
- },
- "mimeType": {
- "description": "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.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached.",
- "format": "google-duration",
- "type": "string"
- },
- "applicationReadable": {
- "description": "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.",
- "type": "boolean"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- }
- },
- "id": "StaticFilesHandler",
- "description": "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.",
- "type": "object"
- },
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "properties": {
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- },
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- },
- "sourceUrl": {
- "description": "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/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- }
- },
- "id": "FileInfo"
- },
- "BasicScaling": {
- "properties": {
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
- },
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "BasicScaling",
- "description": "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.",
- "type": "object"
- },
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReadBytesPerSec": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteOpsPerSec": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteBytesPerSec": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadOpsPerSec": {
- "description": "Target ops read per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
- "properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
- "format": "google-duration",
- "type": "string"
- },
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "CpuUtilization"
- },
- "Status": {
- "description": "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:\nSimple to use and understand for most users\nFlexible 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "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.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- }
- },
- "id": "Status"
- },
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "type": "object",
- "properties": {
- "oauth2ClientSecret": {
- "description": "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",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- },
- "enabled": {
- "description": "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.",
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
"type": "boolean"
}
},
- "id": "IdentityAwareProxy"
- },
- "ManualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object",
- "properties": {
- "instances": {
- "description": "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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ManualScaling"
- },
- "TrafficSplit": {
- "properties": {
- "shardBy": {
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address."
- ],
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP"
- ],
- "description": "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.",
- "type": "string"
- },
- "allocations": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
- "description": "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.",
- "type": "object"
- }
- },
- "id": "TrafficSplit",
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
"type": "object"
},
- "LocationMetadata": {
- "properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata",
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object"
- },
- "OperationMetadataV1Beta": {
- "properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Beta"
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "ListServicesResponse": {
- "properties": {
- "services": {
- "description": "The services belonging to the requested application.",
- "type": "array",
- "items": {
- "$ref": "Service"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListServicesResponse",
- "description": "Response message for Services.ListServices.",
- "type": "object"
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "volumes": {
- "description": "Volumes mounted within the app container.",
- "type": "array",
- "items": {
- "$ref": "Volume"
- }
- },
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
- },
- "cpu": {
- "description": "Number of CPU cores needed.",
- "format": "double",
- "type": "number"
- },
- "memoryGb": {
- "description": "Memory (GB) needed.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Resources"
- },
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
- "properties": {
- "container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
- },
- "sourceReferences": {
- "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
- "type": "array",
- "items": {
- "$ref": "SourceReference"
- }
- },
- "files": {
- "additionalProperties": {
- "$ref": "FileInfo"
- },
- "description": "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.",
- "type": "object"
- }
- },
- "id": "Deployment"
- },
"Volume": {
"description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
+ "id": "Volume",
"properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "name": {
+ "description": "Unique name for the volume.",
"type": "string"
},
"sizeGb": {
@@ -1848,563 +2428,15 @@
"format": "double",
"type": "number"
},
- "name": {
- "description": "Unique name for the volume.",
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
"type": "string"
}
},
- "id": "Volume"
- },
- "Service": {
- "description": "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 other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
- "$ref": "TrafficSplit"
- }
- },
- "id": "Service"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "CreateVersionMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
- "type": "object",
- "properties": {
- "cloudBuildId": {
- "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
- "type": "string"
- }
- },
- "id": "CreateVersionMetadataV1Beta"
- },
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
- "properties": {
- "instances": {
- "description": "The instances belonging to the requested version.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListInstancesResponse"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "errorCode": {
- "description": "Error condition this handler applies to.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ]
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
- },
- "OperationMetadataV1Alpha": {
- "properties": {
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "createVersionMetadata": {
- "$ref": "CreateVersionMetadataV1Alpha"
- }
- },
- "id": "OperationMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation.",
"type": "object"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "id": {
- "description": "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.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "codeBucket": {
- "description": "A 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",
- "type": "string"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "defaultBucket": {
- "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Application"
- },
- "Network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "subnetworkName": {
- "description": "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.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM 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.\nIf the network the VM 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 Flex app.",
- "type": "string"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
- "Instance": {
- "properties": {
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "startTimestamp": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
- },
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "averageLatency": {
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "uint32",
- "type": "integer"
- },
- "availability": {
- "description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ]
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Instance",
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object"
- },
- "UrlDispatchRule": {
- "properties": {
- "path": {
- "description": "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.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "service": {
- "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule",
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "versions": {
- "description": "The versions belonging to the requested service.",
- "type": "array",
- "items": {
- "$ref": "Version"
- }
- }
- },
- "id": "ListVersionsResponse"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
- "properties": {
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
- "format": "int32",
- "type": "integer"
- },
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "format": "google-duration",
- "type": "string"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- }
- },
- "id": "AutomaticScaling"
- },
- "NetworkUtilization": {
- "properties": {
- "targetReceivedBytesPerSec": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentPacketsPerSec": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentBytesPerSec": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedPacketsPerSec": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization",
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- },
- "labels": {
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- }
- },
- "id": "Location"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest"
-}
+ "servicePath": "",
+ "title": "App Engine Admin API",
+ "version": "v1beta5"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/appengine/v1beta5/appengine-gen.go b/vendor/google.golang.org/api/appengine/v1beta5/appengine-gen.go
index b661e317e..4310a83b4 100644
--- a/vendor/google.golang.org/api/appengine/v1beta5/appengine-gen.go
+++ b/vendor/google.golang.org/api/appengine/v1beta5/appengine-gen.go
@@ -1,4 +1,4 @@
-// Package appengine provides access to the Google App Engine Admin API.
+// Package appengine provides access to the App Engine Admin API.
//
// See https://cloud.google.com/appengine/docs/admin-api/
//
@@ -527,6 +527,37 @@ func (s *CpuUtilization) UnmarshalJSON(data []byte) error {
return nil
}
+// CreateVersionMetadataV1: Metadata for the given
+// google.longrunning.Operation during a
+// google.appengine.v1.CreateVersionRequest.
+type CreateVersionMetadataV1 struct {
+ // CloudBuildId: The Cloud Build ID if one was created as part of the
+ // version create. @OutputOnly
+ CloudBuildId string `json:"cloudBuildId,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CloudBuildId") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "CloudBuildId") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *CreateVersionMetadataV1) MarshalJSON() ([]byte, error) {
+ type NoMethod CreateVersionMetadataV1
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// CreateVersionMetadataV1Alpha: Metadata for the given
// google.longrunning.Operation during a
// google.appengine.v1alpha.CreateVersionRequest.
@@ -708,8 +739,9 @@ func (s *DiskUtilization) MarshalJSON() ([]byte, error) {
// EndpointsApiService: 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.The fields here refer to the name and configuration id
-// of a "service" resource in the Service Management API
+// 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).
type EndpointsApiService struct {
// ConfigId: Endpoints service configuration id as specified by the
@@ -725,6 +757,17 @@ type EndpointsApiService struct {
// "myapi.endpoints.myproject.cloud.goog"
Name string `json:"name,omitempty"`
+ // RolloutStrategy: Endpoints rollout strategy. If FIXED, config_id must
+ // be specified. If MANAGED, config_id must be omitted.
+ //
+ // Possible values:
+ // "UNSPECIFIED_ROLLOUT_STRATEGY" - Not specified. Defaults to FIXED.
+ // "FIXED" - Endpoints service configuration id will be fixed to the
+ // configuration id specified by config_id.
+ // "MANAGED" - Endpoints service configuration id will be updated with
+ // each rollout.
+ RolloutStrategy string `json:"rolloutStrategy,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "ConfigId") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -1257,6 +1300,10 @@ func (s *ListVersionsResponse) MarshalJSON() ([]byte, error) {
// Location: A resource that represents Google Cloud Platform location.
type Location struct {
+ // DisplayName: The friendly name for this location, typically a nearby
+ // city name. For example, "Tokyo".
+ DisplayName string `json:"displayName,omitempty"`
+
// Labels: Cross-service attributes for the location. For
// example
// {"cloud.googleapis.com/region": "us-east1"}
@@ -1280,7 +1327,7 @@ type Location struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Labels") to
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -1288,10 +1335,10 @@ type Location struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Labels") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
@@ -1306,11 +1353,11 @@ func (s *Location) MarshalJSON() ([]byte, error) {
// LocationMetadata: Metadata for the given
// google.cloud.location.Location.
type LocationMetadata struct {
- // FlexibleEnvironmentAvailable: App Engine Flexible Environment is
+ // FlexibleEnvironmentAvailable: App Engine flexible environment is
// available in the given location.@OutputOnly
FlexibleEnvironmentAvailable bool `json:"flexibleEnvironmentAvailable,omitempty"`
- // StandardEnvironmentAvailable: App Engine Standard Environment is
+ // StandardEnvironmentAvailable: App Engine standard environment is
// available in the given location.@OutputOnly
StandardEnvironmentAvailable bool `json:"standardEnvironmentAvailable,omitempty"`
@@ -1578,6 +1625,8 @@ func (s *OperationMetadata) MarshalJSON() ([]byte, error) {
// OperationMetadataV1: Metadata for the given
// google.longrunning.Operation.
type OperationMetadataV1 struct {
+ CreateVersionMetadata *CreateVersionMetadataV1 `json:"createVersionMetadata,omitempty"`
+
// EndTime: Time that this operation completed.@OutputOnly
EndTime string `json:"endTime,omitempty"`
@@ -1603,20 +1652,22 @@ type OperationMetadataV1 struct {
// @OutputOnly
Warning []string `json:"warning,omitempty"`
- // ForceSendFields is a list of field names (e.g. "EndTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
+ // ForceSendFields is a list of field names (e.g.
+ // "CreateVersionMetadata") to unconditionally include in API requests.
+ // By default, fields with empty values are omitted from API requests.
+ // However, any non-pointer, non-interface field appearing in
+ // ForceSendFields will be sent to the server regardless of whether the
+ // field is empty or not. This may be used to include empty fields in
+ // Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "EndTime") to include in
- // API requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
+ // NullFields is a list of field names (e.g. "CreateVersionMetadata") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
NullFields []string `json:"-"`
}
@@ -3000,7 +3051,7 @@ type AppsLocationsGetCall struct {
header_ http.Header
}
-// Get: Get information about a location.
+// Get: Gets information about a location.
func (r *AppsLocationsService) Get(appsId string, locationsId string) *AppsLocationsGetCall {
c := &AppsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -3103,7 +3154,7 @@ func (c *AppsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, erro
}
return ret, nil
// {
- // "description": "Get information about a location.",
+ // "description": "Gets information about a location.",
// "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}",
// "httpMethod": "GET",
// "id": "appengine.apps.locations.get",
diff --git a/vendor/google.golang.org/api/appsactivity/v1/appsactivity-api.json b/vendor/google.golang.org/api/appsactivity/v1/appsactivity-api.json
index 99cce6836..e12316d2f 100644
--- a/vendor/google.golang.org/api/appsactivity/v1/appsactivity-api.json
+++ b/vendor/google.golang.org/api/appsactivity/v1/appsactivity-api.json
@@ -1,489 +1,475 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/pDZ7o52oB1KPiP4jc8rmQ24ThMo\"",
- "discoveryVersion": "v1",
- "id": "appsactivity:v1",
- "name": "appsactivity",
- "version": "v1",
- "revision": "20170619",
- "title": "G Suite Activity API",
- "description": "Provides a historical view of activity.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
- "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
- },
- "documentationLink": "https://developers.google.com/google-apps/activity/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/appsactivity/v1/",
- "basePath": "/appsactivity/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "appsactivity/v1/",
- "batchPath": "batch/appsactivity/v1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/activity": {
- "description": "View the activity history of your Google apps"
- },
- "https://www.googleapis.com/auth/drive": {
- "description": "View and manage the files in your Google Drive"
- },
- "https://www.googleapis.com/auth/drive.metadata": {
- "description": "View and manage metadata of files in your Google Drive"
- },
- "https://www.googleapis.com/auth/drive.metadata.readonly": {
- "description": "View metadata for files in your Google Drive"
- },
- "https://www.googleapis.com/auth/drive.readonly": {
- "description": "View the files in your Google Drive"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/activity": {
+ "description": "View the activity history of your Google apps"
+ }
+ }
}
- }
- }
- },
- "schemas": {
- "Activity": {
- "id": "Activity",
- "type": "object",
- "description": "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.",
- "properties": {
- "combinedEvent": {
- "$ref": "Event",
- "description": "The fields common to all of the singleEvents that make up the Activity."
- },
- "singleEvents": {
- "type": "array",
- "description": "A list of all the Events that make up the Activity.",
- "items": {
- "$ref": "Event"
- }
- }
- }
},
- "Event": {
- "id": "Event",
- "type": "object",
- "description": "Represents the changes associated with an action taken by a user.",
- "properties": {
- "additionalEventTypes": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string",
+ "basePath": "/appsactivity/v1/",
+ "baseUrl": "https://www.googleapis.com/appsactivity/v1/",
+ "batchPath": "batch/appsactivity/v1",
+ "description": "Provides a historical view of activity.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/google-apps/activity/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/i2G9IjUY6hcmy1d1bAWQZIc125s\"",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "id": "appsactivity:v1",
+ "kind": "discovery#restDescription",
+ "name": "appsactivity",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
"enum": [
- "comment",
- "create",
- "edit",
- "emptyTrash",
- "move",
- "permissionChange",
- "rename",
- "trash",
- "unknown",
- "untrash",
- "upload"
+ "json"
],
"enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "eventTimeMillis": {
- "type": "string",
- "description": "The time at which the event occurred formatted as Unix time in milliseconds.",
- "format": "uint64"
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
},
- "fromUserDeletion": {
- "type": "boolean",
- "description": "Whether this event is caused by a user being deleted."
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
},
- "move": {
- "$ref": "Move",
- "description": "Extra information for move type events, such as changes in an object's parents."
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "permissionChanges": {
- "type": "array",
- "description": "Extra information for permissionChange type events, such as the user or group the new permission applies to.",
- "items": {
- "$ref": "PermissionChange"
- }
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
},
- "primaryEventType": {
- "type": "string",
- "description": "The main type of event that occurred.",
- "enum": [
- "comment",
- "create",
- "edit",
- "emptyTrash",
- "move",
- "permissionChange",
- "rename",
- "trash",
- "unknown",
- "untrash",
- "upload"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
},
- "rename": {
- "$ref": "Rename",
- "description": "Extra information for rename type events, such as the old and new names."
- },
- "target": {
- "$ref": "Target",
- "description": "Information specific to the Target object modified by the event."
- },
- "user": {
- "$ref": "User",
- "description": "Represents the user responsible for the event."
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "ListActivitiesResponse": {
- "id": "ListActivitiesResponse",
- "type": "object",
- "description": "The response from the list request. Contains a list of activities and a token to retrieve the next page of results.",
- "properties": {
+ "protocol": "rest",
+ "resources": {
"activities": {
- "type": "array",
- "description": "List of activities.",
- "items": {
- "$ref": "Activity"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token for the next page of results."
- }
- }
- },
- "Move": {
- "id": "Move",
- "type": "object",
- "description": "Contains information about changes in an object's parents as a result of a move type event.",
- "properties": {
- "addedParents": {
- "type": "array",
- "description": "The added parent(s).",
- "items": {
- "$ref": "Parent"
- }
- },
- "removedParents": {
- "type": "array",
- "description": "The removed parent(s).",
- "items": {
- "$ref": "Parent"
- }
- }
- }
- },
- "Parent": {
- "id": "Parent",
- "type": "object",
- "description": "Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The parent's ID."
- },
- "isRoot": {
- "type": "boolean",
- "description": "Whether this is the root folder."
- },
- "title": {
- "type": "string",
- "description": "The parent's title."
- }
- }
- },
- "Permission": {
- "id": "Permission",
- "type": "object",
- "description": "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.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the user or group the permission applies to."
- },
- "permissionId": {
- "type": "string",
- "description": "The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource."
- },
- "role": {
- "type": "string",
- "description": "Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.",
- "enum": [
- "commenter",
- "owner",
- "reader",
- "writer"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "type": {
- "type": "string",
- "description": "Indicates how widely permissions are granted.",
- "enum": [
- "anyone",
- "domain",
- "group",
- "user"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "user": {
- "$ref": "User",
- "description": "The user's information if the type is USER."
- },
- "withLink": {
- "type": "boolean",
- "description": "Whether the permission requires a link to the file."
- }
- }
- },
- "PermissionChange": {
- "id": "PermissionChange",
- "type": "object",
- "description": "Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.",
- "properties": {
- "addedPermissions": {
- "type": "array",
- "description": "Lists all Permission objects added.",
- "items": {
- "$ref": "Permission"
- }
- },
- "removedPermissions": {
- "type": "array",
- "description": "Lists all Permission objects removed.",
- "items": {
- "$ref": "Permission"
- }
- }
- }
- },
- "Photo": {
- "id": "Photo",
- "type": "object",
- "description": "Photo information for a user.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The URL of the photo."
- }
- }
- },
- "Rename": {
- "id": "Rename",
- "type": "object",
- "description": "Contains information about a renametype event.",
- "properties": {
- "newTitle": {
- "type": "string",
- "description": "The new title."
- },
- "oldTitle": {
- "type": "string",
- "description": "The old title."
- }
- }
- },
- "Target": {
- "id": "Target",
- "type": "object",
- "description": "Information about the object modified by the event.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the target. For example, in Google Drive, this is the file or folder ID."
- },
- "mimeType": {
- "type": "string",
- "description": "The MIME type of the target."
- },
- "name": {
- "type": "string",
- "description": "The name of the target. For example, in Google Drive, this is the title of the file."
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "A representation of a user.",
- "properties": {
- "isDeleted": {
- "type": "boolean",
- "description": "A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted."
- },
- "isMe": {
- "type": "boolean",
- "description": "Whether the user is the authenticated user."
- },
- "name": {
- "type": "string",
- "description": "The displayable name of the user."
- },
- "permissionId": {
- "type": "string",
- "description": "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."
- },
- "photo": {
- "$ref": "Photo",
- "description": "The profile photo of the user. Not present if the user has no profile photo."
- }
- }
- }
- },
- "resources": {
- "activities": {
- "methods": {
- "list": {
- "id": "appsactivity.activities.list",
- "path": "activities",
- "httpMethod": "GET",
- "description": "Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity 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.",
- "parameters": {
- "drive.ancestorId": {
- "type": "string",
- "description": "Identifies the Drive folder containing the items for which to return activities.",
- "location": "query"
- },
- "drive.fileId": {
- "type": "string",
- "description": "Identifies the Drive item to return activities for.",
- "location": "query"
- },
- "groupingStrategy": {
- "type": "string",
- "description": "Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.",
- "default": "driveUi",
- "enum": [
- "driveUi",
- "none"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "The maximum number of events to return on a page. The response includes a continuation token if there are more events.",
- "default": "50",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A token to retrieve a specific page of results.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "The Google service from which to return activities. Possible values of source are: \n- drive.google.com",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "Indicates the user to return activity for. Use the special value me to indicate the currently authenticated user.",
- "default": "me",
- "location": "query"
+ "methods": {
+ "list": {
+ "description": "Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity 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.",
+ "httpMethod": "GET",
+ "id": "appsactivity.activities.list",
+ "parameters": {
+ "drive.ancestorId": {
+ "description": "Identifies the Drive folder containing the items for which to return activities.",
+ "location": "query",
+ "type": "string"
+ },
+ "drive.fileId": {
+ "description": "Identifies the Drive item to return activities for.",
+ "location": "query",
+ "type": "string"
+ },
+ "groupingStrategy": {
+ "default": "driveUi",
+ "description": "Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.",
+ "enum": [
+ "driveUi",
+ "none"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "default": "50",
+ "description": "The maximum number of events to return on a page. The response includes a continuation token if there are more events.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token to retrieve a specific page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "The Google service from which to return activities. Possible values of source are: \n- drive.google.com",
+ "location": "query",
+ "type": "string"
+ },
+ "userId": {
+ "default": "me",
+ "description": "Indicates the user to return activity for. Use the special value me to indicate the currently authenticated user.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "activities",
+ "response": {
+ "$ref": "ListActivitiesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/activity"
+ ]
+ }
}
- },
- "response": {
- "$ref": "ListActivitiesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/activity",
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.metadata",
- "https://www.googleapis.com/auth/drive.metadata.readonly",
- "https://www.googleapis.com/auth/drive.readonly"
- ]
}
- }
- }
- }
-}
+ },
+ "revision": "20180204",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Activity": {
+ "description": "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.",
+ "id": "Activity",
+ "properties": {
+ "combinedEvent": {
+ "$ref": "Event",
+ "description": "The fields common to all of the singleEvents that make up the Activity."
+ },
+ "singleEvents": {
+ "description": "A list of all the Events that make up the Activity.",
+ "items": {
+ "$ref": "Event"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Event": {
+ "description": "Represents the changes associated with an action taken by a user.",
+ "id": "Event",
+ "properties": {
+ "additionalEventTypes": {
+ "description": "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.",
+ "items": {
+ "enum": [
+ "comment",
+ "create",
+ "edit",
+ "emptyTrash",
+ "move",
+ "permissionChange",
+ "rename",
+ "trash",
+ "unknown",
+ "untrash",
+ "upload"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "eventTimeMillis": {
+ "description": "The time at which the event occurred formatted as Unix time in milliseconds.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "fromUserDeletion": {
+ "description": "Whether this event is caused by a user being deleted.",
+ "type": "boolean"
+ },
+ "move": {
+ "$ref": "Move",
+ "description": "Extra information for move type events, such as changes in an object's parents."
+ },
+ "permissionChanges": {
+ "description": "Extra information for permissionChange type events, such as the user or group the new permission applies to.",
+ "items": {
+ "$ref": "PermissionChange"
+ },
+ "type": "array"
+ },
+ "primaryEventType": {
+ "description": "The main type of event that occurred.",
+ "enum": [
+ "comment",
+ "create",
+ "edit",
+ "emptyTrash",
+ "move",
+ "permissionChange",
+ "rename",
+ "trash",
+ "unknown",
+ "untrash",
+ "upload"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "rename": {
+ "$ref": "Rename",
+ "description": "Extra information for rename type events, such as the old and new names."
+ },
+ "target": {
+ "$ref": "Target",
+ "description": "Information specific to the Target object modified by the event."
+ },
+ "user": {
+ "$ref": "User",
+ "description": "Represents the user responsible for the event."
+ }
+ },
+ "type": "object"
+ },
+ "ListActivitiesResponse": {
+ "description": "The response from the list request. Contains a list of activities and a token to retrieve the next page of results.",
+ "id": "ListActivitiesResponse",
+ "properties": {
+ "activities": {
+ "description": "List of activities.",
+ "items": {
+ "$ref": "Activity"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token for the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Move": {
+ "description": "Contains information about changes in an object's parents as a result of a move type event.",
+ "id": "Move",
+ "properties": {
+ "addedParents": {
+ "description": "The added parent(s).",
+ "items": {
+ "$ref": "Parent"
+ },
+ "type": "array"
+ },
+ "removedParents": {
+ "description": "The removed parent(s).",
+ "items": {
+ "$ref": "Parent"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Parent": {
+ "description": "Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.",
+ "id": "Parent",
+ "properties": {
+ "id": {
+ "description": "The parent's ID.",
+ "type": "string"
+ },
+ "isRoot": {
+ "description": "Whether this is the root folder.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "The parent's title.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Permission": {
+ "description": "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.",
+ "id": "Permission",
+ "properties": {
+ "name": {
+ "description": "The name of the user or group the permission applies to.",
+ "type": "string"
+ },
+ "permissionId": {
+ "description": "The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.",
+ "type": "string"
+ },
+ "role": {
+ "description": "Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.",
+ "enum": [
+ "commenter",
+ "owner",
+ "publishedReader",
+ "reader",
+ "writer"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "type": {
+ "description": "Indicates how widely permissions are granted.",
+ "enum": [
+ "anyone",
+ "domain",
+ "group",
+ "user"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "user": {
+ "$ref": "User",
+ "description": "The user's information if the type is USER."
+ },
+ "withLink": {
+ "description": "Whether the permission requires a link to the file.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "PermissionChange": {
+ "description": "Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.",
+ "id": "PermissionChange",
+ "properties": {
+ "addedPermissions": {
+ "description": "Lists all Permission objects added.",
+ "items": {
+ "$ref": "Permission"
+ },
+ "type": "array"
+ },
+ "removedPermissions": {
+ "description": "Lists all Permission objects removed.",
+ "items": {
+ "$ref": "Permission"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Photo": {
+ "description": "Photo information for a user.",
+ "id": "Photo",
+ "properties": {
+ "url": {
+ "description": "The URL of the photo.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Rename": {
+ "description": "Contains information about a renametype event.",
+ "id": "Rename",
+ "properties": {
+ "newTitle": {
+ "description": "The new title.",
+ "type": "string"
+ },
+ "oldTitle": {
+ "description": "The old title.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Target": {
+ "description": "Information about the object modified by the event.",
+ "id": "Target",
+ "properties": {
+ "id": {
+ "description": "The ID of the target. For example, in Google Drive, this is the file or folder ID.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "The MIME type of the target.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the target. For example, in Google Drive, this is the title of the file.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "User": {
+ "description": "A representation of a user.",
+ "id": "User",
+ "properties": {
+ "isDeleted": {
+ "description": "A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.",
+ "type": "boolean"
+ },
+ "isMe": {
+ "description": "Whether the user is the authenticated user.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The displayable name of the user.",
+ "type": "string"
+ },
+ "permissionId": {
+ "description": "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.",
+ "type": "string"
+ },
+ "photo": {
+ "$ref": "Photo",
+ "description": "The profile photo of the user. Not present if the user has no profile photo."
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "appsactivity/v1/",
+ "title": "G Suite Activity API",
+ "version": "v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/appsactivity/v1/appsactivity-gen.go b/vendor/google.golang.org/api/appsactivity/v1/appsactivity-gen.go
index 2c0096f74..c28c023ff 100644
--- a/vendor/google.golang.org/api/appsactivity/v1/appsactivity-gen.go
+++ b/vendor/google.golang.org/api/appsactivity/v1/appsactivity-gen.go
@@ -49,18 +49,6 @@ const basePath = "https://www.googleapis.com/appsactivity/v1/"
const (
// View the activity history of your Google apps
ActivityScope = "https://www.googleapis.com/auth/activity"
-
- // View and manage the files in your Google Drive
- DriveScope = "https://www.googleapis.com/auth/drive"
-
- // View and manage metadata of files in your Google Drive
- DriveMetadataScope = "https://www.googleapis.com/auth/drive.metadata"
-
- // View metadata for files in your Google Drive
- DriveMetadataReadonlyScope = "https://www.googleapis.com/auth/drive.metadata.readonly"
-
- // View the files in your Google Drive
- DriveReadonlyScope = "https://www.googleapis.com/auth/drive.readonly"
)
func New(client *http.Client) (*Service, error) {
@@ -343,6 +331,7 @@ type Permission struct {
// Possible values:
// "commenter"
// "owner"
+ // "publishedReader"
// "reader"
// "writer"
Role string `json:"role,omitempty"`
@@ -785,11 +774,7 @@ func (c *ActivitiesListCall) Do(opts ...googleapi.CallOption) (*ListActivitiesRe
// "$ref": "ListActivitiesResponse"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/activity",
- // "https://www.googleapis.com/auth/drive",
- // "https://www.googleapis.com/auth/drive.metadata",
- // "https://www.googleapis.com/auth/drive.metadata.readonly",
- // "https://www.googleapis.com/auth/drive.readonly"
+ // "https://www.googleapis.com/auth/activity"
// ]
// }
diff --git a/vendor/google.golang.org/api/appstate/v1/appstate-api.json b/vendor/google.golang.org/api/appstate/v1/appstate-api.json
index 700a95d47..42da1d28e 100644
--- a/vendor/google.golang.org/api/appstate/v1/appstate-api.json
+++ b/vendor/google.golang.org/api/appstate/v1/appstate-api.json
@@ -1,307 +1,307 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/ANNk7azl5zRYtDCCrlgSBbC8-4Y\"",
- "discoveryVersion": "v1",
- "id": "appstate:v1",
- "name": "appstate",
- "canonicalName": "App State",
- "version": "v1",
- "revision": "20170911",
- "title": "Google App State API",
- "description": "The Google App State API.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
- "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
- },
- "documentationLink": "https://developers.google.com/games/services/web/api/states",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/appstate/v1/",
- "basePath": "/appstate/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "appstate/v1/",
- "batchPath": "batch/appstate/v1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/appstate": {
- "description": "View and manage your data for this application"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/appstate": {
+ "description": "View and manage your data for this application"
+ }
+ }
}
- }
- }
- },
- "schemas": {
- "GetResponse": {
- "id": "GetResponse",
- "type": "object",
- "description": "This is a JSON template for an app state resource.",
- "properties": {
- "currentStateVersion": {
- "type": "string",
- "description": "The current app state version."
- },
- "data": {
- "type": "string",
- "description": "The requested data."
- },
- "kind": {
- "type": "string",
- "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.",
- "default": "appstate#getResponse"
- },
- "stateKey": {
- "type": "integer",
- "description": "The key for the data.",
- "format": "int32"
- }
- }
},
- "ListResponse": {
- "id": "ListResponse",
- "type": "object",
- "description": "This is a JSON template to convert a list-response for app state.",
- "properties": {
- "items": {
- "type": "array",
- "description": "The app state data.",
- "items": {
- "$ref": "GetResponse"
- }
- },
- "kind": {
- "type": "string",
- "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#listResponse.",
- "default": "appstate#listResponse"
- },
- "maximumKeyCount": {
- "type": "integer",
- "description": "The maximum number of keys allowed for this user.",
- "format": "int32"
- }
- }
+ "basePath": "/appstate/v1/",
+ "baseUrl": "https://www.googleapis.com/appstate/v1/",
+ "batchPath": "batch/appstate/v1",
+ "canonicalName": "App State",
+ "description": "The Google App State API.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/games/services/web/api/states",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/X8tji3M7ero0WaIAGRtuwW2FqYo\"",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
- "UpdateRequest": {
- "id": "UpdateRequest",
- "type": "object",
- "description": "This is a JSON template for a requests which update app state",
- "properties": {
- "data": {
- "type": "string",
- "description": "The new app state data that your application is trying to update with."
+ "id": "appstate:v1",
+ "kind": "discovery#restDescription",
+ "name": "appstate",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "kind": {
- "type": "string",
- "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#updateRequest.",
- "default": "appstate#updateRequest"
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "WriteResult": {
- "id": "WriteResult",
- "type": "object",
- "description": "This is a JSON template for an app state write result.",
- "properties": {
- "currentStateVersion": {
- "type": "string",
- "description": "The version of the data for this key on the server."
- },
- "kind": {
- "type": "string",
- "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.",
- "default": "appstate#writeResult"
- },
- "stateKey": {
- "type": "integer",
- "description": "The written key.",
- "format": "int32"
+ "protocol": "rest",
+ "resources": {
+ "states": {
+ "methods": {
+ "clear": {
+ "description": "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.",
+ "httpMethod": "POST",
+ "id": "appstate.states.clear",
+ "parameterOrder": [
+ "stateKey"
+ ],
+ "parameters": {
+ "currentDataVersion": {
+ "description": "The version of the data to be cleared. Version strings are returned by the server.",
+ "location": "query",
+ "type": "string"
+ },
+ "stateKey": {
+ "description": "The key for the data to be retrieved.",
+ "format": "int32",
+ "location": "path",
+ "maximum": "3",
+ "minimum": "0",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "states/{stateKey}/clear",
+ "response": {
+ "$ref": "WriteResult"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appstate"
+ ]
+ },
+ "delete": {
+ "description": "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.",
+ "httpMethod": "DELETE",
+ "id": "appstate.states.delete",
+ "parameterOrder": [
+ "stateKey"
+ ],
+ "parameters": {
+ "stateKey": {
+ "description": "The key for the data to be retrieved.",
+ "format": "int32",
+ "location": "path",
+ "maximum": "3",
+ "minimum": "0",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "states/{stateKey}",
+ "scopes": [
+ "https://www.googleapis.com/auth/appstate"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned.",
+ "httpMethod": "GET",
+ "id": "appstate.states.get",
+ "parameterOrder": [
+ "stateKey"
+ ],
+ "parameters": {
+ "stateKey": {
+ "description": "The key for the data to be retrieved.",
+ "format": "int32",
+ "location": "path",
+ "maximum": "3",
+ "minimum": "0",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "states/{stateKey}",
+ "response": {
+ "$ref": "GetResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appstate"
+ ]
+ },
+ "list": {
+ "description": "Lists all the states keys, and optionally the state data.",
+ "httpMethod": "GET",
+ "id": "appstate.states.list",
+ "parameters": {
+ "includeData": {
+ "default": "false",
+ "description": "Whether to include the full data in addition to the version number",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "states",
+ "response": {
+ "$ref": "ListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appstate"
+ ]
+ },
+ "update": {
+ "description": "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.",
+ "httpMethod": "PUT",
+ "id": "appstate.states.update",
+ "parameterOrder": [
+ "stateKey"
+ ],
+ "parameters": {
+ "currentStateVersion": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "stateKey": {
+ "description": "The key for the data to be retrieved.",
+ "format": "int32",
+ "location": "path",
+ "maximum": "3",
+ "minimum": "0",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "states/{stateKey}",
+ "request": {
+ "$ref": "UpdateRequest"
+ },
+ "response": {
+ "$ref": "WriteResult"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appstate"
+ ]
+ }
+ }
}
- }
- }
- },
- "resources": {
- "states": {
- "methods": {
- "clear": {
- "id": "appstate.states.clear",
- "path": "states/{stateKey}/clear",
- "httpMethod": "POST",
- "description": "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.",
- "parameters": {
- "currentDataVersion": {
- "type": "string",
- "description": "The version of the data to be cleared. Version strings are returned by the server.",
- "location": "query"
+ },
+ "revision": "20180122",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "GetResponse": {
+ "description": "This is a JSON template for an app state resource.",
+ "id": "GetResponse",
+ "properties": {
+ "currentStateVersion": {
+ "description": "The current app state version.",
+ "type": "string"
+ },
+ "data": {
+ "description": "The requested data.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "appstate#getResponse",
+ "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.",
+ "type": "string"
+ },
+ "stateKey": {
+ "description": "The key for the data.",
+ "format": "int32",
+ "type": "integer"
+ }
},
- "stateKey": {
- "type": "integer",
- "description": "The key for the data to be retrieved.",
- "required": true,
- "format": "int32",
- "minimum": "0",
- "maximum": "3",
- "location": "path"
- }
- },
- "parameterOrder": [
- "stateKey"
- ],
- "response": {
- "$ref": "WriteResult"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
+ "type": "object"
},
- "delete": {
- "id": "appstate.states.delete",
- "path": "states/{stateKey}",
- "httpMethod": "DELETE",
- "description": "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.",
- "parameters": {
- "stateKey": {
- "type": "integer",
- "description": "The key for the data to be retrieved.",
- "required": true,
- "format": "int32",
- "minimum": "0",
- "maximum": "3",
- "location": "path"
- }
- },
- "parameterOrder": [
- "stateKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
- },
- "get": {
- "id": "appstate.states.get",
- "path": "states/{stateKey}",
- "httpMethod": "GET",
- "description": "Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned.",
- "parameters": {
- "stateKey": {
- "type": "integer",
- "description": "The key for the data to be retrieved.",
- "required": true,
- "format": "int32",
- "minimum": "0",
- "maximum": "3",
- "location": "path"
- }
- },
- "parameterOrder": [
- "stateKey"
- ],
- "response": {
- "$ref": "GetResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
- },
- "list": {
- "id": "appstate.states.list",
- "path": "states",
- "httpMethod": "GET",
- "description": "Lists all the states keys, and optionally the state data.",
- "parameters": {
- "includeData": {
- "type": "boolean",
- "description": "Whether to include the full data in addition to the version number",
- "default": "false",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
- },
- "update": {
- "id": "appstate.states.update",
- "path": "states/{stateKey}",
- "httpMethod": "PUT",
- "description": "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.",
- "parameters": {
- "currentStateVersion": {
- "type": "string",
- "description": "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.",
- "location": "query"
+ "ListResponse": {
+ "description": "This is a JSON template to convert a list-response for app state.",
+ "id": "ListResponse",
+ "properties": {
+ "items": {
+ "description": "The app state data.",
+ "items": {
+ "$ref": "GetResponse"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "appstate#listResponse",
+ "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#listResponse.",
+ "type": "string"
+ },
+ "maximumKeyCount": {
+ "description": "The maximum number of keys allowed for this user.",
+ "format": "int32",
+ "type": "integer"
+ }
},
- "stateKey": {
- "type": "integer",
- "description": "The key for the data to be retrieved.",
- "required": true,
- "format": "int32",
- "minimum": "0",
- "maximum": "3",
- "location": "path"
- }
- },
- "parameterOrder": [
- "stateKey"
- ],
- "request": {
- "$ref": "UpdateRequest"
- },
- "response": {
- "$ref": "WriteResult"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
+ "type": "object"
+ },
+ "UpdateRequest": {
+ "description": "This is a JSON template for a requests which update app state",
+ "id": "UpdateRequest",
+ "properties": {
+ "data": {
+ "description": "The new app state data that your application is trying to update with.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "appstate#updateRequest",
+ "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#updateRequest.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "WriteResult": {
+ "description": "This is a JSON template for an app state write result.",
+ "id": "WriteResult",
+ "properties": {
+ "currentStateVersion": {
+ "description": "The version of the data for this key on the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "appstate#writeResult",
+ "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.",
+ "type": "string"
+ },
+ "stateKey": {
+ "description": "The written key.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
}
- }
- }
- }
-}
+ },
+ "servicePath": "appstate/v1/",
+ "title": "Google App State API",
+ "version": "v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/bigquery/v2/bigquery-api.json b/vendor/google.golang.org/api/bigquery/v2/bigquery-api.json
index 195db9c0f..9a8bd8431 100644
--- a/vendor/google.golang.org/api/bigquery/v2/bigquery-api.json
+++ b/vendor/google.golang.org/api/bigquery/v2/bigquery-api.json
@@ -1,3016 +1,3106 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/c0qLh4qGPc7aXt4DhEPUAWdS164\"",
- "discoveryVersion": "v1",
- "id": "bigquery:v2",
- "name": "bigquery",
- "version": "v2",
- "revision": "20180112",
- "title": "BigQuery API",
- "description": "A data platform for customers to create, manage, share and query data.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/search-16.gif",
- "x32": "https://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/bigquery/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/bigquery/v2/",
- "basePath": "/bigquery/v2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "bigquery/v2/",
- "batchPath": "batch/bigquery/v2",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/bigquery": {
- "description": "View and manage your data in Google BigQuery"
- },
- "https://www.googleapis.com/auth/bigquery.insertdata": {
- "description": "Insert data into Google BigQuery"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/devstorage.full_control": {
- "description": "Manage your data and permissions in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/devstorage.read_only": {
- "description": "View your data in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/devstorage.read_write": {
- "description": "Manage your data in Google Cloud Storage"
- }
- }
- }
- },
- "schemas": {
- "BigtableColumn": {
- "id": "BigtableColumn",
- "type": "object",
- "properties": {
- "encoding": {
- "type": "string",
- "description": "[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."
- },
- "fieldName": {
- "type": "string",
- "description": "[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."
- },
- "onlyReadLatest": {
- "type": "boolean",
- "description": "[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."
- },
- "qualifierEncoded": {
- "type": "string",
- "description": "[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.",
- "format": "byte"
- },
- "qualifierString": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "description": "[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."
- }
- }
- },
- "BigtableColumnFamily": {
- "id": "BigtableColumnFamily",
- "type": "object",
- "properties": {
- "columns": {
- "type": "array",
- "description": "[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.",
- "items": {
- "$ref": "BigtableColumn"
- }
- },
- "encoding": {
- "type": "string",
- "description": "[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."
- },
- "familyId": {
- "type": "string",
- "description": "Identifier of the column family."
- },
- "onlyReadLatest": {
- "type": "boolean",
- "description": "[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."
- },
- "type": {
- "type": "string",
- "description": "[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."
- }
- }
- },
- "BigtableOptions": {
- "id": "BigtableOptions",
- "type": "object",
- "properties": {
- "columnFamilies": {
- "type": "array",
- "description": "[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.",
- "items": {
- "$ref": "BigtableColumnFamily"
- }
- },
- "ignoreUnspecifiedColumnFamilies": {
- "type": "boolean",
- "description": "[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."
- },
- "readRowkeyAsString": {
- "type": "boolean",
- "description": "[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."
- }
- }
- },
- "CsvOptions": {
- "id": "CsvOptions",
- "type": "object",
- "properties": {
- "allowJaggedRows": {
- "type": "boolean",
- "description": "[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."
- },
- "allowQuotedNewlines": {
- "type": "boolean",
- "description": "[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false."
- },
- "encoding": {
- "type": "string",
- "description": "[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."
- },
- "fieldDelimiter": {
- "type": "string",
- "description": "[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 (',')."
- },
- "quote": {
- "type": "string",
- "description": "[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.",
- "default": "\"",
- "pattern": ".?"
- },
- "skipLeadingRows": {
- "type": "string",
- "description": "[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.",
- "format": "int64"
- }
- }
- },
- "Dataset": {
- "id": "Dataset",
- "type": "object",
- "properties": {
- "access": {
- "type": "array",
- "description": "[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;",
- "items": {
- "type": "object",
- "properties": {
- "domain": {
- "type": "string",
- "description": "[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: \"example.com\"."
- },
- "groupByEmail": {
- "type": "string",
- "description": "[Pick one] An email address of a Google Group to grant access to."
- },
- "role": {
- "type": "string",
- "description": "[Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER, WRITER, OWNER."
- },
- "specialGroup": {
- "type": "string",
- "description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users."
- },
- "userByEmail": {
- "type": "string",
- "description": "[Pick one] An email address of a user to grant access to. For example: fred@example.com."
- },
- "view": {
- "$ref": "TableReference",
- "description": "[Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation."
- }
- }
- }
- },
- "creationTime": {
- "type": "string",
- "description": "[Output-only] The time when this dataset was created, in milliseconds since the epoch.",
- "format": "int64"
- },
- "datasetReference": {
- "$ref": "DatasetReference",
- "description": "[Required] A reference that identifies the dataset."
- },
- "defaultTableExpirationMs": {
- "type": "string",
- "description": "[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.",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "[Optional] A user-friendly description of the dataset."
- },
- "etag": {
- "type": "string",
- "description": "[Output-only] A hash of the resource."
- },
- "friendlyName": {
- "type": "string",
- "description": "[Optional] A descriptive name for the dataset."
- },
- "id": {
- "type": "string",
- "description": "[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."
- },
- "kind": {
- "type": "string",
- "description": "[Output-only] The resource type.",
- "default": "bigquery#dataset"
- },
- "labels": {
- "type": "object",
- "description": "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 Labeling Datasets for more information.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.",
- "format": "int64"
- },
- "location": {
- "type": "string",
- "description": "The geographic location where the dataset should reside. Possible values include EU and US. The default value is US."
- },
- "selfLink": {
- "type": "string",
- "description": "[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."
- }
- }
- },
- "DatasetList": {
- "id": "DatasetList",
- "type": "object",
- "properties": {
- "datasets": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "object",
- "properties": {
- "datasetReference": {
- "$ref": "DatasetReference",
- "description": "The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID."
- },
- "friendlyName": {
- "type": "string",
- "description": "A descriptive name for the dataset, if one exists."
- },
- "id": {
- "type": "string",
- "description": "The fully-qualified, unique, opaque ID of the dataset."
- },
- "kind": {
- "type": "string",
- "description": "The resource type. This property always returns the value \"bigquery#dataset\".",
- "default": "bigquery#dataset"
- },
- "labels": {
- "type": "object",
- "description": "The labels associated with this dataset. You can use these to organize and group your datasets.",
- "additionalProperties": {
- "type": "string"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/bigquery": {
+ "description": "View and manage your data in Google BigQuery"
+ },
+ "https://www.googleapis.com/auth/bigquery.insertdata": {
+ "description": "Insert data into Google BigQuery"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/devstorage.full_control": {
+ "description": "Manage your data and permissions in Google Cloud Storage"
+ },
+ "https://www.googleapis.com/auth/devstorage.read_only": {
+ "description": "View your data in Google Cloud Storage"
+ },
+ "https://www.googleapis.com/auth/devstorage.read_write": {
+ "description": "Manage your data in Google Cloud Storage"
}
- }
}
- }
- },
- "etag": {
- "type": "string",
- "description": "A hash value of the results page. You can use this property to determine if the page has changed since the last request."
- },
- "kind": {
- "type": "string",
- "description": "The list type. This property always returns the value \"bigquery#datasetList\".",
- "default": "bigquery#datasetList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token that can be used to request the next results page. This property is omitted on the final results page."
}
- }
},
- "DatasetReference": {
- "id": "DatasetReference",
- "type": "object",
- "properties": {
- "datasetId": {
- "type": "string",
- "description": "[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.",
- "annotations": {
- "required": [
- "bigquery.datasets.update"
- ]
- }
- },
- "projectId": {
- "type": "string",
- "description": "[Optional] The ID of the project containing this dataset.",
- "annotations": {
- "required": [
- "bigquery.datasets.update"
- ]
- }
- }
- }
+ "basePath": "/bigquery/v2/",
+ "baseUrl": "https://www.googleapis.com/bigquery/v2/",
+ "batchPath": "batch/bigquery/v2",
+ "description": "A data platform for customers to create, manage, share and query data.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/bigquery/",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/77sYFu0di9EzzwuBGmUFES4JWbE\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/search-16.gif",
+ "x32": "https://www.google.com/images/icons/product/search-32.gif"
},
- "EncryptionConfiguration": {
- "id": "EncryptionConfiguration",
- "type": "object",
- "properties": {
- "kmsKeyName": {
- "type": "string",
- "description": "[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."
- }
- }
- },
- "ErrorProto": {
- "id": "ErrorProto",
- "type": "object",
- "properties": {
- "debugInfo": {
- "type": "string",
- "description": "Debugging information. This property is internal to Google and should not be used."
- },
- "location": {
- "type": "string",
- "description": "Specifies where the error occurred, if present."
- },
- "message": {
- "type": "string",
- "description": "A human-readable description of the error."
- },
- "reason": {
- "type": "string",
- "description": "A short error code that summarizes the error."
- }
- }
- },
- "ExplainQueryStage": {
- "id": "ExplainQueryStage",
- "type": "object",
- "properties": {
- "completedParallelInputs": {
- "type": "string",
- "description": "Number of parallel input segments completed.",
- "format": "int64"
- },
- "computeMsAvg": {
- "type": "string",
- "description": "Milliseconds the average shard spent on CPU-bound tasks.",
- "format": "int64"
- },
- "computeMsMax": {
- "type": "string",
- "description": "Milliseconds the slowest shard spent on CPU-bound tasks.",
- "format": "int64"
- },
- "computeRatioAvg": {
- "type": "number",
- "description": "Relative amount of time the average shard spent on CPU-bound tasks.",
- "format": "double"
- },
- "computeRatioMax": {
- "type": "number",
- "description": "Relative amount of time the slowest shard spent on CPU-bound tasks.",
- "format": "double"
- },
- "id": {
- "type": "string",
- "description": "Unique ID for stage within plan.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Human-readable name for stage."
- },
- "parallelInputs": {
- "type": "string",
- "description": "Number of parallel input segments to be processed.",
- "format": "int64"
- },
- "readMsAvg": {
- "type": "string",
- "description": "Milliseconds the average shard spent reading input.",
- "format": "int64"
- },
- "readMsMax": {
- "type": "string",
- "description": "Milliseconds the slowest shard spent reading input.",
- "format": "int64"
- },
- "readRatioAvg": {
- "type": "number",
- "description": "Relative amount of time the average shard spent reading input.",
- "format": "double"
- },
- "readRatioMax": {
- "type": "number",
- "description": "Relative amount of time the slowest shard spent reading input.",
- "format": "double"
- },
- "recordsRead": {
- "type": "string",
- "description": "Number of records read into the stage.",
- "format": "int64"
- },
- "recordsWritten": {
- "type": "string",
- "description": "Number of records written by the stage.",
- "format": "int64"
- },
- "shuffleOutputBytes": {
- "type": "string",
- "description": "Total number of bytes written to shuffle.",
- "format": "int64"
- },
- "shuffleOutputBytesSpilled": {
- "type": "string",
- "description": "Total number of bytes written to shuffle and spilled to disk.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "Current status for the stage."
- },
- "steps": {
- "type": "array",
- "description": "List of operations within the stage in dependency order (approximately chronological).",
- "items": {
- "$ref": "ExplainQueryStep"
- }
- },
- "waitMsAvg": {
- "type": "string",
- "description": "Milliseconds the average shard spent waiting to be scheduled.",
- "format": "int64"
- },
- "waitMsMax": {
- "type": "string",
- "description": "Milliseconds the slowest shard spent waiting to be scheduled.",
- "format": "int64"
- },
- "waitRatioAvg": {
- "type": "number",
- "description": "Relative amount of time the average shard spent waiting to be scheduled.",
- "format": "double"
- },
- "waitRatioMax": {
- "type": "number",
- "description": "Relative amount of time the slowest shard spent waiting to be scheduled.",
- "format": "double"
- },
- "writeMsAvg": {
- "type": "string",
- "description": "Milliseconds the average shard spent on writing output.",
- "format": "int64"
- },
- "writeMsMax": {
- "type": "string",
- "description": "Milliseconds the slowest shard spent on writing output.",
- "format": "int64"
- },
- "writeRatioAvg": {
- "type": "number",
- "description": "Relative amount of time the average shard spent on writing output.",
- "format": "double"
- },
- "writeRatioMax": {
- "type": "number",
- "description": "Relative amount of time the slowest shard spent on writing output.",
- "format": "double"
- }
- }
- },
- "ExplainQueryStep": {
- "id": "ExplainQueryStep",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Machine-readable operation type."
- },
- "substeps": {
- "type": "array",
- "description": "Human-readable stage descriptions.",
- "items": {
+ "id": "bigquery:v2",
+ "kind": "discovery#restDescription",
+ "name": "bigquery",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
- }
- }
- },
- "ExternalDataConfiguration": {
- "id": "ExternalDataConfiguration",
- "type": "object",
- "properties": {
- "autodetect": {
- "type": "boolean",
- "description": "Try to detect schema and format options automatically. Any option specified explicitly will be honored."
},
- "bigtableOptions": {
- "$ref": "BigtableOptions",
- "description": "[Optional] Additional options if sourceFormat is set to BIGTABLE."
- },
- "compression": {
- "type": "string",
- "description": "[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."
- },
- "csvOptions": {
- "$ref": "CsvOptions",
- "description": "Additional properties to set if sourceFormat is set to CSV."
- },
- "googleSheetsOptions": {
- "$ref": "GoogleSheetsOptions",
- "description": "[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS."
- },
- "ignoreUnknownValues": {
- "type": "boolean",
- "description": "[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."
- },
- "maxBadRecords": {
- "type": "integer",
- "description": "[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. 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.",
- "format": "int32"
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "[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."
- },
- "sourceFormat": {
- "type": "string",
- "description": "[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\"."
- },
- "sourceUris": {
- "type": "array",
- "description": "[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.",
- "items": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
- }
- }
- },
- "GetQueryResultsResponse": {
- "id": "GetQueryResultsResponse",
- "type": "object",
- "properties": {
- "cacheHit": {
- "type": "boolean",
- "description": "Whether the query result was fetched from the query cache."
},
- "errors": {
- "type": "array",
- "description": "[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.",
- "items": {
- "$ref": "ErrorProto"
- }
- },
- "etag": {
- "type": "string",
- "description": "A hash of this response."
- },
- "jobComplete": {
- "type": "boolean",
- "description": "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."
- },
- "jobReference": {
- "$ref": "JobReference",
- "description": "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)."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#getQueryResultsResponse"
- },
- "numDmlAffectedRows": {
- "type": "string",
- "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.",
- "format": "int64"
- },
- "pageToken": {
- "type": "string",
- "description": "A token used for paging results."
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "TableRow"
- }
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "The schema of the results. Present only when the query completes successfully."
- },
- "totalBytesProcessed": {
- "type": "string",
- "description": "The total number of bytes processed for this query.",
- "format": "int64"
- },
- "totalRows": {
- "type": "string",
- "description": "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.",
- "format": "uint64"
- }
- }
- },
- "GetServiceAccountResponse": {
- "id": "GetServiceAccountResponse",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "The service account email address."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#getServiceAccountResponse"
- }
- }
- },
- "GoogleSheetsOptions": {
- "id": "GoogleSheetsOptions",
- "type": "object",
- "properties": {
- "skipLeadingRows": {
- "type": "string",
- "description": "[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 \u003e 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.",
- "format": "int64"
- }
- }
- },
- "Job": {
- "id": "Job",
- "type": "object",
- "properties": {
- "configuration": {
- "$ref": "JobConfiguration",
- "description": "[Required] Describes the job configuration."
- },
- "etag": {
- "type": "string",
- "description": "[Output-only] A hash of this resource."
- },
- "id": {
- "type": "string",
- "description": "[Output-only] Opaque ID field of the job"
- },
- "jobReference": {
- "$ref": "JobReference",
- "description": "[Optional] Reference describing the unique-per-user name of the job."
- },
- "kind": {
- "type": "string",
- "description": "[Output-only] The type of the resource.",
- "default": "bigquery#job"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output-only] A URL that can be used to access this resource again."
- },
- "statistics": {
- "$ref": "JobStatistics",
- "description": "[Output-only] Information about the job, including starting time and ending time of the job."
- },
- "status": {
- "$ref": "JobStatus",
- "description": "[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete."
- },
- "user_email": {
- "type": "string",
- "description": "[Output-only] Email address of the user who ran the job."
- }
- }
- },
- "JobCancelResponse": {
- "id": "JobCancelResponse",
- "type": "object",
- "properties": {
- "job": {
- "$ref": "Job",
- "description": "The final state of the job."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#jobCancelResponse"
- }
- }
- },
- "JobConfiguration": {
- "id": "JobConfiguration",
- "type": "object",
- "properties": {
- "copy": {
- "$ref": "JobConfigurationTableCopy",
- "description": "[Pick one] Copies a table."
- },
- "dryRun": {
- "type": "boolean",
- "description": "[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."
- },
- "extract": {
- "$ref": "JobConfigurationExtract",
- "description": "[Pick one] Configures an extract job."
- },
- "labels": {
- "type": "object",
- "description": "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.",
- "additionalProperties": {
+ "key": {
+ "description": "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.",
+ "location": "query",
"type": "string"
- }
},
- "load": {
- "$ref": "JobConfigurationLoad",
- "description": "[Pick one] Configures a load job."
- },
- "query": {
- "$ref": "JobConfigurationQuery",
- "description": "[Pick one] Configures a query job."
- }
- }
- },
- "JobConfigurationExtract": {
- "id": "JobConfigurationExtract",
- "type": "object",
- "properties": {
- "compression": {
- "type": "string",
- "description": "[Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE."
- },
- "destinationFormat": {
- "type": "string",
- "description": "[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."
- },
- "destinationUri": {
- "type": "string",
- "description": "[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."
- },
- "destinationUris": {
- "type": "array",
- "description": "[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.",
- "items": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
"type": "string"
- }
},
- "fieldDelimiter": {
- "type": "string",
- "description": "[Optional] Delimiter to use between fields in the exported data. Default is ','"
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
},
- "printHeader": {
- "type": "boolean",
- "description": "[Optional] Whether to print out a header row in the results. Default is true.",
- "default": "true"
- },
- "sourceTable": {
- "$ref": "TableReference",
- "description": "[Required] A reference to the table being exported."
- }
- }
- },
- "JobConfigurationLoad": {
- "id": "JobConfigurationLoad",
- "type": "object",
- "properties": {
- "allowJaggedRows": {
- "type": "boolean",
- "description": "[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."
- },
- "allowQuotedNewlines": {
- "type": "boolean",
- "description": "Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false."
- },
- "autodetect": {
- "type": "boolean",
- "description": "Indicates if we should automatically infer the options and schema for CSV and JSON sources."
- },
- "createDisposition": {
- "type": "string",
- "description": "[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."
- },
- "destinationEncryptionConfiguration": {
- "$ref": "EncryptionConfiguration",
- "description": "[Experimental] Custom encryption configuration (e.g., Cloud KMS keys)."
- },
- "destinationTable": {
- "$ref": "TableReference",
- "description": "[Required] The destination table to load the data into."
- },
- "encoding": {
- "type": "string",
- "description": "[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."
- },
- "fieldDelimiter": {
- "type": "string",
- "description": "[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 (',')."
- },
- "ignoreUnknownValues": {
- "type": "boolean",
- "description": "[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"
- },
- "maxBadRecords": {
- "type": "integer",
- "description": "[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. The default value is 0, which requires that all records are valid.",
- "format": "int32"
- },
- "nullMarker": {
- "type": "string",
- "description": "[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" 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."
- },
- "projectionFields": {
- "type": "array",
- "description": "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.",
- "items": {
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
"type": "string"
- }
},
- "quote": {
- "type": "string",
- "description": "[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.",
- "default": "\"",
- "pattern": ".?"
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "[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."
- },
- "schemaInline": {
- "type": "string",
- "description": "[Deprecated] The inline schema. For CSV schemas, specify as \"Field1:Type1[,Field2:Type2]*\". For example, \"foo:STRING, bar:INTEGER, baz:FLOAT\"."
- },
- "schemaInlineFormat": {
- "type": "string",
- "description": "[Deprecated] The format of the schemaInline property."
- },
- "schemaUpdateOptions": {
- "type": "array",
- "description": "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.",
- "items": {
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
"type": "string"
- }
- },
- "skipLeadingRows": {
- "type": "integer",
- "description": "[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.",
- "format": "int32"
- },
- "sourceFormat": {
- "type": "string",
- "description": "[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\". The default value is CSV."
- },
- "sourceUris": {
- "type": "array",
- "description": "[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.",
- "items": {
- "type": "string"
- }
- },
- "timePartitioning": {
- "$ref": "TimePartitioning",
- "description": "If specified, configures time-based partitioning for the destination table."
- },
- "writeDisposition": {
- "type": "string",
- "description": "[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."
}
- }
},
- "JobConfigurationQuery": {
- "id": "JobConfigurationQuery",
- "type": "object",
- "properties": {
- "allowLargeResults": {
- "type": "boolean",
- "description": "[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.",
- "default": "false"
- },
- "createDisposition": {
- "type": "string",
- "description": "[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."
- },
- "defaultDataset": {
- "$ref": "DatasetReference",
- "description": "[Optional] Specifies the default dataset to use for unqualified table names in the query."
- },
- "destinationEncryptionConfiguration": {
- "$ref": "EncryptionConfiguration",
- "description": "[Experimental] Custom encryption configuration (e.g., Cloud KMS keys)."
- },
- "destinationTable": {
- "$ref": "TableReference",
- "description": "[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."
- },
- "flattenResults": {
- "type": "boolean",
- "description": "[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.",
- "default": "true"
- },
- "maximumBillingTier": {
- "type": "integer",
- "description": "[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.",
- "default": "1",
- "format": "int32"
- },
- "maximumBytesBilled": {
- "type": "string",
- "description": "[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.",
- "format": "int64"
- },
- "parameterMode": {
- "type": "string",
- "description": "Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query."
- },
- "preserveNulls": {
- "type": "boolean",
- "description": "[Deprecated] This property is deprecated."
- },
- "priority": {
- "type": "string",
- "description": "[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE."
- },
- "query": {
- "type": "string",
- "description": "[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL."
- },
- "queryParameters": {
- "type": "array",
- "description": "Query parameters for standard SQL queries.",
- "items": {
- "$ref": "QueryParameter"
- }
- },
- "schemaUpdateOptions": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "tableDefinitions": {
- "type": "object",
- "description": "[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.",
- "additionalProperties": {
- "$ref": "ExternalDataConfiguration"
- }
- },
- "timePartitioning": {
- "$ref": "TimePartitioning",
- "description": "If specified, configures time-based partitioning for the destination table."
- },
- "useLegacySql": {
- "type": "boolean",
- "description": "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."
- },
- "useQueryCache": {
- "type": "boolean",
- "description": "[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.",
- "default": "true"
- },
- "userDefinedFunctionResources": {
- "type": "array",
- "description": "Describes user-defined function resources used in the query.",
- "items": {
- "$ref": "UserDefinedFunctionResource"
- }
- },
- "writeDisposition": {
- "type": "string",
- "description": "[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."
- }
- }
- },
- "JobConfigurationTableCopy": {
- "id": "JobConfigurationTableCopy",
- "type": "object",
- "properties": {
- "createDisposition": {
- "type": "string",
- "description": "[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."
- },
- "destinationEncryptionConfiguration": {
- "$ref": "EncryptionConfiguration",
- "description": "[Experimental] Custom encryption configuration (e.g., Cloud KMS keys)."
- },
- "destinationTable": {
- "$ref": "TableReference",
- "description": "[Required] The destination table"
- },
- "sourceTable": {
- "$ref": "TableReference",
- "description": "[Pick one] Source table to copy."
- },
- "sourceTables": {
- "type": "array",
- "description": "[Pick one] Source tables to copy.",
- "items": {
- "$ref": "TableReference"
- }
- },
- "writeDisposition": {
- "type": "string",
- "description": "[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."
- }
- }
- },
- "JobList": {
- "id": "JobList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "A hash of this page of results."
+ "protocol": "rest",
+ "resources": {
+ "datasets": {
+ "methods": {
+ "delete": {
+ "description": "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.",
+ "httpMethod": "DELETE",
+ "id": "bigquery.datasets.delete",
+ "parameterOrder": [
+ "projectId",
+ "datasetId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of dataset being deleted",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "deleteContents": {
+ "description": "If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False",
+ "location": "query",
+ "type": "boolean"
+ },
+ "projectId": {
+ "description": "Project ID of the dataset being deleted",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Returns the dataset specified by datasetID.",
+ "httpMethod": "GET",
+ "id": "bigquery.datasets.get",
+ "parameterOrder": [
+ "projectId",
+ "datasetId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the requested dataset",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the requested dataset",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}",
+ "response": {
+ "$ref": "Dataset"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "insert": {
+ "description": "Creates a new empty dataset.",
+ "httpMethod": "POST",
+ "id": "bigquery.datasets.insert",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Project ID of the new dataset",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "response": {
+ "$ref": "Dataset"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists all datasets in the specified project to which you have been granted the READER dataset role.",
+ "httpMethod": "GET",
+ "id": "bigquery.datasets.list",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "all": {
+ "description": "Whether to list all datasets, including hidden ones",
+ "location": "query",
+ "type": "boolean"
+ },
+ "filter": {
+ "description": "An expression for filtering the results of the request by label. The syntax is \"labels.\u003cname\u003e[:\u003cvalue\u003e]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See Filtering datasets using labels for details.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Page token, returned by a previous call, to request the next page of results",
+ "location": "query",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the datasets to be listed",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets",
+ "response": {
+ "$ref": "DatasetList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "httpMethod": "PATCH",
+ "id": "bigquery.datasets.patch",
+ "parameterOrder": [
+ "projectId",
+ "datasetId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the dataset being updated",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the dataset being updated",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "response": {
+ "$ref": "Dataset"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "update": {
+ "description": "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.",
+ "httpMethod": "PUT",
+ "id": "bigquery.datasets.update",
+ "parameterOrder": [
+ "projectId",
+ "datasetId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the dataset being updated",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the dataset being updated",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "response": {
+ "$ref": "Dataset"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
},
"jobs": {
- "type": "array",
- "description": "List of jobs that were requested.",
- "items": {
- "type": "object",
- "properties": {
- "configuration": {
- "$ref": "JobConfiguration",
- "description": "[Full-projection-only] Specifies the job configuration."
- },
- "errorResult": {
- "$ref": "ErrorProto",
- "description": "A result object that will be present only if the job has failed."
- },
- "id": {
- "type": "string",
- "description": "Unique opaque ID of the job."
- },
- "jobReference": {
- "$ref": "JobReference",
- "description": "Job reference uniquely identifying the job."
- },
- "kind": {
- "type": "string",
- "description": "The resource type.",
- "default": "bigquery#job"
- },
- "state": {
- "type": "string",
- "description": "Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed."
- },
- "statistics": {
- "$ref": "JobStatistics",
- "description": "[Output-only] Information about the job, including starting time and ending time of the job."
- },
- "status": {
- "$ref": "JobStatus",
- "description": "[Full-projection-only] Describes the state of the job."
- },
- "user_email": {
- "type": "string",
- "description": "[Full-projection-only] Email address of the user who ran the job."
- }
+ "methods": {
+ "cancel": {
+ "description": "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.",
+ "httpMethod": "POST",
+ "id": "bigquery.jobs.cancel",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "parameters": {
+ "jobId": {
+ "description": "[Required] Job ID of the job to cancel",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "location": {
+ "description": "[Experimental] The geographic location of the job. Required except for US and EU.",
+ "location": "query",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "[Required] Project ID of the job to cancel",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/jobs/{jobId}/cancel",
+ "response": {
+ "$ref": "JobCancelResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "bigquery.jobs.get",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "parameters": {
+ "jobId": {
+ "description": "[Required] Job ID of the requested job",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "location": {
+ "description": "[Experimental] The geographic location of the job. Required except for US and EU.",
+ "location": "query",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "[Required] Project ID of the requested job",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/jobs/{jobId}",
+ "response": {
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getQueryResults": {
+ "description": "Retrieves the results of a query job.",
+ "httpMethod": "GET",
+ "id": "bigquery.jobs.getQueryResults",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "parameters": {
+ "jobId": {
+ "description": "[Required] Job ID of the query job",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "location": {
+ "description": "[Experimental] The geographic location where the job should run. Required except for US and EU.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to read",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Page token, returned by a previous call, to request the next page of results",
+ "location": "query",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "[Required] Project ID of the query job",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Zero-based index of the starting row",
+ "format": "uint64",
+ "location": "query",
+ "type": "string"
+ },
+ "timeoutMs": {
+ "description": "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",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ }
+ },
+ "path": "projects/{projectId}/queries/{jobId}",
+ "response": {
+ "$ref": "GetQueryResultsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "insert": {
+ "description": "Starts a new asynchronous job. Requires the Can View project role.",
+ "httpMethod": "POST",
+ "id": "bigquery.jobs.insert",
+ "mediaUpload": {
+ "accept": [
+ "*/*"
+ ],
+ "protocols": {
+ "resumable": {
+ "multipart": true,
+ "path": "/resumable/upload/bigquery/v2/projects/{projectId}/jobs"
+ },
+ "simple": {
+ "multipart": true,
+ "path": "/upload/bigquery/v2/projects/{projectId}/jobs"
+ }
+ }
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Project ID of the project that will be billed for the job",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/jobs",
+ "request": {
+ "$ref": "Job"
+ },
+ "response": {
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.full_control",
+ "https://www.googleapis.com/auth/devstorage.read_only",
+ "https://www.googleapis.com/auth/devstorage.read_write"
+ ],
+ "supportsMediaUpload": true
+ },
+ "list": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "bigquery.jobs.list",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "allUsers": {
+ "description": "Whether to display jobs owned by all users in the project. Default false",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxCreationTime": {
+ "description": "Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned",
+ "format": "uint64",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "minCreationTime": {
+ "description": "Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned",
+ "format": "uint64",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Page token, returned by a previous call, to request the next page of results",
+ "location": "query",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the jobs to list",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields",
+ "enum": [
+ "full",
+ "minimal"
+ ],
+ "enumDescriptions": [
+ "Includes all job data",
+ "Does not include the job configuration"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "stateFilter": {
+ "description": "Filter for job state",
+ "enum": [
+ "done",
+ "pending",
+ "running"
+ ],
+ "enumDescriptions": [
+ "Finished jobs",
+ "Pending jobs",
+ "Running jobs"
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/jobs",
+ "response": {
+ "$ref": "JobList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "query": {
+ "description": "Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.",
+ "httpMethod": "POST",
+ "id": "bigquery.jobs.query",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Project ID of the project billed for the query",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/queries",
+ "request": {
+ "$ref": "QueryRequest"
+ },
+ "response": {
+ "$ref": "QueryResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
}
- }
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#jobList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to request the next page of results."
- }
- }
- },
- "JobReference": {
- "id": "JobReference",
- "type": "object",
- "properties": {
- "jobId": {
- "type": "string",
- "description": "[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.",
- "annotations": {
- "required": [
- "bigquery.jobs.getQueryResults"
- ]
- }
- },
- "projectId": {
- "type": "string",
- "description": "[Required] The ID of the project containing this job.",
- "annotations": {
- "required": [
- "bigquery.jobs.getQueryResults"
- ]
- }
- }
- }
- },
- "JobStatistics": {
- "id": "JobStatistics",
- "type": "object",
- "properties": {
- "creationTime": {
- "type": "string",
- "description": "[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.",
- "format": "int64"
- },
- "endTime": {
- "type": "string",
- "description": "[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.",
- "format": "int64"
- },
- "extract": {
- "$ref": "JobStatistics4",
- "description": "[Output-only] Statistics for an extract job."
- },
- "load": {
- "$ref": "JobStatistics3",
- "description": "[Output-only] Statistics for a load job."
- },
- "query": {
- "$ref": "JobStatistics2",
- "description": "[Output-only] Statistics for a query job."
- },
- "startTime": {
- "type": "string",
- "description": "[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.",
- "format": "int64"
- },
- "totalBytesProcessed": {
- "type": "string",
- "description": "[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.",
- "format": "int64"
- }
- }
- },
- "JobStatistics2": {
- "id": "JobStatistics2",
- "type": "object",
- "properties": {
- "billingTier": {
- "type": "integer",
- "description": "[Output-only] Billing tier for the job.",
- "format": "int32"
- },
- "cacheHit": {
- "type": "boolean",
- "description": "[Output-only] Whether the query result was fetched from the query cache."
- },
- "ddlOperationPerformed": {
- "type": "string",
- "description": "[Output-only, Experimental] 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."
- },
- "ddlTargetTable": {
- "$ref": "TableReference",
- "description": "[Output-only, Experimental] The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries."
- },
- "estimatedBytesProcessed": {
- "type": "string",
- "description": "[Output-only] The original estimate of bytes processed for the job.",
- "format": "int64"
- },
- "numDmlAffectedRows": {
- "type": "string",
- "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.",
- "format": "int64"
- },
- "queryPlan": {
- "type": "array",
- "description": "[Output-only] Describes execution plan for the query.",
- "items": {
- "$ref": "ExplainQueryStage"
- }
- },
- "referencedTables": {
- "type": "array",
- "description": "[Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.",
- "items": {
- "$ref": "TableReference"
- }
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "[Output-only, Experimental] The schema of the results. Present only for successful dry run of non-legacy SQL queries."
- },
- "statementType": {
- "type": "string",
- "description": "[Output-only, Experimental] 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 \"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."
- },
- "timeline": {
- "type": "array",
- "description": "[Output-only] Describes a timeline of job execution.",
- "items": {
- "$ref": "QueryTimelineSample"
- }
- },
- "totalBytesBilled": {
- "type": "string",
- "description": "[Output-only] Total bytes billed for the job.",
- "format": "int64"
- },
- "totalBytesProcessed": {
- "type": "string",
- "description": "[Output-only] Total bytes processed for the job.",
- "format": "int64"
- },
- "totalSlotMs": {
- "type": "string",
- "description": "[Output-only] Slot-milliseconds for the job.",
- "format": "int64"
- },
- "undeclaredQueryParameters": {
- "type": "array",
- "description": "[Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.",
- "items": {
- "$ref": "QueryParameter"
- }
- }
- }
- },
- "JobStatistics3": {
- "id": "JobStatistics3",
- "type": "object",
- "properties": {
- "badRecords": {
- "type": "string",
- "description": "[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.",
- "format": "int64"
- },
- "inputFileBytes": {
- "type": "string",
- "description": "[Output-only] Number of bytes of source data in a load job.",
- "format": "int64"
- },
- "inputFiles": {
- "type": "string",
- "description": "[Output-only] Number of source files in a load job.",
- "format": "int64"
- },
- "outputBytes": {
- "type": "string",
- "description": "[Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.",
- "format": "int64"
- },
- "outputRows": {
- "type": "string",
- "description": "[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.",
- "format": "int64"
- }
- }
- },
- "JobStatistics4": {
- "id": "JobStatistics4",
- "type": "object",
- "properties": {
- "destinationUriFileCounts": {
- "type": "array",
- "description": "[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.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "JobStatus": {
- "id": "JobStatus",
- "type": "object",
- "properties": {
- "errorResult": {
- "$ref": "ErrorProto",
- "description": "[Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful."
- },
- "errors": {
- "type": "array",
- "description": "[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.",
- "items": {
- "$ref": "ErrorProto"
- }
- },
- "state": {
- "type": "string",
- "description": "[Output-only] Running state of the job."
- }
- }
- },
- "JsonObject": {
- "id": "JsonObject",
- "type": "object",
- "description": "Represents a single JSON object.",
- "additionalProperties": {
- "$ref": "JsonValue"
- }
- },
- "JsonValue": {
- "id": "JsonValue",
- "type": "any"
- },
- "ProjectList": {
- "id": "ProjectList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "A hash of the page of results"
- },
- "kind": {
- "type": "string",
- "description": "The type of list.",
- "default": "bigquery#projectList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to request the next page of results."
},
"projects": {
- "type": "array",
- "description": "Projects to which you have at least READ access.",
- "items": {
- "type": "object",
- "properties": {
- "friendlyName": {
- "type": "string",
- "description": "A descriptive name for this project."
- },
- "id": {
- "type": "string",
- "description": "An opaque ID of this project."
- },
- "kind": {
- "type": "string",
- "description": "The resource type.",
- "default": "bigquery#project"
- },
- "numericId": {
- "type": "string",
- "description": "The numeric ID of this project.",
- "format": "uint64"
- },
- "projectReference": {
- "$ref": "ProjectReference",
- "description": "A unique reference to this project."
- }
- }
- }
- },
- "totalItems": {
- "type": "integer",
- "description": "The total number of projects in the list.",
- "format": "int32"
- }
- }
- },
- "ProjectReference": {
- "id": "ProjectReference",
- "type": "object",
- "properties": {
- "projectId": {
- "type": "string",
- "description": "[Required] ID of the project. Can be either the numeric ID or the assigned ID of the project."
- }
- }
- },
- "QueryParameter": {
- "id": "QueryParameter",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query."
- },
- "parameterType": {
- "$ref": "QueryParameterType",
- "description": "[Required] The type of this parameter."
- },
- "parameterValue": {
- "$ref": "QueryParameterValue",
- "description": "[Required] The value of this parameter."
- }
- }
- },
- "QueryParameterType": {
- "id": "QueryParameterType",
- "type": "object",
- "properties": {
- "arrayType": {
- "$ref": "QueryParameterType",
- "description": "[Optional] The type of the array's elements, if this is an array."
- },
- "structTypes": {
- "type": "array",
- "description": "[Optional] The types of the fields of this struct, in order, if this is a struct.",
- "items": {
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "[Optional] Human-oriented description of the field."
- },
- "name": {
- "type": "string",
- "description": "[Optional] The name of this field."
- },
- "type": {
- "$ref": "QueryParameterType",
- "description": "[Required] The type of this field."
- }
- }
- }
- },
- "type": {
- "type": "string",
- "description": "[Required] The top level type of this field."
- }
- }
- },
- "QueryParameterValue": {
- "id": "QueryParameterValue",
- "type": "object",
- "properties": {
- "arrayValues": {
- "type": "array",
- "description": "[Optional] The array values, if this is an array type.",
- "items": {
- "$ref": "QueryParameterValue"
- }
- },
- "structValues": {
- "type": "object",
- "description": "[Optional] The struct field values, in order of the struct type's declaration.",
- "additionalProperties": {
- "$ref": "QueryParameterValue"
- }
- },
- "value": {
- "type": "string",
- "description": "[Optional] The value of this value, if a simple scalar type."
- }
- }
- },
- "QueryRequest": {
- "id": "QueryRequest",
- "type": "object",
- "properties": {
- "defaultDataset": {
- "$ref": "DatasetReference",
- "description": "[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'."
- },
- "dryRun": {
- "type": "boolean",
- "description": "[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."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the request.",
- "default": "bigquery#queryRequest"
- },
- "maxResults": {
- "type": "integer",
- "description": "[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.",
- "format": "uint32"
- },
- "parameterMode": {
- "type": "string",
- "description": "Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query."
- },
- "preserveNulls": {
- "type": "boolean",
- "description": "[Deprecated] This property is deprecated."
- },
- "query": {
- "type": "string",
- "description": "[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: \"SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]\".",
- "annotations": {
- "required": [
- "bigquery.jobs.query"
- ]
- }
- },
- "queryParameters": {
- "type": "array",
- "description": "Query parameters for Standard SQL queries.",
- "items": {
- "$ref": "QueryParameter"
- }
- },
- "timeoutMs": {
- "type": "integer",
- "description": "[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).",
- "format": "uint32"
- },
- "useLegacySql": {
- "type": "boolean",
- "description": "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.",
- "default": "true"
- },
- "useQueryCache": {
- "type": "boolean",
- "description": "[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.",
- "default": "true"
- }
- }
- },
- "QueryResponse": {
- "id": "QueryResponse",
- "type": "object",
- "properties": {
- "cacheHit": {
- "type": "boolean",
- "description": "Whether the query result was fetched from the query cache."
- },
- "errors": {
- "type": "array",
- "description": "[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.",
- "items": {
- "$ref": "ErrorProto"
- }
- },
- "jobComplete": {
- "type": "boolean",
- "description": "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."
- },
- "jobReference": {
- "$ref": "JobReference",
- "description": "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)."
- },
- "kind": {
- "type": "string",
- "description": "The resource type.",
- "default": "bigquery#queryResponse"
- },
- "numDmlAffectedRows": {
- "type": "string",
- "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.",
- "format": "int64"
- },
- "pageToken": {
- "type": "string",
- "description": "A token used for paging results."
- },
- "rows": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "TableRow"
- }
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "The schema of the results. Present only when the query completes successfully."
- },
- "totalBytesProcessed": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "totalRows": {
- "type": "string",
- "description": "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.",
- "format": "uint64"
- }
- }
- },
- "QueryTimelineSample": {
- "id": "QueryTimelineSample",
- "type": "object",
- "properties": {
- "activeInputs": {
- "type": "integer",
- "description": "Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.",
- "format": "int32"
- },
- "completedInputs": {
- "type": "integer",
- "description": "Total parallel units of work completed by this query.",
- "format": "int32"
- },
- "completedInputsForActiveStages": {
- "type": "integer",
- "description": "Total parallel units of work completed by the currently active stages.",
- "format": "int32"
- },
- "elapsedMs": {
- "type": "string",
- "description": "Milliseconds elapsed since the start of query execution.",
- "format": "int64"
- },
- "pendingInputs": {
- "type": "string",
- "description": "Total parallel units of work remaining for the active stages.",
- "format": "int64"
- },
- "totalSlotMs": {
- "type": "string",
- "description": "Cumulative slot-ms consumed by the query.",
- "format": "int64"
- }
- }
- },
- "Streamingbuffer": {
- "id": "Streamingbuffer",
- "type": "object",
- "properties": {
- "estimatedBytes": {
- "type": "string",
- "description": "[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.",
- "format": "uint64"
- },
- "estimatedRows": {
- "type": "string",
- "description": "[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.",
- "format": "uint64"
- },
- "oldestEntryTime": {
- "type": "string",
- "description": "[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.",
- "format": "uint64"
- }
- }
- },
- "Table": {
- "id": "Table",
- "type": "object",
- "properties": {
- "creationTime": {
- "type": "string",
- "description": "[Output-only] The time when this table was created, in milliseconds since the epoch.",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "[Optional] A user-friendly description of this table."
- },
- "encryptionConfiguration": {
- "$ref": "EncryptionConfiguration",
- "description": "[Experimental] Custom encryption configuration (e.g., Cloud KMS keys)."
- },
- "etag": {
- "type": "string",
- "description": "[Output-only] A hash of this resource."
- },
- "expirationTime": {
- "type": "string",
- "description": "[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.",
- "format": "int64"
- },
- "externalDataConfiguration": {
- "$ref": "ExternalDataConfiguration",
- "description": "[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."
- },
- "friendlyName": {
- "type": "string",
- "description": "[Optional] A descriptive name for this table."
- },
- "id": {
- "type": "string",
- "description": "[Output-only] An opaque ID uniquely identifying the table."
- },
- "kind": {
- "type": "string",
- "description": "[Output-only] The type of the resource.",
- "default": "bigquery#table"
- },
- "labels": {
- "type": "object",
- "description": "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.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "[Output-only] The time when this table was last modified, in milliseconds since the epoch.",
- "format": "uint64"
- },
- "location": {
- "type": "string",
- "description": "[Output-only] The geographic location where the table resides. This value is inherited from the dataset."
- },
- "numBytes": {
- "type": "string",
- "description": "[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.",
- "format": "int64"
- },
- "numLongTermBytes": {
- "type": "string",
- "description": "[Output-only] The number of bytes in the table that are considered \"long-term storage\".",
- "format": "int64"
- },
- "numRows": {
- "type": "string",
- "description": "[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.",
- "format": "uint64"
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "[Optional] Describes the schema of this table."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output-only] A URL that can be used to access this resource again."
- },
- "streamingBuffer": {
- "$ref": "Streamingbuffer",
- "description": "[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."
- },
- "tableReference": {
- "$ref": "TableReference",
- "description": "[Required] Reference describing the ID of this table."
- },
- "timePartitioning": {
- "$ref": "TimePartitioning",
- "description": "If specified, configures time-based partitioning for this table."
- },
- "type": {
- "type": "string",
- "description": "[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. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE."
- },
- "view": {
- "$ref": "ViewDefinition",
- "description": "[Optional] The view definition."
- }
- }
- },
- "TableCell": {
- "id": "TableCell",
- "type": "object",
- "properties": {
- "v": {
- "type": "any"
- }
- }
- },
- "TableDataInsertAllRequest": {
- "id": "TableDataInsertAllRequest",
- "type": "object",
- "properties": {
- "ignoreUnknownValues": {
- "type": "boolean",
- "description": "[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."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#tableDataInsertAllRequest"
- },
- "rows": {
- "type": "array",
- "description": "The rows to insert.",
- "items": {
- "type": "object",
- "properties": {
- "insertId": {
- "type": "string",
- "description": "[Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis."
- },
- "json": {
- "$ref": "JsonObject",
- "description": "[Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema."
- }
- }
- }
- },
- "skipInvalidRows": {
- "type": "boolean",
- "description": "[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."
- },
- "templateSuffix": {
- "type": "string",
- "description": "[Experimental] 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."
- }
- }
- },
- "TableDataInsertAllResponse": {
- "id": "TableDataInsertAllResponse",
- "type": "object",
- "properties": {
- "insertErrors": {
- "type": "array",
- "description": "An array of errors for rows that were not inserted.",
- "items": {
- "type": "object",
- "properties": {
- "errors": {
- "type": "array",
- "description": "Error information for the row indicated by the index property.",
- "items": {
- "$ref": "ErrorProto"
+ "methods": {
+ "getServiceAccount": {
+ "description": "Returns the email address of the service account for your project used for interactions with Google Cloud KMS.",
+ "httpMethod": "GET",
+ "id": "bigquery.projects.getServiceAccount",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Project ID for which the service account is requested.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/serviceAccount",
+ "response": {
+ "$ref": "GetServiceAccountResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists all projects to which you have been granted any project role.",
+ "httpMethod": "GET",
+ "id": "bigquery.projects.list",
+ "parameters": {
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Page token, returned by a previous call, to request the next page of results",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "projects",
+ "response": {
+ "$ref": "ProjectList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
}
- },
- "index": {
- "type": "integer",
- "description": "The index of the row that error applies to.",
- "format": "uint32"
- }
}
- }
},
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#tableDataInsertAllResponse"
- }
- }
- },
- "TableDataList": {
- "id": "TableDataList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "A hash of this page of results."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#tableDataList"
- },
- "pageToken": {
- "type": "string",
- "description": "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."
- },
- "rows": {
- "type": "array",
- "description": "Rows of results.",
- "items": {
- "$ref": "TableRow"
- }
- },
- "totalRows": {
- "type": "string",
- "description": "The total number of rows in the complete table.",
- "format": "int64"
- }
- }
- },
- "TableFieldSchema": {
- "id": "TableFieldSchema",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "[Optional] The field description. The maximum length is 1,024 characters."
- },
- "fields": {
- "type": "array",
- "description": "[Optional] Describes the nested schema fields if the type property is set to RECORD.",
- "items": {
- "$ref": "TableFieldSchema"
- }
- },
- "mode": {
- "type": "string",
- "description": "[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE."
- },
- "name": {
- "type": "string",
- "description": "[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."
- },
- "type": {
- "type": "string",
- "description": "[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)."
- }
- }
- },
- "TableList": {
- "id": "TableList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "A hash of this page of results."
- },
- "kind": {
- "type": "string",
- "description": "The type of list.",
- "default": "bigquery#tableList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to request the next page of results."
+ "tabledata": {
+ "methods": {
+ "insertAll": {
+ "description": "Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.",
+ "httpMethod": "POST",
+ "id": "bigquery.tabledata.insertAll",
+ "parameterOrder": [
+ "projectId",
+ "datasetId",
+ "tableId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the destination table.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the destination table.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Table ID of the destination table.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll",
+ "request": {
+ "$ref": "TableDataInsertAllRequest"
+ },
+ "response": {
+ "$ref": "TableDataInsertAllResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/bigquery.insertdata",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Retrieves table data from a specified set of rows. Requires the READER dataset role.",
+ "httpMethod": "GET",
+ "id": "bigquery.tabledata.list",
+ "parameterOrder": [
+ "projectId",
+ "datasetId",
+ "tableId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the table to read",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Page token, returned by a previous call, identifying the result set",
+ "location": "query",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the table to read",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "selectedFields": {
+ "description": "List of fields to return (comma-separated). If unspecified, all fields are returned",
+ "location": "query",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Zero-based index of the starting row to read",
+ "format": "uint64",
+ "location": "query",
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Table ID of the table to read",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data",
+ "response": {
+ "$ref": "TableDataList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
},
"tables": {
- "type": "array",
- "description": "Tables in the requested dataset.",
- "items": {
- "type": "object",
+ "methods": {
+ "delete": {
+ "description": "Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.",
+ "httpMethod": "DELETE",
+ "id": "bigquery.tables.delete",
+ "parameterOrder": [
+ "projectId",
+ "datasetId",
+ "tableId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the table to delete",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the table to delete",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Table ID of the table to delete",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "bigquery.tables.get",
+ "parameterOrder": [
+ "projectId",
+ "datasetId",
+ "tableId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the requested table",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the requested table",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "selectedFields": {
+ "description": "List of fields to return (comma-separated). If unspecified, all fields are returned",
+ "location": "query",
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Table ID of the requested table",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
+ "response": {
+ "$ref": "Table"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "insert": {
+ "description": "Creates a new, empty table in the dataset.",
+ "httpMethod": "POST",
+ "id": "bigquery.tables.insert",
+ "parameterOrder": [
+ "projectId",
+ "datasetId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the new table",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the new table",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}/tables",
+ "request": {
+ "$ref": "Table"
+ },
+ "response": {
+ "$ref": "Table"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists all tables in the specified dataset. Requires the READER dataset role.",
+ "httpMethod": "GET",
+ "id": "bigquery.tables.list",
+ "parameterOrder": [
+ "projectId",
+ "datasetId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the tables to list",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Page token, returned by a previous call, to request the next page of results",
+ "location": "query",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the tables to list",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}/tables",
+ "response": {
+ "$ref": "TableList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "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.",
+ "httpMethod": "PATCH",
+ "id": "bigquery.tables.patch",
+ "parameterOrder": [
+ "projectId",
+ "datasetId",
+ "tableId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the table to update",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the table to update",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Table ID of the table to update",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
+ "request": {
+ "$ref": "Table"
+ },
+ "response": {
+ "$ref": "Table"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "update": {
+ "description": "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.",
+ "httpMethod": "PUT",
+ "id": "bigquery.tables.update",
+ "parameterOrder": [
+ "projectId",
+ "datasetId",
+ "tableId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "Dataset ID of the table to update",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Project ID of the table to update",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Table ID of the table to update",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
+ "request": {
+ "$ref": "Table"
+ },
+ "response": {
+ "$ref": "Table"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180311",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "BigtableColumn": {
+ "id": "BigtableColumn",
"properties": {
- "creationTime": {
- "type": "string",
- "description": "The time when this table was created, in milliseconds since the epoch.",
- "format": "int64"
- },
- "expirationTime": {
- "type": "string",
- "description": "[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.",
- "format": "int64"
- },
- "friendlyName": {
- "type": "string",
- "description": "The user-friendly name for this table."
- },
- "id": {
- "type": "string",
- "description": "An opaque ID of the table"
- },
- "kind": {
- "type": "string",
- "description": "The resource type.",
- "default": "bigquery#table"
- },
- "labels": {
- "type": "object",
- "description": "The labels associated with this table. You can use these to organize and group your tables.",
- "additionalProperties": {
- "type": "string"
+ "encoding": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "fieldName": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "onlyReadLatest": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "qualifierEncoded": {
+ "description": "[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.",
+ "format": "byte",
+ "type": "string"
+ },
+ "qualifierString": {
+ "type": "string"
+ },
+ "type": {
+ "description": "[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"
}
- },
- "tableReference": {
- "$ref": "TableReference",
- "description": "A reference uniquely identifying the table."
- },
- "timePartitioning": {
- "$ref": "TimePartitioning",
- "description": "The time-based partitioning for this table."
- },
- "type": {
- "type": "string",
- "description": "The type of table. Possible values are: TABLE, VIEW."
- },
- "view": {
- "type": "object",
- "description": "Additional details for a view.",
- "properties": {
- "useLegacySql": {
- "type": "boolean",
- "description": "True if view is defined in legacy SQL dialect, false if in standard SQL."
- }
+ },
+ "type": "object"
+ },
+ "BigtableColumnFamily": {
+ "id": "BigtableColumnFamily",
+ "properties": {
+ "columns": {
+ "description": "[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.",
+ "items": {
+ "$ref": "BigtableColumn"
+ },
+ "type": "array"
+ },
+ "encoding": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "familyId": {
+ "description": "Identifier of the column family.",
+ "type": "string"
+ },
+ "onlyReadLatest": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "[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"
}
- }
- }
- }
+ },
+ "type": "object"
},
- "totalItems": {
- "type": "integer",
- "description": "The total number of tables in the dataset.",
- "format": "int32"
+ "BigtableOptions": {
+ "id": "BigtableOptions",
+ "properties": {
+ "columnFamilies": {
+ "description": "[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.",
+ "items": {
+ "$ref": "BigtableColumnFamily"
+ },
+ "type": "array"
+ },
+ "ignoreUnspecifiedColumnFamilies": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "readRowkeyAsString": {
+ "description": "[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.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "CsvOptions": {
+ "id": "CsvOptions",
+ "properties": {
+ "allowJaggedRows": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "allowQuotedNewlines": {
+ "description": "[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.",
+ "type": "boolean"
+ },
+ "encoding": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "fieldDelimiter": {
+ "description": "[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 (',').",
+ "type": "string"
+ },
+ "quote": {
+ "default": "\"",
+ "description": "[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.",
+ "pattern": ".?",
+ "type": "string"
+ },
+ "skipLeadingRows": {
+ "description": "[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.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Dataset": {
+ "id": "Dataset",
+ "properties": {
+ "access": {
+ "description": "[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;",
+ "items": {
+ "properties": {
+ "domain": {
+ "description": "[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: \"example.com\".",
+ "type": "string"
+ },
+ "groupByEmail": {
+ "description": "[Pick one] An email address of a Google Group to grant access to.",
+ "type": "string"
+ },
+ "role": {
+ "description": "[Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER, WRITER, OWNER.",
+ "type": "string"
+ },
+ "specialGroup": {
+ "description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.",
+ "type": "string"
+ },
+ "userByEmail": {
+ "description": "[Pick one] An email address of a user to grant access to. For example: fred@example.com.",
+ "type": "string"
+ },
+ "view": {
+ "$ref": "TableReference",
+ "description": "[Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "creationTime": {
+ "description": "[Output-only] The time when this dataset was created, in milliseconds since the epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "datasetReference": {
+ "$ref": "DatasetReference",
+ "description": "[Required] A reference that identifies the dataset."
+ },
+ "defaultTableExpirationMs": {
+ "description": "[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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description": {
+ "description": "[Optional] A user-friendly description of the dataset.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "[Output-only] A hash of the resource.",
+ "type": "string"
+ },
+ "friendlyName": {
+ "description": "[Optional] A descriptive name for the dataset.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#dataset",
+ "description": "[Output-only] The resource type.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "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 Labeling Datasets for more information.",
+ "type": "object"
+ },
+ "lastModifiedTime": {
+ "description": "[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "location": {
+ "description": "The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatasetList": {
+ "id": "DatasetList",
+ "properties": {
+ "datasets": {
+ "description": "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.",
+ "items": {
+ "properties": {
+ "datasetReference": {
+ "$ref": "DatasetReference",
+ "description": "The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID."
+ },
+ "friendlyName": {
+ "description": "A descriptive name for the dataset, if one exists.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The fully-qualified, unique, opaque ID of the dataset.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#dataset",
+ "description": "The resource type. This property always returns the value \"bigquery#dataset\".",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels associated with this dataset. You can use these to organize and group your datasets.",
+ "type": "object"
+ },
+ "location": {
+ "description": "[Experimental] The geographic location where the data resides.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "A hash value of the results page. You can use this property to determine if the page has changed since the last request.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#datasetList",
+ "description": "The list type. This property always returns the value \"bigquery#datasetList\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "A token that can be used to request the next results page. This property is omitted on the final results page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatasetReference": {
+ "id": "DatasetReference",
+ "properties": {
+ "datasetId": {
+ "annotations": {
+ "required": [
+ "bigquery.datasets.update"
+ ]
+ },
+ "description": "[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.",
+ "type": "string"
+ },
+ "projectId": {
+ "annotations": {
+ "required": [
+ "bigquery.datasets.update"
+ ]
+ },
+ "description": "[Optional] The ID of the project containing this dataset.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DestinationTableProperties": {
+ "id": "DestinationTableProperties",
+ "properties": {
+ "description": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "friendlyName": {
+ "description": "[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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EncryptionConfiguration": {
+ "id": "EncryptionConfiguration",
+ "properties": {
+ "kmsKeyName": {
+ "description": "[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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ErrorProto": {
+ "id": "ErrorProto",
+ "properties": {
+ "debugInfo": {
+ "description": "Debugging information. This property is internal to Google and should not be used.",
+ "type": "string"
+ },
+ "location": {
+ "description": "Specifies where the error occurred, if present.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A human-readable description of the error.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "A short error code that summarizes the error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ExplainQueryStage": {
+ "id": "ExplainQueryStage",
+ "properties": {
+ "completedParallelInputs": {
+ "description": "Number of parallel input segments completed.",
+ "format": "int64",
+ "type": "string"
+ },
+ "computeMsAvg": {
+ "description": "Milliseconds the average shard spent on CPU-bound tasks.",
+ "format": "int64",
+ "type": "string"
+ },
+ "computeMsMax": {
+ "description": "Milliseconds the slowest shard spent on CPU-bound tasks.",
+ "format": "int64",
+ "type": "string"
+ },
+ "computeRatioAvg": {
+ "description": "Relative amount of time the average shard spent on CPU-bound tasks.",
+ "format": "double",
+ "type": "number"
+ },
+ "computeRatioMax": {
+ "description": "Relative amount of time the slowest shard spent on CPU-bound tasks.",
+ "format": "double",
+ "type": "number"
+ },
+ "endMs": {
+ "description": "Stage end time in milliseconds.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique ID for stage within plan.",
+ "format": "int64",
+ "type": "string"
+ },
+ "inputStages": {
+ "description": "IDs for stages that are inputs to this stage.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Human-readable name for stage.",
+ "type": "string"
+ },
+ "parallelInputs": {
+ "description": "Number of parallel input segments to be processed.",
+ "format": "int64",
+ "type": "string"
+ },
+ "readMsAvg": {
+ "description": "Milliseconds the average shard spent reading input.",
+ "format": "int64",
+ "type": "string"
+ },
+ "readMsMax": {
+ "description": "Milliseconds the slowest shard spent reading input.",
+ "format": "int64",
+ "type": "string"
+ },
+ "readRatioAvg": {
+ "description": "Relative amount of time the average shard spent reading input.",
+ "format": "double",
+ "type": "number"
+ },
+ "readRatioMax": {
+ "description": "Relative amount of time the slowest shard spent reading input.",
+ "format": "double",
+ "type": "number"
+ },
+ "recordsRead": {
+ "description": "Number of records read into the stage.",
+ "format": "int64",
+ "type": "string"
+ },
+ "recordsWritten": {
+ "description": "Number of records written by the stage.",
+ "format": "int64",
+ "type": "string"
+ },
+ "shuffleOutputBytes": {
+ "description": "Total number of bytes written to shuffle.",
+ "format": "int64",
+ "type": "string"
+ },
+ "shuffleOutputBytesSpilled": {
+ "description": "Total number of bytes written to shuffle and spilled to disk.",
+ "format": "int64",
+ "type": "string"
+ },
+ "startMs": {
+ "description": "Stage start time in milliseconds.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "Current status for the stage.",
+ "type": "string"
+ },
+ "steps": {
+ "description": "List of operations within the stage in dependency order (approximately chronological).",
+ "items": {
+ "$ref": "ExplainQueryStep"
+ },
+ "type": "array"
+ },
+ "waitMsAvg": {
+ "description": "Milliseconds the average shard spent waiting to be scheduled.",
+ "format": "int64",
+ "type": "string"
+ },
+ "waitMsMax": {
+ "description": "Milliseconds the slowest shard spent waiting to be scheduled.",
+ "format": "int64",
+ "type": "string"
+ },
+ "waitRatioAvg": {
+ "description": "Relative amount of time the average shard spent waiting to be scheduled.",
+ "format": "double",
+ "type": "number"
+ },
+ "waitRatioMax": {
+ "description": "Relative amount of time the slowest shard spent waiting to be scheduled.",
+ "format": "double",
+ "type": "number"
+ },
+ "writeMsAvg": {
+ "description": "Milliseconds the average shard spent on writing output.",
+ "format": "int64",
+ "type": "string"
+ },
+ "writeMsMax": {
+ "description": "Milliseconds the slowest shard spent on writing output.",
+ "format": "int64",
+ "type": "string"
+ },
+ "writeRatioAvg": {
+ "description": "Relative amount of time the average shard spent on writing output.",
+ "format": "double",
+ "type": "number"
+ },
+ "writeRatioMax": {
+ "description": "Relative amount of time the slowest shard spent on writing output.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "ExplainQueryStep": {
+ "id": "ExplainQueryStep",
+ "properties": {
+ "kind": {
+ "description": "Machine-readable operation type.",
+ "type": "string"
+ },
+ "substeps": {
+ "description": "Human-readable stage descriptions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ExternalDataConfiguration": {
+ "id": "ExternalDataConfiguration",
+ "properties": {
+ "autodetect": {
+ "description": "Try to detect schema and format options automatically. Any option specified explicitly will be honored.",
+ "type": "boolean"
+ },
+ "bigtableOptions": {
+ "$ref": "BigtableOptions",
+ "description": "[Optional] Additional options if sourceFormat is set to BIGTABLE."
+ },
+ "compression": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "csvOptions": {
+ "$ref": "CsvOptions",
+ "description": "Additional properties to set if sourceFormat is set to CSV."
+ },
+ "googleSheetsOptions": {
+ "$ref": "GoogleSheetsOptions",
+ "description": "[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS."
+ },
+ "ignoreUnknownValues": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "maxBadRecords": {
+ "description": "[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. 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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "schema": {
+ "$ref": "TableSchema",
+ "description": "[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."
+ },
+ "sourceFormat": {
+ "description": "[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\".",
+ "type": "string"
+ },
+ "sourceUris": {
+ "description": "[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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetQueryResultsResponse": {
+ "id": "GetQueryResultsResponse",
+ "properties": {
+ "cacheHit": {
+ "description": "Whether the query result was fetched from the query cache.",
+ "type": "boolean"
+ },
+ "errors": {
+ "description": "[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.",
+ "items": {
+ "$ref": "ErrorProto"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "A hash of this response.",
+ "type": "string"
+ },
+ "jobComplete": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "jobReference": {
+ "$ref": "JobReference",
+ "description": "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)."
+ },
+ "kind": {
+ "default": "bigquery#getQueryResultsResponse",
+ "description": "The resource type of the response.",
+ "type": "string"
+ },
+ "numDmlAffectedRows": {
+ "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token used for paging results.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "$ref": "TableRow"
+ },
+ "type": "array"
+ },
+ "schema": {
+ "$ref": "TableSchema",
+ "description": "The schema of the results. Present only when the query completes successfully."
+ },
+ "totalBytesProcessed": {
+ "description": "The total number of bytes processed for this query.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totalRows": {
+ "description": "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.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GetServiceAccountResponse": {
+ "id": "GetServiceAccountResponse",
+ "properties": {
+ "email": {
+ "description": "The service account email address.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#getServiceAccountResponse",
+ "description": "The resource type of the response.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GoogleSheetsOptions": {
+ "id": "GoogleSheetsOptions",
+ "properties": {
+ "skipLeadingRows": {
+ "description": "[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 \u003e 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.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Job": {
+ "id": "Job",
+ "properties": {
+ "configuration": {
+ "$ref": "JobConfiguration",
+ "description": "[Required] Describes the job configuration."
+ },
+ "etag": {
+ "description": "[Output-only] A hash of this resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output-only] Opaque ID field of the job",
+ "type": "string"
+ },
+ "jobReference": {
+ "$ref": "JobReference",
+ "description": "[Optional] Reference describing the unique-per-user name of the job."
+ },
+ "kind": {
+ "default": "bigquery#job",
+ "description": "[Output-only] The type of the resource.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output-only] A URL that can be used to access this resource again.",
+ "type": "string"
+ },
+ "statistics": {
+ "$ref": "JobStatistics",
+ "description": "[Output-only] Information about the job, including starting time and ending time of the job."
+ },
+ "status": {
+ "$ref": "JobStatus",
+ "description": "[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete."
+ },
+ "user_email": {
+ "description": "[Output-only] Email address of the user who ran the job.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobCancelResponse": {
+ "id": "JobCancelResponse",
+ "properties": {
+ "job": {
+ "$ref": "Job",
+ "description": "The final state of the job."
+ },
+ "kind": {
+ "default": "bigquery#jobCancelResponse",
+ "description": "The resource type of the response.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobConfiguration": {
+ "id": "JobConfiguration",
+ "properties": {
+ "copy": {
+ "$ref": "JobConfigurationTableCopy",
+ "description": "[Pick one] Copies a table."
+ },
+ "dryRun": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "extract": {
+ "$ref": "JobConfigurationExtract",
+ "description": "[Pick one] Configures an extract job."
+ },
+ "jobTimeoutMs": {
+ "description": "[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.",
+ "format": "int64",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "load": {
+ "$ref": "JobConfigurationLoad",
+ "description": "[Pick one] Configures a load job."
+ },
+ "query": {
+ "$ref": "JobConfigurationQuery",
+ "description": "[Pick one] Configures a query job."
+ }
+ },
+ "type": "object"
+ },
+ "JobConfigurationExtract": {
+ "id": "JobConfigurationExtract",
+ "properties": {
+ "compression": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "destinationFormat": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "destinationUri": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "destinationUris": {
+ "description": "[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "fieldDelimiter": {
+ "description": "[Optional] Delimiter to use between fields in the exported data. Default is ','",
+ "type": "string"
+ },
+ "printHeader": {
+ "default": "true",
+ "description": "[Optional] Whether to print out a header row in the results. Default is true.",
+ "type": "boolean"
+ },
+ "sourceTable": {
+ "$ref": "TableReference",
+ "description": "[Required] A reference to the table being exported."
+ }
+ },
+ "type": "object"
+ },
+ "JobConfigurationLoad": {
+ "id": "JobConfigurationLoad",
+ "properties": {
+ "allowJaggedRows": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "allowQuotedNewlines": {
+ "description": "Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.",
+ "type": "boolean"
+ },
+ "autodetect": {
+ "description": "Indicates if we should automatically infer the options and schema for CSV and JSON sources.",
+ "type": "boolean"
+ },
+ "createDisposition": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "destinationEncryptionConfiguration": {
+ "$ref": "EncryptionConfiguration",
+ "description": "Custom encryption configuration (e.g., Cloud KMS keys)."
+ },
+ "destinationTable": {
+ "$ref": "TableReference",
+ "description": "[Required] The destination table to load the data into."
+ },
+ "destinationTableProperties": {
+ "$ref": "DestinationTableProperties",
+ "description": "[Experimental] [Optional] Properties with which to create the destination table if it is new."
+ },
+ "encoding": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "fieldDelimiter": {
+ "description": "[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 (',').",
+ "type": "string"
+ },
+ "ignoreUnknownValues": {
+ "description": "[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",
+ "type": "boolean"
+ },
+ "maxBadRecords": {
+ "description": "[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. The default value is 0, which requires that all records are valid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nullMarker": {
+ "description": "[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" 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.",
+ "type": "string"
+ },
+ "projectionFields": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "quote": {
+ "default": "\"",
+ "description": "[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.",
+ "pattern": ".?",
+ "type": "string"
+ },
+ "schema": {
+ "$ref": "TableSchema",
+ "description": "[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."
+ },
+ "schemaInline": {
+ "description": "[Deprecated] The inline schema. For CSV schemas, specify as \"Field1:Type1[,Field2:Type2]*\". For example, \"foo:STRING, bar:INTEGER, baz:FLOAT\".",
+ "type": "string"
+ },
+ "schemaInlineFormat": {
+ "description": "[Deprecated] The format of the schemaInline property.",
+ "type": "string"
+ },
+ "schemaUpdateOptions": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "skipLeadingRows": {
+ "description": "[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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceFormat": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "sourceUris": {
+ "description": "[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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "timePartitioning": {
+ "$ref": "TimePartitioning",
+ "description": "If specified, configures time-based partitioning for the destination table."
+ },
+ "writeDisposition": {
+ "description": "[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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobConfigurationQuery": {
+ "id": "JobConfigurationQuery",
+ "properties": {
+ "allowLargeResults": {
+ "default": "false",
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "createDisposition": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "defaultDataset": {
+ "$ref": "DatasetReference",
+ "description": "[Optional] Specifies the default dataset to use for unqualified table names in the query."
+ },
+ "destinationEncryptionConfiguration": {
+ "$ref": "EncryptionConfiguration",
+ "description": "Custom encryption configuration (e.g., Cloud KMS keys)."
+ },
+ "destinationTable": {
+ "$ref": "TableReference",
+ "description": "[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."
+ },
+ "flattenResults": {
+ "default": "true",
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "maximumBillingTier": {
+ "default": "1",
+ "description": "[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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maximumBytesBilled": {
+ "description": "[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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "parameterMode": {
+ "description": "Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.",
+ "type": "string"
+ },
+ "preserveNulls": {
+ "description": "[Deprecated] This property is deprecated.",
+ "type": "boolean"
+ },
+ "priority": {
+ "description": "[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.",
+ "type": "string"
+ },
+ "query": {
+ "description": "[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.",
+ "type": "string"
+ },
+ "queryParameters": {
+ "description": "Query parameters for standard SQL queries.",
+ "items": {
+ "$ref": "QueryParameter"
+ },
+ "type": "array"
+ },
+ "schemaUpdateOptions": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tableDefinitions": {
+ "additionalProperties": {
+ "$ref": "ExternalDataConfiguration"
+ },
+ "description": "[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.",
+ "type": "object"
+ },
+ "timePartitioning": {
+ "$ref": "TimePartitioning",
+ "description": "If specified, configures time-based partitioning for the destination table."
+ },
+ "useLegacySql": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "useQueryCache": {
+ "default": "true",
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "userDefinedFunctionResources": {
+ "description": "Describes user-defined function resources used in the query.",
+ "items": {
+ "$ref": "UserDefinedFunctionResource"
+ },
+ "type": "array"
+ },
+ "writeDisposition": {
+ "description": "[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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobConfigurationTableCopy": {
+ "id": "JobConfigurationTableCopy",
+ "properties": {
+ "createDisposition": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "destinationEncryptionConfiguration": {
+ "$ref": "EncryptionConfiguration",
+ "description": "Custom encryption configuration (e.g., Cloud KMS keys)."
+ },
+ "destinationTable": {
+ "$ref": "TableReference",
+ "description": "[Required] The destination table"
+ },
+ "sourceTable": {
+ "$ref": "TableReference",
+ "description": "[Pick one] Source table to copy."
+ },
+ "sourceTables": {
+ "description": "[Pick one] Source tables to copy.",
+ "items": {
+ "$ref": "TableReference"
+ },
+ "type": "array"
+ },
+ "writeDisposition": {
+ "description": "[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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobList": {
+ "id": "JobList",
+ "properties": {
+ "etag": {
+ "description": "A hash of this page of results.",
+ "type": "string"
+ },
+ "jobs": {
+ "description": "List of jobs that were requested.",
+ "items": {
+ "properties": {
+ "configuration": {
+ "$ref": "JobConfiguration",
+ "description": "[Full-projection-only] Specifies the job configuration."
+ },
+ "errorResult": {
+ "$ref": "ErrorProto",
+ "description": "A result object that will be present only if the job has failed."
+ },
+ "id": {
+ "description": "Unique opaque ID of the job.",
+ "type": "string"
+ },
+ "jobReference": {
+ "$ref": "JobReference",
+ "description": "Job reference uniquely identifying the job."
+ },
+ "kind": {
+ "default": "bigquery#job",
+ "description": "The resource type.",
+ "type": "string"
+ },
+ "state": {
+ "description": "Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.",
+ "type": "string"
+ },
+ "statistics": {
+ "$ref": "JobStatistics",
+ "description": "[Output-only] Information about the job, including starting time and ending time of the job."
+ },
+ "status": {
+ "$ref": "JobStatus",
+ "description": "[Full-projection-only] Describes the state of the job."
+ },
+ "user_email": {
+ "description": "[Full-projection-only] Email address of the user who ran the job.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "bigquery#jobList",
+ "description": "The resource type of the response.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "A token to request the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobReference": {
+ "id": "JobReference",
+ "properties": {
+ "jobId": {
+ "annotations": {
+ "required": [
+ "bigquery.jobs.getQueryResults"
+ ]
+ },
+ "description": "[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.",
+ "type": "string"
+ },
+ "location": {
+ "description": "[Experimental] The geographic location of the job. Required except for US and EU.",
+ "type": "string"
+ },
+ "projectId": {
+ "annotations": {
+ "required": [
+ "bigquery.jobs.getQueryResults"
+ ]
+ },
+ "description": "[Required] The ID of the project containing this job.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobStatistics": {
+ "id": "JobStatistics",
+ "properties": {
+ "completionRatio": {
+ "description": "[Experimental] [Output-only] Job progress (0.0 -\u003e 1.0) for LOAD and EXTRACT jobs.",
+ "format": "double",
+ "type": "number"
+ },
+ "creationTime": {
+ "description": "[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "[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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "extract": {
+ "$ref": "JobStatistics4",
+ "description": "[Output-only] Statistics for an extract job."
+ },
+ "load": {
+ "$ref": "JobStatistics3",
+ "description": "[Output-only] Statistics for a load job."
+ },
+ "query": {
+ "$ref": "JobStatistics2",
+ "description": "[Output-only] Statistics for a query job."
+ },
+ "startTime": {
+ "description": "[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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totalBytesProcessed": {
+ "description": "[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobStatistics2": {
+ "id": "JobStatistics2",
+ "properties": {
+ "billingTier": {
+ "description": "[Output-only] Billing tier for the job.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "cacheHit": {
+ "description": "[Output-only] Whether the query result was fetched from the query cache.",
+ "type": "boolean"
+ },
+ "ddlOperationPerformed": {
+ "description": "[Output-only, Experimental] 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.",
+ "type": "string"
+ },
+ "ddlTargetTable": {
+ "$ref": "TableReference",
+ "description": "[Output-only, Experimental] The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries."
+ },
+ "estimatedBytesProcessed": {
+ "description": "[Output-only] The original estimate of bytes processed for the job.",
+ "format": "int64",
+ "type": "string"
+ },
+ "numDmlAffectedRows": {
+ "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.",
+ "format": "int64",
+ "type": "string"
+ },
+ "queryPlan": {
+ "description": "[Output-only] Describes execution plan for the query.",
+ "items": {
+ "$ref": "ExplainQueryStage"
+ },
+ "type": "array"
+ },
+ "referencedTables": {
+ "description": "[Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.",
+ "items": {
+ "$ref": "TableReference"
+ },
+ "type": "array"
+ },
+ "schema": {
+ "$ref": "TableSchema",
+ "description": "[Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries."
+ },
+ "statementType": {
+ "description": "[Output-only, Experimental] 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 \"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.",
+ "type": "string"
+ },
+ "timeline": {
+ "description": "[Output-only] [Experimental] Describes a timeline of job execution.",
+ "items": {
+ "$ref": "QueryTimelineSample"
+ },
+ "type": "array"
+ },
+ "totalBytesBilled": {
+ "description": "[Output-only] Total bytes billed for the job.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totalBytesProcessed": {
+ "description": "[Output-only] Total bytes processed for the job.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totalPartitionsProcessed": {
+ "description": "[Output-only] Total number of partitions processed from all partitioned tables referenced in the job.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totalSlotMs": {
+ "description": "[Output-only] Slot-milliseconds for the job.",
+ "format": "int64",
+ "type": "string"
+ },
+ "undeclaredQueryParameters": {
+ "description": "[Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.",
+ "items": {
+ "$ref": "QueryParameter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "JobStatistics3": {
+ "id": "JobStatistics3",
+ "properties": {
+ "badRecords": {
+ "description": "[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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "inputFileBytes": {
+ "description": "[Output-only] Number of bytes of source data in a load job.",
+ "format": "int64",
+ "type": "string"
+ },
+ "inputFiles": {
+ "description": "[Output-only] Number of source files in a load job.",
+ "format": "int64",
+ "type": "string"
+ },
+ "outputBytes": {
+ "description": "[Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.",
+ "format": "int64",
+ "type": "string"
+ },
+ "outputRows": {
+ "description": "[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.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobStatistics4": {
+ "id": "JobStatistics4",
+ "properties": {
+ "destinationUriFileCounts": {
+ "description": "[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.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "JobStatus": {
+ "id": "JobStatus",
+ "properties": {
+ "errorResult": {
+ "$ref": "ErrorProto",
+ "description": "[Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful."
+ },
+ "errors": {
+ "description": "[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.",
+ "items": {
+ "$ref": "ErrorProto"
+ },
+ "type": "array"
+ },
+ "state": {
+ "description": "[Output-only] Running state of the job.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JsonObject": {
+ "additionalProperties": {
+ "$ref": "JsonValue"
+ },
+ "description": "Represents a single JSON object.",
+ "id": "JsonObject",
+ "type": "object"
+ },
+ "JsonValue": {
+ "id": "JsonValue",
+ "type": "any"
+ },
+ "ProjectList": {
+ "id": "ProjectList",
+ "properties": {
+ "etag": {
+ "description": "A hash of the page of results",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#projectList",
+ "description": "The type of list.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "A token to request the next page of results.",
+ "type": "string"
+ },
+ "projects": {
+ "description": "Projects to which you have at least READ access.",
+ "items": {
+ "properties": {
+ "friendlyName": {
+ "description": "A descriptive name for this project.",
+ "type": "string"
+ },
+ "id": {
+ "description": "An opaque ID of this project.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#project",
+ "description": "The resource type.",
+ "type": "string"
+ },
+ "numericId": {
+ "description": "The numeric ID of this project.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "projectReference": {
+ "$ref": "ProjectReference",
+ "description": "A unique reference to this project."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "totalItems": {
+ "description": "The total number of projects in the list.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ProjectReference": {
+ "id": "ProjectReference",
+ "properties": {
+ "projectId": {
+ "description": "[Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "QueryParameter": {
+ "id": "QueryParameter",
+ "properties": {
+ "name": {
+ "description": "[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.",
+ "type": "string"
+ },
+ "parameterType": {
+ "$ref": "QueryParameterType",
+ "description": "[Required] The type of this parameter."
+ },
+ "parameterValue": {
+ "$ref": "QueryParameterValue",
+ "description": "[Required] The value of this parameter."
+ }
+ },
+ "type": "object"
+ },
+ "QueryParameterType": {
+ "id": "QueryParameterType",
+ "properties": {
+ "arrayType": {
+ "$ref": "QueryParameterType",
+ "description": "[Optional] The type of the array's elements, if this is an array."
+ },
+ "structTypes": {
+ "description": "[Optional] The types of the fields of this struct, in order, if this is a struct.",
+ "items": {
+ "properties": {
+ "description": {
+ "description": "[Optional] Human-oriented description of the field.",
+ "type": "string"
+ },
+ "name": {
+ "description": "[Optional] The name of this field.",
+ "type": "string"
+ },
+ "type": {
+ "$ref": "QueryParameterType",
+ "description": "[Required] The type of this field."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "[Required] The top level type of this field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "QueryParameterValue": {
+ "id": "QueryParameterValue",
+ "properties": {
+ "arrayValues": {
+ "description": "[Optional] The array values, if this is an array type.",
+ "items": {
+ "$ref": "QueryParameterValue"
+ },
+ "type": "array"
+ },
+ "structValues": {
+ "additionalProperties": {
+ "$ref": "QueryParameterValue"
+ },
+ "description": "[Optional] The struct field values, in order of the struct type's declaration.",
+ "type": "object"
+ },
+ "value": {
+ "description": "[Optional] The value of this value, if a simple scalar type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "QueryRequest": {
+ "id": "QueryRequest",
+ "properties": {
+ "defaultDataset": {
+ "$ref": "DatasetReference",
+ "description": "[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'."
+ },
+ "dryRun": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "bigquery#queryRequest",
+ "description": "The resource type of the request.",
+ "type": "string"
+ },
+ "location": {
+ "description": "[Experimental] The geographic location where the job should run. Required except for US and EU.",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "[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.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "parameterMode": {
+ "description": "Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.",
+ "type": "string"
+ },
+ "preserveNulls": {
+ "description": "[Deprecated] This property is deprecated.",
+ "type": "boolean"
+ },
+ "query": {
+ "annotations": {
+ "required": [
+ "bigquery.jobs.query"
+ ]
+ },
+ "description": "[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: \"SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]\".",
+ "type": "string"
+ },
+ "queryParameters": {
+ "description": "Query parameters for Standard SQL queries.",
+ "items": {
+ "$ref": "QueryParameter"
+ },
+ "type": "array"
+ },
+ "timeoutMs": {
+ "description": "[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).",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "useLegacySql": {
+ "default": "true",
+ "description": "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.",
+ "type": "boolean"
+ },
+ "useQueryCache": {
+ "default": "true",
+ "description": "[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.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "QueryResponse": {
+ "id": "QueryResponse",
+ "properties": {
+ "cacheHit": {
+ "description": "Whether the query result was fetched from the query cache.",
+ "type": "boolean"
+ },
+ "errors": {
+ "description": "[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.",
+ "items": {
+ "$ref": "ErrorProto"
+ },
+ "type": "array"
+ },
+ "jobComplete": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "jobReference": {
+ "$ref": "JobReference",
+ "description": "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)."
+ },
+ "kind": {
+ "default": "bigquery#queryResponse",
+ "description": "The resource type.",
+ "type": "string"
+ },
+ "numDmlAffectedRows": {
+ "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token used for paging results.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "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.",
+ "items": {
+ "$ref": "TableRow"
+ },
+ "type": "array"
+ },
+ "schema": {
+ "$ref": "TableSchema",
+ "description": "The schema of the results. Present only when the query completes successfully."
+ },
+ "totalBytesProcessed": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totalRows": {
+ "description": "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.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "QueryTimelineSample": {
+ "id": "QueryTimelineSample",
+ "properties": {
+ "activeInputs": {
+ "description": "Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.",
+ "format": "int64",
+ "type": "string"
+ },
+ "completedInputs": {
+ "description": "Total parallel units of work completed by this query.",
+ "format": "int64",
+ "type": "string"
+ },
+ "elapsedMs": {
+ "description": "Milliseconds elapsed since the start of query execution.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pendingInputs": {
+ "description": "Total parallel units of work remaining for the active stages.",
+ "format": "int64",
+ "type": "string"
+ },
+ "totalSlotMs": {
+ "description": "Cumulative slot-ms consumed by the query.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Streamingbuffer": {
+ "id": "Streamingbuffer",
+ "properties": {
+ "estimatedBytes": {
+ "description": "[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "estimatedRows": {
+ "description": "[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "oldestEntryTime": {
+ "description": "[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Table": {
+ "id": "Table",
+ "properties": {
+ "creationTime": {
+ "description": "[Output-only] The time when this table was created, in milliseconds since the epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description": {
+ "description": "[Optional] A user-friendly description of this table.",
+ "type": "string"
+ },
+ "encryptionConfiguration": {
+ "$ref": "EncryptionConfiguration",
+ "description": "Custom encryption configuration (e.g., Cloud KMS keys)."
+ },
+ "etag": {
+ "description": "[Output-only] A hash of this resource.",
+ "type": "string"
+ },
+ "expirationTime": {
+ "description": "[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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "externalDataConfiguration": {
+ "$ref": "ExternalDataConfiguration",
+ "description": "[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."
+ },
+ "friendlyName": {
+ "description": "[Optional] A descriptive name for this table.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output-only] An opaque ID uniquely identifying the table.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#table",
+ "description": "[Output-only] The type of the resource.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "lastModifiedTime": {
+ "description": "[Output-only] The time when this table was last modified, in milliseconds since the epoch.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "location": {
+ "description": "[Output-only] The geographic location where the table resides. This value is inherited from the dataset.",
+ "type": "string"
+ },
+ "numBytes": {
+ "description": "[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "numLongTermBytes": {
+ "description": "[Output-only] The number of bytes in the table that are considered \"long-term storage\".",
+ "format": "int64",
+ "type": "string"
+ },
+ "numRows": {
+ "description": "[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "schema": {
+ "$ref": "TableSchema",
+ "description": "[Optional] Describes the schema of this table."
+ },
+ "selfLink": {
+ "description": "[Output-only] A URL that can be used to access this resource again.",
+ "type": "string"
+ },
+ "streamingBuffer": {
+ "$ref": "Streamingbuffer",
+ "description": "[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."
+ },
+ "tableReference": {
+ "$ref": "TableReference",
+ "description": "[Required] Reference describing the ID of this table."
+ },
+ "timePartitioning": {
+ "$ref": "TimePartitioning",
+ "description": "If specified, configures time-based partitioning for this table."
+ },
+ "type": {
+ "description": "[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. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.",
+ "type": "string"
+ },
+ "view": {
+ "$ref": "ViewDefinition",
+ "description": "[Optional] The view definition."
+ }
+ },
+ "type": "object"
+ },
+ "TableCell": {
+ "id": "TableCell",
+ "properties": {
+ "v": {
+ "type": "any"
+ }
+ },
+ "type": "object"
+ },
+ "TableDataInsertAllRequest": {
+ "id": "TableDataInsertAllRequest",
+ "properties": {
+ "ignoreUnknownValues": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "bigquery#tableDataInsertAllRequest",
+ "description": "The resource type of the response.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "The rows to insert.",
+ "items": {
+ "properties": {
+ "insertId": {
+ "description": "[Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.",
+ "type": "string"
+ },
+ "json": {
+ "$ref": "JsonObject",
+ "description": "[Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "skipInvalidRows": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "templateSuffix": {
+ "description": "[Experimental] 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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TableDataInsertAllResponse": {
+ "id": "TableDataInsertAllResponse",
+ "properties": {
+ "insertErrors": {
+ "description": "An array of errors for rows that were not inserted.",
+ "items": {
+ "properties": {
+ "errors": {
+ "description": "Error information for the row indicated by the index property.",
+ "items": {
+ "$ref": "ErrorProto"
+ },
+ "type": "array"
+ },
+ "index": {
+ "description": "The index of the row that error applies to.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "bigquery#tableDataInsertAllResponse",
+ "description": "The resource type of the response.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TableDataList": {
+ "id": "TableDataList",
+ "properties": {
+ "etag": {
+ "description": "A hash of this page of results.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#tableDataList",
+ "description": "The resource type of the response.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "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.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "Rows of results.",
+ "items": {
+ "$ref": "TableRow"
+ },
+ "type": "array"
+ },
+ "totalRows": {
+ "description": "The total number of rows in the complete table.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TableFieldSchema": {
+ "id": "TableFieldSchema",
+ "properties": {
+ "description": {
+ "description": "[Optional] The field description. The maximum length is 1,024 characters.",
+ "type": "string"
+ },
+ "fields": {
+ "description": "[Optional] Describes the nested schema fields if the type property is set to RECORD.",
+ "items": {
+ "$ref": "TableFieldSchema"
+ },
+ "type": "array"
+ },
+ "mode": {
+ "description": "[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.",
+ "type": "string"
+ },
+ "name": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "type": {
+ "description": "[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"
+ }
+ },
+ "type": "object"
+ },
+ "TableList": {
+ "id": "TableList",
+ "properties": {
+ "etag": {
+ "description": "A hash of this page of results.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#tableList",
+ "description": "The type of list.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "A token to request the next page of results.",
+ "type": "string"
+ },
+ "tables": {
+ "description": "Tables in the requested dataset.",
+ "items": {
+ "properties": {
+ "creationTime": {
+ "description": "The time when this table was created, in milliseconds since the epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "expirationTime": {
+ "description": "[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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "friendlyName": {
+ "description": "The user-friendly name for this table.",
+ "type": "string"
+ },
+ "id": {
+ "description": "An opaque ID of the table",
+ "type": "string"
+ },
+ "kind": {
+ "default": "bigquery#table",
+ "description": "The resource type.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels associated with this table. You can use these to organize and group your tables.",
+ "type": "object"
+ },
+ "tableReference": {
+ "$ref": "TableReference",
+ "description": "A reference uniquely identifying the table."
+ },
+ "timePartitioning": {
+ "$ref": "TimePartitioning",
+ "description": "The time-based partitioning for this table."
+ },
+ "type": {
+ "description": "The type of table. Possible values are: TABLE, VIEW.",
+ "type": "string"
+ },
+ "view": {
+ "description": "Additional details for a view.",
+ "properties": {
+ "useLegacySql": {
+ "description": "True if view is defined in legacy SQL dialect, false if in standard SQL.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "totalItems": {
+ "description": "The total number of tables in the dataset.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "TableReference": {
+ "id": "TableReference",
+ "properties": {
+ "datasetId": {
+ "annotations": {
+ "required": [
+ "bigquery.tables.update"
+ ]
+ },
+ "description": "[Required] The ID of the dataset containing this table.",
+ "type": "string"
+ },
+ "projectId": {
+ "annotations": {
+ "required": [
+ "bigquery.tables.update"
+ ]
+ },
+ "description": "[Required] The ID of the project containing this table.",
+ "type": "string"
+ },
+ "tableId": {
+ "annotations": {
+ "required": [
+ "bigquery.tables.update"
+ ]
+ },
+ "description": "[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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TableRow": {
+ "id": "TableRow",
+ "properties": {
+ "f": {
+ "description": "Represents a single row in the result set, consisting of one or more fields.",
+ "items": {
+ "$ref": "TableCell"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TableSchema": {
+ "id": "TableSchema",
+ "properties": {
+ "fields": {
+ "description": "Describes the fields in a table.",
+ "items": {
+ "$ref": "TableFieldSchema"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TimePartitioning": {
+ "id": "TimePartitioning",
+ "properties": {
+ "expirationMs": {
+ "description": "[Optional] Number of milliseconds for which to keep the storage for a partition.",
+ "format": "int64",
+ "type": "string"
+ },
+ "field": {
+ "description": "[Experimental] [Optional] If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.",
+ "type": "string"
+ },
+ "requirePartitionFilter": {
+ "default": "false",
+ "description": "[Experimental] [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "[Required] The only type supported is DAY, which will generate one partition per day.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserDefinedFunctionResource": {
+ "id": "UserDefinedFunctionResource",
+ "properties": {
+ "inlineCode": {
+ "description": "[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.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ViewDefinition": {
+ "id": "ViewDefinition",
+ "properties": {
+ "query": {
+ "description": "[Required] A query that BigQuery executes when the view is referenced.",
+ "type": "string"
+ },
+ "useLegacySql": {
+ "description": "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.",
+ "type": "boolean"
+ },
+ "userDefinedFunctionResources": {
+ "description": "Describes user-defined function resources used in the query.",
+ "items": {
+ "$ref": "UserDefinedFunctionResource"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
}
- }
},
- "TableReference": {
- "id": "TableReference",
- "type": "object",
- "properties": {
- "datasetId": {
- "type": "string",
- "description": "[Required] The ID of the dataset containing this table.",
- "annotations": {
- "required": [
- "bigquery.tables.update"
- ]
- }
- },
- "projectId": {
- "type": "string",
- "description": "[Required] The ID of the project containing this table.",
- "annotations": {
- "required": [
- "bigquery.tables.update"
- ]
- }
- },
- "tableId": {
- "type": "string",
- "description": "[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.",
- "annotations": {
- "required": [
- "bigquery.tables.update"
- ]
- }
- }
- }
- },
- "TableRow": {
- "id": "TableRow",
- "type": "object",
- "properties": {
- "f": {
- "type": "array",
- "description": "Represents a single row in the result set, consisting of one or more fields.",
- "items": {
- "$ref": "TableCell"
- }
- }
- }
- },
- "TableSchema": {
- "id": "TableSchema",
- "type": "object",
- "properties": {
- "fields": {
- "type": "array",
- "description": "Describes the fields in a table.",
- "items": {
- "$ref": "TableFieldSchema"
- }
- }
- }
- },
- "TimePartitioning": {
- "id": "TimePartitioning",
- "type": "object",
- "properties": {
- "expirationMs": {
- "type": "string",
- "description": "[Optional] Number of milliseconds for which to keep the storage for a partition.",
- "format": "int64"
- },
- "field": {
- "type": "string",
- "description": "[Experimental] [Optional] If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED."
- },
- "type": {
- "type": "string",
- "description": "[Required] The only type supported is DAY, which will generate one partition per day."
- }
- }
- },
- "UserDefinedFunctionResource": {
- "id": "UserDefinedFunctionResource",
- "type": "object",
- "properties": {
- "inlineCode": {
- "type": "string",
- "description": "[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."
- },
- "resourceUri": {
- "type": "string",
- "description": "[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path)."
- }
- }
- },
- "ViewDefinition": {
- "id": "ViewDefinition",
- "type": "object",
- "properties": {
- "query": {
- "type": "string",
- "description": "[Required] A query that BigQuery executes when the view is referenced."
- },
- "useLegacySql": {
- "type": "boolean",
- "description": "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."
- },
- "userDefinedFunctionResources": {
- "type": "array",
- "description": "Describes user-defined function resources used in the query.",
- "items": {
- "$ref": "UserDefinedFunctionResource"
- }
- }
- }
- }
- },
- "resources": {
- "datasets": {
- "methods": {
- "delete": {
- "id": "bigquery.datasets.delete",
- "path": "projects/{projectId}/datasets/{datasetId}",
- "httpMethod": "DELETE",
- "description": "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.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of dataset being deleted",
- "required": true,
- "location": "path"
- },
- "deleteContents": {
- "type": "boolean",
- "description": "If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the dataset being deleted",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "bigquery.datasets.get",
- "path": "projects/{projectId}/datasets/{datasetId}",
- "httpMethod": "GET",
- "description": "Returns the dataset specified by datasetID.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the requested dataset",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the requested dataset",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "insert": {
- "id": "bigquery.datasets.insert",
- "path": "projects/{projectId}/datasets",
- "httpMethod": "POST",
- "description": "Creates a new empty dataset.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "Project ID of the new dataset",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "request": {
- "$ref": "Dataset"
- },
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "bigquery.datasets.list",
- "path": "projects/{projectId}/datasets",
- "httpMethod": "GET",
- "description": "Lists all datasets in the specified project to which you have been granted the READER dataset role.",
- "parameters": {
- "all": {
- "type": "boolean",
- "description": "Whether to list all datasets, including hidden ones",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "An expression for filtering the results of the request by label. The syntax is \"labels.\u003cname\u003e[:\u003cvalue\u003e]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See Filtering datasets using labels for details.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the datasets to be listed",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "DatasetList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "patch": {
- "id": "bigquery.datasets.patch",
- "path": "projects/{projectId}/datasets/{datasetId}",
- "httpMethod": "PATCH",
- "description": "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.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the dataset being updated",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the dataset being updated",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "request": {
- "$ref": "Dataset"
- },
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "update": {
- "id": "bigquery.datasets.update",
- "path": "projects/{projectId}/datasets/{datasetId}",
- "httpMethod": "PUT",
- "description": "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.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the dataset being updated",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the dataset being updated",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "request": {
- "$ref": "Dataset"
- },
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "jobs": {
- "methods": {
- "cancel": {
- "id": "bigquery.jobs.cancel",
- "path": "projects/{projectId}/jobs/{jobId}/cancel",
- "httpMethod": "POST",
- "description": "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.",
- "parameters": {
- "jobId": {
- "type": "string",
- "description": "[Required] Job ID of the job to cancel",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "[Required] Project ID of the job to cancel",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "JobCancelResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "bigquery.jobs.get",
- "path": "projects/{projectId}/jobs/{jobId}",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "jobId": {
- "type": "string",
- "description": "[Required] Job ID of the requested job",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "[Required] Project ID of the requested job",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "getQueryResults": {
- "id": "bigquery.jobs.getQueryResults",
- "path": "projects/{projectId}/queries/{jobId}",
- "httpMethod": "GET",
- "description": "Retrieves the results of a query job.",
- "parameters": {
- "jobId": {
- "type": "string",
- "description": "[Required] Job ID of the query job",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to read",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "[Required] Project ID of the query job",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "string",
- "description": "Zero-based index of the starting row",
- "format": "uint64",
- "location": "query"
- },
- "timeoutMs": {
- "type": "integer",
- "description": "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",
- "format": "uint32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "GetQueryResultsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "insert": {
- "id": "bigquery.jobs.insert",
- "path": "projects/{projectId}/jobs",
- "httpMethod": "POST",
- "description": "Starts a new asynchronous job. Requires the Can View project role.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "Project ID of the project that will be billed for the job",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "*/*"
- ],
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/bigquery/v2/projects/{projectId}/jobs"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/bigquery/v2/projects/{projectId}/jobs"
- }
- }
- }
- },
- "list": {
- "id": "bigquery.jobs.list",
- "path": "projects/{projectId}/jobs",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "allUsers": {
- "type": "boolean",
- "description": "Whether to display jobs owned by all users in the project. Default false",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the jobs to list",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields",
- "enum": [
- "full",
- "minimal"
- ],
- "enumDescriptions": [
- "Includes all job data",
- "Does not include the job configuration"
- ],
- "location": "query"
- },
- "stateFilter": {
- "type": "string",
- "description": "Filter for job state",
- "enum": [
- "done",
- "pending",
- "running"
- ],
- "enumDescriptions": [
- "Finished jobs",
- "Pending jobs",
- "Running jobs"
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "JobList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "query": {
- "id": "bigquery.jobs.query",
- "path": "projects/{projectId}/queries",
- "httpMethod": "POST",
- "description": "Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "Project ID of the project billed for the query",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "request": {
- "$ref": "QueryRequest"
- },
- "response": {
- "$ref": "QueryResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "projects": {
- "methods": {
- "getServiceAccount": {
- "id": "bigquery.projects.getServiceAccount",
- "path": "projects/{projectId}/serviceAccount",
- "httpMethod": "GET",
- "description": "Returns the email address of the service account for your project used for interactions with Google Cloud KMS.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "Project ID for which the service account is requested.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "GetServiceAccountResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "list": {
- "id": "bigquery.projects.list",
- "path": "projects",
- "httpMethod": "GET",
- "description": "Lists all projects to which you have been granted any project role.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ProjectList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "tabledata": {
- "methods": {
- "insertAll": {
- "id": "bigquery.tabledata.insertAll",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll",
- "httpMethod": "POST",
- "description": "Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the destination table.",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the destination table.",
- "required": true,
- "location": "path"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the destination table.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "request": {
- "$ref": "TableDataInsertAllRequest"
- },
- "response": {
- "$ref": "TableDataInsertAllResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/bigquery.insertdata",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "bigquery.tabledata.list",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data",
- "httpMethod": "GET",
- "description": "Retrieves table data from a specified set of rows. Requires the READER dataset role.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the table to read",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, identifying the result set",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the table to read",
- "required": true,
- "location": "path"
- },
- "selectedFields": {
- "type": "string",
- "description": "List of fields to return (comma-separated). If unspecified, all fields are returned",
- "location": "query"
- },
- "startIndex": {
- "type": "string",
- "description": "Zero-based index of the starting row to read",
- "format": "uint64",
- "location": "query"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the table to read",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "response": {
- "$ref": "TableDataList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "tables": {
- "methods": {
- "delete": {
- "id": "bigquery.tables.delete",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- "httpMethod": "DELETE",
- "description": "Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the table to delete",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the table to delete",
- "required": true,
- "location": "path"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the table to delete",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "bigquery.tables.get",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the requested table",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the requested table",
- "required": true,
- "location": "path"
- },
- "selectedFields": {
- "type": "string",
- "description": "List of fields to return (comma-separated). If unspecified, all fields are returned",
- "location": "query"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the requested table",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "response": {
- "$ref": "Table"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "insert": {
- "id": "bigquery.tables.insert",
- "path": "projects/{projectId}/datasets/{datasetId}/tables",
- "httpMethod": "POST",
- "description": "Creates a new, empty table in the dataset.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the new table",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the new table",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "request": {
- "$ref": "Table"
- },
- "response": {
- "$ref": "Table"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "bigquery.tables.list",
- "path": "projects/{projectId}/datasets/{datasetId}/tables",
- "httpMethod": "GET",
- "description": "Lists all tables in the specified dataset. Requires the READER dataset role.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the tables to list",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the tables to list",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "response": {
- "$ref": "TableList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "patch": {
- "id": "bigquery.tables.patch",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- "httpMethod": "PATCH",
- "description": "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.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the table to update",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the table to update",
- "required": true,
- "location": "path"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the table to update",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "request": {
- "$ref": "Table"
- },
- "response": {
- "$ref": "Table"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "update": {
- "id": "bigquery.tables.update",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- "httpMethod": "PUT",
- "description": "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.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the table to update",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the table to update",
- "required": true,
- "location": "path"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the table to update",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "request": {
- "$ref": "Table"
- },
- "response": {
- "$ref": "Table"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "bigquery/v2/",
+ "title": "BigQuery API",
+ "version": "v2"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/bigquery/v2/bigquery-gen.go b/vendor/google.golang.org/api/bigquery/v2/bigquery-gen.go
index e382f4daf..a129d81be 100644
--- a/vendor/google.golang.org/api/bigquery/v2/bigquery-gen.go
+++ b/vendor/google.golang.org/api/bigquery/v2/bigquery-gen.go
@@ -604,6 +604,10 @@ type DatasetListDatasets struct {
// organize and group your datasets.
Labels map[string]string `json:"labels,omitempty"`
+ // Location: [Experimental] The geographic location where the data
+ // resides.
+ Location string `json:"location,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "DatasetReference") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -660,6 +664,42 @@ func (s *DatasetReference) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type DestinationTableProperties struct {
+ // Description: [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 `json:"description,omitempty"`
+
+ // FriendlyName: [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 `json:"friendlyName,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Description") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Description") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *DestinationTableProperties) MarshalJSON() ([]byte, error) {
+ type NoMethod DestinationTableProperties
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type EncryptionConfiguration struct {
// KmsKeyName: [Optional] Describes the Cloud KMS encryption key that
// will be used to protect destination BigQuery table. The BigQuery
@@ -747,9 +787,15 @@ type ExplainQueryStage struct {
// CPU-bound tasks.
ComputeRatioMax float64 `json:"computeRatioMax,omitempty"`
+ // EndMs: Stage end time in milliseconds.
+ EndMs int64 `json:"endMs,omitempty,string"`
+
// Id: Unique ID for stage within plan.
Id int64 `json:"id,omitempty,string"`
+ // InputStages: IDs for stages that are inputs to this stage.
+ InputStages googleapi.Int64s `json:"inputStages,omitempty"`
+
// Name: Human-readable name for stage.
Name string `json:"name,omitempty"`
@@ -783,6 +829,9 @@ type ExplainQueryStage struct {
// and spilled to disk.
ShuffleOutputBytesSpilled int64 `json:"shuffleOutputBytesSpilled,omitempty,string"`
+ // StartMs: Stage start time in milliseconds.
+ StartMs int64 `json:"startMs,omitempty,string"`
+
// Status: Current status for the stage.
Status string `json:"status,omitempty"`
@@ -1256,6 +1305,10 @@ type JobConfiguration struct {
// Extract: [Pick one] Configures an extract job.
Extract *JobConfigurationExtract `json:"extract,omitempty"`
+ // JobTimeoutMs: [Optional] Job timeout in milliseconds. If this time
+ // limit is exceeded, BigQuery may attempt to terminate the job.
+ JobTimeoutMs int64 `json:"jobTimeoutMs,omitempty,string"`
+
// Labels: 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
@@ -1295,8 +1348,9 @@ func (s *JobConfiguration) MarshalJSON() ([]byte, error) {
type JobConfigurationExtract struct {
// Compression: [Optional] The compression type to use for exported
- // files. Possible values include GZIP and NONE. The default value is
- // NONE.
+ // files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The
+ // default value is NONE. DEFLATE and SNAPPY are only supported for
+ // Avro.
Compression string `json:"compression,omitempty"`
// DestinationFormat: [Optional] The exported file format. Possible
@@ -1377,14 +1431,18 @@ type JobConfigurationLoad struct {
// one atomic update upon job completion.
CreateDisposition string `json:"createDisposition,omitempty"`
- // DestinationEncryptionConfiguration: [Experimental] Custom encryption
- // configuration (e.g., Cloud KMS keys).
+ // DestinationEncryptionConfiguration: Custom encryption configuration
+ // (e.g., Cloud KMS keys).
DestinationEncryptionConfiguration *EncryptionConfiguration `json:"destinationEncryptionConfiguration,omitempty"`
// DestinationTable: [Required] The destination table to load the data
// into.
DestinationTable *TableReference `json:"destinationTable,omitempty"`
+ // DestinationTableProperties: [Experimental] [Optional] Properties with
+ // which to create the destination table if it is new.
+ DestinationTableProperties *DestinationTableProperties `json:"destinationTableProperties,omitempty"`
+
// Encoding: [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
@@ -1480,7 +1538,8 @@ type JobConfigurationLoad struct {
// SourceFormat: [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". The default value is CSV.
+ // specify "AVRO". For parquet, specify "PARQUET". For orc, specify
+ // "ORC". The default value is CSV.
SourceFormat string `json:"sourceFormat,omitempty"`
// SourceUris: [Required] The fully-qualified URIs that point to your
@@ -1556,8 +1615,8 @@ type JobConfigurationQuery struct {
// unqualified table names in the query.
DefaultDataset *DatasetReference `json:"defaultDataset,omitempty"`
- // DestinationEncryptionConfiguration: [Experimental] Custom encryption
- // configuration (e.g., Cloud KMS keys).
+ // DestinationEncryptionConfiguration: Custom encryption configuration
+ // (e.g., Cloud KMS keys).
DestinationEncryptionConfiguration *EncryptionConfiguration `json:"destinationEncryptionConfiguration,omitempty"`
// DestinationTable: [Optional] Describes the table where the query
@@ -1697,8 +1756,8 @@ type JobConfigurationTableCopy struct {
// one atomic update upon job completion.
CreateDisposition string `json:"createDisposition,omitempty"`
- // DestinationEncryptionConfiguration: [Experimental] Custom encryption
- // configuration (e.g., Cloud KMS keys).
+ // DestinationEncryptionConfiguration: Custom encryption configuration
+ // (e.g., Cloud KMS keys).
DestinationEncryptionConfiguration *EncryptionConfiguration `json:"destinationEncryptionConfiguration,omitempty"`
// DestinationTable: [Required] The destination table
@@ -1848,6 +1907,10 @@ type JobReference struct {
// maximum length is 1,024 characters.
JobId string `json:"jobId,omitempty"`
+ // Location: [Experimental] The geographic location of the job. Required
+ // except for US and EU.
+ Location string `json:"location,omitempty"`
+
// ProjectId: [Required] The ID of the project containing this job.
ProjectId string `json:"projectId,omitempty"`
@@ -1875,6 +1938,10 @@ func (s *JobReference) MarshalJSON() ([]byte, error) {
}
type JobStatistics struct {
+ // CompletionRatio: [Experimental] [Output-only] Job progress (0.0 ->
+ // 1.0) for LOAD and EXTRACT jobs.
+ CompletionRatio float64 `json:"completionRatio,omitempty"`
+
// CreationTime: [Output-only] Creation time of this job, in
// milliseconds since the epoch. This field will be present on all jobs.
CreationTime int64 `json:"creationTime,omitempty,string"`
@@ -1902,7 +1969,7 @@ type JobStatistics struct {
// processed in the query statistics instead.
TotalBytesProcessed int64 `json:"totalBytesProcessed,omitempty,string"`
- // ForceSendFields is a list of field names (e.g. "CreationTime") to
+ // ForceSendFields is a list of field names (e.g. "CompletionRatio") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -1910,12 +1977,13 @@ type JobStatistics struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "CreationTime") to include
- // in API requests with the JSON null value. By default, fields with
- // empty values are omitted from API requests. However, any field with
- // an empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
+ // NullFields is a list of field names (e.g. "CompletionRatio") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
NullFields []string `json:"-"`
}
@@ -1925,6 +1993,20 @@ func (s *JobStatistics) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+func (s *JobStatistics) UnmarshalJSON(data []byte) error {
+ type NoMethod JobStatistics
+ var s1 struct {
+ CompletionRatio gensupport.JSONFloat64 `json:"completionRatio"`
+ *NoMethod
+ }
+ s1.NoMethod = (*NoMethod)(s)
+ if err := json.Unmarshal(data, &s1); err != nil {
+ return err
+ }
+ s.CompletionRatio = float64(s1.CompletionRatio)
+ return nil
+}
+
type JobStatistics2 struct {
// BillingTier: [Output-only] Billing tier for the job.
BillingTier int64 `json:"billingTier,omitempty"`
@@ -1960,13 +2042,13 @@ type JobStatistics2 struct {
// QueryPlan: [Output-only] Describes execution plan for the query.
QueryPlan []*ExplainQueryStage `json:"queryPlan,omitempty"`
- // ReferencedTables: [Output-only, Experimental] Referenced tables for
- // the job. Queries that reference more than 50 tables will not have a
- // complete list.
+ // ReferencedTables: [Output-only] Referenced tables for the job.
+ // Queries that reference more than 50 tables will not have a complete
+ // list.
ReferencedTables []*TableReference `json:"referencedTables,omitempty"`
- // Schema: [Output-only, Experimental] The schema of the results.
- // Present only for successful dry run of non-legacy SQL queries.
+ // Schema: [Output-only] The schema of the results. Present only for
+ // successful dry run of non-legacy SQL queries.
Schema *TableSchema `json:"schema,omitempty"`
// StatementType: [Output-only, Experimental] The type of query
@@ -1976,7 +2058,8 @@ type JobStatistics2 struct {
// query.
StatementType string `json:"statementType,omitempty"`
- // Timeline: [Output-only] Describes a timeline of job execution.
+ // Timeline: [Output-only] [Experimental] Describes a timeline of job
+ // execution.
Timeline []*QueryTimelineSample `json:"timeline,omitempty"`
// TotalBytesBilled: [Output-only] Total bytes billed for the job.
@@ -1985,6 +2068,10 @@ type JobStatistics2 struct {
// TotalBytesProcessed: [Output-only] Total bytes processed for the job.
TotalBytesProcessed int64 `json:"totalBytesProcessed,omitempty,string"`
+ // TotalPartitionsProcessed: [Output-only] Total number of partitions
+ // processed from all partitioned tables referenced in the job.
+ TotalPartitionsProcessed int64 `json:"totalPartitionsProcessed,omitempty,string"`
+
// TotalSlotMs: [Output-only] Slot-milliseconds for the job.
TotalSlotMs int64 `json:"totalSlotMs,omitempty,string"`
@@ -2396,6 +2483,10 @@ type QueryRequest struct {
// Kind: The resource type of the request.
Kind string `json:"kind,omitempty"`
+ // Location: [Experimental] The geographic location where the job should
+ // run. Required except for US and EU.
+ Location string `json:"location,omitempty"`
+
// MaxResults: [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
@@ -2554,15 +2645,11 @@ type QueryTimelineSample struct {
// ActiveInputs: Total number of active workers. This does not
// correspond directly to slot usage. This is the largest value observed
// since the last sample.
- ActiveInputs int64 `json:"activeInputs,omitempty"`
+ ActiveInputs int64 `json:"activeInputs,omitempty,string"`
// CompletedInputs: Total parallel units of work completed by this
// query.
- CompletedInputs int64 `json:"completedInputs,omitempty"`
-
- // CompletedInputsForActiveStages: Total parallel units of work
- // completed by the currently active stages.
- CompletedInputsForActiveStages int64 `json:"completedInputsForActiveStages,omitempty"`
+ CompletedInputs int64 `json:"completedInputs,omitempty,string"`
// ElapsedMs: Milliseconds elapsed since the start of query execution.
ElapsedMs int64 `json:"elapsedMs,omitempty,string"`
@@ -2643,8 +2730,8 @@ type Table struct {
// Description: [Optional] A user-friendly description of this table.
Description string `json:"description,omitempty"`
- // EncryptionConfiguration: [Experimental] Custom encryption
- // configuration (e.g., Cloud KMS keys).
+ // EncryptionConfiguration: Custom encryption configuration (e.g., Cloud
+ // KMS keys).
EncryptionConfiguration *EncryptionConfiguration `json:"encryptionConfiguration,omitempty"`
// Etag: [Output-only] A hash of this resource.
@@ -3258,6 +3345,11 @@ type TimePartitioning struct {
// Its mode must be NULLABLE or REQUIRED.
Field string `json:"field,omitempty"`
+ // RequirePartitionFilter: [Experimental] [Optional] If set to true,
+ // queries over this table require a partition filter that can be used
+ // for partition elimination to be specified.
+ RequirePartitionFilter bool `json:"requirePartitionFilter,omitempty"`
+
// Type: [Required] The only type supported is DAY, which will generate
// one partition per day.
Type string `json:"type,omitempty"`
@@ -4290,6 +4382,13 @@ func (r *JobsService) Cancel(projectId string, jobId string) *JobsCancelCall {
return c
}
+// Location sets the optional parameter "location": [Experimental] The
+// geographic location of the job. Required except for US and EU.
+func (c *JobsCancelCall) Location(location string) *JobsCancelCall {
+ c.urlParams_.Set("location", location)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -4386,6 +4485,11 @@ func (c *JobsCancelCall) Do(opts ...googleapi.CallOption) (*JobCancelResponse, e
// "required": true,
// "type": "string"
// },
+ // "location": {
+ // "description": "[Experimental] The geographic location of the job. Required except for US and EU.",
+ // "location": "query",
+ // "type": "string"
+ // },
// "projectId": {
// "description": "[Required] Project ID of the job to cancel",
// "location": "path",
@@ -4427,6 +4531,13 @@ func (r *JobsService) Get(projectId string, jobId string) *JobsGetCall {
return c
}
+// Location sets the optional parameter "location": [Experimental] The
+// geographic location of the job. Required except for US and EU.
+func (c *JobsGetCall) Location(location string) *JobsGetCall {
+ c.urlParams_.Set("location", location)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -4536,6 +4647,11 @@ func (c *JobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error) {
// "required": true,
// "type": "string"
// },
+ // "location": {
+ // "description": "[Experimental] The geographic location of the job. Required except for US and EU.",
+ // "location": "query",
+ // "type": "string"
+ // },
// "projectId": {
// "description": "[Required] Project ID of the requested job",
// "location": "path",
@@ -4576,6 +4692,14 @@ func (r *JobsService) GetQueryResults(projectId string, jobId string) *JobsGetQu
return c
}
+// Location sets the optional parameter "location": [Experimental] The
+// geographic location where the job should run. Required except for US
+// and EU.
+func (c *JobsGetQueryResultsCall) Location(location string) *JobsGetQueryResultsCall {
+ c.urlParams_.Set("location", location)
+ return c
+}
+
// MaxResults sets the optional parameter "maxResults": Maximum number
// of results to read
func (c *JobsGetQueryResultsCall) MaxResults(maxResults int64) *JobsGetQueryResultsCall {
@@ -4715,6 +4839,11 @@ func (c *JobsGetQueryResultsCall) Do(opts ...googleapi.CallOption) (*GetQueryRes
// "required": true,
// "type": "string"
// },
+ // "location": {
+ // "description": "[Experimental] The geographic location where the job should run. Required except for US and EU.",
+ // "location": "query",
+ // "type": "string"
+ // },
// "maxResults": {
// "description": "Maximum number of results to read",
// "format": "uint32",
@@ -4886,11 +5015,12 @@ func (c *JobsInsertCall) doRequest(alt string) (*http.Response, error) {
body = new(bytes.Buffer)
reqHeaders.Set("Content-Type", "application/json")
}
- body, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
+ body, getBody, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body)
defer cleanup()
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
+ gensupport.SetGetBody(req, getBody)
googleapi.Expand(req.URL, map[string]string{
"projectId": c.projectId,
})
@@ -5029,6 +5159,14 @@ func (c *JobsListCall) AllUsers(allUsers bool) *JobsListCall {
return c
}
+// MaxCreationTime sets the optional parameter "maxCreationTime": Max
+// value for job creation time, in milliseconds since the POSIX epoch.
+// If set, only jobs created before or at this timestamp are returned
+func (c *JobsListCall) MaxCreationTime(maxCreationTime uint64) *JobsListCall {
+ c.urlParams_.Set("maxCreationTime", fmt.Sprint(maxCreationTime))
+ return c
+}
+
// MaxResults sets the optional parameter "maxResults": Maximum number
// of results to return
func (c *JobsListCall) MaxResults(maxResults int64) *JobsListCall {
@@ -5036,6 +5174,14 @@ func (c *JobsListCall) MaxResults(maxResults int64) *JobsListCall {
return c
}
+// MinCreationTime sets the optional parameter "minCreationTime": Min
+// value for job creation time, in milliseconds since the POSIX epoch.
+// If set, only jobs created after or at this timestamp are returned
+func (c *JobsListCall) MinCreationTime(minCreationTime uint64) *JobsListCall {
+ c.urlParams_.Set("minCreationTime", fmt.Sprint(minCreationTime))
+ return c
+}
+
// PageToken sets the optional parameter "pageToken": Page token,
// returned by a previous call, to request the next page of results
func (c *JobsListCall) PageToken(pageToken string) *JobsListCall {
@@ -5172,12 +5318,24 @@ func (c *JobsListCall) Do(opts ...googleapi.CallOption) (*JobList, error) {
// "location": "query",
// "type": "boolean"
// },
+ // "maxCreationTime": {
+ // "description": "Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned",
+ // "format": "uint64",
+ // "location": "query",
+ // "type": "string"
+ // },
// "maxResults": {
// "description": "Maximum number of results to return",
// "format": "uint32",
// "location": "query",
// "type": "integer"
// },
+ // "minCreationTime": {
+ // "description": "Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned",
+ // "format": "uint64",
+ // "location": "query",
+ // "type": "string"
+ // },
// "pageToken": {
// "description": "Page token, returned by a previous call, to request the next page of results",
// "location": "query",
diff --git a/vendor/google.golang.org/api/bigquerydatatransfer/v1/bigquerydatatransfer-api.json b/vendor/google.golang.org/api/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
index dadd20cf9..0741a3492 100644
--- a/vendor/google.golang.org/api/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
+++ b/vendor/google.golang.org/api/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
@@ -1,1029 +1,599 @@
{
- "basePath": "",
- "revision": "20180114",
- "documentationLink": "https://cloud.google.com/bigquery/",
- "id": "bigquerydatatransfer:v1",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "DataSource": {
- "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
- "type": "object",
- "properties": {
- "defaultSchedule": {
- "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
- "type": "string"
- },
- "supportsMultipleTransfers": {
- "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets.",
- "type": "boolean"
- },
- "defaultDataRefreshWindowDays": {
- "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
- "format": "int32",
- "type": "integer"
- },
- "manualRunsDisabled": {
- "description": "Disables backfilling and manual run scheduling\nfor the data source.",
- "type": "boolean"
- },
- "transferType": {
- "enumDescriptions": [
- "Invalid or Unknown transfer type placeholder.",
- "Batch data transfer.",
- "Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project."
- ],
- "enum": [
- "TRANSFER_TYPE_UNSPECIFIED",
- "BATCH",
- "STREAMING"
- ],
- "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.",
- "type": "string"
- },
- "description": {
- "description": "User friendly data source description string.",
- "type": "string"
- },
- "dataSourceId": {
- "description": "Data source id.",
- "type": "string"
- },
- "scopes": {
- "description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "description": "Data source resource name.",
- "type": "string"
- },
- "minimumScheduleInterval": {
- "description": "The minimum interval for scheduler to schedule runs.",
- "format": "google-duration",
- "type": "string"
- },
- "clientId": {
- "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
- "type": "string"
- },
- "authorizationType": {
- "enumDescriptions": [
- "Type unspecified.",
- "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
- "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
- ],
- "enum": [
- "AUTHORIZATION_TYPE_UNSPECIFIED",
- "AUTHORIZATION_CODE",
- "GOOGLE_PLUS_AUTHORIZATION_CODE"
- ],
- "description": "Indicates the type of authorization.",
- "type": "string"
- },
- "supportsCustomSchedule": {
- "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.",
- "type": "boolean"
- },
- "displayName": {
- "description": "User friendly data source name.",
- "type": "string"
- },
- "updateDeadlineSeconds": {
- "description": "The number of seconds to wait for an update from the data source\nbefore BigQuery marks the transfer as failed.",
- "format": "int32",
- "type": "integer"
- },
- "dataRefreshType": {
- "enumDescriptions": [
- "The data source won't support data auto refresh, which is default value.",
- "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.",
- "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
- ],
- "enum": [
- "DATA_REFRESH_TYPE_UNSPECIFIED",
- "SLIDING_WINDOW",
- "CUSTOM_SLIDING_WINDOW"
- ],
- "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
- "type": "string"
- },
- "parameters": {
- "description": "Data source parameters.",
- "type": "array",
- "items": {
- "$ref": "DataSourceParameter"
- }
- },
- "helpUrl": {
- "description": "Url for the help document for this data source.",
- "type": "string"
- }
- },
- "id": "DataSource"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Status"
- },
- "ScheduleTransferRunsRequest": {
- "description": "A request to schedule transfer runs for a time range.",
- "type": "object",
- "properties": {
- "startTime": {
- "description": "Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "ScheduleTransferRunsRequest"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: `\"us-east1\"`.",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "TransferConfig": {
- "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.",
- "type": "object",
- "properties": {
- "dataSourceId": {
- "description": "Data source id. Cannot be changed once data transfer is created.",
- "type": "string"
- },
- "state": {
- "description": "Output only. State of the most recently updated transfer run.",
- "type": "string",
- "enumDescriptions": [
- "State placeholder.",
- "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
- "Data transfer is in progress.",
- "Data transfer completed successsfully.",
- "Data transfer failed.",
- "Data transfer is cancelled."
- ],
- "enum": [
- "TRANSFER_STATE_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ]
- },
- "userId": {
- "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.",
- "format": "int64",
- "type": "string"
- },
- "destinationDatasetId": {
- "description": "The BigQuery target dataset id.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "type": "string"
- },
- "params": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Data transfer specific parameters.",
- "type": "object"
- },
- "datasetRegion": {
- "description": "Output only. Region in which BigQuery dataset is located.",
- "type": "string"
- },
- "displayName": {
- "description": "User specified display name for the data transfer.",
- "type": "string"
- },
- "nextRunTime": {
- "description": "Output only. Next time when data transfer will run.",
- "format": "google-datetime",
- "type": "string"
- },
- "disabled": {
- "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
- "type": "boolean"
- },
- "updateTime": {
- "description": "Output only. Data transfer modification time. Ignored by server on input.",
- "format": "google-datetime",
- "type": "string"
- },
- "schedule": {
- "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
- "type": "string"
- },
- "dataRefreshWindowDays": {
- "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TransferConfig"
- },
- "TransferRun": {
- "description": "Represents a data transfer run.\nNext id: 27",
- "type": "object",
- "properties": {
- "state": {
- "enumDescriptions": [
- "State placeholder.",
- "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
- "Data transfer is in progress.",
- "Data transfer completed successsfully.",
- "Data transfer failed.",
- "Data transfer is cancelled."
- ],
- "enum": [
- "TRANSFER_STATE_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ],
- "description": "Data transfer run state. Ignored for input requests.",
- "type": "string"
- },
- "userId": {
- "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
- "type": "string"
- },
- "destinationDatasetId": {
- "description": "Output only. The BigQuery target dataset id.",
- "type": "string"
- },
- "params": {
- "description": "Output only. Data transfer specific parameters.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "endTime": {
- "description": "Output only. Time when transfer run ended.\nParameter ignored by server for input requests.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Output only. Time when transfer run was started.\nParameter ignored by server for input requests.",
- "format": "google-datetime",
- "type": "string"
- },
- "scheduleTime": {
- "description": "Minimum time after which a transfer run can be started.",
- "format": "google-datetime",
- "type": "string"
- },
- "errorStatus": {
- "description": "Status of the transfer run.",
- "$ref": "Status"
- },
- "updateTime": {
- "description": "Output only. Last time the data transfer run state was updated.",
- "format": "google-datetime",
- "type": "string"
- },
- "schedule": {
- "description": "Output only. Describes the schedule of this transfer run if it was\ncreated as part of a regular schedule. For batch transfer runs that are\nscheduled manually, this is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.",
- "type": "string"
- },
- "runTime": {
- "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
- "format": "google-datetime",
- "type": "string"
- },
- "dataSourceId": {
- "description": "Output only. Data source id.",
- "type": "string"
- }
- },
- "id": "TransferRun"
- },
- "CheckValidCredsRequest": {
- "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
- "type": "object",
- "properties": {},
- "id": "CheckValidCredsRequest"
- },
- "CheckValidCredsResponse": {
- "description": "A response indicating whether the credentials exist and are valid.",
- "type": "object",
- "properties": {
- "hasValidCreds": {
- "description": "If set to `true`, the credentials exist and are valid.",
- "type": "boolean"
- }
- },
- "id": "CheckValidCredsResponse"
- },
- "ScheduleTransferRunsResponse": {
- "description": "A response to schedule transfer runs for a time range.",
- "type": "object",
- "properties": {
- "runs": {
- "description": "The transfer runs that were scheduled.",
- "type": "array",
- "items": {
- "$ref": "TransferRun"
- }
- }
- },
- "id": "ScheduleTransferRunsResponse"
- },
- "ListTransferLogsResponse": {
- "description": "The returned list transfer run messages.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.",
- "type": "string"
- },
- "transferMessages": {
- "description": "Output only. The stored pipeline transfer messages.",
- "type": "array",
- "items": {
- "$ref": "TransferMessage"
- }
- }
- },
- "id": "ListTransferLogsResponse"
- },
- "TransferMessage": {
- "description": "Represents a user facing message for a particular data transfer run.",
- "type": "object",
- "properties": {
- "messageTime": {
- "description": "Time when message was logged.",
- "format": "google-datetime",
- "type": "string"
- },
- "severity": {
- "enumDescriptions": [
- "No severity specified.",
- "Informational message.",
- "Warning message.",
- "Error message."
- ],
- "enum": [
- "MESSAGE_SEVERITY_UNSPECIFIED",
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Message severity.",
- "type": "string"
- },
- "messageText": {
- "description": "Message text.",
- "type": "string"
- }
- },
- "id": "TransferMessage"
- },
- "ListDataSourcesResponse": {
- "description": "Returns list of supported data sources and their metadata.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.",
- "type": "string"
- },
- "dataSources": {
- "description": "List of supported data sources and their transfer settings.",
- "type": "array",
- "items": {
- "$ref": "DataSource"
- }
- }
- },
- "id": "ListDataSourcesResponse"
- },
- "DataSourceParameter": {
- "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "When parameter is a record, describes child fields.",
- "type": "array",
- "items": {
- "$ref": "DataSourceParameter"
- }
- },
- "maxValue": {
- "description": "For integer and double values specifies maxminum allowed value.",
- "format": "double",
- "type": "number"
- },
- "type": {
- "enumDescriptions": [
- "Type unspecified.",
- "String parameter.",
- "Integer parameter (64-bits).\nWill be serialized to json as string.",
- "Double precision floating point parameter.",
- "Boolean parameter.",
- "Record parameter.",
- "Page ID for a Google+ Page."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "STRING",
- "INTEGER",
- "DOUBLE",
- "BOOLEAN",
- "RECORD",
- "PLUS_PAGE"
- ],
- "description": "Parameter type.",
- "type": "string"
- },
- "recurse": {
- "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
- "type": "boolean"
- },
- "description": {
- "description": "Parameter description.",
- "type": "string"
- },
- "allowedValues": {
- "description": "All possible values for the parameter.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "validationHelpUrl": {
- "description": "URL to a help document to further explain the naming requirements.",
- "type": "string"
- },
- "minValue": {
- "description": "For integer and double values specifies minimum allowed value.",
- "format": "double",
- "type": "number"
- },
- "validationRegex": {
- "description": "Regular expression which can be used for parameter validation.",
- "type": "string"
- },
- "paramId": {
- "description": "Parameter identifier.",
- "type": "string"
- },
- "required": {
- "description": "Is parameter required.",
- "type": "boolean"
- },
- "repeated": {
- "description": "Can parameter have multiple values.",
- "type": "boolean"
- },
- "displayName": {
- "description": "Parameter display name in the user interface.",
- "type": "string"
- },
- "validationDescription": {
- "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.",
- "type": "string"
- },
- "immutable": {
- "description": "Cannot be changed after initial creation.",
- "type": "boolean"
- }
- },
- "id": "DataSourceParameter"
- },
- "ListTransferRunsResponse": {
- "properties": {
- "transferRuns": {
- "description": "Output only. The stored pipeline transfer runs.",
- "type": "array",
- "items": {
- "$ref": "TransferRun"
- }
- },
- "nextPageToken": {
- "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.",
- "type": "string"
- }
- },
- "id": "ListTransferRunsResponse",
- "description": "The returned list of pipelines in the project.",
- "type": "object"
- },
- "ListLocationsResponse": {
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
- },
- "ListTransferConfigsResponse": {
- "properties": {
- "transferConfigs": {
- "description": "Output only. The stored pipeline transfer configurations.",
- "type": "array",
- "items": {
- "$ref": "TransferConfig"
- }
- },
- "nextPageToken": {
- "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.",
- "type": "string"
- }
- },
- "id": "ListTransferConfigsResponse",
- "description": "The returned list of pipelines in the project.",
- "type": "object"
- }
- },
- "protocol": "rest",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "canonicalName": "BigQuery Data Transfer",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
+ "https://www.googleapis.com/auth/bigquery": {
+ "description": "View and manage your data in Google BigQuery"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
- "https://www.googleapis.com/auth/bigquery": {
- "description": "View and manage your data in Google BigQuery"
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
}
}
}
},
- "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "bigquerydatatransfer",
+ "basePath": "",
+ "baseUrl": "https://bigquerydatatransfer.googleapis.com/",
"batchPath": "batch",
+ "canonicalName": "BigQuery Data Transfer",
+ "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/bigquery/",
"fullyEncodeReservedExpansion": true,
- "title": "BigQuery Data Transfer API",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "bigquerydatatransfer:v1",
+ "kind": "discovery#restDescription",
+ "name": "bigquerydatatransfer",
+ "ownerDomain": "google.com",
"ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
"resources": {
"projects": {
"resources": {
- "locations": {
+ "dataSources": {
"methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
+ "checkValidCreds": {
+ "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
+ "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds",
+ "httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
"parameterOrder": [
"name"
],
+ "parameters": {
+ "name": {
+ "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:checkValidCreds",
+ "request": {
+ "$ref": "CheckValidCredsRequest"
+ },
+ "response": {
+ "$ref": "CheckValidCredsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
+ "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
"httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.dataSources.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "DataSource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
+ "flatPath": "v1/projects/{projectsId}/dataSources",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.dataSources.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/dataSources",
+ "response": {
+ "$ref": "ListDataSourcesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "get": {
+ "description": "Gets information about a location.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the location.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.list",
+ "parameterOrder": [
+ "name"
+ ],
"parameters": {
"filter": {
- "location": "query",
"description": "The standard list filter.",
+ "location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^projects/[^/]+$",
- "location": "path"
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
"location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations",
"path": "v1/{+name}/locations",
- "id": "bigquerydatatransfer.projects.locations.list"
- },
- "get": {
"response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name for the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
+ "$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.get",
- "description": "Get information about a location."
+ ]
}
},
"resources": {
"dataSources": {
"methods": {
- "get": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.dataSources.get",
- "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
- "response": {
- "$ref": "DataSource"
- },
+ "checkValidCreds": {
+ "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds",
+ "httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
+ "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
"location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
"required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "list": {
- "id": "bigquerydatatransfer.projects.locations.dataSources.list",
- "path": "v1/{+parent}/dataSources",
- "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListDataSourcesResponse"
- },
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources"
- },
- "checkValidCreds": {
"path": "v1/{+name}:checkValidCreds",
- "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
- "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
"request": {
"$ref": "CheckValidCredsRequest"
},
"response": {
"$ref": "CheckValidCredsResponse"
},
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.get",
+ "parameterOrder": [
+ "name"
],
"parameters": {
"name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
"location": "path",
- "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds"
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "DataSource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/dataSources",
+ "response": {
+ "$ref": "ListDataSourcesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
}
}
},
"transferConfigs": {
"methods": {
- "scheduleRuns": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
- "path": "v1/{+parent}:scheduleRuns",
- "request": {
- "$ref": "ScheduleTransferRunsRequest"
- },
- "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "create": {
+ "description": "Creates a new data transfer configuration.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
"httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
"parameterOrder": [
"parent"
],
- "response": {
- "$ref": "ScheduleTransferRunsResponse"
- },
"parameters": {
+ "authorizationCode": {
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e\u0026scope=\u003cdata_source_scopes\u003e\u0026redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
+ "location": "query",
+ "type": "string"
+ },
"parent": {
- "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1/{+parent}/transferConfigs",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "httpMethod": "DELETE",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "patch": {
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
- },
- "authorizationCode": {
- "location": "query",
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch"
- },
"get": {
- "response": {
- "$ref": "TransferConfig"
- },
+ "description": "Returns information about a data transfer config.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.get",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
+ "required": true,
+ "type": "string"
}
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "TransferConfig"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.get",
- "description": "Returns information about a data transfer config."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
- "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs."
+ ]
},
"list": {
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
"description": "Returns information about all data transfers in the project.",
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
"parameters": {
+ "dataSourceIds": {
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
"pageSize": {
"description": "Page size. The default page size is the maximum value of 1000 results.",
"format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
- "required": true,
- "type": "string"
- },
- "dataSourceIds": {
- "repeated": true,
"location": "query",
- "description": "When specified, only configurations of requested data sources are returned.",
- "type": "string"
+ "type": "integer"
},
"pageToken": {
- "location": "query",
"description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
"type": "string"
}
},
+ "path": "v1/{+parent}/transferConfigs",
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs"
+ ]
},
- "create": {
- "response": {
- "$ref": "TransferConfig"
- },
+ "patch": {
+ "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "httpMethod": "PATCH",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch",
"parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
+ "name"
],
"parameters": {
"authorizationCode": {
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string",
- "location": "query"
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e\u0026scope=\u003cdata_source_scopes\u003e\u0026redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
+ "location": "query",
+ "type": "string"
},
- "parent": {
- "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.",
+ "name": {
+ "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
- "description": "Creates a new data transfer configuration.",
+ "path": "v1/{+name}",
"request": {
"$ref": "TransferConfig"
- }
+ },
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "scheduleRuns": {
+ "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
+ "httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}:scheduleRuns",
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ },
+ "response": {
+ "$ref": "ScheduleTransferRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
},
"resources": {
@@ -1031,93 +601,95 @@
"methods": {
"delete": {
"description": "Deletes the specified transfer run.",
- "response": {
- "$ref": "Empty"
- },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "httpMethod": "DELETE",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"required": true,
"type": "string"
}
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete"
+ ]
},
"get": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
"description": "Returns information about the particular transfer run.",
- "response": {
- "$ref": "TransferRun"
- },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "TransferRun"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
- }
- }
+ ]
},
"list": {
- "response": {
- "$ref": "ListTransferRunsResponse"
- },
+ "description": "Returns information about running and completed jobs.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
- "runAttempt": {
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"location": "query",
- "enum": [
- "RUN_ATTEMPT_UNSPECIFIED",
- "LATEST"
- ],
- "description": "Indicates how run attempts are to be pulled.",
"type": "string"
},
"parent": {
"description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
+ "required": true,
+ "type": "string"
},
- "pageToken": {
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
+ "runAttempt": {
+ "description": "Indicates how run attempts are to be pulled.",
+ "enum": [
+ "RUN_ATTEMPT_UNSPECIFIED",
+ "LATEST"
+ ],
+ "location": "query",
+ "type": "string"
},
"states": {
+ "description": "When specified, only transfer runs with requested states are returned.",
"enum": [
"TRANSFER_STATE_UNSPECIFIED",
"PENDING",
@@ -1126,76 +698,74 @@
"FAILED",
"CANCELLED"
],
- "description": "When specified, only transfer runs with requested states are returned.",
- "type": "string",
+ "location": "query",
"repeated": true,
- "location": "query"
- },
- "pageSize": {
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs",
"path": "v1/{+parent}/runs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
- "description": "Returns information about running and completed jobs."
+ "response": {
+ "$ref": "ListTransferRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
}
},
"resources": {
"transferLogs": {
"methods": {
"list": {
- "path": "v1/{+parent}/transferLogs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
"description": "Returns user facing log messages for the data transfer run.",
- "response": {
- "$ref": "ListTransferLogsResponse"
- },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
- "parent": {
- "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"messageTypes": {
- "repeated": true,
- "location": "query",
+ "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
"enum": [
"MESSAGE_SEVERITY_UNSPECIFIED",
"INFO",
"WARNING",
"ERROR"
],
- "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "required": true,
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs"
+ "path": "v1/{+parent}/transferLogs",
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
}
}
}
@@ -1205,306 +775,205 @@
}
}
},
- "dataSources": {
- "methods": {
- "checkValidCreds": {
- "request": {
- "$ref": "CheckValidCredsRequest"
- },
- "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CheckValidCredsResponse"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/dataSources/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds",
- "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
- "path": "v1/{+name}:checkValidCreds"
- },
- "get": {
- "id": "bigquerydatatransfer.projects.dataSources.get",
- "path": "v1/{+name}",
- "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
- "httpMethod": "GET",
- "response": {
- "$ref": "DataSource"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/dataSources/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}"
- },
- "list": {
- "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
- "response": {
- "$ref": "ListDataSourcesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/projects/{projectsId}/dataSources",
- "path": "v1/{+parent}/dataSources",
- "id": "bigquerydatatransfer.projects.dataSources.list"
- }
- }
- },
"transferConfigs": {
"methods": {
- "scheduleRuns": {
- "request": {
- "$ref": "ScheduleTransferRunsRequest"
- },
- "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
- "response": {
- "$ref": "ScheduleTransferRunsResponse"
- },
+ "create": {
+ "description": "Creates a new data transfer configuration.",
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.transferConfigs.create",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
"parameters": {
+ "authorizationCode": {
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e\u0026scope=\u003cdata_source_scopes\u003e\u0026redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
+ "location": "query",
+ "type": "string"
+ },
"parent": {
- "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1/{+parent}/transferConfigs",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "httpMethod": "DELETE",
+ "id": "bigquerydatatransfer.projects.transferConfigs.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
- "path": "v1/{+parent}:scheduleRuns",
- "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns"
+ ]
},
"get": {
"description": "Returns information about a data transfer config.",
- "response": {
- "$ref": "TransferConfig"
- },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.transferConfigs.get",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
- "location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ "type": "string"
}
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "TransferConfig"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Returns information about all data transfers in the project.",
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.transferConfigs.list",
+ "parameterOrder": [
+ "parent"
],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.get"
+ "parameters": {
+ "dataSourceIds": {
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/transferConfigs",
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
"patch": {
- "request": {
- "$ref": "TransferConfig"
- },
"description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
"httpMethod": "PATCH",
+ "id": "bigquerydatatransfer.projects.transferConfigs.patch",
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "TransferConfig"
- },
"parameters": {
"authorizationCode": {
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string",
- "location": "query"
- },
- "updateMask": {
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e\u0026scope=\u003cdata_source_scopes\u003e\u0026redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
"location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
"type": "string"
},
"name": {
"description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "id": "bigquerydatatransfer.projects.transferConfigs.patch",
- "path": "v1/{+name}"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
"path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.delete",
- "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs."
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/transferConfigs",
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.transferConfigs.list",
- "description": "Returns information about all data transfers in the project.",
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "dataSourceIds": {
- "description": "When specified, only configurations of requested data sources are returned.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
- }
- }
- },
- "create": {
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "authorizationCode": {
- "location": "query",
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string"
- },
- "parent": {
- "location": "path",
- "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs",
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.transferConfigs.create",
- "description": "Creates a new data transfer configuration.",
"request": {
"$ref": "TransferConfig"
- }
+ },
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "scheduleRuns": {
+ "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
+ "httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}:scheduleRuns",
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ },
+ "response": {
+ "$ref": "ScheduleTransferRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
},
"resources": {
@@ -1512,83 +981,95 @@
"methods": {
"delete": {
"description": "Deletes the specified transfer run.",
- "response": {
- "$ref": "Empty"
- },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "httpMethod": "DELETE",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
"parameters": {
"name": {
- "location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
+ "type": "string"
}
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete"
+ ]
},
"get": {
- "response": {
- "$ref": "TransferRun"
- },
+ "description": "Returns information about the particular transfer run.",
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
- "location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
+ "type": "string"
}
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "TransferRun"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
- "description": "Returns information about the particular transfer run."
+ ]
},
"list": {
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
- "path": "v1/{+parent}/runs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
"description": "Returns information about running and completed jobs.",
- "response": {
- "$ref": "ListTransferRunsResponse"
- },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
"pageToken": {
"description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "runAttempt": {
+ "description": "Indicates how run attempts are to be pulled.",
+ "enum": [
+ "RUN_ATTEMPT_UNSPECIFIED",
+ "LATEST"
+ ],
+ "location": "query",
+ "type": "string"
},
"states": {
- "repeated": true,
- "location": "query",
+ "description": "When specified, only transfer runs with requested states are returned.",
"enum": [
"TRANSFER_STATE_UNSPECIFIED",
"PENDING",
@@ -1597,81 +1078,69 @@
"FAILED",
"CANCELLED"
],
- "description": "When specified, only transfer runs with requested states are returned.",
- "type": "string"
- },
- "pageSize": {
"location": "query",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer"
- },
- "runAttempt": {
- "enum": [
- "RUN_ATTEMPT_UNSPECIFIED",
- "LATEST"
- ],
- "description": "Indicates how run attempts are to be pulled.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ "repeated": true,
+ "type": "string"
}
- }
+ },
+ "path": "v1/{+parent}/runs",
+ "response": {
+ "$ref": "ListTransferRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
}
},
"resources": {
"transferLogs": {
"methods": {
"list": {
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
- "path": "v1/{+parent}/transferLogs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
"description": "Returns user facing log messages for the data transfer run.",
- "response": {
- "$ref": "ListTransferLogsResponse"
- },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
"parameters": {
- "pageSize": {
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"messageTypes": {
+ "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
"enum": [
"MESSAGE_SEVERITY_UNSPECIFIED",
"INFO",
"WARNING",
"ERROR"
],
- "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
- "type": "string",
+ "location": "query",
"repeated": true,
- "location": "query"
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "location": "query",
+ "type": "string"
},
"parent": {
"description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "required": true,
"type": "string"
}
},
+ "path": "v1/{+parent}/transferLogs",
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
@@ -1687,97 +1156,628 @@
}
}
},
- "parameters": {
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
+ "revision": "20180317",
+ "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
+ "schemas": {
+ "CheckValidCredsRequest": {
+ "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
+ "id": "CheckValidCredsRequest",
+ "properties": {},
+ "type": "object"
},
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
+ "CheckValidCredsResponse": {
+ "description": "A response indicating whether the credentials exist and are valid.",
+ "id": "CheckValidCredsResponse",
+ "properties": {
+ "hasValidCreds": {
+ "description": "If set to `true`, the credentials exist and are valid.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "DataSource": {
+ "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
+ "id": "DataSource",
+ "properties": {
+ "authorizationType": {
+ "description": "Indicates the type of authorization.",
+ "enum": [
+ "AUTHORIZATION_TYPE_UNSPECIFIED",
+ "AUTHORIZATION_CODE",
+ "GOOGLE_PLUS_AUTHORIZATION_CODE"
+ ],
+ "enumDescriptions": [
+ "Type unspecified.",
+ "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
+ "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
+ ],
+ "type": "string"
+ },
+ "clientId": {
+ "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
+ "type": "string"
+ },
+ "dataRefreshType": {
+ "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
+ "enum": [
+ "DATA_REFRESH_TYPE_UNSPECIFIED",
+ "SLIDING_WINDOW",
+ "CUSTOM_SLIDING_WINDOW"
+ ],
+ "enumDescriptions": [
+ "The data source won't support data auto refresh, which is default value.",
+ "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.",
+ "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
+ ],
+ "type": "string"
+ },
+ "dataSourceId": {
+ "description": "Data source id.",
+ "type": "string"
+ },
+ "defaultDataRefreshWindowDays": {
+ "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "defaultSchedule": {
+ "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
+ "type": "string"
+ },
+ "description": {
+ "description": "User friendly data source description string.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "User friendly data source name.",
+ "type": "string"
+ },
+ "helpUrl": {
+ "description": "Url for the help document for this data source.",
+ "type": "string"
+ },
+ "manualRunsDisabled": {
+ "description": "Disables backfilling and manual run scheduling\nfor the data source.",
+ "type": "boolean"
+ },
+ "minimumScheduleInterval": {
+ "description": "The minimum interval for scheduler to schedule runs.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "name": {
+ "description": "Data source resource name.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Data source parameters.",
+ "items": {
+ "$ref": "DataSourceParameter"
+ },
+ "type": "array"
+ },
+ "scopes": {
+ "description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportsCustomSchedule": {
+ "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.",
+ "type": "boolean"
+ },
+ "supportsMultipleTransfers": {
+ "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets.",
+ "type": "boolean"
+ },
+ "transferType": {
+ "description": "Deprecated. This field has no effect.",
+ "enum": [
+ "TRANSFER_TYPE_UNSPECIFIED",
+ "BATCH",
+ "STREAMING"
+ ],
+ "enumDescriptions": [
+ "Invalid or Unknown transfer type placeholder.",
+ "Batch data transfer.",
+ "Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project."
+ ],
+ "type": "string"
+ },
+ "updateDeadlineSeconds": {
+ "description": "The number of seconds to wait for an update from the data source\nbefore BigQuery marks the transfer as failed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "DataSourceParameter": {
+ "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
+ "id": "DataSourceParameter",
+ "properties": {
+ "allowedValues": {
+ "description": "All possible values for the parameter.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "Parameter description.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Parameter display name in the user interface.",
+ "type": "string"
+ },
+ "fields": {
+ "description": "When parameter is a record, describes child fields.",
+ "items": {
+ "$ref": "DataSourceParameter"
+ },
+ "type": "array"
+ },
+ "immutable": {
+ "description": "Cannot be changed after initial creation.",
+ "type": "boolean"
+ },
+ "maxValue": {
+ "description": "For integer and double values specifies maxminum allowed value.",
+ "format": "double",
+ "type": "number"
+ },
+ "minValue": {
+ "description": "For integer and double values specifies minimum allowed value.",
+ "format": "double",
+ "type": "number"
+ },
+ "paramId": {
+ "description": "Parameter identifier.",
+ "type": "string"
+ },
+ "recurse": {
+ "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
+ "type": "boolean"
+ },
+ "repeated": {
+ "description": "Can parameter have multiple values.",
+ "type": "boolean"
+ },
+ "required": {
+ "description": "Is parameter required.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Parameter type.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "STRING",
+ "INTEGER",
+ "DOUBLE",
+ "BOOLEAN",
+ "RECORD",
+ "PLUS_PAGE"
+ ],
+ "enumDescriptions": [
+ "Type unspecified.",
+ "String parameter.",
+ "Integer parameter (64-bits).\nWill be serialized to json as string.",
+ "Double precision floating point parameter.",
+ "Boolean parameter.",
+ "Record parameter.",
+ "Page ID for a Google+ Page."
+ ],
+ "type": "string"
+ },
+ "validationDescription": {
+ "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.",
+ "type": "string"
+ },
+ "validationHelpUrl": {
+ "description": "URL to a help document to further explain the naming requirements.",
+ "type": "string"
+ },
+ "validationRegex": {
+ "description": "Regular expression which can be used for parameter validation.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
+ "ListDataSourcesResponse": {
+ "description": "Returns list of supported data sources and their metadata.",
+ "id": "ListDataSourcesResponse",
+ "properties": {
+ "dataSources": {
+ "description": "List of supported data sources and their transfer settings.",
+ "items": {
+ "$ref": "DataSource"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "ListTransferConfigsResponse": {
+ "description": "The returned list of pipelines in the project.",
+ "id": "ListTransferConfigsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.",
+ "type": "string"
+ },
+ "transferConfigs": {
+ "description": "Output only. The stored pipeline transfer configurations.",
+ "items": {
+ "$ref": "TransferConfig"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "ListTransferLogsResponse": {
+ "description": "The returned list transfer run messages.",
+ "id": "ListTransferLogsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.",
+ "type": "string"
+ },
+ "transferMessages": {
+ "description": "Output only. The stored pipeline transfer messages.",
+ "items": {
+ "$ref": "TransferMessage"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ "ListTransferRunsResponse": {
+ "description": "The returned list of pipelines in the project.",
+ "id": "ListTransferRunsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.",
+ "type": "string"
+ },
+ "transferRuns": {
+ "description": "Output only. The stored pipeline transfer runs.",
+ "items": {
+ "$ref": "TransferRun"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
+ "properties": {
+ "displayName": {
+ "description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
+ "ScheduleTransferRunsRequest": {
+ "description": "A request to schedule transfer runs for a time range.",
+ "id": "ScheduleTransferRunsRequest",
+ "properties": {
+ "endTime": {
+ "description": "End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
+ "ScheduleTransferRunsResponse": {
+ "description": "A response to schedule transfer runs for a time range.",
+ "id": "ScheduleTransferRunsResponse",
+ "properties": {
+ "runs": {
+ "description": "The transfer runs that were scheduled.",
+ "items": {
+ "$ref": "TransferRun"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TransferConfig": {
+ "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.\nNext id: 21",
+ "id": "TransferConfig",
+ "properties": {
+ "dataRefreshWindowDays": {
+ "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dataSourceId": {
+ "description": "Data source id. Cannot be changed once data transfer is created.",
+ "type": "string"
+ },
+ "datasetRegion": {
+ "description": "Output only. Region in which BigQuery dataset is located.",
+ "type": "string"
+ },
+ "destinationDatasetId": {
+ "description": "The BigQuery target dataset id.",
+ "type": "string"
+ },
+ "disabled": {
+ "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
+ "type": "boolean"
+ },
+ "displayName": {
+ "description": "User specified display name for the data transfer.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
+ "type": "string"
+ },
+ "nextRunTime": {
+ "description": "Output only. Next time when data transfer will run.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Data transfer specific parameters.",
+ "type": "object"
+ },
+ "schedule": {
+ "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
+ "type": "string"
+ },
+ "state": {
+ "description": "Output only. State of the most recently updated transfer run.",
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "enumDescriptions": [
+ "State placeholder.",
+ "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
+ "Data transfer is in progress.",
+ "Data transfer completed successsfully.",
+ "Data transfer failed.",
+ "Data transfer is cancelled."
+ ],
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. Data transfer modification time. Ignored by server on input.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "userId": {
+ "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TransferMessage": {
+ "description": "Represents a user facing message for a particular data transfer run.",
+ "id": "TransferMessage",
+ "properties": {
+ "messageText": {
+ "description": "Message text.",
+ "type": "string"
+ },
+ "messageTime": {
+ "description": "Time when message was logged.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "severity": {
+ "description": "Message severity.",
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "enumDescriptions": [
+ "No severity specified.",
+ "Informational message.",
+ "Warning message.",
+ "Error message."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TransferRun": {
+ "description": "Represents a data transfer run.\nNext id: 27",
+ "id": "TransferRun",
+ "properties": {
+ "dataSourceId": {
+ "description": "Output only. Data source id.",
+ "type": "string"
+ },
+ "destinationDatasetId": {
+ "description": "Output only. The BigQuery target dataset id.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Output only. Time when transfer run ended.\nParameter ignored by server for input requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "errorStatus": {
+ "$ref": "Status",
+ "description": "Status of the transfer run."
+ },
+ "name": {
+ "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Output only. Data transfer specific parameters.",
+ "type": "object"
+ },
+ "runTime": {
+ "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "schedule": {
+ "description": "Output only. Describes the schedule of this transfer run if it was\ncreated as part of a regular schedule. For batch transfer runs that are\nscheduled manually, this is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.",
+ "type": "string"
+ },
+ "scheduleTime": {
+ "description": "Minimum time after which a transfer run can be started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Output only. Time when transfer run was started.\nParameter ignored by server for input requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "description": "Data transfer run state. Ignored for input requests.",
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "enumDescriptions": [
+ "State placeholder.",
+ "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
+ "Data transfer is in progress.",
+ "Data transfer completed successsfully.",
+ "Data transfer failed.",
+ "Data transfer is cancelled."
+ ],
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. Last time the data transfer run state was updated.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "userId": {
+ "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
},
+ "servicePath": "",
+ "title": "BigQuery Data Transfer API",
"version": "v1",
- "baseUrl": "https://bigquerydatatransfer.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
- "servicePath": ""
-}
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go b/vendor/google.golang.org/api/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go
index 908c508f0..b28484300 100644
--- a/vendor/google.golang.org/api/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go
+++ b/vendor/google.golang.org/api/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go
@@ -346,10 +346,7 @@ type DataSource struct {
// to different BigQuery targets.
SupportsMultipleTransfers bool `json:"supportsMultipleTransfers,omitempty"`
- // TransferType: Transfer type. Currently supports only batch
- // transfers,
- // which are transfers that use the BigQuery batch APIs (load or
- // query) to ingest the data.
+ // TransferType: Deprecated. This field has no effect.
//
// Possible values:
// "TRANSFER_TYPE_UNSPECIFIED" - Invalid or Unknown transfer type
@@ -726,6 +723,11 @@ func (s *ListTransferRunsResponse) MarshalJSON() ([]byte, error) {
// Location: A resource that represents Google Cloud Platform location.
type Location struct {
+ // DisplayName: The friendly name for this location, typically a nearby
+ // city name.
+ // For example, "Tokyo".
+ DisplayName string `json:"displayName,omitempty"`
+
// Labels: Cross-service attributes for the location. For example
//
// {"cloud.googleapis.com/region": "us-east1"}
@@ -749,7 +751,7 @@ type Location struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Labels") to
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -757,10 +759,10 @@ type Location struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Labels") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
@@ -970,6 +972,7 @@ func (s *Status) MarshalJSON() ([]byte, error) {
// `destination_dataset_id` is created when needed and shared with
// the
// appropriate data source service account.
+// Next id: 21
type TransferConfig struct {
// DataRefreshWindowDays: The number of days to look back to
// automatically refresh the data.
@@ -1728,7 +1731,7 @@ type ProjectsLocationsGetCall struct {
header_ http.Header
}
-// Get: Get information about a location.
+// Get: Gets information about a location.
func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall {
c := &ProjectsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -1829,7 +1832,7 @@ func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location,
}
return ret, nil
// {
- // "description": "Get information about a location.",
+ // "description": "Gets information about a location.",
// "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
// "httpMethod": "GET",
// "id": "bigquerydatatransfer.projects.locations.get",
@@ -2704,7 +2707,6 @@ func (c *ProjectsLocationsTransferConfigsCreateCall) Do(opts ...googleapi.CallOp
// "$ref": "TransferConfig"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
// "https://www.googleapis.com/auth/cloud-platform"
// ]
// }
@@ -3363,7 +3365,6 @@ func (c *ProjectsLocationsTransferConfigsPatchCall) Do(opts ...googleapi.CallOpt
// "$ref": "TransferConfig"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
// "https://www.googleapis.com/auth/cloud-platform"
// ]
// }
@@ -4400,7 +4401,6 @@ func (c *ProjectsTransferConfigsCreateCall) Do(opts ...googleapi.CallOption) (*T
// "$ref": "TransferConfig"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
// "https://www.googleapis.com/auth/cloud-platform"
// ]
// }
@@ -5059,7 +5059,6 @@ func (c *ProjectsTransferConfigsPatchCall) Do(opts ...googleapi.CallOption) (*Tr
// "$ref": "TransferConfig"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
// "https://www.googleapis.com/auth/cloud-platform"
// ]
// }
diff --git a/vendor/google.golang.org/api/blogger/v2/blogger-api.json b/vendor/google.golang.org/api/blogger/v2/blogger-api.json
index 74e820248..731ba13fa 100644
--- a/vendor/google.golang.org/api/blogger/v2/blogger-api.json
+++ b/vendor/google.golang.org/api/blogger/v2/blogger-api.json
@@ -1,923 +1,923 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/Mm4a0u3lPNBqEzKCYhfhIpC2Mw4\"",
- "discoveryVersion": "v1",
- "id": "blogger:v2",
- "name": "blogger",
- "version": "v2",
- "revision": "20150422",
- "title": "Blogger API",
- "description": "API for access to the data within Blogger.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/blogger-16.png",
- "x32": "https://www.google.com/images/icons/product/blogger-32.png"
- },
- "documentationLink": "https://developers.google.com/blogger/docs/2.0/json/getting_started",
- "labels": [
- "limited_availability"
- ],
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/blogger/v2/",
- "basePath": "/blogger/v2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "blogger/v2/",
- "batchPath": "batch/blogger/v2",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/blogger": {
- "description": "Manage your Blogger account"
- }
- }
- }
- },
- "schemas": {
- "Blog": {
- "id": "Blog",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "The description of this blog. This is displayed underneath the title."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#blog",
- "default": "blogger#blog"
- },
- "locale": {
- "type": "object",
- "description": "The locale this Blog is set to.",
- "properties": {
- "country": {
- "type": "string",
- "description": "The country this blog's locale is set to."
- },
- "language": {
- "type": "string",
- "description": "The language this blog is authored in."
- },
- "variant": {
- "type": "string",
- "description": "The language variant this blog is authored in."
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/blogger": {
+ "description": "Manage your Blogger account"
+ }
}
- }
+ }
+ },
+ "basePath": "/blogger/v2/",
+ "baseUrl": "https://www.googleapis.com/blogger/v2/",
+ "batchPath": "batch/blogger/v2",
+ "description": "API for access to the data within Blogger.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/blogger/docs/2.0/json/getting_started",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/Mm4a0u3lPNBqEzKCYhfhIpC2Mw4\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/blogger-16.png",
+ "x32": "https://www.google.com/images/icons/product/blogger-32.png"
+ },
+ "id": "blogger:v2",
+ "kind": "discovery#restDescription",
+ "labels": [
+ "limited_availability"
+ ],
+ "name": "blogger",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
},
- "name": {
- "type": "string",
- "description": "The name of this blog. This is displayed as the title."
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "blogs": {
+ "methods": {
+ "get": {
+ "description": "Gets one blog by id.",
+ "httpMethod": "GET",
+ "id": "blogger.blogs.get",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the blog to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}",
+ "response": {
+ "$ref": "Blog"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
+ }
+ },
+ "comments": {
+ "methods": {
+ "get": {
+ "description": "Gets one comment by id.",
+ "httpMethod": "GET",
+ "id": "blogger.comments.get",
+ "parameterOrder": [
+ "blogId",
+ "postId",
+ "commentId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to containing the comment.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "commentId": {
+ "description": "The ID of the comment to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "ID of the post to fetch posts from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
+ "response": {
+ "$ref": "Comment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the comments for a blog, possibly filtered.",
+ "httpMethod": "GET",
+ "id": "blogger.comments.list",
+ "parameterOrder": [
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch comments from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "fetchBodies": {
+ "description": "Whether the body content of the comments is included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "Maximum number of comments to include in the result.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token if request is paged.",
+ "location": "query",
+ "type": "string"
+ },
+ "postId": {
+ "description": "ID of the post to fetch posts from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/comments",
+ "response": {
+ "$ref": "CommentList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
+ }
},
"pages": {
- "type": "object",
- "description": "The container of pages in this blog.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the container for pages in this blog."
- },
- "totalItems": {
- "type": "integer",
- "description": "The count of pages in this blog.",
- "format": "int32"
+ "methods": {
+ "get": {
+ "description": "Gets one blog page by id.",
+ "httpMethod": "GET",
+ "id": "blogger.pages.get",
+ "parameterOrder": [
+ "blogId",
+ "pageId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog containing the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/pages/{pageId}",
+ "response": {
+ "$ref": "Page"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "list": {
+ "description": "Retrieves pages for a blog, possibly filtered.",
+ "httpMethod": "GET",
+ "id": "blogger.pages.list",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch pages from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "fetchBodies": {
+ "description": "Whether to retrieve the Page bodies.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "blogs/{blogId}/pages",
+ "response": {
+ "$ref": "PageList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
}
- }
},
"posts": {
- "type": "object",
- "description": "The container of posts in this blog.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the container for posts in this blog."
- },
- "totalItems": {
- "type": "integer",
- "description": "The count of posts in this blog.",
- "format": "int32"
+ "methods": {
+ "get": {
+ "description": "Get a post by id.",
+ "httpMethod": "GET",
+ "id": "blogger.posts.get",
+ "parameterOrder": [
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch the post from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "The ID of the post",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}",
+ "response": {
+ "$ref": "Post"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of posts, possibly filtered.",
+ "httpMethod": "GET",
+ "id": "blogger.posts.list",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch posts from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "fetchBodies": {
+ "description": "Whether the body content of posts is included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "Maximum number of posts to fetch.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token if the request is paged.",
+ "location": "query",
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts",
+ "response": {
+ "$ref": "PostList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
}
- }
},
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this blog was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this blog was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL where this blog is published."
- }
- }
- },
- "BlogList": {
- "id": "BlogList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The list of Blogs this user has Authorship or Admin rights over.",
- "items": {
- "$ref": "Blog"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#blogList",
- "default": "blogger#blogList"
- }
- }
- },
- "Comment": {
- "id": "Comment",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Comment.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
+ "users": {
+ "methods": {
+ "get": {
+ "description": "Gets one user by id.",
+ "httpMethod": "GET",
+ "id": "blogger.users.get",
+ "parameterOrder": [
+ "userId"
+ ],
+ "parameters": {
+ "userId": {
+ "description": "The ID of the user to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}",
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
},
- "id": {
- "type": "string",
- "description": "The identifier of the Comment creator."
- },
- "image": {
- "type": "object",
- "description": "The comment creator's avatar.",
- "properties": {
+ "resources": {
+ "blogs": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of blogs, possibly filtered.",
+ "httpMethod": "GET",
+ "id": "blogger.users.blogs.list",
+ "parameterOrder": [
+ "userId"
+ ],
+ "parameters": {
+ "userId": {
+ "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}/blogs",
+ "response": {
+ "$ref": "BlogList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20150422",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Blog": {
+ "id": "Blog",
+ "properties": {
+ "description": {
+ "description": "The description of this blog. This is displayed underneath the title.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier for this resource.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "blogger#blog",
+ "description": "The kind of this entry. Always blogger#blog",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale this Blog is set to.",
+ "properties": {
+ "country": {
+ "description": "The country this blog's locale is set to.",
+ "type": "string"
+ },
+ "language": {
+ "description": "The language this blog is authored in.",
+ "type": "string"
+ },
+ "variant": {
+ "description": "The language variant this blog is authored in.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "name": {
+ "description": "The name of this blog. This is displayed as the title.",
+ "type": "string"
+ },
+ "pages": {
+ "description": "The container of pages in this blog.",
+ "properties": {
+ "selfLink": {
+ "description": "The URL of the container for pages in this blog.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The count of pages in this blog.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "posts": {
+ "description": "The container of posts in this blog.",
+ "properties": {
+ "selfLink": {
+ "description": "The URL of the container for posts in this blog.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The count of posts in this blog.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "published": {
+ "description": "RFC 3339 date-time when this blog was published.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "RFC 3339 date-time when this blog was last updated.",
+ "format": "date-time",
+ "type": "string"
+ },
"url": {
- "type": "string",
- "description": "The comment creator's avatar URL."
+ "description": "The URL where this blog is published.",
+ "type": "string"
}
- }
},
- "url": {
- "type": "string",
- "description": "The URL of the Comment creator's Profile page."
- }
- }
+ "type": "object"
},
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this comment.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the blog containing this comment.",
- "format": "int64"
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The actual content of the comment. May include HTML markup."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource.",
- "format": "int64"
- },
- "inReplyTo": {
- "type": "object",
- "description": "Data about the comment this is in reply to.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identified of the parent of this comment.",
- "format": "int64"
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#comment",
- "default": "blogger#comment"
- },
- "post": {
- "type": "object",
- "description": "Data about the post containing this comment.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the post containing this comment.",
- "format": "int64"
- }
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this comment was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this comment was last updated.",
- "format": "date-time"
- }
- }
- },
- "CommentList": {
- "id": "CommentList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The List of Comments for a Post.",
- "items": {
- "$ref": "Comment"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#commentList",
- "default": "blogger#commentList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- },
- "prevPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the previous page, if one exists."
- }
- }
- },
- "Page": {
- "id": "Page",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Page.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
+ "BlogList": {
+ "id": "BlogList",
+ "properties": {
+ "items": {
+ "description": "The list of Blogs this user has Authorship or Admin rights over.",
+ "items": {
+ "$ref": "Blog"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#blogList",
+ "description": "The kind of this entity. Always blogger#blogList",
+ "type": "string"
+ }
},
- "id": {
- "type": "string",
- "description": "The identifier of the Page creator."
+ "type": "object"
+ },
+ "Comment": {
+ "id": "Comment",
+ "properties": {
+ "author": {
+ "description": "The author of this Comment.",
+ "properties": {
+ "displayName": {
+ "description": "The display name.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier of the Comment creator.",
+ "type": "string"
+ },
+ "image": {
+ "description": "The comment creator's avatar.",
+ "properties": {
+ "url": {
+ "description": "The comment creator's avatar URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "url": {
+ "description": "The URL of the Comment creator's Profile page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "blog": {
+ "description": "Data about the blog containing this comment.",
+ "properties": {
+ "id": {
+ "description": "The identifier of the blog containing this comment.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "content": {
+ "description": "The actual content of the comment. May include HTML markup.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier for this resource.",
+ "format": "int64",
+ "type": "string"
+ },
+ "inReplyTo": {
+ "description": "Data about the comment this is in reply to.",
+ "properties": {
+ "id": {
+ "description": "The identified of the parent of this comment.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "kind": {
+ "default": "blogger#comment",
+ "description": "The kind of this entry. Always blogger#comment",
+ "type": "string"
+ },
+ "post": {
+ "description": "Data about the post containing this comment.",
+ "properties": {
+ "id": {
+ "description": "The identifier of the post containing this comment.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "published": {
+ "description": "RFC 3339 date-time when this comment was published.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "RFC 3339 date-time when this comment was last updated.",
+ "format": "date-time",
+ "type": "string"
+ }
},
- "image": {
- "type": "object",
- "description": "The page author's avatar.",
- "properties": {
+ "type": "object"
+ },
+ "CommentList": {
+ "id": "CommentList",
+ "properties": {
+ "items": {
+ "description": "The List of Comments for a Post.",
+ "items": {
+ "$ref": "Comment"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#commentList",
+ "description": "The kind of this entry. Always blogger#commentList",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to fetch the next page, if one exists.",
+ "type": "string"
+ },
+ "prevPageToken": {
+ "description": "Pagination token to fetch the previous page, if one exists.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Page": {
+ "id": "Page",
+ "properties": {
+ "author": {
+ "description": "The author of this Page.",
+ "properties": {
+ "displayName": {
+ "description": "The display name.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier of the Page creator.",
+ "type": "string"
+ },
+ "image": {
+ "description": "The page author's avatar.",
+ "properties": {
+ "url": {
+ "description": "The page author's avatar URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "url": {
+ "description": "The URL of the Page creator's Profile page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "blog": {
+ "description": "Data about the blog containing this Page.",
+ "properties": {
+ "id": {
+ "description": "The identifier of the blog containing this page.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "content": {
+ "description": "The body content of this Page, in HTML.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier for this resource.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "blogger#page",
+ "description": "The kind of this entity. Always blogger#page",
+ "type": "string"
+ },
+ "published": {
+ "description": "RFC 3339 date-time when this Page was published.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of this entity. This is the name displayed in the Admin user interface.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "RFC 3339 date-time when this Page was last updated.",
+ "format": "date-time",
+ "type": "string"
+ },
"url": {
- "type": "string",
- "description": "The page author's avatar URL."
+ "description": "The URL that this Page is displayed at.",
+ "type": "string"
}
- }
},
- "url": {
- "type": "string",
- "description": "The URL of the Page creator's Profile page."
- }
- }
+ "type": "object"
},
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this Page.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the blog containing this page.",
- "format": "int64"
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The body content of this Page, in HTML."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#page",
- "default": "blogger#page"
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this Page was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "title": {
- "type": "string",
- "description": "The title of this entity. This is the name displayed in the Admin user interface."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this Page was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL that this Page is displayed at."
- }
- }
- },
- "PageList": {
- "id": "PageList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The list of Pages for a Blog.",
- "items": {
- "$ref": "Page"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#pageList",
- "default": "blogger#pageList"
- }
- }
- },
- "Post": {
- "id": "Post",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Post.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
+ "PageList": {
+ "id": "PageList",
+ "properties": {
+ "items": {
+ "description": "The list of Pages for a Blog.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#pageList",
+ "description": "The kind of this entity. Always blogger#pageList",
+ "type": "string"
+ }
},
- "id": {
- "type": "string",
- "description": "The identifier of the Post creator."
- },
- "image": {
- "type": "object",
- "description": "The Post author's avatar.",
- "properties": {
+ "type": "object"
+ },
+ "Post": {
+ "id": "Post",
+ "properties": {
+ "author": {
+ "description": "The author of this Post.",
+ "properties": {
+ "displayName": {
+ "description": "The display name.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier of the Post creator.",
+ "type": "string"
+ },
+ "image": {
+ "description": "The Post author's avatar.",
+ "properties": {
+ "url": {
+ "description": "The Post author's avatar URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "url": {
+ "description": "The URL of the Post creator's Profile page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "blog": {
+ "description": "Data about the blog containing this Post.",
+ "properties": {
+ "id": {
+ "description": "The identifier of the Blog that contains this Post.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "content": {
+ "description": "The content of the Post. May contain HTML markup.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier of this Post.",
+ "format": "int64",
+ "type": "string"
+ },
+ "kind": {
+ "default": "blogger#post",
+ "description": "The kind of this entity. Always blogger#post",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The list of labels this Post was tagged with.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "published": {
+ "description": "RFC 3339 date-time when this Post was published.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "replies": {
+ "description": "The container of comments on this Post.",
+ "properties": {
+ "selfLink": {
+ "description": "The URL of the comments on this post.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The count of comments on this post.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the Post.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "RFC 3339 date-time when this Post was last updated.",
+ "format": "date-time",
+ "type": "string"
+ },
"url": {
- "type": "string",
- "description": "The Post author's avatar URL."
+ "description": "The URL where this Post is displayed.",
+ "type": "string"
}
- }
},
- "url": {
- "type": "string",
- "description": "The URL of the Post creator's Profile page."
- }
- }
+ "type": "object"
},
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this Post.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the Blog that contains this Post.",
- "format": "int64"
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The content of the Post. May contain HTML markup."
- },
- "id": {
- "type": "string",
- "description": "The identifier of this Post.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#post",
- "default": "blogger#post"
- },
- "labels": {
- "type": "array",
- "description": "The list of labels this Post was tagged with.",
- "items": {
- "type": "string"
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this Post was published.",
- "format": "date-time"
- },
- "replies": {
- "type": "object",
- "description": "The container of comments on this Post.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the comments on this post."
- },
- "totalItems": {
- "type": "string",
- "description": "The count of comments on this post.",
- "format": "int64"
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "title": {
- "type": "string",
- "description": "The title of the Post."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this Post was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL where this Post is displayed."
- }
- }
- },
- "PostList": {
- "id": "PostList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The list of Posts for this Blog.",
- "items": {
- "$ref": "Post"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postList",
- "default": "blogger#postList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- },
- "prevPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the previous page, if one exists."
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "properties": {
- "about": {
- "type": "string",
- "description": "Profile summary information."
- },
- "blogs": {
- "type": "object",
- "description": "The container of blogs for this user.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the Blogs for this user."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "The timestamp of when this profile was created, in seconds since epoch.",
- "format": "date-time"
- },
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this User."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#user",
- "default": "blogger#user"
- },
- "locale": {
- "type": "object",
- "description": "This user's locale",
- "properties": {
- "country": {
- "type": "string",
- "description": "The user's country setting."
- },
- "language": {
- "type": "string",
- "description": "The user's language setting."
- },
- "variant": {
- "type": "string",
- "description": "The user's language variant setting."
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "url": {
- "type": "string",
- "description": "The user's profile page."
- }
- }
- }
- },
- "resources": {
- "blogs": {
- "methods": {
- "get": {
- "id": "blogger.blogs.get",
- "path": "blogs/{blogId}",
- "httpMethod": "GET",
- "description": "Gets one blog by id.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "Blog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "comments": {
- "methods": {
- "get": {
- "id": "blogger.comments.get",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
- "httpMethod": "GET",
- "description": "Gets one comment by id.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to containing the comment.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to get.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "ID of the post to fetch posts from.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.comments.list",
- "path": "blogs/{blogId}/posts/{postId}/comments",
- "httpMethod": "GET",
- "description": "Retrieves the comments for a blog, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch comments from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of the comments is included.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of comments to include in the result.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if request is paged.",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "ID of the post to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "CommentList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "pages": {
- "methods": {
- "get": {
- "id": "blogger.pages.get",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "GET",
- "description": "Gets one blog page by id.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog containing the page.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.pages.list",
- "path": "blogs/{blogId}/pages",
- "httpMethod": "GET",
- "description": "Retrieves pages for a blog, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch pages from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether to retrieve the Page bodies.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "PageList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "posts": {
- "methods": {
- "get": {
- "id": "blogger.posts.get",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "GET",
- "description": "Get a post by id.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch the post from.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the post",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.posts.list",
- "path": "blogs/{blogId}/posts",
- "httpMethod": "GET",
- "description": "Retrieves a list of posts, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of posts is included.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of posts to fetch.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if the request is paged.",
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "PostList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "get": {
- "id": "blogger.users.get",
- "path": "users/{userId}",
- "httpMethod": "GET",
- "description": "Gets one user by id.",
- "parameters": {
- "userId": {
- "type": "string",
- "description": "The ID of the user to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- },
- "resources": {
- "blogs": {
- "methods": {
- "list": {
- "id": "blogger.users.blogs.list",
- "path": "users/{userId}/blogs",
- "httpMethod": "GET",
- "description": "Retrieves a list of blogs, possibly filtered.",
- "parameters": {
- "userId": {
- "type": "string",
- "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- "required": true,
- "location": "path"
+ "PostList": {
+ "id": "PostList",
+ "properties": {
+ "items": {
+ "description": "The list of Posts for this Blog.",
+ "items": {
+ "$ref": "Post"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#postList",
+ "description": "The kind of this entity. Always blogger#postList",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to fetch the next page, if one exists.",
+ "type": "string"
+ },
+ "prevPageToken": {
+ "description": "Pagination token to fetch the previous page, if one exists.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "BlogList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
+ },
+ "type": "object"
+ },
+ "User": {
+ "id": "User",
+ "properties": {
+ "about": {
+ "description": "Profile summary information.",
+ "type": "string"
+ },
+ "blogs": {
+ "description": "The container of blogs for this user.",
+ "properties": {
+ "selfLink": {
+ "description": "The URL of the Blogs for this user.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "created": {
+ "description": "The timestamp of when this profile was created, in seconds since epoch.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier for this User.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "blogger#user",
+ "description": "The kind of this entity. Always blogger#user",
+ "type": "string"
+ },
+ "locale": {
+ "description": "This user's locale",
+ "properties": {
+ "country": {
+ "description": "The user's country setting.",
+ "type": "string"
+ },
+ "language": {
+ "description": "The user's language setting.",
+ "type": "string"
+ },
+ "variant": {
+ "description": "The user's language variant setting.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The user's profile page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
- }
- }
-}
+ },
+ "servicePath": "blogger/v2/",
+ "title": "Blogger API",
+ "version": "v2"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/blogger/v3/blogger-api.json b/vendor/google.golang.org/api/blogger/v3/blogger-api.json
index 795f53243..39b70c175 100644
--- a/vendor/google.golang.org/api/blogger/v3/blogger-api.json
+++ b/vendor/google.golang.org/api/blogger/v3/blogger-api.json
@@ -1,2507 +1,2507 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/Goh5bsNuqq7lTY-yMf_QcKSL760\"",
- "discoveryVersion": "v1",
- "id": "blogger:v3",
- "name": "blogger",
- "version": "v3",
- "revision": "20150422",
- "title": "Blogger API",
- "description": "API for access to the data within Blogger.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/blogger-16.png",
- "x32": "https://www.google.com/images/icons/product/blogger-32.png"
- },
- "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started",
- "labels": [
- "limited_availability"
- ],
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/blogger/v3/",
- "basePath": "/blogger/v3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "blogger/v3/",
- "batchPath": "batch/blogger/v3",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/blogger": {
- "description": "Manage your Blogger account"
- },
- "https://www.googleapis.com/auth/blogger.readonly": {
- "description": "View your Blogger account"
- }
- }
- }
- },
- "schemas": {
- "Blog": {
- "id": "Blog",
- "type": "object",
- "properties": {
- "customMetaData": {
- "type": "string",
- "description": "The JSON custom meta-data for the Blog"
- },
- "description": {
- "type": "string",
- "description": "The description of this blog. This is displayed underneath the title."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#blog",
- "default": "blogger#blog"
- },
- "locale": {
- "type": "object",
- "description": "The locale this Blog is set to.",
- "properties": {
- "country": {
- "type": "string",
- "description": "The country this blog's locale is set to."
- },
- "language": {
- "type": "string",
- "description": "The language this blog is authored in."
- },
- "variant": {
- "type": "string",
- "description": "The language variant this blog is authored in."
- }
- }
- },
- "name": {
- "type": "string",
- "description": "The name of this blog. This is displayed as the title."
- },
- "pages": {
- "type": "object",
- "description": "The container of pages in this blog.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the container for pages in this blog."
- },
- "totalItems": {
- "type": "integer",
- "description": "The count of pages in this blog.",
- "format": "int32"
- }
- }
- },
- "posts": {
- "type": "object",
- "description": "The container of posts in this blog.",
- "properties": {
- "items": {
- "type": "array",
- "description": "The List of Posts for this Blog.",
- "items": {
- "$ref": "Post"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The URL of the container for posts in this blog."
- },
- "totalItems": {
- "type": "integer",
- "description": "The count of posts in this blog.",
- "format": "int32"
- }
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this blog was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "status": {
- "type": "string",
- "description": "The status of the blog."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this blog was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL where this blog is published."
- }
- }
- },
- "BlogList": {
- "id": "BlogList",
- "type": "object",
- "properties": {
- "blogUserInfos": {
- "type": "array",
- "description": "Admin level list of blog per-user information",
- "items": {
- "$ref": "BlogUserInfo"
- }
- },
- "items": {
- "type": "array",
- "description": "The list of Blogs this user has Authorship or Admin rights over.",
- "items": {
- "$ref": "Blog"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#blogList",
- "default": "blogger#blogList"
- }
- }
- },
- "BlogPerUserInfo": {
- "id": "BlogPerUserInfo",
- "type": "object",
- "properties": {
- "blogId": {
- "type": "string",
- "description": "ID of the Blog resource"
- },
- "hasAdminAccess": {
- "type": "boolean",
- "description": "True if the user has Admin level access to the blog."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#blogPerUserInfo",
- "default": "blogger#blogPerUserInfo"
- },
- "photosAlbumKey": {
- "type": "string",
- "description": "The Photo Album Key for the user when adding photos to the blog"
- },
- "role": {
- "type": "string",
- "description": "Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER)."
- },
- "userId": {
- "type": "string",
- "description": "ID of the User"
- }
- }
- },
- "BlogUserInfo": {
- "id": "BlogUserInfo",
- "type": "object",
- "properties": {
- "blog": {
- "$ref": "Blog",
- "description": "The Blog resource."
- },
- "blog_user_info": {
- "$ref": "BlogPerUserInfo",
- "description": "Information about a User for the Blog."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#blogUserInfo",
- "default": "blogger#blogUserInfo"
- }
- }
- },
- "Comment": {
- "id": "Comment",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Comment.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier of the Comment creator."
- },
- "image": {
- "type": "object",
- "description": "The comment creator's avatar.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The comment creator's avatar URL."
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/blogger": {
+ "description": "Manage your Blogger account"
+ },
+ "https://www.googleapis.com/auth/blogger.readonly": {
+ "description": "View your Blogger account"
}
- }
- },
- "url": {
- "type": "string",
- "description": "The URL of the Comment creator's Profile page."
}
- }
- },
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this comment.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the blog containing this comment."
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The actual content of the comment. May include HTML markup."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource."
- },
- "inReplyTo": {
- "type": "object",
- "description": "Data about the comment this is in reply to.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identified of the parent of this comment."
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#comment",
- "default": "blogger#comment"
- },
- "post": {
- "type": "object",
- "description": "Data about the post containing this comment.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the post containing this comment."
- }
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this comment was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "status": {
- "type": "string",
- "description": "The status of the comment (only populated for admin users)"
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this comment was last updated.",
- "format": "date-time"
}
- }
},
- "CommentList": {
- "id": "CommentList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the response."
- },
- "items": {
- "type": "array",
- "description": "The List of Comments for a Post.",
- "items": {
- "$ref": "Comment"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#commentList",
- "default": "blogger#commentList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- },
- "prevPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the previous page, if one exists."
- }
- }
+ "basePath": "/blogger/v3/",
+ "baseUrl": "https://www.googleapis.com/blogger/v3/",
+ "batchPath": "batch/blogger/v3",
+ "description": "API for access to the data within Blogger.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/Goh5bsNuqq7lTY-yMf_QcKSL760\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/blogger-16.png",
+ "x32": "https://www.google.com/images/icons/product/blogger-32.png"
},
- "Page": {
- "id": "Page",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Page.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier of the Page creator."
- },
- "image": {
- "type": "object",
- "description": "The page author's avatar.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The page author's avatar URL."
- }
- }
- },
- "url": {
- "type": "string",
- "description": "The URL of the Page creator's Profile page."
- }
- }
- },
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this Page.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the blog containing this page."
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The body content of this Page, in HTML."
- },
- "etag": {
- "type": "string",
- "description": "Etag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#page",
- "default": "blogger#page"
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this Page was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "status": {
- "type": "string",
- "description": "The status of the page for admin resources (either LIVE or DRAFT)."
- },
- "title": {
- "type": "string",
- "description": "The title of this entity. This is the name displayed in the Admin user interface."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this Page was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL that this Page is displayed at."
- }
- }
- },
- "PageList": {
- "id": "PageList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the response."
- },
- "items": {
- "type": "array",
- "description": "The list of Pages for a Blog.",
- "items": {
- "$ref": "Page"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#pageList",
- "default": "blogger#pageList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- }
- }
- },
- "Pageviews": {
- "id": "Pageviews",
- "type": "object",
- "properties": {
- "blogId": {
- "type": "string",
- "description": "Blog Id"
- },
- "counts": {
- "type": "array",
- "description": "The container of posts in this blog.",
- "items": {
- "type": "object",
- "properties": {
- "count": {
- "type": "string",
- "description": "Count of page views for the given time range",
- "format": "int64"
- },
- "timeRange": {
- "type": "string",
- "description": "Time range the given count applies to"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#page_views",
- "default": "blogger#page_views"
- }
- }
- },
- "Post": {
- "id": "Post",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Post.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier of the Post creator."
- },
- "image": {
- "type": "object",
- "description": "The Post author's avatar.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The Post author's avatar URL."
- }
- }
- },
- "url": {
- "type": "string",
- "description": "The URL of the Post creator's Profile page."
- }
- }
- },
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this Post.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the Blog that contains this Post."
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The content of the Post. May contain HTML markup."
- },
- "customMetaData": {
- "type": "string",
- "description": "The JSON meta-data for the Post."
- },
- "etag": {
- "type": "string",
- "description": "Etag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The identifier of this Post."
- },
- "images": {
- "type": "array",
- "description": "Display image for the Post.",
- "items": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#post",
- "default": "blogger#post"
- },
- "labels": {
- "type": "array",
- "description": "The list of labels this Post was tagged with.",
- "items": {
+ "id": "blogger:v3",
+ "kind": "discovery#restDescription",
+ "labels": [
+ "limited_availability"
+ ],
+ "name": "blogger",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
},
- "location": {
- "type": "object",
- "description": "The location for geotagged posts.",
- "properties": {
- "lat": {
- "type": "number",
- "description": "Location's latitude.",
- "format": "double"
- },
- "lng": {
- "type": "number",
- "description": "Location's longitude.",
- "format": "double"
- },
- "name": {
- "type": "string",
- "description": "Location name."
- },
- "span": {
- "type": "string",
- "description": "Location's viewport span. Can be used when rendering a map preview."
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "blogUserInfos": {
+ "methods": {
+ "get": {
+ "description": "Gets one blog and user info pair by blogId and userId.",
+ "httpMethod": "GET",
+ "id": "blogger.blogUserInfos.get",
+ "parameterOrder": [
+ "userId",
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the blog to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxPosts": {
+ "description": "Maximum number of posts to pull back with the blog.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "userId": {
+ "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}/blogs/{blogId}",
+ "response": {
+ "$ref": "BlogUserInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ }
}
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this Post was published.",
- "format": "date-time"
- },
- "readerComments": {
- "type": "string",
- "description": "Comment control and display setting for readers of this post."
- },
- "replies": {
- "type": "object",
- "description": "The container of comments on this Post.",
- "properties": {
- "items": {
- "type": "array",
- "description": "The List of Comments for this Post.",
- "items": {
- "$ref": "Comment"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The URL of the comments on this post."
- },
- "totalItems": {
- "type": "string",
- "description": "The count of comments on this post.",
- "format": "int64"
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "status": {
- "type": "string",
- "description": "Status of the post. Only set for admin-level requests"
- },
- "title": {
- "type": "string",
- "description": "The title of the Post."
- },
- "titleLink": {
- "type": "string",
- "description": "The title link URL, similar to atom's related link."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this Post was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL where this Post is displayed."
- }
- }
- },
- "PostList": {
- "id": "PostList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the response."
- },
- "items": {
- "type": "array",
- "description": "The list of Posts for this Blog.",
- "items": {
- "$ref": "Post"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postList",
- "default": "blogger#postList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- }
- }
- },
- "PostPerUserInfo": {
- "id": "PostPerUserInfo",
- "type": "object",
- "properties": {
- "blogId": {
- "type": "string",
- "description": "ID of the Blog that the post resource belongs to."
- },
- "hasEditAccess": {
- "type": "boolean",
- "description": "True if the user has Author level access to the post."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postPerUserInfo",
- "default": "blogger#postPerUserInfo"
- },
- "postId": {
- "type": "string",
- "description": "ID of the Post resource."
- },
- "userId": {
- "type": "string",
- "description": "ID of the User."
- }
- }
- },
- "PostUserInfo": {
- "id": "PostUserInfo",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postUserInfo",
- "default": "blogger#postUserInfo"
- },
- "post": {
- "$ref": "Post",
- "description": "The Post resource."
- },
- "post_user_info": {
- "$ref": "PostPerUserInfo",
- "description": "Information about a User for the Post."
- }
- }
- },
- "PostUserInfosList": {
- "id": "PostUserInfosList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The list of Posts with User information for the post, for this Blog.",
- "items": {
- "$ref": "PostUserInfo"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postList",
- "default": "blogger#postUserInfosList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "properties": {
- "about": {
- "type": "string",
- "description": "Profile summary information."
},
"blogs": {
- "type": "object",
- "description": "The container of blogs for this user.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the Blogs for this user."
+ "methods": {
+ "get": {
+ "description": "Gets one blog by ID.",
+ "httpMethod": "GET",
+ "id": "blogger.blogs.get",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the blog to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxPosts": {
+ "description": "Maximum number of posts to pull back with the blog.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "view": {
+ "description": "Access level with which to view the blog. Note that some fields require elevated access.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail.",
+ "Author level detail.",
+ "Reader level detail."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}",
+ "response": {
+ "$ref": "Blog"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "getByUrl": {
+ "description": "Retrieve a Blog by URL.",
+ "httpMethod": "GET",
+ "id": "blogger.blogs.getByUrl",
+ "parameterOrder": [
+ "url"
+ ],
+ "parameters": {
+ "url": {
+ "description": "The URL of the blog to retrieve.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Access level with which to view the blog. Note that some fields require elevated access.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail.",
+ "Author level detail.",
+ "Reader level detail."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/byurl",
+ "response": {
+ "$ref": "Blog"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "listByUser": {
+ "description": "Retrieves a list of blogs, possibly filtered.",
+ "httpMethod": "GET",
+ "id": "blogger.blogs.listByUser",
+ "parameterOrder": [
+ "userId"
+ ],
+ "parameters": {
+ "fetchUserInfo": {
+ "description": "Whether the response is a list of blogs with per-user information instead of just blogs.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "role": {
+ "description": "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.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin role - Blogs where the user has Admin level access.",
+ "Author role - Blogs where the user has Author level access.",
+ "Reader role - Blogs where the user has Reader level access (to a private blog)."
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "status": {
+ "default": "LIVE",
+ "description": "Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.",
+ "enum": [
+ "DELETED",
+ "LIVE"
+ ],
+ "enumDescriptions": [
+ "Blog has been deleted by an administrator.",
+ "Blog is currently live."
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Access level with which to view the blogs. Note that some fields require elevated access.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail.",
+ "Author level detail.",
+ "Reader level detail."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}/blogs",
+ "response": {
+ "$ref": "BlogList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ }
}
- }
},
- "created": {
- "type": "string",
- "description": "The timestamp of when this profile was created, in seconds since epoch.",
- "format": "date-time"
- },
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this User."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#user",
- "default": "blogger#user"
- },
- "locale": {
- "type": "object",
- "description": "This user's locale",
- "properties": {
- "country": {
- "type": "string",
- "description": "The user's country setting."
- },
- "language": {
- "type": "string",
- "description": "The user's language setting."
- },
- "variant": {
- "type": "string",
- "description": "The user's language variant setting."
+ "comments": {
+ "methods": {
+ "approve": {
+ "description": "Marks a comment as not spam.",
+ "httpMethod": "POST",
+ "id": "blogger.comments.approve",
+ "parameterOrder": [
+ "blogId",
+ "postId",
+ "commentId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "commentId": {
+ "description": "The ID of the comment to mark as not spam.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "The ID of the Post.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/approve",
+ "response": {
+ "$ref": "Comment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "delete": {
+ "description": "Delete a comment by ID.",
+ "httpMethod": "DELETE",
+ "id": "blogger.comments.delete",
+ "parameterOrder": [
+ "blogId",
+ "postId",
+ "commentId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "commentId": {
+ "description": "The ID of the comment to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "The ID of the Post.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "get": {
+ "description": "Gets one comment by ID.",
+ "httpMethod": "GET",
+ "id": "blogger.comments.get",
+ "parameterOrder": [
+ "blogId",
+ "postId",
+ "commentId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to containing the comment.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "commentId": {
+ "description": "The ID of the comment to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "ID of the post to fetch posts from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "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.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail",
+ "Author level detail",
+ "Admin level detail"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
+ "response": {
+ "$ref": "Comment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the comments for a post, possibly filtered.",
+ "httpMethod": "GET",
+ "id": "blogger.comments.list",
+ "parameterOrder": [
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch comments from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "fetchBodies": {
+ "description": "Whether the body content of the comments is included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "Maximum number of comments to include in the result.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token if request is paged.",
+ "location": "query",
+ "type": "string"
+ },
+ "postId": {
+ "description": "ID of the post to fetch posts from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "emptied",
+ "live",
+ "pending",
+ "spam"
+ ],
+ "enumDescriptions": [
+ "Comments that have had their content removed",
+ "Comments that are publicly visible",
+ "Comments that are awaiting administrator approval",
+ "Comments marked as spam by the administrator"
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail",
+ "Author level detail",
+ "Reader level detail"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/comments",
+ "response": {
+ "$ref": "CommentList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "listByBlog": {
+ "description": "Retrieves the comments for a blog, across all posts, possibly filtered.",
+ "httpMethod": "GET",
+ "id": "blogger.comments.listByBlog",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch comments from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "fetchBodies": {
+ "description": "Whether the body content of the comments is included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "Maximum number of comments to include in the result.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token if request is paged.",
+ "location": "query",
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "emptied",
+ "live",
+ "pending",
+ "spam"
+ ],
+ "enumDescriptions": [
+ "Comments that have had their content removed",
+ "Comments that are publicly visible",
+ "Comments that are awaiting administrator approval",
+ "Comments marked as spam by the administrator"
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/comments",
+ "response": {
+ "$ref": "CommentList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "markAsSpam": {
+ "description": "Marks a comment as spam.",
+ "httpMethod": "POST",
+ "id": "blogger.comments.markAsSpam",
+ "parameterOrder": [
+ "blogId",
+ "postId",
+ "commentId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "commentId": {
+ "description": "The ID of the comment to mark as spam.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "The ID of the Post.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/spam",
+ "response": {
+ "$ref": "Comment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "removeContent": {
+ "description": "Removes the content of a comment.",
+ "httpMethod": "POST",
+ "id": "blogger.comments.removeContent",
+ "parameterOrder": [
+ "blogId",
+ "postId",
+ "commentId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "commentId": {
+ "description": "The ID of the comment to delete content from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "The ID of the Post.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent",
+ "response": {
+ "$ref": "Comment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
}
- }
},
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
+ "pageViews": {
+ "methods": {
+ "get": {
+ "description": "Retrieve pageview stats for a Blog.",
+ "httpMethod": "GET",
+ "id": "blogger.pageViews.get",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the blog to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "range": {
+ "enum": [
+ "30DAYS",
+ "7DAYS",
+ "all"
+ ],
+ "enumDescriptions": [
+ "Page view counts from the last thirty days.",
+ "Page view counts from the last seven days.",
+ "Total page view counts from all time."
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/pageviews",
+ "response": {
+ "$ref": "Pageviews"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
+ }
},
- "url": {
- "type": "string",
- "description": "The user's profile page."
+ "pages": {
+ "methods": {
+ "delete": {
+ "description": "Delete a page by ID.",
+ "httpMethod": "DELETE",
+ "id": "blogger.pages.delete",
+ "parameterOrder": [
+ "blogId",
+ "pageId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the Page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/pages/{pageId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "get": {
+ "description": "Gets one blog page by ID.",
+ "httpMethod": "GET",
+ "id": "blogger.pages.get",
+ "parameterOrder": [
+ "blogId",
+ "pageId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog containing the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail",
+ "Author level detail",
+ "Reader level detail"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/pages/{pageId}",
+ "response": {
+ "$ref": "Page"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Add a page.",
+ "httpMethod": "POST",
+ "id": "blogger.pages.insert",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to add the page to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "isDraft": {
+ "description": "Whether to create the page as a draft (default: false).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "blogs/{blogId}/pages",
+ "request": {
+ "$ref": "Page"
+ },
+ "response": {
+ "$ref": "Page"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "list": {
+ "description": "Retrieves the pages for a blog, optionally including non-LIVE statuses.",
+ "httpMethod": "GET",
+ "id": "blogger.pages.list",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch Pages from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "fetchBodies": {
+ "description": "Whether to retrieve the Page bodies.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "Maximum number of Pages to fetch.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Continuation token if the request is paged.",
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "draft",
+ "live"
+ ],
+ "enumDescriptions": [
+ "Draft (unpublished) Pages",
+ "Pages that are publicly visible"
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail",
+ "Author level detail",
+ "Reader level detail"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/pages",
+ "response": {
+ "$ref": "PageList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Update a page. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "blogger.pages.patch",
+ "parameterOrder": [
+ "blogId",
+ "pageId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the Page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "publish": {
+ "description": "Whether a publish action should be performed when the page is updated (default: false).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "revert": {
+ "description": "Whether a revert action should be performed when the page is updated (default: false).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "blogs/{blogId}/pages/{pageId}",
+ "request": {
+ "$ref": "Page"
+ },
+ "response": {
+ "$ref": "Page"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "publish": {
+ "description": "Publishes a draft page.",
+ "httpMethod": "POST",
+ "id": "blogger.pages.publish",
+ "parameterOrder": [
+ "blogId",
+ "pageId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/pages/{pageId}/publish",
+ "response": {
+ "$ref": "Page"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "revert": {
+ "description": "Revert a published or scheduled page to draft state.",
+ "httpMethod": "POST",
+ "id": "blogger.pages.revert",
+ "parameterOrder": [
+ "blogId",
+ "pageId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/pages/{pageId}/revert",
+ "response": {
+ "$ref": "Page"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "update": {
+ "description": "Update a page.",
+ "httpMethod": "PUT",
+ "id": "blogger.pages.update",
+ "parameterOrder": [
+ "blogId",
+ "pageId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageId": {
+ "description": "The ID of the Page.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "publish": {
+ "description": "Whether a publish action should be performed when the page is updated (default: false).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "revert": {
+ "description": "Whether a revert action should be performed when the page is updated (default: false).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "blogs/{blogId}/pages/{pageId}",
+ "request": {
+ "$ref": "Page"
+ },
+ "response": {
+ "$ref": "Page"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
+ }
+ },
+ "postUserInfos": {
+ "methods": {
+ "get": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "blogger.postUserInfos.get",
+ "parameterOrder": [
+ "userId",
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxComments": {
+ "description": "Maximum number of comments to pull back on a post.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "postId": {
+ "description": "The ID of the post to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}/blogs/{blogId}/posts/{postId}",
+ "response": {
+ "$ref": "PostUserInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "list": {
+ "description": "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.",
+ "httpMethod": "GET",
+ "id": "blogger.postUserInfos.list",
+ "parameterOrder": [
+ "userId",
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch posts from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "fetchBodies": {
+ "default": "false",
+ "description": "Whether the body content of posts is included. Default is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "labels": {
+ "description": "Comma-separated list of labels to search for.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of posts to fetch.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "orderBy": {
+ "default": "PUBLISHED",
+ "description": "Sort order applied to search results. Default is published.",
+ "enum": [
+ "published",
+ "updated"
+ ],
+ "enumDescriptions": [
+ "Order by the date the post was published",
+ "Order by the date the post was last updated"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Continuation token if the request is paged.",
+ "location": "query",
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "draft",
+ "live",
+ "scheduled"
+ ],
+ "enumDescriptions": [
+ "Draft posts",
+ "Published posts",
+ "Posts that are scheduled to publish in future."
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail",
+ "Author level detail",
+ "Reader level detail"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}/blogs/{blogId}/posts",
+ "response": {
+ "$ref": "PostUserInfosList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ }
+ }
+ },
+ "posts": {
+ "methods": {
+ "delete": {
+ "description": "Delete a post by ID.",
+ "httpMethod": "DELETE",
+ "id": "blogger.posts.delete",
+ "parameterOrder": [
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "The ID of the Post.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "get": {
+ "description": "Get a post by ID.",
+ "httpMethod": "GET",
+ "id": "blogger.posts.get",
+ "parameterOrder": [
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch the post from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "fetchBody": {
+ "default": "true",
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "fetchImages": {
+ "description": "Whether image URL metadata for each post is included (default: false).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxComments": {
+ "description": "Maximum number of comments to pull back on a post.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "postId": {
+ "description": "The ID of the post",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail",
+ "Author level detail",
+ "Reader level detail"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}",
+ "response": {
+ "$ref": "Post"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "getByPath": {
+ "description": "Retrieve a Post by Path.",
+ "httpMethod": "GET",
+ "id": "blogger.posts.getByPath",
+ "parameterOrder": [
+ "blogId",
+ "path"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch the post from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxComments": {
+ "description": "Maximum number of comments to pull back on a post.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "path": {
+ "description": "Path of the Post to retrieve.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail",
+ "Author level detail",
+ "Reader level detail"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/bypath",
+ "response": {
+ "$ref": "Post"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Add a post.",
+ "httpMethod": "POST",
+ "id": "blogger.posts.insert",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to add the post to.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "fetchBody": {
+ "default": "true",
+ "description": "Whether the body content of the post is included with the result (default: true).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "fetchImages": {
+ "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "isDraft": {
+ "description": "Whether to create the post as a draft (default: false).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "blogs/{blogId}/posts",
+ "request": {
+ "$ref": "Post"
+ },
+ "response": {
+ "$ref": "Post"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of posts, possibly filtered.",
+ "httpMethod": "GET",
+ "id": "blogger.posts.list",
+ "parameterOrder": [
+ "blogId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch posts from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "endDate": {
+ "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "fetchBodies": {
+ "default": "true",
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "fetchImages": {
+ "description": "Whether image URL metadata for each post is included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "labels": {
+ "description": "Comma-separated list of labels to search for.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of posts to fetch.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "orderBy": {
+ "default": "PUBLISHED",
+ "description": "Sort search results",
+ "enum": [
+ "published",
+ "updated"
+ ],
+ "enumDescriptions": [
+ "Order by the date the post was published",
+ "Order by the date the post was last updated"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Continuation token if the request is paged.",
+ "location": "query",
+ "type": "string"
+ },
+ "startDate": {
+ "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "status": {
+ "description": "Statuses to include in the results.",
+ "enum": [
+ "draft",
+ "live",
+ "scheduled"
+ ],
+ "enumDescriptions": [
+ "Draft (non-published) posts.",
+ "Published posts",
+ "Posts that are scheduled to publish in the future."
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Access level with which to view the returned result. Note that some fields require escalated access.",
+ "enum": [
+ "ADMIN",
+ "AUTHOR",
+ "READER"
+ ],
+ "enumDescriptions": [
+ "Admin level detail",
+ "Author level detail",
+ "Reader level detail"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts",
+ "response": {
+ "$ref": "PostList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Update a post. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "blogger.posts.patch",
+ "parameterOrder": [
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "fetchBody": {
+ "default": "true",
+ "description": "Whether the body content of the post is included with the result (default: true).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "fetchImages": {
+ "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxComments": {
+ "description": "Maximum number of comments to retrieve with the returned post.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "postId": {
+ "description": "The ID of the Post.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "publish": {
+ "description": "Whether a publish action should be performed when the post is updated (default: false).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "revert": {
+ "description": "Whether a revert action should be performed when the post is updated (default: false).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}",
+ "request": {
+ "$ref": "Post"
+ },
+ "response": {
+ "$ref": "Post"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "publish": {
+ "description": "Publishes a draft post, optionally at the specific time of the given publishDate parameter.",
+ "httpMethod": "POST",
+ "id": "blogger.posts.publish",
+ "parameterOrder": [
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "The ID of the Post.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "publishDate": {
+ "description": "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.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/publish",
+ "response": {
+ "$ref": "Post"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "revert": {
+ "description": "Revert a published or scheduled post to draft state.",
+ "httpMethod": "POST",
+ "id": "blogger.posts.revert",
+ "parameterOrder": [
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "postId": {
+ "description": "The ID of the Post.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}/revert",
+ "response": {
+ "$ref": "Post"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ },
+ "search": {
+ "description": "Search for a post.",
+ "httpMethod": "GET",
+ "id": "blogger.posts.search",
+ "parameterOrder": [
+ "blogId",
+ "q"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "ID of the blog to fetch the post from.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "fetchBodies": {
+ "default": "true",
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "orderBy": {
+ "default": "PUBLISHED",
+ "description": "Sort search results",
+ "enum": [
+ "published",
+ "updated"
+ ],
+ "enumDescriptions": [
+ "Order by the date the post was published",
+ "Order by the date the post was last updated"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "q": {
+ "description": "Query terms to search this blog for matching posts.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "blogs/{blogId}/posts/search",
+ "response": {
+ "$ref": "PostList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ },
+ "update": {
+ "description": "Update a post.",
+ "httpMethod": "PUT",
+ "id": "blogger.posts.update",
+ "parameterOrder": [
+ "blogId",
+ "postId"
+ ],
+ "parameters": {
+ "blogId": {
+ "description": "The ID of the Blog.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "fetchBody": {
+ "default": "true",
+ "description": "Whether the body content of the post is included with the result (default: true).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "fetchImages": {
+ "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxComments": {
+ "description": "Maximum number of comments to retrieve with the returned post.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "postId": {
+ "description": "The ID of the Post.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "publish": {
+ "description": "Whether a publish action should be performed when the post is updated (default: false).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "revert": {
+ "description": "Whether a revert action should be performed when the post is updated (default: false).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "blogs/{blogId}/posts/{postId}",
+ "request": {
+ "$ref": "Post"
+ },
+ "response": {
+ "$ref": "Post"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger"
+ ]
+ }
+ }
+ },
+ "users": {
+ "methods": {
+ "get": {
+ "description": "Gets one user by ID.",
+ "httpMethod": "GET",
+ "id": "blogger.users.get",
+ "parameterOrder": [
+ "userId"
+ ],
+ "parameters": {
+ "userId": {
+ "description": "The ID of the user to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}",
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/blogger",
+ "https://www.googleapis.com/auth/blogger.readonly"
+ ]
+ }
+ }
}
- }
- }
- },
- "resources": {
- "blogUserInfos": {
- "methods": {
- "get": {
- "id": "blogger.blogUserInfos.get",
- "path": "users/{userId}/blogs/{blogId}",
- "httpMethod": "GET",
- "description": "Gets one blog and user info pair by blogId and userId.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog to get.",
- "required": true,
- "location": "path"
- },
- "maxPosts": {
- "type": "integer",
- "description": "Maximum number of posts to pull back with the blog.",
- "format": "uint32",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId",
- "blogId"
- ],
- "response": {
- "$ref": "BlogUserInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- }
- }
},
- "blogs": {
- "methods": {
- "get": {
- "id": "blogger.blogs.get",
- "path": "blogs/{blogId}",
- "httpMethod": "GET",
- "description": "Gets one blog by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog to get.",
- "required": true,
- "location": "path"
+ "revision": "20150422",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Blog": {
+ "id": "Blog",
+ "properties": {
+ "customMetaData": {
+ "description": "The JSON custom meta-data for the Blog",
+ "type": "string"
+ },
+ "description": {
+ "description": "The description of this blog. This is displayed underneath the title.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "blogger#blog",
+ "description": "The kind of this entry. Always blogger#blog",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale this Blog is set to.",
+ "properties": {
+ "country": {
+ "description": "The country this blog's locale is set to.",
+ "type": "string"
+ },
+ "language": {
+ "description": "The language this blog is authored in.",
+ "type": "string"
+ },
+ "variant": {
+ "description": "The language variant this blog is authored in.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "name": {
+ "description": "The name of this blog. This is displayed as the title.",
+ "type": "string"
+ },
+ "pages": {
+ "description": "The container of pages in this blog.",
+ "properties": {
+ "selfLink": {
+ "description": "The URL of the container for pages in this blog.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The count of pages in this blog.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "posts": {
+ "description": "The container of posts in this blog.",
+ "properties": {
+ "items": {
+ "description": "The List of Posts for this Blog.",
+ "items": {
+ "$ref": "Post"
+ },
+ "type": "array"
+ },
+ "selfLink": {
+ "description": "The URL of the container for posts in this blog.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The count of posts in this blog.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "published": {
+ "description": "RFC 3339 date-time when this blog was published.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the blog.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "RFC 3339 date-time when this blog was last updated.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this blog is published.",
+ "type": "string"
+ }
},
- "maxPosts": {
- "type": "integer",
- "description": "Maximum number of posts to pull back with the blog.",
- "format": "uint32",
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the blog. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail.",
- "Author level detail.",
- "Reader level detail."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "Blog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
+ "type": "object"
},
- "getByUrl": {
- "id": "blogger.blogs.getByUrl",
- "path": "blogs/byurl",
- "httpMethod": "GET",
- "description": "Retrieve a Blog by URL.",
- "parameters": {
- "url": {
- "type": "string",
- "description": "The URL of the blog to retrieve.",
- "required": true,
- "location": "query"
+ "BlogList": {
+ "id": "BlogList",
+ "properties": {
+ "blogUserInfos": {
+ "description": "Admin level list of blog per-user information",
+ "items": {
+ "$ref": "BlogUserInfo"
+ },
+ "type": "array"
+ },
+ "items": {
+ "description": "The list of Blogs this user has Authorship or Admin rights over.",
+ "items": {
+ "$ref": "Blog"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#blogList",
+ "description": "The kind of this entity. Always blogger#blogList",
+ "type": "string"
+ }
},
- "view": {
- "type": "string",
- "description": "Access level with which to view the blog. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail.",
- "Author level detail.",
- "Reader level detail."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "url"
- ],
- "response": {
- "$ref": "Blog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
+ "type": "object"
},
- "listByUser": {
- "id": "blogger.blogs.listByUser",
- "path": "users/{userId}/blogs",
- "httpMethod": "GET",
- "description": "Retrieves a list of blogs, possibly filtered.",
- "parameters": {
- "fetchUserInfo": {
- "type": "boolean",
- "description": "Whether the response is a list of blogs with per-user information instead of just blogs.",
- "location": "query"
+ "BlogPerUserInfo": {
+ "id": "BlogPerUserInfo",
+ "properties": {
+ "blogId": {
+ "description": "ID of the Blog resource",
+ "type": "string"
+ },
+ "hasAdminAccess": {
+ "description": "True if the user has Admin level access to the blog.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "blogger#blogPerUserInfo",
+ "description": "The kind of this entity. Always blogger#blogPerUserInfo",
+ "type": "string"
+ },
+ "photosAlbumKey": {
+ "description": "The Photo Album Key for the user when adding photos to the blog",
+ "type": "string"
+ },
+ "role": {
+ "description": "Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).",
+ "type": "string"
+ },
+ "userId": {
+ "description": "ID of the User",
+ "type": "string"
+ }
},
- "role": {
- "type": "string",
- "description": "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.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin role - Blogs where the user has Admin level access.",
- "Author role - Blogs where the user has Author level access.",
- "Reader role - Blogs where the user has Reader level access (to a private blog)."
- ],
- "repeated": true,
- "location": "query"
+ "type": "object"
+ },
+ "BlogUserInfo": {
+ "id": "BlogUserInfo",
+ "properties": {
+ "blog": {
+ "$ref": "Blog",
+ "description": "The Blog resource."
+ },
+ "blog_user_info": {
+ "$ref": "BlogPerUserInfo",
+ "description": "Information about a User for the Blog."
+ },
+ "kind": {
+ "default": "blogger#blogUserInfo",
+ "description": "The kind of this entity. Always blogger#blogUserInfo",
+ "type": "string"
+ }
},
- "status": {
- "type": "string",
- "description": "Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.",
- "default": "LIVE",
- "enum": [
- "DELETED",
- "LIVE"
- ],
- "enumDescriptions": [
- "Blog has been deleted by an administrator.",
- "Blog is currently live."
- ],
- "repeated": true,
- "location": "query"
+ "type": "object"
+ },
+ "Comment": {
+ "id": "Comment",
+ "properties": {
+ "author": {
+ "description": "The author of this Comment.",
+ "properties": {
+ "displayName": {
+ "description": "The display name.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier of the Comment creator.",
+ "type": "string"
+ },
+ "image": {
+ "description": "The comment creator's avatar.",
+ "properties": {
+ "url": {
+ "description": "The comment creator's avatar URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "url": {
+ "description": "The URL of the Comment creator's Profile page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "blog": {
+ "description": "Data about the blog containing this comment.",
+ "properties": {
+ "id": {
+ "description": "The identifier of the blog containing this comment.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "content": {
+ "description": "The actual content of the comment. May include HTML markup.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier for this resource.",
+ "type": "string"
+ },
+ "inReplyTo": {
+ "description": "Data about the comment this is in reply to.",
+ "properties": {
+ "id": {
+ "description": "The identified of the parent of this comment.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "kind": {
+ "default": "blogger#comment",
+ "description": "The kind of this entry. Always blogger#comment",
+ "type": "string"
+ },
+ "post": {
+ "description": "Data about the post containing this comment.",
+ "properties": {
+ "id": {
+ "description": "The identifier of the post containing this comment.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "published": {
+ "description": "RFC 3339 date-time when this comment was published.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the comment (only populated for admin users)",
+ "type": "string"
+ },
+ "updated": {
+ "description": "RFC 3339 date-time when this comment was last updated.",
+ "format": "date-time",
+ "type": "string"
+ }
},
- "userId": {
- "type": "string",
- "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- "required": true,
- "location": "path"
+ "type": "object"
+ },
+ "CommentList": {
+ "id": "CommentList",
+ "properties": {
+ "etag": {
+ "description": "Etag of the response.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The List of Comments for a Post.",
+ "items": {
+ "$ref": "Comment"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#commentList",
+ "description": "The kind of this entry. Always blogger#commentList",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to fetch the next page, if one exists.",
+ "type": "string"
+ },
+ "prevPageToken": {
+ "description": "Pagination token to fetch the previous page, if one exists.",
+ "type": "string"
+ }
},
- "view": {
- "type": "string",
- "description": "Access level with which to view the blogs. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail.",
- "Author level detail.",
- "Reader level detail."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "BlogList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
+ "type": "object"
+ },
+ "Page": {
+ "id": "Page",
+ "properties": {
+ "author": {
+ "description": "The author of this Page.",
+ "properties": {
+ "displayName": {
+ "description": "The display name.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier of the Page creator.",
+ "type": "string"
+ },
+ "image": {
+ "description": "The page author's avatar.",
+ "properties": {
+ "url": {
+ "description": "The page author's avatar URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "url": {
+ "description": "The URL of the Page creator's Profile page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "blog": {
+ "description": "Data about the blog containing this Page.",
+ "properties": {
+ "id": {
+ "description": "The identifier of the blog containing this page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "content": {
+ "description": "The body content of this Page, in HTML.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Etag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "blogger#page",
+ "description": "The kind of this entity. Always blogger#page",
+ "type": "string"
+ },
+ "published": {
+ "description": "RFC 3339 date-time when this Page was published.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the page for admin resources (either LIVE or DRAFT).",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of this entity. This is the name displayed in the Admin user interface.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "RFC 3339 date-time when this Page was last updated.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL that this Page is displayed at.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PageList": {
+ "id": "PageList",
+ "properties": {
+ "etag": {
+ "description": "Etag of the response.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The list of Pages for a Blog.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#pageList",
+ "description": "The kind of this entity. Always blogger#pageList",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to fetch the next page, if one exists.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Pageviews": {
+ "id": "Pageviews",
+ "properties": {
+ "blogId": {
+ "description": "Blog Id",
+ "type": "string"
+ },
+ "counts": {
+ "description": "The container of posts in this blog.",
+ "items": {
+ "properties": {
+ "count": {
+ "description": "Count of page views for the given time range",
+ "format": "int64",
+ "type": "string"
+ },
+ "timeRange": {
+ "description": "Time range the given count applies to",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#page_views",
+ "description": "The kind of this entry. Always blogger#page_views",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Post": {
+ "id": "Post",
+ "properties": {
+ "author": {
+ "description": "The author of this Post.",
+ "properties": {
+ "displayName": {
+ "description": "The display name.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier of the Post creator.",
+ "type": "string"
+ },
+ "image": {
+ "description": "The Post author's avatar.",
+ "properties": {
+ "url": {
+ "description": "The Post author's avatar URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "url": {
+ "description": "The URL of the Post creator's Profile page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "blog": {
+ "description": "Data about the blog containing this Post.",
+ "properties": {
+ "id": {
+ "description": "The identifier of the Blog that contains this Post.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "content": {
+ "description": "The content of the Post. May contain HTML markup.",
+ "type": "string"
+ },
+ "customMetaData": {
+ "description": "The JSON meta-data for the Post.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Etag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier of this Post.",
+ "type": "string"
+ },
+ "images": {
+ "description": "Display image for the Post.",
+ "items": {
+ "properties": {
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#post",
+ "description": "The kind of this entity. Always blogger#post",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The list of labels this Post was tagged with.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "location": {
+ "description": "The location for geotagged posts.",
+ "properties": {
+ "lat": {
+ "description": "Location's latitude.",
+ "format": "double",
+ "type": "number"
+ },
+ "lng": {
+ "description": "Location's longitude.",
+ "format": "double",
+ "type": "number"
+ },
+ "name": {
+ "description": "Location name.",
+ "type": "string"
+ },
+ "span": {
+ "description": "Location's viewport span. Can be used when rendering a map preview.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "published": {
+ "description": "RFC 3339 date-time when this Post was published.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "readerComments": {
+ "description": "Comment control and display setting for readers of this post.",
+ "type": "string"
+ },
+ "replies": {
+ "description": "The container of comments on this Post.",
+ "properties": {
+ "items": {
+ "description": "The List of Comments for this Post.",
+ "items": {
+ "$ref": "Comment"
+ },
+ "type": "array"
+ },
+ "selfLink": {
+ "description": "The URL of the comments on this post.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The count of comments on this post.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the post. Only set for admin-level requests",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the Post.",
+ "type": "string"
+ },
+ "titleLink": {
+ "description": "The title link URL, similar to atom's related link.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "RFC 3339 date-time when this Post was last updated.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this Post is displayed.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostList": {
+ "id": "PostList",
+ "properties": {
+ "etag": {
+ "description": "Etag of the response.",
+ "type": "string"
+ },
+ "items": {
+ "description": "The list of Posts for this Blog.",
+ "items": {
+ "$ref": "Post"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#postList",
+ "description": "The kind of this entity. Always blogger#postList",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to fetch the next page, if one exists.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostPerUserInfo": {
+ "id": "PostPerUserInfo",
+ "properties": {
+ "blogId": {
+ "description": "ID of the Blog that the post resource belongs to.",
+ "type": "string"
+ },
+ "hasEditAccess": {
+ "description": "True if the user has Author level access to the post.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "blogger#postPerUserInfo",
+ "description": "The kind of this entity. Always blogger#postPerUserInfo",
+ "type": "string"
+ },
+ "postId": {
+ "description": "ID of the Post resource.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "ID of the User.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostUserInfo": {
+ "id": "PostUserInfo",
+ "properties": {
+ "kind": {
+ "default": "blogger#postUserInfo",
+ "description": "The kind of this entity. Always blogger#postUserInfo",
+ "type": "string"
+ },
+ "post": {
+ "$ref": "Post",
+ "description": "The Post resource."
+ },
+ "post_user_info": {
+ "$ref": "PostPerUserInfo",
+ "description": "Information about a User for the Post."
+ }
+ },
+ "type": "object"
+ },
+ "PostUserInfosList": {
+ "id": "PostUserInfosList",
+ "properties": {
+ "items": {
+ "description": "The list of Posts with User information for the post, for this Blog.",
+ "items": {
+ "$ref": "PostUserInfo"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "blogger#postUserInfosList",
+ "description": "The kind of this entity. Always blogger#postList",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Pagination token to fetch the next page, if one exists.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "User": {
+ "id": "User",
+ "properties": {
+ "about": {
+ "description": "Profile summary information.",
+ "type": "string"
+ },
+ "blogs": {
+ "description": "The container of blogs for this user.",
+ "properties": {
+ "selfLink": {
+ "description": "The URL of the Blogs for this user.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "created": {
+ "description": "The timestamp of when this profile was created, in seconds since epoch.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier for this User.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "blogger#user",
+ "description": "The kind of this entity. Always blogger#user",
+ "type": "string"
+ },
+ "locale": {
+ "description": "This user's locale",
+ "properties": {
+ "country": {
+ "description": "The user's country setting.",
+ "type": "string"
+ },
+ "language": {
+ "description": "The user's language setting.",
+ "type": "string"
+ },
+ "variant": {
+ "description": "The user's language variant setting.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "The API REST URL to fetch this resource from.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The user's profile page.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "comments": {
- "methods": {
- "approve": {
- "id": "blogger.comments.approve",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/approve",
- "httpMethod": "POST",
- "description": "Marks a comment as not spam.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to mark as not spam.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "delete": {
- "id": "blogger.comments.delete",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
- "httpMethod": "DELETE",
- "description": "Delete a comment by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to delete.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "get": {
- "id": "blogger.comments.get",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
- "httpMethod": "GET",
- "description": "Gets one comment by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to containing the comment.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to get.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "ID of the post to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "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.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Admin level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "list": {
- "id": "blogger.comments.list",
- "path": "blogs/{blogId}/posts/{postId}/comments",
- "httpMethod": "GET",
- "description": "Retrieves the comments for a post, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch comments from.",
- "required": true,
- "location": "path"
- },
- "endDate": {
- "type": "string",
- "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of the comments is included.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of comments to include in the result.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if request is paged.",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "ID of the post to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "status": {
- "type": "string",
- "enum": [
- "emptied",
- "live",
- "pending",
- "spam"
- ],
- "enumDescriptions": [
- "Comments that have had their content removed",
- "Comments that are publicly visible",
- "Comments that are awaiting administrator approval",
- "Comments marked as spam by the administrator"
- ],
- "repeated": true,
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "CommentList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "listByBlog": {
- "id": "blogger.comments.listByBlog",
- "path": "blogs/{blogId}/comments",
- "httpMethod": "GET",
- "description": "Retrieves the comments for a blog, across all posts, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch comments from.",
- "required": true,
- "location": "path"
- },
- "endDate": {
- "type": "string",
- "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of the comments is included.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of comments to include in the result.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if request is paged.",
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "status": {
- "type": "string",
- "enum": [
- "emptied",
- "live",
- "pending",
- "spam"
- ],
- "enumDescriptions": [
- "Comments that have had their content removed",
- "Comments that are publicly visible",
- "Comments that are awaiting administrator approval",
- "Comments marked as spam by the administrator"
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "CommentList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "markAsSpam": {
- "id": "blogger.comments.markAsSpam",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/spam",
- "httpMethod": "POST",
- "description": "Marks a comment as spam.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to mark as spam.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "removeContent": {
- "id": "blogger.comments.removeContent",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent",
- "httpMethod": "POST",
- "description": "Removes the content of a comment.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to delete content from.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "pageViews": {
- "methods": {
- "get": {
- "id": "blogger.pageViews.get",
- "path": "blogs/{blogId}/pageviews",
- "httpMethod": "GET",
- "description": "Retrieve pageview stats for a Blog.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog to get.",
- "required": true,
- "location": "path"
- },
- "range": {
- "type": "string",
- "enum": [
- "30DAYS",
- "7DAYS",
- "all"
- ],
- "enumDescriptions": [
- "Page view counts from the last thirty days.",
- "Page view counts from the last seven days.",
- "Total page view counts from all time."
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "Pageviews"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "pages": {
- "methods": {
- "delete": {
- "id": "blogger.pages.delete",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "DELETE",
- "description": "Delete a page by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the Page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "get": {
- "id": "blogger.pages.get",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "GET",
- "description": "Gets one blog page by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog containing the page.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page to get.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "insert": {
- "id": "blogger.pages.insert",
- "path": "blogs/{blogId}/pages",
- "httpMethod": "POST",
- "description": "Add a page.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to add the page to.",
- "required": true,
- "location": "path"
- },
- "isDraft": {
- "type": "boolean",
- "description": "Whether to create the page as a draft (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "request": {
- "$ref": "Page"
- },
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.pages.list",
- "path": "blogs/{blogId}/pages",
- "httpMethod": "GET",
- "description": "Retrieves the pages for a blog, optionally including non-LIVE statuses.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch Pages from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether to retrieve the Page bodies.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of Pages to fetch.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if the request is paged.",
- "location": "query"
- },
- "status": {
- "type": "string",
- "enum": [
- "draft",
- "live"
- ],
- "enumDescriptions": [
- "Draft (unpublished) Pages",
- "Pages that are publicly visible"
- ],
- "repeated": true,
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "PageList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "patch": {
- "id": "blogger.pages.patch",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "PATCH",
- "description": "Update a page. This method supports patch semantics.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the Page.",
- "required": true,
- "location": "path"
- },
- "publish": {
- "type": "boolean",
- "description": "Whether a publish action should be performed when the page is updated (default: false).",
- "location": "query"
- },
- "revert": {
- "type": "boolean",
- "description": "Whether a revert action should be performed when the page is updated (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "request": {
- "$ref": "Page"
- },
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "publish": {
- "id": "blogger.pages.publish",
- "path": "blogs/{blogId}/pages/{pageId}/publish",
- "httpMethod": "POST",
- "description": "Publishes a draft page.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "revert": {
- "id": "blogger.pages.revert",
- "path": "blogs/{blogId}/pages/{pageId}/revert",
- "httpMethod": "POST",
- "description": "Revert a published or scheduled page to draft state.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "update": {
- "id": "blogger.pages.update",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "PUT",
- "description": "Update a page.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the Page.",
- "required": true,
- "location": "path"
- },
- "publish": {
- "type": "boolean",
- "description": "Whether a publish action should be performed when the page is updated (default: false).",
- "location": "query"
- },
- "revert": {
- "type": "boolean",
- "description": "Whether a revert action should be performed when the page is updated (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "request": {
- "$ref": "Page"
- },
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "postUserInfos": {
- "methods": {
- "get": {
- "id": "blogger.postUserInfos.get",
- "path": "users/{userId}/blogs/{blogId}/posts/{postId}",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog.",
- "required": true,
- "location": "path"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to pull back on a post.",
- "format": "uint32",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the post to get.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId",
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "PostUserInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "list": {
- "id": "blogger.postUserInfos.list",
- "path": "users/{userId}/blogs/{blogId}/posts",
- "httpMethod": "GET",
- "description": "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.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "endDate": {
- "type": "string",
- "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of posts is included. Default is false.",
- "default": "false",
- "location": "query"
- },
- "labels": {
- "type": "string",
- "description": "Comma-separated list of labels to search for.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of posts to fetch.",
- "format": "uint32",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sort order applied to search results. Default is published.",
- "default": "PUBLISHED",
- "enum": [
- "published",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the date the post was published",
- "Order by the date the post was last updated"
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if the request is paged.",
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "status": {
- "type": "string",
- "enum": [
- "draft",
- "live",
- "scheduled"
- ],
- "enumDescriptions": [
- "Draft posts",
- "Published posts",
- "Posts that are scheduled to publish in future."
- ],
- "repeated": true,
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "userId",
- "blogId"
- ],
- "response": {
- "$ref": "PostUserInfosList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- }
- }
- },
- "posts": {
- "methods": {
- "delete": {
- "id": "blogger.posts.delete",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "DELETE",
- "description": "Delete a post by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "get": {
- "id": "blogger.posts.get",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "GET",
- "description": "Get a post by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch the post from.",
- "required": true,
- "location": "path"
- },
- "fetchBody": {
- "type": "boolean",
- "description": "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.",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included (default: false).",
- "location": "query"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to pull back on a post.",
- "format": "uint32",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the post",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "getByPath": {
- "id": "blogger.posts.getByPath",
- "path": "blogs/{blogId}/posts/bypath",
- "httpMethod": "GET",
- "description": "Retrieve a Post by Path.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch the post from.",
- "required": true,
- "location": "path"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to pull back on a post.",
- "format": "uint32",
- "location": "query"
- },
- "path": {
- "type": "string",
- "description": "Path of the Post to retrieve.",
- "required": true,
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "path"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "insert": {
- "id": "blogger.posts.insert",
- "path": "blogs/{blogId}/posts",
- "httpMethod": "POST",
- "description": "Add a post.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to add the post to.",
- "required": true,
- "location": "path"
- },
- "fetchBody": {
- "type": "boolean",
- "description": "Whether the body content of the post is included with the result (default: true).",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
- "location": "query"
- },
- "isDraft": {
- "type": "boolean",
- "description": "Whether to create the post as a draft (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "request": {
- "$ref": "Post"
- },
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.posts.list",
- "path": "blogs/{blogId}/posts",
- "httpMethod": "GET",
- "description": "Retrieves a list of posts, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "endDate": {
- "type": "string",
- "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "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.",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included.",
- "location": "query"
- },
- "labels": {
- "type": "string",
- "description": "Comma-separated list of labels to search for.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of posts to fetch.",
- "format": "uint32",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sort search results",
- "default": "PUBLISHED",
- "enum": [
- "published",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the date the post was published",
- "Order by the date the post was last updated"
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if the request is paged.",
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "status": {
- "type": "string",
- "description": "Statuses to include in the results.",
- "enum": [
- "draft",
- "live",
- "scheduled"
- ],
- "enumDescriptions": [
- "Draft (non-published) posts.",
- "Published posts",
- "Posts that are scheduled to publish in the future."
- ],
- "repeated": true,
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require escalated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "PostList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "patch": {
- "id": "blogger.posts.patch",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "PATCH",
- "description": "Update a post. This method supports patch semantics.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "fetchBody": {
- "type": "boolean",
- "description": "Whether the body content of the post is included with the result (default: true).",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
- "location": "query"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to retrieve with the returned post.",
- "format": "uint32",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- },
- "publish": {
- "type": "boolean",
- "description": "Whether a publish action should be performed when the post is updated (default: false).",
- "location": "query"
- },
- "revert": {
- "type": "boolean",
- "description": "Whether a revert action should be performed when the post is updated (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "request": {
- "$ref": "Post"
- },
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "publish": {
- "id": "blogger.posts.publish",
- "path": "blogs/{blogId}/posts/{postId}/publish",
- "httpMethod": "POST",
- "description": "Publishes a draft post, optionally at the specific time of the given publishDate parameter.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- },
- "publishDate": {
- "type": "string",
- "description": "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.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "revert": {
- "id": "blogger.posts.revert",
- "path": "blogs/{blogId}/posts/{postId}/revert",
- "httpMethod": "POST",
- "description": "Revert a published or scheduled post to draft state.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "search": {
- "id": "blogger.posts.search",
- "path": "blogs/{blogId}/posts/search",
- "httpMethod": "GET",
- "description": "Search for a post.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch the post from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "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.",
- "default": "true",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sort search results",
- "default": "PUBLISHED",
- "enum": [
- "published",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the date the post was published",
- "Order by the date the post was last updated"
- ],
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Query terms to search this blog for matching posts.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "q"
- ],
- "response": {
- "$ref": "PostList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "update": {
- "id": "blogger.posts.update",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "PUT",
- "description": "Update a post.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "fetchBody": {
- "type": "boolean",
- "description": "Whether the body content of the post is included with the result (default: true).",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
- "location": "query"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to retrieve with the returned post.",
- "format": "uint32",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- },
- "publish": {
- "type": "boolean",
- "description": "Whether a publish action should be performed when the post is updated (default: false).",
- "location": "query"
- },
- "revert": {
- "type": "boolean",
- "description": "Whether a revert action should be performed when the post is updated (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "request": {
- "$ref": "Post"
- },
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "get": {
- "id": "blogger.users.get",
- "path": "users/{userId}",
- "httpMethod": "GET",
- "description": "Gets one user by ID.",
- "parameters": {
- "userId": {
- "type": "string",
- "description": "The ID of the user to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- }
- }
- }
- }
-}
+ "servicePath": "blogger/v3/",
+ "title": "Blogger API",
+ "version": "v3"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/books/v1/books-api.json b/vendor/google.golang.org/api/books/v1/books-api.json
index b23b59299..0bcc27029 100644
--- a/vendor/google.golang.org/api/books/v1/books-api.json
+++ b/vendor/google.golang.org/api/books/v1/books-api.json
@@ -1,4745 +1,4745 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/grKqkiLaDaBaqW7ezJtDaKmrU78\"",
- "discoveryVersion": "v1",
- "id": "books:v1",
- "name": "books",
- "version": "v1",
- "revision": "20171127",
- "title": "Books API",
- "description": "Searches for books and manages your Google Books library.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/ebooks-16.png",
- "x32": "https://www.google.com/images/icons/product/ebooks-32.png"
- },
- "documentationLink": "https://developers.google.com/books/docs/v1/getting_started",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/books/v1/",
- "basePath": "/books/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "books/v1/",
- "batchPath": "batch/books/v1",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/books": {
- "description": "Manage your books"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/books": {
+ "description": "Manage your books"
+ }
+ }
}
- }
- }
- },
- "schemas": {
- "Annotation": {
- "id": "Annotation",
- "type": "object",
- "properties": {
- "afterSelectedText": {
- "type": "string",
- "description": "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."
- },
- "beforeSelectedText": {
- "type": "string",
- "description": "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."
- },
- "clientVersionRanges": {
- "type": "object",
- "description": "Selection ranges sent from the client.",
- "properties": {
- "cfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in CFI format for this annotation sent by client."
- },
- "contentVersion": {
- "type": "string",
- "description": "Content version the client sent in."
- },
- "gbImageRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB image format for this annotation sent by client."
- },
- "gbTextRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB text format for this annotation sent by client."
- },
- "imageCfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in image CFI format for this annotation sent by client."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Timestamp for the created time of this annotation.",
- "format": "date-time"
- },
- "currentVersionRanges": {
- "type": "object",
- "description": "Selection ranges for the most recent content version.",
- "properties": {
- "cfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in CFI format for this annotation for version above."
- },
- "contentVersion": {
- "type": "string",
- "description": "Content version applicable to ranges below."
- },
- "gbImageRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB image format for this annotation for version above."
- },
- "gbTextRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB text format for this annotation for version above."
- },
- "imageCfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in image CFI format for this annotation for version above."
- }
- }
- },
- "data": {
- "type": "string",
- "description": "User-created data for this annotation."
- },
- "deleted": {
- "type": "boolean",
- "description": "Indicates that this annotation is deleted."
- },
- "highlightStyle": {
- "type": "string",
- "description": "The highlight style for this annotation."
- },
- "id": {
- "type": "string",
- "description": "Id of this annotation, in the form of a GUID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#annotation"
- },
- "layerId": {
- "type": "string",
- "description": "The layer this annotation is for."
- },
- "layerSummary": {
- "type": "object",
- "properties": {
- "allowedCharacterCount": {
- "type": "integer",
- "description": "Maximum allowed characters on this layer, especially for the \"copy\" layer.",
- "format": "int32"
- },
- "limitType": {
- "type": "string",
- "description": "Type of limitation on this layer. \"limited\" or \"unlimited\" for the \"copy\" layer."
- },
- "remainingCharacterCount": {
- "type": "integer",
- "description": "Remaining allowed characters on this layer, especially for the \"copy\" layer.",
- "format": "int32"
- }
- }
- },
- "pageIds": {
- "type": "array",
- "description": "Pages that this annotation spans.",
- "items": {
+ },
+ "basePath": "/books/v1/",
+ "baseUrl": "https://www.googleapis.com/books/v1/",
+ "batchPath": "batch/books/v1",
+ "description": "Searches for books and manages your Google Books library.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/books/docs/v1/getting_started",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/grKqkiLaDaBaqW7ezJtDaKmrU78\"",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/ebooks-16.png",
+ "x32": "https://www.google.com/images/icons/product/ebooks-32.png"
+ },
+ "id": "books:v1",
+ "kind": "discovery#restDescription",
+ "name": "books",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
},
- "selectedText": {
- "type": "string",
- "description": "Excerpt from the volume."
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
},
- "selfLink": {
- "type": "string",
- "description": "URL to this resource."
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
},
- "updated": {
- "type": "string",
- "description": "Timestamp for the last time this annotation was modified.",
- "format": "date-time"
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "volumeId": {
- "type": "string",
- "description": "The volume that this annotation belongs to."
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "Annotationdata": {
- "id": "Annotationdata",
- "type": "object",
- "properties": {
- "annotationType": {
- "type": "string",
- "description": "The type of annotation this data is for."
+ "protocol": "rest",
+ "resources": {
+ "bookshelves": {
+ "methods": {
+ "get": {
+ "description": "Retrieves metadata for a specific bookshelf for the specified user.",
+ "httpMethod": "GET",
+ "id": "books.bookshelves.get",
+ "parameterOrder": [
+ "userId",
+ "shelf"
+ ],
+ "parameters": {
+ "shelf": {
+ "description": "ID of bookshelf to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "userId": {
+ "description": "ID of user for whom to retrieve bookshelves.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}/bookshelves/{shelf}",
+ "response": {
+ "$ref": "Bookshelf"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of public bookshelves for the specified user.",
+ "httpMethod": "GET",
+ "id": "books.bookshelves.list",
+ "parameterOrder": [
+ "userId"
+ ],
+ "parameters": {
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "userId": {
+ "description": "ID of user for whom to retrieve bookshelves.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}/bookshelves",
+ "response": {
+ "$ref": "Bookshelves"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ },
+ "resources": {
+ "volumes": {
+ "methods": {
+ "list": {
+ "description": "Retrieves volumes in a specific bookshelf for the specified user.",
+ "httpMethod": "GET",
+ "id": "books.bookshelves.volumes.list",
+ "parameterOrder": [
+ "userId",
+ "shelf"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "shelf": {
+ "description": "ID of bookshelf to retrieve volumes.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "showPreorders": {
+ "description": "Set to true to show pre-ordered books. Defaults to false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first element to return (starts at 0)",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "userId": {
+ "description": "ID of user for whom to retrieve bookshelf volumes.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/{userId}/bookshelves/{shelf}/volumes",
+ "response": {
+ "$ref": "Volumes"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ }
+ }
},
- "data": {
- "type": "any"
+ "cloudloading": {
+ "methods": {
+ "addBook": {
+ "description": "",
+ "httpMethod": "POST",
+ "id": "books.cloudloading.addBook",
+ "parameters": {
+ "drive_document_id": {
+ "description": "A drive document id. The upload_client_token must not be set.",
+ "location": "query",
+ "type": "string"
+ },
+ "mime_type": {
+ "description": "The document MIME type. It can be set only if the drive_document_id is set.",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The document name. It can be set only if the drive_document_id is set.",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_client_token": {
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "cloudloading/addBook",
+ "response": {
+ "$ref": "BooksCloudloadingResource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "deleteBook": {
+ "description": "Remove the book and its contents",
+ "httpMethod": "POST",
+ "id": "books.cloudloading.deleteBook",
+ "parameterOrder": [
+ "volumeId"
+ ],
+ "parameters": {
+ "volumeId": {
+ "description": "The id of the book to be removed.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "cloudloading/deleteBook",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "updateBook": {
+ "description": "",
+ "httpMethod": "POST",
+ "id": "books.cloudloading.updateBook",
+ "path": "cloudloading/updateBook",
+ "request": {
+ "$ref": "BooksCloudloadingResource"
+ },
+ "response": {
+ "$ref": "BooksCloudloadingResource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
},
- "encoded_data": {
- "type": "string",
- "description": "Base64 encoded data for this annotation data.",
- "format": "byte"
+ "dictionary": {
+ "methods": {
+ "listOfflineMetadata": {
+ "description": "Returns a list of offline dictionary metadata available",
+ "httpMethod": "GET",
+ "id": "books.dictionary.listOfflineMetadata",
+ "parameterOrder": [
+ "cpksver"
+ ],
+ "parameters": {
+ "cpksver": {
+ "description": "The device/version ID from which to request the data.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "dictionary/listOfflineMetadata",
+ "response": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
},
- "id": {
- "type": "string",
- "description": "Unique id for this annotation data."
- },
- "kind": {
- "type": "string",
- "description": "Resource Type",
- "default": "books#annotationdata"
- },
- "layerId": {
- "type": "string",
- "description": "The Layer id for this data. *"
- },
- "selfLink": {
- "type": "string",
- "description": "URL for this resource. *"
- },
- "updated": {
- "type": "string",
- "description": "Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).",
- "format": "date-time"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume id for this data. *"
- }
- }
- },
- "Annotations": {
- "id": "Annotations",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of annotations.",
- "items": {
- "$ref": "Annotation"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#annotations"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results."
- },
- "totalItems": {
- "type": "integer",
- "description": "Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.",
- "format": "int32"
- }
- }
- },
- "AnnotationsSummary": {
- "id": "AnnotationsSummary",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "default": "books#annotationsSummary"
+ "familysharing": {
+ "methods": {
+ "getFamilyInfo": {
+ "description": "Gets information regarding the family that the user is part of.",
+ "httpMethod": "GET",
+ "id": "books.familysharing.getFamilyInfo",
+ "parameters": {
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "familysharing/getFamilyInfo",
+ "response": {
+ "$ref": "FamilyInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "share": {
+ "description": "Initiates sharing of the content with the user's family. Empty response indicates success.",
+ "httpMethod": "POST",
+ "id": "books.familysharing.share",
+ "parameters": {
+ "docId": {
+ "description": "The docid to share.",
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to share.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "familysharing/share",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "unshare": {
+ "description": "Initiates revoking content that has already been shared with the user's family. Empty response indicates success.",
+ "httpMethod": "POST",
+ "id": "books.familysharing.unshare",
+ "parameters": {
+ "docId": {
+ "description": "The docid to unshare.",
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to unshare.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "familysharing/unshare",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
},
"layers": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "allowedCharacterCount": {
- "type": "integer",
- "format": "int32"
- },
- "layerId": {
- "type": "string"
- },
- "limitType": {
- "type": "string"
- },
- "remainingCharacterCount": {
- "type": "integer",
- "format": "int32"
- },
- "updated": {
- "type": "string",
- "format": "date-time"
- }
- }
- }
- }
- }
- },
- "Annotationsdata": {
- "id": "Annotationsdata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of Annotation Data.",
- "items": {
- "$ref": "Annotationdata"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type",
- "default": "books#annotationsdata"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results."
- },
- "totalItems": {
- "type": "integer",
- "description": "The total number of volume annotations found.",
- "format": "int32"
- }
- }
- },
- "BooksAnnotationsRange": {
- "id": "BooksAnnotationsRange",
- "type": "object",
- "properties": {
- "endOffset": {
- "type": "string",
- "description": "The offset from the ending position."
- },
- "endPosition": {
- "type": "string",
- "description": "The ending position for the range."
- },
- "startOffset": {
- "type": "string",
- "description": "The offset from the starting position."
- },
- "startPosition": {
- "type": "string",
- "description": "The starting position for the range."
- }
- }
- },
- "BooksCloudloadingResource": {
- "id": "BooksCloudloadingResource",
- "type": "object",
- "properties": {
- "author": {
- "type": "string"
- },
- "processingState": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "volumeId": {
- "type": "string"
- }
- }
- },
- "BooksVolumesRecommendedRateResponse": {
- "id": "BooksVolumesRecommendedRateResponse",
- "type": "object",
- "properties": {
- "consistency_token": {
- "type": "string"
- }
- }
- },
- "Bookshelf": {
- "id": "Bookshelf",
- "type": "object",
- "properties": {
- "access": {
- "type": "string",
- "description": "Whether this bookshelf is PUBLIC or PRIVATE."
- },
- "created": {
- "type": "string",
- "description": "Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).",
- "format": "date-time"
- },
- "description": {
- "type": "string",
- "description": "Description of this bookshelf."
- },
- "id": {
- "type": "integer",
- "description": "Id of this bookshelf, only unique by user.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for bookshelf metadata.",
- "default": "books#bookshelf"
- },
- "selfLink": {
- "type": "string",
- "description": "URL to this resource."
- },
- "title": {
- "type": "string",
- "description": "Title of this bookshelf."
- },
- "updated": {
- "type": "string",
- "description": "Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).",
- "format": "date-time"
- },
- "volumeCount": {
- "type": "integer",
- "description": "Number of volumes in this bookshelf.",
- "format": "int32"
- },
- "volumesLastUpdated": {
- "type": "string",
- "description": "Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).",
- "format": "date-time"
- }
- }
- },
- "Bookshelves": {
- "id": "Bookshelves",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of bookshelves.",
- "items": {
- "$ref": "Bookshelf"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#bookshelves"
- }
- }
- },
- "Category": {
- "id": "Category",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of onboarding categories.",
- "items": {
- "type": "object",
- "properties": {
- "badgeUrl": {
- "type": "string"
- },
- "categoryId": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "onboarding#category"
- }
- }
- },
- "ConcurrentAccessRestriction": {
- "id": "ConcurrentAccessRestriction",
- "type": "object",
- "properties": {
- "deviceAllowed": {
- "type": "boolean",
- "description": "Whether access is granted for this (user, device, volume)."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#concurrentAccessRestriction"
- },
- "maxConcurrentDevices": {
- "type": "integer",
- "description": "The maximum number of concurrent access licenses for this volume.",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "Error/warning message."
- },
- "nonce": {
- "type": "string",
- "description": "Client nonce for verification. Download access and client-validation only."
- },
- "reasonCode": {
- "type": "string",
- "description": "Error/warning reason code."
- },
- "restricted": {
- "type": "boolean",
- "description": "Whether this volume has any concurrent access restrictions."
- },
- "signature": {
- "type": "string",
- "description": "Response signature."
- },
- "source": {
- "type": "string",
- "description": "Client app identifier for verification. Download access and client-validation only."
- },
- "timeWindowSeconds": {
- "type": "integer",
- "description": "Time in seconds for license auto-expiration.",
- "format": "int32"
- },
- "volumeId": {
- "type": "string",
- "description": "Identifies the volume for which this entry applies."
- }
- }
- },
- "Dictlayerdata": {
- "id": "Dictlayerdata",
- "type": "object",
- "properties": {
- "common": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The display title and localized canonical name to use when searching for this entity on Google search."
- }
- }
- },
- "dict": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "description": "The source, url and attribution for this dictionary data.",
- "properties": {
- "attribution": {
- "type": "string"
+ "methods": {
+ "get": {
+ "description": "Gets the layer summary for a volume.",
+ "httpMethod": "GET",
+ "id": "books.layers.get",
+ "parameterOrder": [
+ "volumeId",
+ "summaryId"
+ ],
+ "parameters": {
+ "contentVersion": {
+ "description": "The content version for the requested volume.",
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "summaryId": {
+ "description": "The ID for the layer to get the summary for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to retrieve layers for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "volumes/{volumeId}/layersummary/{summaryId}",
+ "response": {
+ "$ref": "Layersummary"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
},
- "url": {
- "type": "string"
+ "list": {
+ "description": "List the layer summaries for a volume.",
+ "httpMethod": "GET",
+ "id": "books.layers.list",
+ "parameterOrder": [
+ "volumeId"
+ ],
+ "parameters": {
+ "contentVersion": {
+ "description": "The content version for the requested volume.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "200",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous page.",
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to retrieve layers for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "volumes/{volumeId}/layersummary",
+ "response": {
+ "$ref": "Layersummaries"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
}
- }
},
- "words": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "derivatives": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
+ "resources": {
+ "annotationData": {
+ "methods": {
+ "get": {
+ "description": "Gets the annotation data.",
+ "httpMethod": "GET",
+ "id": "books.layers.annotationData.get",
+ "parameterOrder": [
+ "volumeId",
+ "layerId",
+ "annotationDataId",
+ "contentVersion"
+ ],
+ "parameters": {
+ "allowWebDefinitions": {
+ "description": "For the dictionary layer. Whether or not to allow web definitions.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "annotationDataId": {
+ "description": "The ID of the annotation data to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "contentVersion": {
+ "description": "The content version for the volume you are trying to retrieve.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "h": {
+ "description": "The requested pixel height for any images. If height is provided width must also be provided.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "layerId": {
+ "description": "The ID for the layer to get the annotations.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
+ "location": "query",
+ "type": "string"
+ },
+ "scale": {
+ "description": "The requested scale for the image.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to retrieve annotations for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "w": {
+ "description": "The requested pixel width for any images. If width is provided height must also be provided.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ }
},
- "url": {
- "type": "string"
- }
- }
- },
- "text": {
- "type": "string"
- }
- }
- }
- },
- "examples": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
+ "path": "volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}",
+ "response": {
+ "$ref": "Annotationdata"
},
- "url": {
- "type": "string"
- }
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
},
- "text": {
- "type": "string"
+ "list": {
+ "description": "Gets the annotation data for a volume and layer.",
+ "httpMethod": "GET",
+ "id": "books.layers.annotationData.list",
+ "parameterOrder": [
+ "volumeId",
+ "layerId",
+ "contentVersion"
+ ],
+ "parameters": {
+ "annotationDataId": {
+ "description": "The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "contentVersion": {
+ "description": "The content version for the requested volume.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "h": {
+ "description": "The requested pixel height for any images. If height is provided width must also be provided.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "layerId": {
+ "description": "The ID for the layer to get the annotation data.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "200",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous page.",
+ "location": "query",
+ "type": "string"
+ },
+ "scale": {
+ "description": "The requested scale for the image.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "updatedMax": {
+ "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
+ "location": "query",
+ "type": "string"
+ },
+ "updatedMin": {
+ "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to retrieve annotation data for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "w": {
+ "description": "The requested pixel width for any images. If width is provided height must also be provided.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ }
+ },
+ "path": "volumes/{volumeId}/layers/{layerId}/data",
+ "response": {
+ "$ref": "Annotationsdata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
}
- }
}
- },
- "senses": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "conjugations": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- }
+ },
+ "volumeAnnotations": {
+ "methods": {
+ "get": {
+ "description": "Gets the volume annotation.",
+ "httpMethod": "GET",
+ "id": "books.layers.volumeAnnotations.get",
+ "parameterOrder": [
+ "volumeId",
+ "layerId",
+ "annotationId"
+ ],
+ "parameters": {
+ "annotationId": {
+ "description": "The ID of the volume annotation to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "layerId": {
+ "description": "The ID for the layer to get the annotations.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to retrieve annotations for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}",
+ "response": {
+ "$ref": "Volumeannotation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
},
- "definitions": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "definition": {
- "type": "string"
- },
- "examples": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
+ "list": {
+ "description": "Gets the volume annotations for a volume and layer.",
+ "httpMethod": "GET",
+ "id": "books.layers.volumeAnnotations.list",
+ "parameterOrder": [
+ "volumeId",
+ "layerId",
+ "contentVersion"
+ ],
+ "parameters": {
+ "contentVersion": {
+ "description": "The content version for the requested volume.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "endOffset": {
+ "description": "The end offset to end retrieving data from.",
+ "location": "query",
+ "type": "string"
+ },
+ "endPosition": {
+ "description": "The end position to end retrieving data from.",
+ "location": "query",
+ "type": "string"
+ },
+ "layerId": {
+ "description": "The ID for the layer to get the annotations.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "200",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous page.",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "startOffset": {
+ "description": "The start offset to start retrieving data from.",
+ "location": "query",
+ "type": "string"
+ },
+ "startPosition": {
+ "description": "The start position to start retrieving data from.",
+ "location": "query",
+ "type": "string"
+ },
+ "updatedMax": {
+ "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
+ "location": "query",
+ "type": "string"
+ },
+ "updatedMin": {
+ "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeAnnotationsVersion": {
+ "description": "The version of the volume annotations that you are requesting.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to retrieve annotations for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "volumes/{volumeId}/layers/{layerId}",
+ "response": {
+ "$ref": "Volumeannotations"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "myconfig": {
+ "methods": {
+ "getUserSettings": {
+ "description": "Gets the current settings for the user.",
+ "httpMethod": "GET",
+ "id": "books.myconfig.getUserSettings",
+ "path": "myconfig/getUserSettings",
+ "response": {
+ "$ref": "Usersettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "releaseDownloadAccess": {
+ "description": "Release downloaded content access restriction.",
+ "httpMethod": "POST",
+ "id": "books.myconfig.releaseDownloadAccess",
+ "parameterOrder": [
+ "volumeIds",
+ "cpksver"
+ ],
+ "parameters": {
+ "cpksver": {
+ "description": "The device/version ID from which to release the restriction.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeIds": {
+ "description": "The volume(s) to release restrictions for.",
+ "location": "query",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "myconfig/releaseDownloadAccess",
+ "response": {
+ "$ref": "DownloadAccesses"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "requestAccess": {
+ "description": "Request concurrent and download access restrictions.",
+ "httpMethod": "POST",
+ "id": "books.myconfig.requestAccess",
+ "parameterOrder": [
+ "source",
+ "volumeId",
+ "nonce",
+ "cpksver"
+ ],
+ "parameters": {
+ "cpksver": {
+ "description": "The device/version ID from which to request the restrictions.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "licenseTypes": {
+ "description": "The type of access license to request. If not specified, the default is BOTH.",
+ "enum": [
+ "BOTH",
+ "CONCURRENT",
+ "DOWNLOAD"
+ ],
+ "enumDescriptions": [
+ "Both concurrent and download licenses.",
+ "Concurrent access license.",
+ "Offline download access license."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "locale": {
+ "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
+ "location": "query",
+ "type": "string"
+ },
+ "nonce": {
+ "description": "The client nonce value.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to request concurrent/download restrictions for.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "myconfig/requestAccess",
+ "response": {
+ "$ref": "RequestAccess"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "syncVolumeLicenses": {
+ "description": "Request downloaded content access for specified volumes on the My eBooks shelf.",
+ "httpMethod": "POST",
+ "id": "books.myconfig.syncVolumeLicenses",
+ "parameterOrder": [
+ "source",
+ "nonce",
+ "cpksver"
+ ],
+ "parameters": {
+ "cpksver": {
+ "description": "The device/version ID from which to release the restriction.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "features": {
+ "description": "List of features supported by the client, i.e., 'RENTALS'",
+ "enum": [
+ "RENTALS"
+ ],
+ "enumDescriptions": [
+ "Client supports rentals."
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "includeNonComicsSeries": {
+ "description": "Set to true to include non-comics series. Defaults to false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "locale": {
+ "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
+ "location": "query",
+ "type": "string"
+ },
+ "nonce": {
+ "description": "The client nonce value.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "showPreorders": {
+ "description": "Set to true to show pre-ordered books. Defaults to false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "volumeIds": {
+ "description": "The volume(s) to request download restrictions for.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "myconfig/syncVolumeLicenses",
+ "response": {
+ "$ref": "Volumes"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "updateUserSettings": {
+ "description": "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.",
+ "httpMethod": "POST",
+ "id": "books.myconfig.updateUserSettings",
+ "path": "myconfig/updateUserSettings",
+ "request": {
+ "$ref": "Usersettings"
+ },
+ "response": {
+ "$ref": "Usersettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
+ "mylibrary": {
+ "resources": {
+ "annotations": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an annotation.",
+ "httpMethod": "DELETE",
+ "id": "books.mylibrary.annotations.delete",
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "parameters": {
+ "annotationId": {
+ "description": "The ID for the annotation to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/annotations/{annotationId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "insert": {
+ "description": "Inserts a new annotation.",
+ "httpMethod": "POST",
+ "id": "books.mylibrary.annotations.insert",
+ "parameters": {
+ "annotationId": {
+ "description": "The ID for the annotation to insert.",
+ "location": "query",
+ "type": "string"
+ },
+ "country": {
+ "description": "ISO-3166-1 code to override the IP-based location.",
+ "location": "query",
+ "type": "string"
+ },
+ "showOnlySummaryInResponse": {
+ "description": "Requests that only the summary of the specified layer be provided in the response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/annotations",
+ "request": {
+ "$ref": "Annotation"
+ },
+ "response": {
+ "$ref": "Annotation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of annotations, possibly filtered.",
+ "httpMethod": "GET",
+ "id": "books.mylibrary.annotations.list",
+ "parameters": {
+ "contentVersion": {
+ "description": "The content version for the requested volume.",
+ "location": "query",
+ "type": "string"
+ },
+ "layerId": {
+ "description": "The layer ID to limit annotation by.",
+ "location": "query",
+ "type": "string"
+ },
+ "layerIds": {
+ "description": "The layer ID(s) to limit annotation by.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "40",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous page.",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "updatedMax": {
+ "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
+ "location": "query",
+ "type": "string"
+ },
+ "updatedMin": {
+ "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume to restrict annotations to.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/annotations",
+ "response": {
+ "$ref": "Annotations"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "summary": {
+ "description": "Gets the summary of specified layers.",
+ "httpMethod": "POST",
+ "id": "books.mylibrary.annotations.summary",
+ "parameterOrder": [
+ "layerIds",
+ "volumeId"
+ ],
+ "parameters": {
+ "layerIds": {
+ "description": "Array of layer IDs to get the summary for.",
+ "location": "query",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "Volume id to get the summary for.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/annotations/summary",
+ "response": {
+ "$ref": "AnnotationsSummary"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "update": {
+ "description": "Updates an existing annotation.",
+ "httpMethod": "PUT",
+ "id": "books.mylibrary.annotations.update",
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "parameters": {
+ "annotationId": {
+ "description": "The ID for the annotation to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/annotations/{annotationId}",
+ "request": {
+ "$ref": "Annotation"
+ },
+ "response": {
+ "$ref": "Annotation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
+ "bookshelves": {
+ "methods": {
+ "addVolume": {
+ "description": "Adds a volume to a bookshelf.",
+ "httpMethod": "POST",
+ "id": "books.mylibrary.bookshelves.addVolume",
+ "parameterOrder": [
+ "shelf",
+ "volumeId"
+ ],
+ "parameters": {
+ "reason": {
+ "description": "The reason for which the book is added to the library.",
+ "enum": [
+ "IOS_PREX",
+ "IOS_SEARCH",
+ "ONBOARDING"
+ ],
+ "enumDescriptions": [
+ "Volumes added from the PREX flow on iOS.",
+ "Volumes added from the Search flow on iOS.",
+ "Volumes added from the Onboarding flow."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "shelf": {
+ "description": "ID of bookshelf to which to add a volume.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "ID of volume to add.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/bookshelves/{shelf}/addVolume",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "clearVolumes": {
+ "description": "Clears all volumes from a bookshelf.",
+ "httpMethod": "POST",
+ "id": "books.mylibrary.bookshelves.clearVolumes",
+ "parameterOrder": [
+ "shelf"
+ ],
+ "parameters": {
+ "shelf": {
+ "description": "ID of bookshelf from which to remove a volume.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/bookshelves/{shelf}/clearVolumes",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "get": {
+ "description": "Retrieves metadata for a specific bookshelf belonging to the authenticated user.",
+ "httpMethod": "GET",
+ "id": "books.mylibrary.bookshelves.get",
+ "parameterOrder": [
+ "shelf"
+ ],
+ "parameters": {
+ "shelf": {
+ "description": "ID of bookshelf to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/bookshelves/{shelf}",
+ "response": {
+ "$ref": "Bookshelf"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of bookshelves belonging to the authenticated user.",
+ "httpMethod": "GET",
+ "id": "books.mylibrary.bookshelves.list",
+ "parameters": {
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/bookshelves",
+ "response": {
+ "$ref": "Bookshelves"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "moveVolume": {
+ "description": "Moves a volume within a bookshelf.",
+ "httpMethod": "POST",
+ "id": "books.mylibrary.bookshelves.moveVolume",
+ "parameterOrder": [
+ "shelf",
+ "volumeId",
+ "volumePosition"
+ ],
+ "parameters": {
+ "shelf": {
+ "description": "ID of bookshelf with the volume.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "ID of volume to move.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "volumePosition": {
+ "description": "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.)",
+ "format": "int32",
+ "location": "query",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "path": "mylibrary/bookshelves/{shelf}/moveVolume",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "removeVolume": {
+ "description": "Removes a volume from a bookshelf.",
+ "httpMethod": "POST",
+ "id": "books.mylibrary.bookshelves.removeVolume",
+ "parameterOrder": [
+ "shelf",
+ "volumeId"
+ ],
+ "parameters": {
+ "reason": {
+ "description": "The reason for which the book is removed from the library.",
+ "enum": [
+ "ONBOARDING"
+ ],
+ "enumDescriptions": [
+ "Samples removed from the Onboarding flow."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "shelf": {
+ "description": "ID of bookshelf from which to remove a volume.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "ID of volume to remove.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/bookshelves/{shelf}/removeVolume",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ },
+ "resources": {
+ "volumes": {
+ "methods": {
+ "list": {
+ "description": "Gets volume information for volumes on a bookshelf.",
+ "httpMethod": "GET",
+ "id": "books.mylibrary.bookshelves.volumes.list",
+ "parameterOrder": [
+ "shelf"
+ ],
+ "parameters": {
+ "country": {
+ "description": "ISO-3166-1 code to override the IP-based location.",
+ "location": "query",
+ "type": "string"
},
- "url": {
- "type": "string"
+ "maxResults": {
+ "description": "Maximum number of results to return",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields.",
+ "enum": [
+ "full",
+ "lite"
+ ],
+ "enumDescriptions": [
+ "Includes all volume data.",
+ "Includes a subset of fields in volumeInfo and accessInfo."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "q": {
+ "description": "Full-text search query string in this bookshelf.",
+ "location": "query",
+ "type": "string"
+ },
+ "shelf": {
+ "description": "The bookshelf ID or name retrieve volumes for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "showPreorders": {
+ "description": "Set to true to show pre-ordered books. Defaults to false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first element to return (starts at 0)",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
}
- }
},
- "text": {
- "type": "string"
- }
- }
+ "path": "mylibrary/bookshelves/{shelf}/volumes",
+ "response": {
+ "$ref": "Volumes"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
}
- }
}
- }
- },
- "partOfSpeech": {
- "type": "string"
- },
- "pronunciation": {
- "type": "string"
- },
- "pronunciationUrl": {
- "type": "string"
- },
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "syllabification": {
- "type": "string"
- },
- "synonyms": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "text": {
- "type": "string"
- }
- }
- }
}
- }
}
- },
- "source": {
- "type": "object",
- "description": "The words with different meanings but not related words, e.g. \"go\" (game) and \"go\" (verb).",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "default": "books#dictlayerdata"
- }
- }
- },
- "Discoveryclusters": {
- "id": "Discoveryclusters",
- "type": "object",
- "properties": {
- "clusters": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "banner_with_content_container": {
- "type": "object",
- "properties": {
- "fillColorArgb": {
- "type": "string"
- },
- "imageUrl": {
- "type": "string"
- },
- "maskColorArgb": {
- "type": "string"
- },
- "moreButtonText": {
- "type": "string"
- },
- "moreButtonUrl": {
- "type": "string"
- },
- "textColorArgb": {
- "type": "string"
- }
- }
- },
- "subTitle": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "totalVolumes": {
- "type": "integer",
- "format": "int32"
- },
- "uid": {
- "type": "string"
- },
- "volumes": {
- "type": "array",
- "items": {
- "$ref": "Volume"
- }
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resorce type.",
- "default": "books#discovery#clusters"
- },
- "totalClusters": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "DownloadAccessRestriction": {
- "id": "DownloadAccessRestriction",
- "type": "object",
- "properties": {
- "deviceAllowed": {
- "type": "boolean",
- "description": "If restricted, whether access is granted for this (user, device, volume)."
- },
- "downloadsAcquired": {
- "type": "integer",
- "description": "If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).",
- "format": "int32"
- },
- "justAcquired": {
- "type": "boolean",
- "description": "If deviceAllowed, whether access was just acquired with this request."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#downloadAccessRestriction"
- },
- "maxDownloadDevices": {
- "type": "integer",
- "description": "If restricted, the maximum number of content download licenses for this volume.",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "Error/warning message."
- },
- "nonce": {
- "type": "string",
- "description": "Client nonce for verification. Download access and client-validation only."
- },
- "reasonCode": {
- "type": "string",
- "description": "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"
- },
- "restricted": {
- "type": "boolean",
- "description": "Whether this volume has any download access restrictions."
- },
- "signature": {
- "type": "string",
- "description": "Response signature."
- },
- "source": {
- "type": "string",
- "description": "Client app identifier for verification. Download access and client-validation only."
- },
- "volumeId": {
- "type": "string",
- "description": "Identifies the volume for which this entry applies."
- }
- }
- },
- "DownloadAccesses": {
- "id": "DownloadAccesses",
- "type": "object",
- "properties": {
- "downloadAccessList": {
- "type": "array",
- "description": "A list of download access responses.",
- "items": {
- "$ref": "DownloadAccessRestriction"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#downloadAccesses"
- }
- }
- },
- "FamilyInfo": {
- "id": "FamilyInfo",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#familyInfo"
- },
- "membership": {
- "type": "object",
- "description": "Family membership info of the user that made the request.",
- "properties": {
- "acquirePermission": {
- "type": "string",
- "description": "Restrictions on user buying and acquiring content."
- },
- "ageGroup": {
- "type": "string",
- "description": "The age group of the user."
- },
- "allowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating for the user."
- },
- "isInFamily": {
- "type": "boolean"
- },
- "role": {
- "type": "string",
- "description": "The role of the user in the family."
- }
- }
- }
- }
- },
- "Geolayerdata": {
- "id": "Geolayerdata",
- "type": "object",
- "properties": {
- "common": {
- "type": "object",
- "properties": {
- "lang": {
- "type": "string",
- "description": "The language of the information url and description."
- },
- "previewImageUrl": {
- "type": "string",
- "description": "The URL for the preview image information."
- },
- "snippet": {
- "type": "string",
- "description": "The description for this location."
- },
- "snippetUrl": {
- "type": "string",
- "description": "The URL for information for this location. Ex: wikipedia link."
- },
- "title": {
- "type": "string",
- "description": "The display title and localized canonical name to use when searching for this entity on Google search."
- }
- }
- },
- "geo": {
- "type": "object",
- "properties": {
- "boundary": {
- "type": "array",
- "description": "The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.",
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "latitude": {
- "type": "integer",
- "format": "uint32"
- },
- "longitude": {
- "type": "integer",
- "format": "uint32"
- }
- }
- }
- }
- },
- "cachePolicy": {
- "type": "string",
- "description": "The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER"
- },
- "countryCode": {
- "type": "string",
- "description": "The country code of the location."
- },
- "latitude": {
- "type": "number",
- "description": "The latitude of the location.",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "description": "The longitude of the location.",
- "format": "double"
- },
- "mapType": {
- "type": "string",
- "description": "The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN"
- },
- "viewport": {
- "type": "object",
- "description": "The viewport for showing this location. This is a latitude, longitude rectangle.",
- "properties": {
- "hi": {
- "type": "object",
- "properties": {
- "latitude": {
- "type": "number",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "format": "double"
- }
- }
},
- "lo": {
- "type": "object",
- "properties": {
- "latitude": {
- "type": "number",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "format": "double"
+ "readingpositions": {
+ "methods": {
+ "get": {
+ "description": "Retrieves my reading position information for a volume.",
+ "httpMethod": "GET",
+ "id": "books.mylibrary.readingpositions.get",
+ "parameterOrder": [
+ "volumeId"
+ ],
+ "parameters": {
+ "contentVersion": {
+ "description": "Volume content version for which this reading position is requested.",
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "ID of volume for which to retrieve a reading position.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/readingpositions/{volumeId}",
+ "response": {
+ "$ref": "ReadingPosition"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "setPosition": {
+ "description": "Sets my reading position information for a volume.",
+ "httpMethod": "POST",
+ "id": "books.mylibrary.readingpositions.setPosition",
+ "parameterOrder": [
+ "volumeId",
+ "timestamp",
+ "position"
+ ],
+ "parameters": {
+ "action": {
+ "description": "Action that caused this reading position to be set.",
+ "enum": [
+ "bookmark",
+ "chapter",
+ "next-page",
+ "prev-page",
+ "scroll",
+ "search"
+ ],
+ "enumDescriptions": [
+ "User chose bookmark within volume.",
+ "User selected chapter from list.",
+ "Next page event.",
+ "Previous page event.",
+ "User navigated to page.",
+ "User chose search results within volume."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "contentVersion": {
+ "description": "Volume content version for which this reading position applies.",
+ "location": "query",
+ "type": "string"
+ },
+ "deviceCookie": {
+ "description": "Random persistent device cookie optional on set position.",
+ "location": "query",
+ "type": "string"
+ },
+ "position": {
+ "description": "Position string for the new volume reading position.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "RFC 3339 UTC format timestamp associated with this reading position.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "ID of volume for which to update the reading position.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "mylibrary/readingpositions/{volumeId}/setPosition",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
}
- }
}
- }
- },
- "zoom": {
- "type": "integer",
- "description": "The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels",
- "format": "int32"
}
- }
- },
- "kind": {
- "type": "string",
- "default": "books#geolayerdata"
- }
- }
- },
- "Layersummaries": {
- "id": "Layersummaries",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of layer summary items.",
- "items": {
- "$ref": "Layersummary"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#layersummaries"
- },
- "totalItems": {
- "type": "integer",
- "description": "The total number of layer summaries found.",
- "format": "int32"
- }
- }
- },
- "Layersummary": {
- "id": "Layersummary",
- "type": "object",
- "properties": {
- "annotationCount": {
- "type": "integer",
- "description": "The number of annotations for this layer.",
- "format": "int32"
- },
- "annotationTypes": {
- "type": "array",
- "description": "The list of annotation types contained for this layer.",
- "items": {
- "type": "string"
- }
- },
- "annotationsDataLink": {
- "type": "string",
- "description": "Link to get data for this annotation."
- },
- "annotationsLink": {
- "type": "string",
- "description": "The link to get the annotations for this layer."
- },
- "contentVersion": {
- "type": "string",
- "description": "The content version this resource is for."
- },
- "dataCount": {
- "type": "integer",
- "description": "The number of data items for this layer.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "Unique id of this layer summary."
- },
- "kind": {
- "type": "string",
- "description": "Resource Type",
- "default": "books#layersummary"
- },
- "layerId": {
- "type": "string",
- "description": "The layer id for this summary."
- },
- "selfLink": {
- "type": "string",
- "description": "URL to this resource."
- },
- "updated": {
- "type": "string",
- "description": "Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).",
- "format": "date-time"
- },
- "volumeAnnotationsVersion": {
- "type": "string",
- "description": "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."
- },
- "volumeId": {
- "type": "string",
- "description": "The volume id this resource is for."
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of offline dictionary metadata.",
- "items": {
- "type": "object",
- "properties": {
- "download_url": {
- "type": "string"
- },
- "encrypted_key": {
- "type": "string"
- },
- "language": {
- "type": "string"
- },
- "size": {
- "type": "string",
- "format": "int64"
- },
- "version": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "dictionary#metadata"
- }
- }
- },
- "Notification": {
- "id": "Notification",
- "type": "object",
- "properties": {
- "body": {
- "type": "string"
- },
- "crmExperimentIds": {
- "type": "array",
- "description": "The list of crm experiment ids.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "doc_id": {
- "type": "string"
- },
- "doc_type": {
- "type": "string"
- },
- "dont_show_notification": {
- "type": "boolean"
- },
- "iconUrl": {
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#notification"
- },
- "notificationGroup": {
- "type": "string"
- },
- "notification_type": {
- "type": "string"
- },
- "pcampaign_id": {
- "type": "string"
- },
- "reason": {
- "type": "string"
- },
- "show_notification_settings_action": {
- "type": "boolean"
- },
- "targetUrl": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- }
- },
- "Offers": {
- "id": "Offers",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of offers.",
- "items": {
- "type": "object",
- "properties": {
- "artUrl": {
- "type": "string"
- },
- "gservicesKey": {
- "type": "string"
- },
- "id": {
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "author": {
- "type": "string"
- },
- "canonicalVolumeLink": {
- "type": "string"
- },
- "coverUrl": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "volumeId": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "promooffer#offers"
- }
- }
- },
- "ReadingPosition": {
- "id": "ReadingPosition",
- "type": "object",
- "properties": {
- "epubCfiPosition": {
- "type": "string",
- "description": "Position in an EPUB as a CFI."
- },
- "gbImagePosition": {
- "type": "string",
- "description": "Position in a volume for image-based content."
- },
- "gbTextPosition": {
- "type": "string",
- "description": "Position in a volume for text-based content."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for a reading position.",
- "default": "books#readingPosition"
- },
- "pdfPosition": {
- "type": "string",
- "description": "Position in a PDF file."
- },
- "updated": {
- "type": "string",
- "description": "Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).",
- "format": "date-time"
- },
- "volumeId": {
- "type": "string",
- "description": "Volume id associated with this reading position."
- }
- }
- },
- "RequestAccess": {
- "id": "RequestAccess",
- "type": "object",
- "properties": {
- "concurrentAccess": {
- "$ref": "ConcurrentAccessRestriction",
- "description": "A concurrent access response."
- },
- "downloadAccess": {
- "$ref": "DownloadAccessRestriction",
- "description": "A download access response."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#requestAccess"
- }
- }
- },
- "Review": {
- "id": "Review",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "Author of this review.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "Name of this person."
- }
- }
- },
- "content": {
- "type": "string",
- "description": "Review text."
- },
- "date": {
- "type": "string",
- "description": "Date of this review."
- },
- "fullTextUrl": {
- "type": "string",
- "description": "URL for the full review text, for reviews gathered from the web."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for a review.",
- "default": "books#review"
- },
- "rating": {
- "type": "string",
- "description": "Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED."
- },
- "source": {
- "type": "object",
- "description": "Information regarding the source of this review, when the review is not from a Google Books user.",
- "properties": {
- "description": {
- "type": "string",
- "description": "Name of the source."
- },
- "extraDescription": {
- "type": "string",
- "description": "Extra text about the source of the review."
- },
- "url": {
- "type": "string",
- "description": "URL of the source of the review."
- }
- }
- },
- "title": {
- "type": "string",
- "description": "Title for this review."
- },
- "type": {
- "type": "string",
- "description": "Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER."
- },
- "volumeId": {
- "type": "string",
- "description": "Volume that this review is for."
- }
- }
- },
- "Series": {
- "id": "Series",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#series"
- },
- "series": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "bannerImageUrl": {
- "type": "string"
- },
- "imageUrl": {
- "type": "string"
- },
- "seriesId": {
- "type": "string"
- },
- "seriesType": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "Seriesmembership": {
- "id": "Seriesmembership",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resorce type.",
- "default": "books#series#membership"
- },
- "member": {
- "type": "array",
- "items": {
- "$ref": "Volume"
- }
- },
- "nextPageToken": {
- "type": "string"
- }
- }
- },
- "Usersettings": {
- "id": "Usersettings",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#usersettings"
- },
- "notesExport": {
- "type": "object",
- "description": "User settings in sub-objects, each for different purposes.",
- "properties": {
- "folderName": {
- "type": "string"
- },
- "isEnabled": {
- "type": "boolean"
- }
- }
},
"notification": {
- "type": "object",
- "properties": {
- "matchMyInterests": {
- "type": "object",
- "properties": {
- "opted_state": {
- "type": "string"
+ "methods": {
+ "get": {
+ "description": "Returns notification details for a given notification id.",
+ "httpMethod": "GET",
+ "id": "books.notification.get",
+ "parameterOrder": [
+ "notification_id"
+ ],
+ "parameters": {
+ "locale": {
+ "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.",
+ "location": "query",
+ "type": "string"
+ },
+ "notification_id": {
+ "description": "String to identify the notification.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "notification/get",
+ "response": {
+ "$ref": "Notification"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
+ "onboarding": {
+ "methods": {
+ "listCategories": {
+ "description": "List categories for onboarding experience.",
+ "httpMethod": "GET",
+ "id": "books.onboarding.listCategories",
+ "parameters": {
+ "locale": {
+ "description": "ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "onboarding/listCategories",
+ "response": {
+ "$ref": "Category"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "listCategoryVolumes": {
+ "description": "List available volumes under categories for onboarding experience.",
+ "httpMethod": "GET",
+ "id": "books.onboarding.listCategoryVolumes",
+ "parameters": {
+ "categoryId": {
+ "description": "List of category ids requested.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "locale": {
+ "description": "ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxAllowedMaturityRating": {
+ "description": "The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.",
+ "enum": [
+ "mature",
+ "not-mature"
+ ],
+ "enumDescriptions": [
+ "Show books which are rated mature or lower.",
+ "Show books which are rated not mature."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Number of maximum results per page to be included in the response.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value of the nextToken from the previous page.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "onboarding/listCategoryVolumes",
+ "response": {
+ "$ref": "Volume2"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
+ "personalizedstream": {
+ "methods": {
+ "get": {
+ "description": "Returns a stream of personalized book clusters",
+ "httpMethod": "GET",
+ "id": "books.personalizedstream.get",
+ "parameters": {
+ "locale": {
+ "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxAllowedMaturityRating": {
+ "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
+ "enum": [
+ "mature",
+ "not-mature"
+ ],
+ "enumDescriptions": [
+ "Show books which are rated mature or lower.",
+ "Show books which are rated not mature."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "personalizedstream/get",
+ "response": {
+ "$ref": "Discoveryclusters"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
+ "promooffer": {
+ "methods": {
+ "accept": {
+ "description": "",
+ "httpMethod": "POST",
+ "id": "books.promooffer.accept",
+ "parameters": {
+ "androidId": {
+ "description": "device android_id",
+ "location": "query",
+ "type": "string"
+ },
+ "device": {
+ "description": "device device",
+ "location": "query",
+ "type": "string"
+ },
+ "manufacturer": {
+ "description": "device manufacturer",
+ "location": "query",
+ "type": "string"
+ },
+ "model": {
+ "description": "device model",
+ "location": "query",
+ "type": "string"
+ },
+ "offerId": {
+ "location": "query",
+ "type": "string"
+ },
+ "product": {
+ "description": "device product",
+ "location": "query",
+ "type": "string"
+ },
+ "serial": {
+ "description": "device serial",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "Volume id to exercise the offer",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "promooffer/accept",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "dismiss": {
+ "description": "",
+ "httpMethod": "POST",
+ "id": "books.promooffer.dismiss",
+ "parameters": {
+ "androidId": {
+ "description": "device android_id",
+ "location": "query",
+ "type": "string"
+ },
+ "device": {
+ "description": "device device",
+ "location": "query",
+ "type": "string"
+ },
+ "manufacturer": {
+ "description": "device manufacturer",
+ "location": "query",
+ "type": "string"
+ },
+ "model": {
+ "description": "device model",
+ "location": "query",
+ "type": "string"
+ },
+ "offerId": {
+ "description": "Offer to dimiss",
+ "location": "query",
+ "type": "string"
+ },
+ "product": {
+ "description": "device product",
+ "location": "query",
+ "type": "string"
+ },
+ "serial": {
+ "description": "device serial",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "promooffer/dismiss",
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "get": {
+ "description": "Returns a list of promo offers available to the user",
+ "httpMethod": "GET",
+ "id": "books.promooffer.get",
+ "parameters": {
+ "androidId": {
+ "description": "device android_id",
+ "location": "query",
+ "type": "string"
+ },
+ "device": {
+ "description": "device device",
+ "location": "query",
+ "type": "string"
+ },
+ "manufacturer": {
+ "description": "device manufacturer",
+ "location": "query",
+ "type": "string"
+ },
+ "model": {
+ "description": "device model",
+ "location": "query",
+ "type": "string"
+ },
+ "product": {
+ "description": "device product",
+ "location": "query",
+ "type": "string"
+ },
+ "serial": {
+ "description": "device serial",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "promooffer/get",
+ "response": {
+ "$ref": "Offers"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
+ "series": {
+ "methods": {
+ "get": {
+ "description": "Returns Series metadata for the given series ids.",
+ "httpMethod": "GET",
+ "id": "books.series.get",
+ "parameterOrder": [
+ "series_id"
+ ],
+ "parameters": {
+ "series_id": {
+ "description": "String that identifies the series",
+ "location": "query",
+ "repeated": true,
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "series/get",
+ "response": {
+ "$ref": "Series"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ },
+ "resources": {
+ "membership": {
+ "methods": {
+ "get": {
+ "description": "Returns Series membership data given the series id.",
+ "httpMethod": "GET",
+ "id": "books.series.membership.get",
+ "parameterOrder": [
+ "series_id"
+ ],
+ "parameters": {
+ "page_size": {
+ "description": "Number of maximum results per page to be included in the response.",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "page_token": {
+ "description": "The value of the nextToken from the previous page.",
+ "location": "query",
+ "type": "string"
+ },
+ "series_id": {
+ "description": "String that identifies the series",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "series/membership/get",
+ "response": {
+ "$ref": "Seriesmembership"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "volumes": {
+ "methods": {
+ "get": {
+ "description": "Gets volume information for a single volume.",
+ "httpMethod": "GET",
+ "id": "books.volumes.get",
+ "parameterOrder": [
+ "volumeId"
+ ],
+ "parameters": {
+ "country": {
+ "description": "ISO-3166-1 code to override the IP-based location.",
+ "location": "query",
+ "type": "string"
+ },
+ "includeNonComicsSeries": {
+ "description": "Set to true to include non-comics series. Defaults to false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "partner": {
+ "description": "Brand results for partner ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields.",
+ "enum": [
+ "full",
+ "lite"
+ ],
+ "enumDescriptions": [
+ "Includes all volume data.",
+ "Includes a subset of fields in volumeInfo and accessInfo."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "user_library_consistent_read": {
+ "location": "query",
+ "type": "boolean"
+ },
+ "volumeId": {
+ "description": "ID of volume to retrieve.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "volumes/{volumeId}",
+ "response": {
+ "$ref": "Volume"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "list": {
+ "description": "Performs a book search.",
+ "httpMethod": "GET",
+ "id": "books.volumes.list",
+ "parameterOrder": [
+ "q"
+ ],
+ "parameters": {
+ "download": {
+ "description": "Restrict to volumes by download availability.",
+ "enum": [
+ "epub"
+ ],
+ "enumDescriptions": [
+ "All volumes with epub."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filter search results.",
+ "enum": [
+ "ebooks",
+ "free-ebooks",
+ "full",
+ "paid-ebooks",
+ "partial"
+ ],
+ "enumDescriptions": [
+ "All Google eBooks.",
+ "Google eBook with full volume text viewability.",
+ "Public can view entire volume text.",
+ "Google eBook with a price.",
+ "Public able to see parts of text."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "langRestrict": {
+ "description": "Restrict results to books with this language code.",
+ "location": "query",
+ "type": "string"
+ },
+ "libraryRestrict": {
+ "description": "Restrict search to this user's library.",
+ "enum": [
+ "my-library",
+ "no-restrict"
+ ],
+ "enumDescriptions": [
+ "Restrict to the user's library, any shelf.",
+ "Do not restrict based on user's library."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "maxAllowedMaturityRating": {
+ "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
+ "enum": [
+ "mature",
+ "not-mature"
+ ],
+ "enumDescriptions": [
+ "Show books which are rated mature or lower.",
+ "Show books which are rated not mature."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "40",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Sort search results.",
+ "enum": [
+ "newest",
+ "relevance"
+ ],
+ "enumDescriptions": [
+ "Most recently published.",
+ "Relevance to search terms."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "partner": {
+ "description": "Restrict and brand results for partner ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "printType": {
+ "description": "Restrict to books or magazines.",
+ "enum": [
+ "all",
+ "books",
+ "magazines"
+ ],
+ "enumDescriptions": [
+ "All volume content types.",
+ "Just books.",
+ "Just magazines."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "projection": {
+ "description": "Restrict information returned to a set of selected fields.",
+ "enum": [
+ "full",
+ "lite"
+ ],
+ "enumDescriptions": [
+ "Includes all volume data.",
+ "Includes a subset of fields in volumeInfo and accessInfo."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "q": {
+ "description": "Full-text search query string.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "showPreorders": {
+ "description": "Set to true to show books available for preorder. Defaults to false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first result to return (starts at 0)",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "volumes",
+ "response": {
+ "$ref": "Volumes"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ },
+ "resources": {
+ "associated": {
+ "methods": {
+ "list": {
+ "description": "Return a list of associated books.",
+ "httpMethod": "GET",
+ "id": "books.volumes.associated.list",
+ "parameterOrder": [
+ "volumeId"
+ ],
+ "parameters": {
+ "association": {
+ "description": "Association type.",
+ "enum": [
+ "end-of-sample",
+ "end-of-volume",
+ "related-for-play"
+ ],
+ "enumDescriptions": [
+ "Recommendations for display end-of-sample.",
+ "Recommendations for display end-of-volume.",
+ "Related volumes for Play Store."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "locale": {
+ "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxAllowedMaturityRating": {
+ "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
+ "enum": [
+ "mature",
+ "not-mature"
+ ],
+ "enumDescriptions": [
+ "Show books which are rated mature or lower.",
+ "Show books which are rated not mature."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "ID of the source volume.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "volumes/{volumeId}/associated",
+ "response": {
+ "$ref": "Volumes"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
+ "mybooks": {
+ "methods": {
+ "list": {
+ "description": "Return a list of books in My Library.",
+ "httpMethod": "GET",
+ "id": "books.volumes.mybooks.list",
+ "parameters": {
+ "acquireMethod": {
+ "description": "How the book was acquired",
+ "enum": [
+ "FAMILY_SHARED",
+ "PREORDERED",
+ "PREVIOUSLY_RENTED",
+ "PUBLIC_DOMAIN",
+ "PURCHASED",
+ "RENTED",
+ "SAMPLE",
+ "UPLOADED"
+ ],
+ "enumDescriptions": [
+ "Books acquired via Family Sharing",
+ "Preordered books (not yet available)",
+ "User-rented books past their expiration time",
+ "Public domain books",
+ "Purchased books",
+ "User-rented books",
+ "Sample books",
+ "User uploaded books"
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "country": {
+ "description": "ISO-3166-1 code to override the IP-based location.",
+ "location": "query",
+ "type": "string"
+ },
+ "locale": {
+ "description": "ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "100",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "processingState": {
+ "description": "The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.",
+ "enum": [
+ "COMPLETED_FAILED",
+ "COMPLETED_SUCCESS",
+ "RUNNING"
+ ],
+ "enumDescriptions": [
+ "The volume processing hase failed.",
+ "The volume processing was completed.",
+ "The volume processing is not completed."
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first result to return (starts at 0)",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ }
+ },
+ "path": "volumes/mybooks",
+ "response": {
+ "$ref": "Volumes"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
+ "recommended": {
+ "methods": {
+ "list": {
+ "description": "Return a list of recommended books for the current user.",
+ "httpMethod": "GET",
+ "id": "books.volumes.recommended.list",
+ "parameters": {
+ "locale": {
+ "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxAllowedMaturityRating": {
+ "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
+ "enum": [
+ "mature",
+ "not-mature"
+ ],
+ "enumDescriptions": [
+ "Show books which are rated mature or lower.",
+ "Show books which are rated not mature."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "volumes/recommended",
+ "response": {
+ "$ref": "Volumes"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "rate": {
+ "description": "Rate a recommended book for the current user.",
+ "httpMethod": "POST",
+ "id": "books.volumes.recommended.rate",
+ "parameterOrder": [
+ "rating",
+ "volumeId"
+ ],
+ "parameters": {
+ "locale": {
+ "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
+ "location": "query",
+ "type": "string"
+ },
+ "rating": {
+ "description": "Rating to be given to the volume.",
+ "enum": [
+ "HAVE_IT",
+ "NOT_INTERESTED"
+ ],
+ "enumDescriptions": [
+ "Rating indicating a dismissal due to ownership.",
+ "Rating indicating a negative dismissal of a volume."
+ ],
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "ID of the source volume.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "volumes/recommended/rate",
+ "response": {
+ "$ref": "BooksVolumesRecommendedRateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
+ "useruploaded": {
+ "methods": {
+ "list": {
+ "description": "Return a list of books uploaded by the current user.",
+ "httpMethod": "GET",
+ "id": "books.volumes.useruploaded.list",
+ "parameters": {
+ "locale": {
+ "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "Maximum number of results to return.",
+ "format": "uint32",
+ "location": "query",
+ "maximum": "40",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "processingState": {
+ "description": "The processing state of the user uploaded volumes to be returned.",
+ "enum": [
+ "COMPLETED_FAILED",
+ "COMPLETED_SUCCESS",
+ "RUNNING"
+ ],
+ "enumDescriptions": [
+ "The volume processing hase failed.",
+ "The volume processing was completed.",
+ "The volume processing is not completed."
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "source": {
+ "description": "String to identify the originator of this request.",
+ "location": "query",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "Index of the first result to return (starts at 0)",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "volumeId": {
+ "description": "The ids of the volumes to be returned. If not specified all that match the processingState are returned.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "volumes/useruploaded",
+ "response": {
+ "$ref": "Volumes"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
}
- }
- },
- "moreFromAuthors": {
- "type": "object",
- "properties": {
- "opted_state": {
- "type": "string"
- }
- }
- },
- "moreFromSeries": {
- "type": "object",
- "properties": {
- "opted_state": {
- "type": "string"
- }
- }
- },
- "priceDrop": {
- "type": "object",
- "properties": {
- "opted_state": {
- "type": "string"
- }
- }
- },
- "rewardExpirations": {
- "type": "object",
- "properties": {
- "opted_state": {
- "type": "string"
- }
- }
}
- }
}
- }
},
- "Volume": {
- "id": "Volume",
- "type": "object",
- "properties": {
- "accessInfo": {
- "type": "object",
- "description": "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.).",
- "properties": {
- "accessViewStatus": {
- "type": "string",
- "description": "Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)"
- },
- "country": {
- "type": "string",
- "description": "The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)"
- },
- "downloadAccess": {
- "$ref": "DownloadAccessRestriction",
- "description": "Information about a volume's download license access restrictions."
- },
- "driveImportedContentLink": {
- "type": "string",
- "description": "URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive."
- },
- "embeddable": {
- "type": "boolean",
- "description": "Whether this volume can be embedded in a viewport using the Embedded Viewer API."
- },
- "epub": {
- "type": "object",
- "description": "Information about epub content. (In LITE projection.)",
- "properties": {
- "acsTokenLink": {
- "type": "string",
- "description": "URL to retrieve ACS token for epub download. (In LITE projection.)"
+ "revision": "20171127",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Annotation": {
+ "id": "Annotation",
+ "properties": {
+ "afterSelectedText": {
+ "description": "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.",
+ "type": "string"
},
- "downloadLink": {
- "type": "string",
- "description": "URL to download epub. (In LITE projection.)"
+ "beforeSelectedText": {
+ "description": "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.",
+ "type": "string"
},
- "isAvailable": {
- "type": "boolean",
- "description": "Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)"
- }
- }
- },
- "explicitOfflineLicenseManagement": {
- "type": "boolean",
- "description": "Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it."
- },
- "pdf": {
- "type": "object",
- "description": "Information about pdf content. (In LITE projection.)",
- "properties": {
- "acsTokenLink": {
- "type": "string",
- "description": "URL to retrieve ACS token for pdf download. (In LITE projection.)"
- },
- "downloadLink": {
- "type": "string",
- "description": "URL to download pdf. (In LITE projection.)"
- },
- "isAvailable": {
- "type": "boolean",
- "description": "Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)"
- }
- }
- },
- "publicDomain": {
- "type": "boolean",
- "description": "Whether or not this book is public domain in the country listed above."
- },
- "quoteSharingAllowed": {
- "type": "boolean",
- "description": "Whether quote sharing is allowed for this volume."
- },
- "textToSpeechPermission": {
- "type": "string",
- "description": "Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED."
- },
- "viewOrderUrl": {
- "type": "string",
- "description": "For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page."
- },
- "viewability": {
- "type": "string",
- "description": "The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES."
- },
- "webReaderLink": {
- "type": "string",
- "description": "URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes."
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "Opaque identifier for a specific version of a volume resource. (In LITE projection)"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier for a volume. (In LITE projection.)"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for a volume. (In LITE projection.)",
- "default": "books#volume"
- },
- "layerInfo": {
- "type": "object",
- "description": "What layers exist in this volume and high level information about them.",
- "properties": {
- "layers": {
- "type": "array",
- "description": "A layer should appear here if and only if the layer exists for this book.",
- "items": {
- "type": "object",
- "properties": {
- "layerId": {
- "type": "string",
- "description": "The layer id of this layer (e.g. \"geo\")."
- },
- "volumeAnnotationsVersion": {
- "type": "string",
- "description": "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."
- }
- }
- }
- }
- }
- },
- "recommendedInfo": {
- "type": "object",
- "description": "Recommendation related information for this volume.",
- "properties": {
- "explanation": {
- "type": "string",
- "description": "A text explaining why this volume is recommended."
- }
- }
- },
- "saleInfo": {
- "type": "object",
- "description": "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).",
- "properties": {
- "buyLink": {
- "type": "string",
- "description": "URL to purchase this volume on the Google Books site. (In LITE projection)"
- },
- "country": {
- "type": "string",
- "description": "The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)"
- },
- "isEbook": {
- "type": "boolean",
- "description": "Whether or not this volume is an eBook (can be added to the My eBooks shelf)."
- },
- "listPrice": {
- "type": "object",
- "description": "Suggested retail price. (In LITE projection.)",
- "properties": {
- "amount": {
- "type": "number",
- "description": "Amount in the currency listed below. (In LITE projection.)",
- "format": "double"
- },
- "currencyCode": {
- "type": "string",
- "description": "An ISO 4217, three-letter currency code. (In LITE projection.)"
- }
- }
- },
- "offers": {
- "type": "array",
- "description": "Offers available for this volume (sales and rentals).",
- "items": {
- "type": "object",
- "properties": {
- "finskyOfferType": {
- "type": "integer",
- "description": "The finsky offer type (e.g., PURCHASE=0 RENTAL=3)",
- "format": "int32"
- },
- "giftable": {
- "type": "boolean",
- "description": "Indicates whether the offer is giftable."
- },
- "listPrice": {
- "type": "object",
- "description": "Offer list (=undiscounted) price in Micros.",
+ "clientVersionRanges": {
+ "description": "Selection ranges sent from the client.",
"properties": {
- "amountInMicros": {
- "type": "number",
- "format": "double"
- },
- "currencyCode": {
- "type": "string"
- }
- }
- },
- "rentalDuration": {
- "type": "object",
- "description": "The rental duration (for rental offers only).",
+ "cfiRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in CFI format for this annotation sent by client."
+ },
+ "contentVersion": {
+ "description": "Content version the client sent in.",
+ "type": "string"
+ },
+ "gbImageRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in GB image format for this annotation sent by client."
+ },
+ "gbTextRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in GB text format for this annotation sent by client."
+ },
+ "imageCfiRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in image CFI format for this annotation sent by client."
+ }
+ },
+ "type": "object"
+ },
+ "created": {
+ "description": "Timestamp for the created time of this annotation.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "currentVersionRanges": {
+ "description": "Selection ranges for the most recent content version.",
"properties": {
- "count": {
- "type": "number",
- "format": "double"
- },
- "unit": {
- "type": "string"
- }
- }
- },
- "retailPrice": {
- "type": "object",
- "description": "Offer retail (=discounted) price in Micros",
+ "cfiRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in CFI format for this annotation for version above."
+ },
+ "contentVersion": {
+ "description": "Content version applicable to ranges below.",
+ "type": "string"
+ },
+ "gbImageRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in GB image format for this annotation for version above."
+ },
+ "gbTextRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in GB text format for this annotation for version above."
+ },
+ "imageCfiRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in image CFI format for this annotation for version above."
+ }
+ },
+ "type": "object"
+ },
+ "data": {
+ "description": "User-created data for this annotation.",
+ "type": "string"
+ },
+ "deleted": {
+ "description": "Indicates that this annotation is deleted.",
+ "type": "boolean"
+ },
+ "highlightStyle": {
+ "description": "The highlight style for this annotation.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Id of this annotation, in the form of a GUID.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "books#annotation",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "layerId": {
+ "description": "The layer this annotation is for.",
+ "type": "string"
+ },
+ "layerSummary": {
"properties": {
- "amountInMicros": {
- "type": "number",
- "format": "double"
- },
- "currencyCode": {
+ "allowedCharacterCount": {
+ "description": "Maximum allowed characters on this layer, especially for the \"copy\" layer.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "limitType": {
+ "description": "Type of limitation on this layer. \"limited\" or \"unlimited\" for the \"copy\" layer.",
+ "type": "string"
+ },
+ "remainingCharacterCount": {
+ "description": "Remaining allowed characters on this layer, especially for the \"copy\" layer.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "pageIds": {
+ "description": "Pages that this annotation spans.",
+ "items": {
"type": "string"
- }
- }
- }
- }
- }
- },
- "onSaleDate": {
- "type": "string",
- "description": "The date on which this book is available for sale.",
- "format": "date-time"
- },
- "retailPrice": {
- "type": "object",
- "description": "The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)",
- "properties": {
- "amount": {
- "type": "number",
- "description": "Amount in the currency listed below. (In LITE projection.)",
- "format": "double"
+ },
+ "type": "array"
},
- "currencyCode": {
- "type": "string",
- "description": "An ISO 4217, three-letter currency code. (In LITE projection.)"
- }
- }
- },
- "saleability": {
- "type": "string",
- "description": "Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER."
- }
- }
- },
- "searchInfo": {
- "type": "object",
- "description": "Search result information related to this volume.",
- "properties": {
- "textSnippet": {
- "type": "string",
- "description": "A text snippet containing the search query."
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "URL to this resource. (In LITE projection.)"
- },
- "userInfo": {
- "type": "object",
- "description": "User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)",
- "properties": {
- "acquiredTime": {
- "type": "string",
- "description": "Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.",
- "format": "date-time"
- },
- "acquisitionType": {
- "type": "integer",
- "description": "How this volume was acquired.",
- "format": "int32"
- },
- "copy": {
- "type": "object",
- "description": "Copy/Paste accounting information.",
- "properties": {
- "allowedCharacterCount": {
- "type": "integer",
- "format": "int32"
+ "selectedText": {
+ "description": "Excerpt from the volume.",
+ "type": "string"
},
- "limitType": {
- "type": "string"
- },
- "remainingCharacterCount": {
- "type": "integer",
- "format": "int32"
+ "selfLink": {
+ "description": "URL to this resource.",
+ "type": "string"
},
"updated": {
- "type": "string",
- "format": "date-time"
+ "description": "Timestamp for the last time this annotation was modified.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume that this annotation belongs to.",
+ "type": "string"
}
- }
},
- "entitlementType": {
- "type": "integer",
- "description": "Whether this volume is purchased, sample, pd download etc.",
- "format": "int32"
- },
- "familySharing": {
- "type": "object",
- "description": "Information on the ability to share with the family.",
- "properties": {
- "familyRole": {
- "type": "string",
- "description": "The role of the user in the family."
- },
- "isSharingAllowed": {
- "type": "boolean",
- "description": "Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action."
- },
- "isSharingDisabledByFop": {
- "type": "boolean",
- "description": "Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet."
- }
- }
- },
- "isFamilySharedFromUser": {
- "type": "boolean",
- "description": "Whether or not the user shared this volume with the family."
- },
- "isFamilySharedToUser": {
- "type": "boolean",
- "description": "Whether or not the user received this volume through family sharing."
- },
- "isFamilySharingAllowed": {
- "type": "boolean",
- "description": "Deprecated: Replaced by familySharing."
- },
- "isFamilySharingDisabledByFop": {
- "type": "boolean",
- "description": "Deprecated: Replaced by familySharing."
- },
- "isInMyBooks": {
- "type": "boolean",
- "description": "Whether or not this volume is currently in \"my books.\""
- },
- "isPreordered": {
- "type": "boolean",
- "description": "Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)"
- },
- "isPurchased": {
- "type": "boolean",
- "description": "Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)"
- },
- "isUploaded": {
- "type": "boolean",
- "description": "Whether or not this volume was user uploaded."
- },
- "readingPosition": {
- "$ref": "ReadingPosition",
- "description": "The user's current reading position in the volume, if one is available. (In LITE projection.)"
- },
- "rentalPeriod": {
- "type": "object",
- "description": "Period during this book is/was a valid rental.",
- "properties": {
- "endUtcSec": {
- "type": "string",
- "format": "int64"
- },
- "startUtcSec": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "rentalState": {
- "type": "string",
- "description": "Whether this book is an active or an expired rental."
- },
- "review": {
- "$ref": "Review",
- "description": "This user's review of this volume, if one exists."
- },
- "updated": {
- "type": "string",
- "description": "Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).",
- "format": "date-time"
- },
- "userUploadedVolumeInfo": {
- "type": "object",
- "properties": {
- "processingState": {
- "type": "string"
- }
- }
- }
- }
+ "type": "object"
},
- "volumeInfo": {
- "type": "object",
- "description": "General volume information.",
- "properties": {
- "allowAnonLogging": {
- "type": "boolean",
- "description": "Whether anonymous logging should be allowed."
- },
- "authors": {
- "type": "array",
- "description": "The names of the authors and/or editors for this volume. (In LITE projection)",
- "items": {
- "type": "string"
- }
- },
- "averageRating": {
- "type": "number",
- "description": "The mean review rating for this volume. (min = 1.0, max = 5.0)",
- "format": "double"
- },
- "canonicalVolumeLink": {
- "type": "string",
- "description": "Canonical URL for a volume. (In LITE projection.)"
- },
- "categories": {
- "type": "array",
- "description": "A list of subject categories, such as \"Fiction\", \"Suspense\", etc.",
- "items": {
- "type": "string"
- }
- },
- "contentVersion": {
- "type": "string",
- "description": "An identifier for the version of the volume content (text & images). (In LITE projection)"
- },
- "description": {
- "type": "string",
- "description": "A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)"
- },
- "dimensions": {
- "type": "object",
- "description": "Physical dimensions of this volume.",
- "properties": {
- "height": {
- "type": "string",
- "description": "Height or length of this volume (in cm)."
- },
- "thickness": {
- "type": "string",
- "description": "Thickness of this volume (in cm)."
- },
- "width": {
- "type": "string",
- "description": "Width of this volume (in cm)."
- }
- }
- },
- "imageLinks": {
- "type": "object",
- "description": "A list of image links for all the sizes that are available. (In LITE projection.)",
- "properties": {
- "extraLarge": {
- "type": "string",
- "description": "Image link for extra large size (width of ~1280 pixels). (In LITE projection)"
- },
- "large": {
- "type": "string",
- "description": "Image link for large size (width of ~800 pixels). (In LITE projection)"
- },
- "medium": {
- "type": "string",
- "description": "Image link for medium size (width of ~575 pixels). (In LITE projection)"
- },
- "small": {
- "type": "string",
- "description": "Image link for small size (width of ~300 pixels). (In LITE projection)"
- },
- "smallThumbnail": {
- "type": "string",
- "description": "Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)"
- },
- "thumbnail": {
- "type": "string",
- "description": "Image link for thumbnail size (width of ~128 pixels). (In LITE projection)"
- }
- }
- },
- "industryIdentifiers": {
- "type": "array",
- "description": "Industry standard identifiers for this volume.",
- "items": {
- "type": "object",
- "properties": {
- "identifier": {
- "type": "string",
- "description": "Industry specific volume identifier."
- },
- "type": {
- "type": "string",
- "description": "Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER."
- }
- }
- }
- },
- "infoLink": {
- "type": "string",
- "description": "URL to view information about this volume on the Google Books site. (In LITE projection)"
- },
- "language": {
- "type": "string",
- "description": "Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc."
- },
- "mainCategory": {
- "type": "string",
- "description": "The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight."
- },
- "maturityRating": {
- "type": "string"
- },
- "pageCount": {
- "type": "integer",
- "description": "Total number of pages as per publisher metadata.",
- "format": "int32"
- },
- "panelizationSummary": {
- "type": "object",
- "description": "A top-level summary of the panelization info in this volume.",
- "properties": {
- "containsEpubBubbles": {
- "type": "boolean"
- },
- "containsImageBubbles": {
- "type": "boolean"
- },
- "epubBubbleVersion": {
- "type": "string"
- },
- "imageBubbleVersion": {
- "type": "string"
- }
- }
- },
- "previewLink": {
- "type": "string",
- "description": "URL to preview this volume on the Google Books site."
- },
- "printType": {
- "type": "string",
- "description": "Type of publication of this volume. Possible values are BOOK or MAGAZINE."
- },
- "printedPageCount": {
- "type": "integer",
- "description": "Total number of printed pages in generated pdf representation.",
- "format": "int32"
- },
- "publishedDate": {
- "type": "string",
- "description": "Date of publication. (In LITE projection.)"
- },
- "publisher": {
- "type": "string",
- "description": "Publisher of this volume. (In LITE projection.)"
- },
- "ratingsCount": {
- "type": "integer",
- "description": "The number of review ratings for this volume.",
- "format": "int32"
- },
- "readingModes": {
- "type": "any",
- "description": "The reading modes available for this volume."
- },
- "samplePageCount": {
- "type": "integer",
- "description": "Total number of sample pages as per publisher metadata.",
- "format": "int32"
- },
- "seriesInfo": {
- "$ref": "Volumeseriesinfo"
- },
- "subtitle": {
- "type": "string",
- "description": "Volume subtitle. (In LITE projection.)"
- },
- "title": {
- "type": "string",
- "description": "Volume title. (In LITE projection.)"
- }
- }
- }
- }
- },
- "Volume2": {
- "id": "Volume2",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of volumes.",
- "items": {
- "$ref": "Volume"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "onboarding#volume"
- },
- "nextPageToken": {
- "type": "string"
- }
- }
- },
- "Volumeannotation": {
- "id": "Volumeannotation",
- "type": "object",
- "properties": {
- "annotationDataId": {
- "type": "string",
- "description": "The annotation data id for this volume annotation."
- },
- "annotationDataLink": {
- "type": "string",
- "description": "Link to get data for this annotation."
- },
- "annotationType": {
- "type": "string",
- "description": "The type of annotation this is."
- },
- "contentRanges": {
- "type": "object",
- "description": "The content ranges to identify the selected text.",
- "properties": {
- "cfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in CFI format for this annotation for version above."
- },
- "contentVersion": {
- "type": "string",
- "description": "Content version applicable to ranges below."
- },
- "gbImageRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB image format for this annotation for version above."
- },
- "gbTextRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB text format for this annotation for version above."
- }
- }
- },
- "data": {
- "type": "string",
- "description": "Data for this annotation."
- },
- "deleted": {
- "type": "boolean",
- "description": "Indicates that this annotation is deleted."
- },
- "id": {
- "type": "string",
- "description": "Unique id of this volume annotation."
- },
- "kind": {
- "type": "string",
- "description": "Resource Type",
- "default": "books#volumeannotation"
- },
- "layerId": {
- "type": "string",
- "description": "The Layer this annotation is for."
- },
- "pageIds": {
- "type": "array",
- "description": "Pages the annotation spans.",
- "items": {
- "type": "string"
- }
- },
- "selectedText": {
- "type": "string",
- "description": "Excerpt from the volume."
- },
- "selfLink": {
- "type": "string",
- "description": "URL to this resource."
- },
- "updated": {
- "type": "string",
- "description": "Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).",
- "format": "date-time"
- },
- "volumeId": {
- "type": "string",
- "description": "The Volume this annotation is for."
- }
- }
- },
- "Volumeannotations": {
- "id": "Volumeannotations",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of volume annotations.",
- "items": {
- "$ref": "Volumeannotation"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type",
- "default": "books#volumeannotations"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results."
- },
- "totalItems": {
- "type": "integer",
- "description": "The total number of volume annotations found.",
- "format": "int32"
- },
- "version": {
- "type": "string",
- "description": "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)."
- }
- }
- },
- "Volumes": {
- "id": "Volumes",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of volumes.",
- "items": {
- "$ref": "Volume"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#volumes"
- },
- "totalItems": {
- "type": "integer",
- "description": "Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.",
- "format": "int32"
- }
- }
- },
- "Volumeseriesinfo": {
- "id": "Volumeseriesinfo",
- "type": "object",
- "properties": {
- "bookDisplayNumber": {
- "type": "string",
- "description": "The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#volume_series_info"
- },
- "shortSeriesBookTitle": {
- "type": "string",
- "description": "Short book title in the context of the series."
- },
- "volumeSeries": {
- "type": "array",
- "items": {
- "type": "object",
+ "Annotationdata": {
+ "id": "Annotationdata",
+ "properties": {
+ "annotationType": {
+ "description": "The type of annotation this data is for.",
+ "type": "string"
+ },
+ "data": {
+ "type": "any"
+ },
+ "encoded_data": {
+ "description": "Base64 encoded data for this annotation data.",
+ "format": "byte",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique id for this annotation data.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "books#annotationdata",
+ "description": "Resource Type",
+ "type": "string"
+ },
+ "layerId": {
+ "description": "The Layer id for this data. *",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "URL for this resource. *",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "The volume id for this data. *",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Annotations": {
+ "id": "Annotations",
"properties": {
- "issue": {
- "type": "array",
- "description": "List of issues. Applicable only for Collection Edition and Omnibus.",
"items": {
- "type": "object",
- "properties": {
- "issueDisplayNumber": {
- "type": "string"
+ "description": "A list of annotations.",
+ "items": {
+ "$ref": "Annotation"
},
- "issueOrderNumber": {
- "type": "integer",
- "format": "int32"
- }
- }
+ "type": "array"
+ },
+ "kind": {
+ "default": "books#annotations",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.",
+ "format": "int32",
+ "type": "integer"
}
- },
- "orderNumber": {
- "type": "integer",
- "description": "The book order number in the series.",
- "format": "int32"
- },
- "seriesBookType": {
- "type": "string",
- "description": "The book type in the context of series. Examples - Single Issue, Collection Edition, etc."
- },
- "seriesId": {
- "type": "string",
- "description": "The series id."
- }
- }
- }
- }
- }
- }
- },
- "resources": {
- "bookshelves": {
- "methods": {
- "get": {
- "id": "books.bookshelves.get",
- "path": "users/{userId}/bookshelves/{shelf}",
- "httpMethod": "GET",
- "description": "Retrieves metadata for a specific bookshelf for the specified user.",
- "parameters": {
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf to retrieve.",
- "required": true,
- "location": "path"
},
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of user for whom to retrieve bookshelves.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId",
- "shelf"
- ],
- "response": {
- "$ref": "Bookshelf"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
+ "type": "object"
},
- "list": {
- "id": "books.bookshelves.list",
- "path": "users/{userId}/bookshelves",
- "httpMethod": "GET",
- "description": "Retrieves a list of public bookshelves for the specified user.",
- "parameters": {
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of user for whom to retrieve bookshelves.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "Bookshelves"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- },
- "resources": {
- "volumes": {
- "methods": {
- "list": {
- "id": "books.bookshelves.volumes.list",
- "path": "users/{userId}/bookshelves/{shelf}/volumes",
- "httpMethod": "GET",
- "description": "Retrieves volumes in a specific bookshelf for the specified user.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
+ "AnnotationsSummary": {
+ "id": "AnnotationsSummary",
+ "properties": {
+ "kind": {
+ "default": "books#annotationsSummary",
+ "type": "string"
},
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf to retrieve volumes.",
- "required": true,
- "location": "path"
- },
- "showPreorders": {
- "type": "boolean",
- "description": "Set to true to show pre-ordered books. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first element to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of user for whom to retrieve bookshelf volumes.",
- "required": true,
- "location": "path"
+ "layers": {
+ "items": {
+ "properties": {
+ "allowedCharacterCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "layerId": {
+ "type": "string"
+ },
+ "limitType": {
+ "type": "string"
+ },
+ "remainingCharacterCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "updated": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
}
- },
- "parameterOrder": [
- "userId",
- "shelf"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
- },
- "cloudloading": {
- "methods": {
- "addBook": {
- "id": "books.cloudloading.addBook",
- "path": "cloudloading/addBook",
- "httpMethod": "POST",
- "description": "",
- "parameters": {
- "drive_document_id": {
- "type": "string",
- "description": "A drive document id. The upload_client_token must not be set.",
- "location": "query"
},
- "mime_type": {
- "type": "string",
- "description": "The document MIME type. It can be set only if the drive_document_id is set.",
- "location": "query"
- },
- "name": {
- "type": "string",
- "description": "The document name. It can be set only if the drive_document_id is set.",
- "location": "query"
- },
- "upload_client_token": {
- "type": "string",
- "location": "query"
- }
- },
- "response": {
- "$ref": "BooksCloudloadingResource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
+ "type": "object"
},
- "deleteBook": {
- "id": "books.cloudloading.deleteBook",
- "path": "cloudloading/deleteBook",
- "httpMethod": "POST",
- "description": "Remove the book and its contents",
- "parameters": {
- "volumeId": {
- "type": "string",
- "description": "The id of the book to be removed.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "volumeId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "updateBook": {
- "id": "books.cloudloading.updateBook",
- "path": "cloudloading/updateBook",
- "httpMethod": "POST",
- "description": "",
- "request": {
- "$ref": "BooksCloudloadingResource"
- },
- "response": {
- "$ref": "BooksCloudloadingResource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "dictionary": {
- "methods": {
- "listOfflineMetadata": {
- "id": "books.dictionary.listOfflineMetadata",
- "path": "dictionary/listOfflineMetadata",
- "httpMethod": "GET",
- "description": "Returns a list of offline dictionary metadata available",
- "parameters": {
- "cpksver": {
- "type": "string",
- "description": "The device/version ID from which to request the data.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "cpksver"
- ],
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "familysharing": {
- "methods": {
- "getFamilyInfo": {
- "id": "books.familysharing.getFamilyInfo",
- "path": "familysharing/getFamilyInfo",
- "httpMethod": "GET",
- "description": "Gets information regarding the family that the user is part of.",
- "parameters": {
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "FamilyInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "share": {
- "id": "books.familysharing.share",
- "path": "familysharing/share",
- "httpMethod": "POST",
- "description": "Initiates sharing of the content with the user's family. Empty response indicates success.",
- "parameters": {
- "docId": {
- "type": "string",
- "description": "The docid to share.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to share.",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "unshare": {
- "id": "books.familysharing.unshare",
- "path": "familysharing/unshare",
- "httpMethod": "POST",
- "description": "Initiates revoking content that has already been shared with the user's family. Empty response indicates success.",
- "parameters": {
- "docId": {
- "type": "string",
- "description": "The docid to unshare.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to unshare.",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "layers": {
- "methods": {
- "get": {
- "id": "books.layers.get",
- "path": "volumes/{volumeId}/layersummary/{summaryId}",
- "httpMethod": "GET",
- "description": "Gets the layer summary for a volume.",
- "parameters": {
- "contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "summaryId": {
- "type": "string",
- "description": "The ID for the layer to get the summary for.",
- "required": true,
- "location": "path"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve layers for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId",
- "summaryId"
- ],
- "response": {
- "$ref": "Layersummary"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.layers.list",
- "path": "volumes/{volumeId}/layersummary",
- "httpMethod": "GET",
- "description": "List the layer summaries for a volume.",
- "parameters": {
- "contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "maximum": "200",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve layers for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId"
- ],
- "response": {
- "$ref": "Layersummaries"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- },
- "resources": {
- "annotationData": {
- "methods": {
- "get": {
- "id": "books.layers.annotationData.get",
- "path": "volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}",
- "httpMethod": "GET",
- "description": "Gets the annotation data.",
- "parameters": {
- "allowWebDefinitions": {
- "type": "boolean",
- "description": "For the dictionary layer. Whether or not to allow web definitions.",
- "location": "query"
+ "Annotationsdata": {
+ "id": "Annotationsdata",
+ "properties": {
+ "items": {
+ "description": "A list of Annotation Data.",
+ "items": {
+ "$ref": "Annotationdata"
+ },
+ "type": "array"
},
- "annotationDataId": {
- "type": "string",
- "description": "The ID of the annotation data to retrieve.",
- "required": true,
- "location": "path"
+ "kind": {
+ "default": "books#annotationsdata",
+ "description": "Resource type",
+ "type": "string"
},
- "contentVersion": {
- "type": "string",
- "description": "The content version for the volume you are trying to retrieve.",
- "required": true,
- "location": "query"
+ "nextPageToken": {
+ "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.",
+ "type": "string"
},
- "h": {
- "type": "integer",
- "description": "The requested pixel height for any images. If height is provided width must also be provided.",
- "format": "int32",
- "location": "query"
- },
- "layerId": {
- "type": "string",
- "description": "The ID for the layer to get the annotations.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- "location": "query"
- },
- "scale": {
- "type": "integer",
- "description": "The requested scale for the image.",
- "format": "int32",
- "minimum": "0",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve annotations for.",
- "required": true,
- "location": "path"
- },
- "w": {
- "type": "integer",
- "description": "The requested pixel width for any images. If width is provided height must also be provided.",
- "format": "int32",
- "location": "query"
+ "totalItems": {
+ "description": "The total number of volume annotations found.",
+ "format": "int32",
+ "type": "integer"
}
- },
- "parameterOrder": [
- "volumeId",
- "layerId",
- "annotationDataId",
- "contentVersion"
- ],
- "response": {
- "$ref": "Annotationdata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
},
- "list": {
- "id": "books.layers.annotationData.list",
- "path": "volumes/{volumeId}/layers/{layerId}/data",
- "httpMethod": "GET",
- "description": "Gets the annotation data for a volume and layer.",
- "parameters": {
- "annotationDataId": {
- "type": "string",
- "description": "The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.",
- "repeated": true,
- "location": "query"
- },
- "contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "required": true,
- "location": "query"
- },
- "h": {
- "type": "integer",
- "description": "The requested pixel height for any images. If height is provided width must also be provided.",
- "format": "int32",
- "location": "query"
- },
- "layerId": {
- "type": "string",
- "description": "The ID for the layer to get the annotation data.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "maximum": "200",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- },
- "scale": {
- "type": "integer",
- "description": "The requested scale for the image.",
- "format": "int32",
- "minimum": "0",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "updatedMax": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve annotation data for.",
- "required": true,
- "location": "path"
- },
- "w": {
- "type": "integer",
- "description": "The requested pixel width for any images. If width is provided height must also be provided.",
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "volumeId",
- "layerId",
- "contentVersion"
- ],
- "response": {
- "$ref": "Annotationsdata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
+ "type": "object"
},
- "volumeAnnotations": {
- "methods": {
- "get": {
- "id": "books.layers.volumeAnnotations.get",
- "path": "volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}",
- "httpMethod": "GET",
- "description": "Gets the volume annotation.",
- "parameters": {
- "annotationId": {
- "type": "string",
- "description": "The ID of the volume annotation to retrieve.",
- "required": true,
- "location": "path"
- },
- "layerId": {
- "type": "string",
- "description": "The ID for the layer to get the annotations.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve annotations for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId",
- "layerId",
- "annotationId"
- ],
- "response": {
- "$ref": "Volumeannotation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.layers.volumeAnnotations.list",
- "path": "volumes/{volumeId}/layers/{layerId}",
- "httpMethod": "GET",
- "description": "Gets the volume annotations for a volume and layer.",
- "parameters": {
- "contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "required": true,
- "location": "query"
- },
+ "BooksAnnotationsRange": {
+ "id": "BooksAnnotationsRange",
+ "properties": {
"endOffset": {
- "type": "string",
- "description": "The end offset to end retrieving data from.",
- "location": "query"
+ "description": "The offset from the ending position.",
+ "type": "string"
},
"endPosition": {
- "type": "string",
- "description": "The end position to end retrieving data from.",
- "location": "query"
- },
- "layerId": {
- "type": "string",
- "description": "The ID for the layer to get the annotations.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "maximum": "200",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
+ "description": "The ending position for the range.",
+ "type": "string"
},
"startOffset": {
- "type": "string",
- "description": "The start offset to start retrieving data from.",
- "location": "query"
+ "description": "The offset from the starting position.",
+ "type": "string"
},
"startPosition": {
- "type": "string",
- "description": "The start position to start retrieving data from.",
- "location": "query"
+ "description": "The starting position for the range.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BooksCloudloadingResource": {
+ "id": "BooksCloudloadingResource",
+ "properties": {
+ "author": {
+ "type": "string"
},
- "updatedMax": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
- "location": "query"
+ "processingState": {
+ "type": "string"
},
- "updatedMin": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
- "location": "query"
- },
- "volumeAnnotationsVersion": {
- "type": "string",
- "description": "The version of the volume annotations that you are requesting.",
- "location": "query"
+ "title": {
+ "type": "string"
},
"volumeId": {
- "type": "string",
- "description": "The volume to retrieve annotations for.",
- "required": true,
- "location": "path"
+ "type": "string"
}
- },
- "parameterOrder": [
- "volumeId",
- "layerId",
- "contentVersion"
- ],
- "response": {
- "$ref": "Volumeannotations"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
- },
- "myconfig": {
- "methods": {
- "getUserSettings": {
- "id": "books.myconfig.getUserSettings",
- "path": "myconfig/getUserSettings",
- "httpMethod": "GET",
- "description": "Gets the current settings for the user.",
- "response": {
- "$ref": "Usersettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
+ },
+ "type": "object"
},
- "releaseDownloadAccess": {
- "id": "books.myconfig.releaseDownloadAccess",
- "path": "myconfig/releaseDownloadAccess",
- "httpMethod": "POST",
- "description": "Release downloaded content access restriction.",
- "parameters": {
- "cpksver": {
- "type": "string",
- "description": "The device/version ID from which to release the restriction.",
- "required": true,
- "location": "query"
+ "BooksVolumesRecommendedRateResponse": {
+ "id": "BooksVolumesRecommendedRateResponse",
+ "properties": {
+ "consistency_token": {
+ "type": "string"
+ }
},
- "locale": {
- "type": "string",
- "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeIds": {
- "type": "string",
- "description": "The volume(s) to release restrictions for.",
- "required": true,
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "volumeIds",
- "cpksver"
- ],
- "response": {
- "$ref": "DownloadAccesses"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
+ "type": "object"
},
- "requestAccess": {
- "id": "books.myconfig.requestAccess",
- "path": "myconfig/requestAccess",
- "httpMethod": "POST",
- "description": "Request concurrent and download access restrictions.",
- "parameters": {
- "cpksver": {
- "type": "string",
- "description": "The device/version ID from which to request the restrictions.",
- "required": true,
- "location": "query"
+ "Bookshelf": {
+ "id": "Bookshelf",
+ "properties": {
+ "access": {
+ "description": "Whether this bookshelf is PUBLIC or PRIVATE.",
+ "type": "string"
+ },
+ "created": {
+ "description": "Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of this bookshelf.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Id of this bookshelf, only unique by user.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "kind": {
+ "default": "books#bookshelf",
+ "description": "Resource type for bookshelf metadata.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "URL to this resource.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of this bookshelf.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "volumeCount": {
+ "description": "Number of volumes in this bookshelf.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "volumesLastUpdated": {
+ "description": "Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).",
+ "format": "date-time",
+ "type": "string"
+ }
},
- "licenseTypes": {
- "type": "string",
- "description": "The type of access license to request. If not specified, the default is BOTH.",
- "enum": [
- "BOTH",
- "CONCURRENT",
- "DOWNLOAD"
- ],
- "enumDescriptions": [
- "Both concurrent and download licenses.",
- "Concurrent access license.",
- "Offline download access license."
- ],
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
- "location": "query"
- },
- "nonce": {
- "type": "string",
- "description": "The client nonce value.",
- "required": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "required": true,
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to request concurrent/download restrictions for.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "source",
- "volumeId",
- "nonce",
- "cpksver"
- ],
- "response": {
- "$ref": "RequestAccess"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
+ "type": "object"
},
- "syncVolumeLicenses": {
- "id": "books.myconfig.syncVolumeLicenses",
- "path": "myconfig/syncVolumeLicenses",
- "httpMethod": "POST",
- "description": "Request downloaded content access for specified volumes on the My eBooks shelf.",
- "parameters": {
- "cpksver": {
- "type": "string",
- "description": "The device/version ID from which to release the restriction.",
- "required": true,
- "location": "query"
+ "Bookshelves": {
+ "id": "Bookshelves",
+ "properties": {
+ "items": {
+ "description": "A list of bookshelves.",
+ "items": {
+ "$ref": "Bookshelf"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "books#bookshelves",
+ "description": "Resource type.",
+ "type": "string"
+ }
},
- "features": {
- "type": "string",
- "description": "List of features supported by the client, i.e., 'RENTALS'",
- "enum": [
- "RENTALS"
- ],
- "enumDescriptions": [
- "Client supports rentals."
- ],
- "repeated": true,
- "location": "query"
- },
- "includeNonComicsSeries": {
- "type": "boolean",
- "description": "Set to true to include non-comics series. Defaults to false.",
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
- "location": "query"
- },
- "nonce": {
- "type": "string",
- "description": "The client nonce value.",
- "required": true,
- "location": "query"
- },
- "showPreorders": {
- "type": "boolean",
- "description": "Set to true to show pre-ordered books. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "required": true,
- "location": "query"
- },
- "volumeIds": {
- "type": "string",
- "description": "The volume(s) to request download restrictions for.",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "source",
- "nonce",
- "cpksver"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
+ "type": "object"
},
- "updateUserSettings": {
- "id": "books.myconfig.updateUserSettings",
- "path": "myconfig/updateUserSettings",
- "httpMethod": "POST",
- "description": "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.",
- "request": {
- "$ref": "Usersettings"
- },
- "response": {
- "$ref": "Usersettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "mylibrary": {
- "resources": {
- "annotations": {
- "methods": {
- "delete": {
- "id": "books.mylibrary.annotations.delete",
- "path": "mylibrary/annotations/{annotationId}",
- "httpMethod": "DELETE",
- "description": "Deletes an annotation.",
- "parameters": {
- "annotationId": {
- "type": "string",
- "description": "The ID for the annotation to delete.",
- "required": true,
- "location": "path"
+ "Category": {
+ "id": "Category",
+ "properties": {
+ "items": {
+ "description": "A list of onboarding categories.",
+ "items": {
+ "properties": {
+ "badgeUrl": {
+ "type": "string"
+ },
+ "categoryId": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "onboarding#category",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConcurrentAccessRestriction": {
+ "id": "ConcurrentAccessRestriction",
+ "properties": {
+ "deviceAllowed": {
+ "description": "Whether access is granted for this (user, device, volume).",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "books#concurrentAccessRestriction",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "maxConcurrentDevices": {
+ "description": "The maximum number of concurrent access licenses for this volume.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "Error/warning message.",
+ "type": "string"
+ },
+ "nonce": {
+ "description": "Client nonce for verification. Download access and client-validation only.",
+ "type": "string"
+ },
+ "reasonCode": {
+ "description": "Error/warning reason code.",
+ "type": "string"
+ },
+ "restricted": {
+ "description": "Whether this volume has any concurrent access restrictions.",
+ "type": "boolean"
+ },
+ "signature": {
+ "description": "Response signature.",
+ "type": "string"
},
"source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
+ "description": "Client app identifier for verification. Download access and client-validation only.",
+ "type": "string"
+ },
+ "timeWindowSeconds": {
+ "description": "Time in seconds for license auto-expiration.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "volumeId": {
+ "description": "Identifies the volume for which this entry applies.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "annotationId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
},
- "insert": {
- "id": "books.mylibrary.annotations.insert",
- "path": "mylibrary/annotations",
- "httpMethod": "POST",
- "description": "Inserts a new annotation.",
- "parameters": {
- "annotationId": {
- "type": "string",
- "description": "The ID for the annotation to insert.",
- "location": "query"
+ "type": "object"
+ },
+ "Dictlayerdata": {
+ "id": "Dictlayerdata",
+ "properties": {
+ "common": {
+ "properties": {
+ "title": {
+ "description": "The display title and localized canonical name to use when searching for this entity on Google search.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "country": {
- "type": "string",
- "description": "ISO-3166-1 code to override the IP-based location.",
- "location": "query"
+ "dict": {
+ "properties": {
+ "source": {
+ "description": "The source, url and attribution for this dictionary data.",
+ "properties": {
+ "attribution": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "words": {
+ "items": {
+ "properties": {
+ "derivatives": {
+ "items": {
+ "properties": {
+ "source": {
+ "properties": {
+ "attribution": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "text": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "examples": {
+ "items": {
+ "properties": {
+ "source": {
+ "properties": {
+ "attribution": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "text": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "senses": {
+ "items": {
+ "properties": {
+ "conjugations": {
+ "items": {
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "definitions": {
+ "items": {
+ "properties": {
+ "definition": {
+ "type": "string"
+ },
+ "examples": {
+ "items": {
+ "properties": {
+ "source": {
+ "properties": {
+ "attribution": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "text": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "partOfSpeech": {
+ "type": "string"
+ },
+ "pronunciation": {
+ "type": "string"
+ },
+ "pronunciationUrl": {
+ "type": "string"
+ },
+ "source": {
+ "properties": {
+ "attribution": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "syllabification": {
+ "type": "string"
+ },
+ "synonyms": {
+ "items": {
+ "properties": {
+ "source": {
+ "properties": {
+ "attribution": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "text": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "source": {
+ "description": "The words with different meanings but not related words, e.g. \"go\" (game) and \"go\" (verb).",
+ "properties": {
+ "attribution": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
- "showOnlySummaryInResponse": {
- "type": "boolean",
- "description": "Requests that only the summary of the specified layer be provided in the response.",
- "location": "query"
+ "kind": {
+ "default": "books#dictlayerdata",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Discoveryclusters": {
+ "id": "Discoveryclusters",
+ "properties": {
+ "clusters": {
+ "items": {
+ "properties": {
+ "banner_with_content_container": {
+ "properties": {
+ "fillColorArgb": {
+ "type": "string"
+ },
+ "imageUrl": {
+ "type": "string"
+ },
+ "maskColorArgb": {
+ "type": "string"
+ },
+ "moreButtonText": {
+ "type": "string"
+ },
+ "moreButtonUrl": {
+ "type": "string"
+ },
+ "textColorArgb": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "subTitle": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "totalVolumes": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "uid": {
+ "type": "string"
+ },
+ "volumes": {
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "books#discovery#clusters",
+ "description": "Resorce type.",
+ "type": "string"
+ },
+ "totalClusters": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DownloadAccessRestriction": {
+ "id": "DownloadAccessRestriction",
+ "properties": {
+ "deviceAllowed": {
+ "description": "If restricted, whether access is granted for this (user, device, volume).",
+ "type": "boolean"
+ },
+ "downloadsAcquired": {
+ "description": "If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "justAcquired": {
+ "description": "If deviceAllowed, whether access was just acquired with this request.",
+ "type": "boolean"
+ },
+ "kind": {
+ "default": "books#downloadAccessRestriction",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "maxDownloadDevices": {
+ "description": "If restricted, the maximum number of content download licenses for this volume.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "Error/warning message.",
+ "type": "string"
+ },
+ "nonce": {
+ "description": "Client nonce for verification. Download access and client-validation only.",
+ "type": "string"
+ },
+ "reasonCode": {
+ "description": "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",
+ "type": "string"
+ },
+ "restricted": {
+ "description": "Whether this volume has any download access restrictions.",
+ "type": "boolean"
+ },
+ "signature": {
+ "description": "Response signature.",
+ "type": "string"
},
"source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
+ "description": "Client app identifier for verification. Download access and client-validation only.",
+ "type": "string"
+ },
+ "volumeId": {
+ "description": "Identifies the volume for which this entry applies.",
+ "type": "string"
}
- },
- "request": {
- "$ref": "Annotation"
- },
- "response": {
- "$ref": "Annotation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
},
- "list": {
- "id": "books.mylibrary.annotations.list",
- "path": "mylibrary/annotations",
- "httpMethod": "GET",
- "description": "Retrieves a list of annotations, possibly filtered.",
- "parameters": {
+ "type": "object"
+ },
+ "DownloadAccesses": {
+ "id": "DownloadAccesses",
+ "properties": {
+ "downloadAccessList": {
+ "description": "A list of download access responses.",
+ "items": {
+ "$ref": "DownloadAccessRestriction"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "books#downloadAccesses",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FamilyInfo": {
+ "id": "FamilyInfo",
+ "properties": {
+ "kind": {
+ "default": "books#familyInfo",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "membership": {
+ "description": "Family membership info of the user that made the request.",
+ "properties": {
+ "acquirePermission": {
+ "description": "Restrictions on user buying and acquiring content.",
+ "type": "string"
+ },
+ "ageGroup": {
+ "description": "The age group of the user.",
+ "type": "string"
+ },
+ "allowedMaturityRating": {
+ "description": "The maximum allowed maturity rating for the user.",
+ "type": "string"
+ },
+ "isInFamily": {
+ "type": "boolean"
+ },
+ "role": {
+ "description": "The role of the user in the family.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "Geolayerdata": {
+ "id": "Geolayerdata",
+ "properties": {
+ "common": {
+ "properties": {
+ "lang": {
+ "description": "The language of the information url and description.",
+ "type": "string"
+ },
+ "previewImageUrl": {
+ "description": "The URL for the preview image information.",
+ "type": "string"
+ },
+ "snippet": {
+ "description": "The description for this location.",
+ "type": "string"
+ },
+ "snippetUrl": {
+ "description": "The URL for information for this location. Ex: wikipedia link.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The display title and localized canonical name to use when searching for this entity on Google search.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "geo": {
+ "properties": {
+ "boundary": {
+ "description": "The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.",
+ "items": {
+ "items": {
+ "properties": {
+ "latitude": {
+ "format": "uint32",
+ "type": "integer"
+ },
+ "longitude": {
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "cachePolicy": {
+ "description": "The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "The country code of the location.",
+ "type": "string"
+ },
+ "latitude": {
+ "description": "The latitude of the location.",
+ "format": "double",
+ "type": "number"
+ },
+ "longitude": {
+ "description": "The longitude of the location.",
+ "format": "double",
+ "type": "number"
+ },
+ "mapType": {
+ "description": "The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN",
+ "type": "string"
+ },
+ "viewport": {
+ "description": "The viewport for showing this location. This is a latitude, longitude rectangle.",
+ "properties": {
+ "hi": {
+ "properties": {
+ "latitude": {
+ "format": "double",
+ "type": "number"
+ },
+ "longitude": {
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "lo": {
+ "properties": {
+ "latitude": {
+ "format": "double",
+ "type": "number"
+ },
+ "longitude": {
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "zoom": {
+ "description": "The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "kind": {
+ "default": "books#geolayerdata",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Layersummaries": {
+ "id": "Layersummaries",
+ "properties": {
+ "items": {
+ "description": "A list of layer summary items.",
+ "items": {
+ "$ref": "Layersummary"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "books#layersummaries",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The total number of layer summaries found.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Layersummary": {
+ "id": "Layersummary",
+ "properties": {
+ "annotationCount": {
+ "description": "The number of annotations for this layer.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "annotationTypes": {
+ "description": "The list of annotation types contained for this layer.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "annotationsDataLink": {
+ "description": "Link to get data for this annotation.",
+ "type": "string"
+ },
+ "annotationsLink": {
+ "description": "The link to get the annotations for this layer.",
+ "type": "string"
+ },
"contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "location": "query"
+ "description": "The content version this resource is for.",
+ "type": "string"
+ },
+ "dataCount": {
+ "description": "The number of data items for this layer.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Unique id of this layer summary.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "books#layersummary",
+ "description": "Resource Type",
+ "type": "string"
},
"layerId": {
- "type": "string",
- "description": "The layer ID to limit annotation by.",
- "location": "query"
+ "description": "The layer id for this summary.",
+ "type": "string"
},
- "layerIds": {
- "type": "string",
- "description": "The layer ID(s) to limit annotation by.",
- "repeated": true,
- "location": "query"
+ "selfLink": {
+ "description": "URL to this resource.",
+ "type": "string"
},
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "maximum": "40",
- "location": "query"
+ "updated": {
+ "description": "Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).",
+ "format": "date-time",
+ "type": "string"
},
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "updatedMax": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
- "location": "query"
+ "volumeAnnotationsVersion": {
+ "description": "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.",
+ "type": "string"
},
"volumeId": {
- "type": "string",
- "description": "The volume to restrict annotations to.",
- "location": "query"
+ "description": "The volume id this resource is for.",
+ "type": "string"
}
- },
- "response": {
- "$ref": "Annotations"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
},
- "summary": {
- "id": "books.mylibrary.annotations.summary",
- "path": "mylibrary/annotations/summary",
- "httpMethod": "POST",
- "description": "Gets the summary of specified layers.",
- "parameters": {
- "layerIds": {
- "type": "string",
- "description": "Array of layer IDs to get the summary for.",
- "required": true,
- "repeated": true,
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "Volume id to get the summary for.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "layerIds",
- "volumeId"
- ],
- "response": {
- "$ref": "AnnotationsSummary"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "update": {
- "id": "books.mylibrary.annotations.update",
- "path": "mylibrary/annotations/{annotationId}",
- "httpMethod": "PUT",
- "description": "Updates an existing annotation.",
- "parameters": {
- "annotationId": {
- "type": "string",
- "description": "The ID for the annotation to update.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "annotationId"
- ],
- "request": {
- "$ref": "Annotation"
- },
- "response": {
- "$ref": "Annotation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
+ "type": "object"
},
- "bookshelves": {
- "methods": {
- "addVolume": {
- "id": "books.mylibrary.bookshelves.addVolume",
- "path": "mylibrary/bookshelves/{shelf}/addVolume",
- "httpMethod": "POST",
- "description": "Adds a volume to a bookshelf.",
- "parameters": {
+ "Metadata": {
+ "id": "Metadata",
+ "properties": {
+ "items": {
+ "description": "A list of offline dictionary metadata.",
+ "items": {
+ "properties": {
+ "download_url": {
+ "type": "string"
+ },
+ "encrypted_key": {
+ "type": "string"
+ },
+ "language": {
+ "type": "string"
+ },
+ "size": {
+ "format": "int64",
+ "type": "string"
+ },
+ "version": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "dictionary#metadata",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Notification": {
+ "id": "Notification",
+ "properties": {
+ "body": {
+ "type": "string"
+ },
+ "crmExperimentIds": {
+ "description": "The list of crm experiment ids.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "doc_id": {
+ "type": "string"
+ },
+ "doc_type": {
+ "type": "string"
+ },
+ "dont_show_notification": {
+ "type": "boolean"
+ },
+ "iconUrl": {
+ "type": "string"
+ },
+ "kind": {
+ "default": "books#notification",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "notificationGroup": {
+ "type": "string"
+ },
+ "notification_type": {
+ "type": "string"
+ },
+ "pcampaign_id": {
+ "type": "string"
+ },
"reason": {
- "type": "string",
- "description": "The reason for which the book is added to the library.",
- "enum": [
- "IOS_PREX",
- "IOS_SEARCH",
- "ONBOARDING"
- ],
- "enumDescriptions": [
- "Volumes added from the PREX flow on iOS.",
- "Volumes added from the Search flow on iOS.",
- "Volumes added from the Onboarding flow."
- ],
- "location": "query"
+ "type": "string"
},
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf to which to add a volume.",
- "required": true,
- "location": "path"
+ "show_notification_settings_action": {
+ "type": "boolean"
},
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
+ "targetUrl": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Offers": {
+ "id": "Offers",
+ "properties": {
+ "items": {
+ "description": "A list of offers.",
+ "items": {
+ "properties": {
+ "artUrl": {
+ "type": "string"
+ },
+ "gservicesKey": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "properties": {
+ "author": {
+ "type": "string"
+ },
+ "canonicalVolumeLink": {
+ "type": "string"
+ },
+ "coverUrl": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "volumeId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "promooffer#offers",
+ "description": "Resource type.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReadingPosition": {
+ "id": "ReadingPosition",
+ "properties": {
+ "epubCfiPosition": {
+ "description": "Position in an EPUB as a CFI.",
+ "type": "string"
+ },
+ "gbImagePosition": {
+ "description": "Position in a volume for image-based content.",
+ "type": "string"
+ },
+ "gbTextPosition": {
+ "description": "Position in a volume for text-based content.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "books#readingPosition",
+ "description": "Resource type for a reading position.",
+ "type": "string"
+ },
+ "pdfPosition": {
+ "description": "Position in a PDF file.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).",
+ "format": "date-time",
+ "type": "string"
},
"volumeId": {
- "type": "string",
- "description": "ID of volume to add.",
- "required": true,
- "location": "query"
+ "description": "Volume id associated with this reading position.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "shelf",
- "volumeId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
},
- "clearVolumes": {
- "id": "books.mylibrary.bookshelves.clearVolumes",
- "path": "mylibrary/bookshelves/{shelf}/clearVolumes",
- "httpMethod": "POST",
- "description": "Clears all volumes from a bookshelf.",
- "parameters": {
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf from which to remove a volume.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "get": {
- "id": "books.mylibrary.bookshelves.get",
- "path": "mylibrary/bookshelves/{shelf}",
- "httpMethod": "GET",
- "description": "Retrieves metadata for a specific bookshelf belonging to the authenticated user.",
- "parameters": {
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf to retrieve.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf"
- ],
- "response": {
- "$ref": "Bookshelf"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.mylibrary.bookshelves.list",
- "path": "mylibrary/bookshelves",
- "httpMethod": "GET",
- "description": "Retrieves a list of bookshelves belonging to the authenticated user.",
- "parameters": {
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Bookshelves"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "moveVolume": {
- "id": "books.mylibrary.bookshelves.moveVolume",
- "path": "mylibrary/bookshelves/{shelf}/moveVolume",
- "httpMethod": "POST",
- "description": "Moves a volume within a bookshelf.",
- "parameters": {
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf with the volume.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume to move.",
- "required": true,
- "location": "query"
- },
- "volumePosition": {
- "type": "integer",
- "description": "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.)",
- "required": true,
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf",
- "volumeId",
- "volumePosition"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "removeVolume": {
- "id": "books.mylibrary.bookshelves.removeVolume",
- "path": "mylibrary/bookshelves/{shelf}/removeVolume",
- "httpMethod": "POST",
- "description": "Removes a volume from a bookshelf.",
- "parameters": {
- "reason": {
- "type": "string",
- "description": "The reason for which the book is removed from the library.",
- "enum": [
- "ONBOARDING"
- ],
- "enumDescriptions": [
- "Samples removed from the Onboarding flow."
- ],
- "location": "query"
- },
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf from which to remove a volume.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume to remove.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf",
- "volumeId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- },
- "resources": {
- "volumes": {
- "methods": {
- "list": {
- "id": "books.mylibrary.bookshelves.volumes.list",
- "path": "mylibrary/bookshelves/{shelf}/volumes",
- "httpMethod": "GET",
- "description": "Gets volume information for volumes on a bookshelf.",
- "parameters": {
- "country": {
- "type": "string",
- "description": "ISO-3166-1 code to override the IP-based location.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "full",
- "lite"
- ],
- "enumDescriptions": [
- "Includes all volume data.",
- "Includes a subset of fields in volumeInfo and accessInfo."
- ],
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Full-text search query string in this bookshelf.",
- "location": "query"
- },
- "shelf": {
- "type": "string",
- "description": "The bookshelf ID or name retrieve volumes for.",
- "required": true,
- "location": "path"
- },
- "showPreorders": {
- "type": "boolean",
- "description": "Set to true to show pre-ordered books. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first element to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
+ "type": "object"
},
- "readingpositions": {
- "methods": {
- "get": {
- "id": "books.mylibrary.readingpositions.get",
- "path": "mylibrary/readingpositions/{volumeId}",
- "httpMethod": "GET",
- "description": "Retrieves my reading position information for a volume.",
- "parameters": {
- "contentVersion": {
- "type": "string",
- "description": "Volume content version for which this reading position is requested.",
- "location": "query"
+ "RequestAccess": {
+ "id": "RequestAccess",
+ "properties": {
+ "concurrentAccess": {
+ "$ref": "ConcurrentAccessRestriction",
+ "description": "A concurrent access response."
},
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
+ "downloadAccess": {
+ "$ref": "DownloadAccessRestriction",
+ "description": "A download access response."
},
- "volumeId": {
- "type": "string",
- "description": "ID of volume for which to retrieve a reading position.",
- "required": true,
- "location": "path"
+ "kind": {
+ "default": "books#requestAccess",
+ "description": "Resource type.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "volumeId"
- ],
- "response": {
- "$ref": "ReadingPosition"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
},
- "setPosition": {
- "id": "books.mylibrary.readingpositions.setPosition",
- "path": "mylibrary/readingpositions/{volumeId}/setPosition",
- "httpMethod": "POST",
- "description": "Sets my reading position information for a volume.",
- "parameters": {
- "action": {
- "type": "string",
- "description": "Action that caused this reading position to be set.",
- "enum": [
- "bookmark",
- "chapter",
- "next-page",
- "prev-page",
- "scroll",
- "search"
- ],
- "enumDescriptions": [
- "User chose bookmark within volume.",
- "User selected chapter from list.",
- "Next page event.",
- "Previous page event.",
- "User navigated to page.",
- "User chose search results within volume."
- ],
- "location": "query"
- },
- "contentVersion": {
- "type": "string",
- "description": "Volume content version for which this reading position applies.",
- "location": "query"
- },
- "deviceCookie": {
- "type": "string",
- "description": "Random persistent device cookie optional on set position.",
- "location": "query"
- },
- "position": {
- "type": "string",
- "description": "Position string for the new volume reading position.",
- "required": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "timestamp": {
- "type": "string",
- "description": "RFC 3339 UTC format timestamp associated with this reading position.",
- "required": true,
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume for which to update the reading position.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId",
- "timestamp",
- "position"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
- },
- "notification": {
- "methods": {
- "get": {
- "id": "books.notification.get",
- "path": "notification/get",
- "httpMethod": "GET",
- "description": "Returns notification details for a given notification id.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.",
- "location": "query"
- },
- "notification_id": {
- "type": "string",
- "description": "String to identify the notification.",
- "required": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "notification_id"
- ],
- "response": {
- "$ref": "Notification"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "onboarding": {
- "methods": {
- "listCategories": {
- "id": "books.onboarding.listCategories",
- "path": "onboarding/listCategories",
- "httpMethod": "GET",
- "description": "List categories for onboarding experience.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Category"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
+ "type": "object"
},
- "listCategoryVolumes": {
- "id": "books.onboarding.listCategoryVolumes",
- "path": "onboarding/listCategoryVolumes",
- "httpMethod": "GET",
- "description": "List available volumes under categories for onboarding experience.",
- "parameters": {
- "categoryId": {
- "type": "string",
- "description": "List of category ids requested.",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.",
- "location": "query"
- },
- "maxAllowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.",
- "enum": [
- "mature",
- "not-mature"
- ],
- "enumDescriptions": [
- "Show books which are rated mature or lower.",
- "Show books which are rated not mature."
- ],
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "Number of maximum results per page to be included in the response.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Volume2"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "personalizedstream": {
- "methods": {
- "get": {
- "id": "books.personalizedstream.get",
- "path": "personalizedstream/get",
- "httpMethod": "GET",
- "description": "Returns a stream of personalized book clusters",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
- },
- "maxAllowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- "enum": [
- "mature",
- "not-mature"
- ],
- "enumDescriptions": [
- "Show books which are rated mature or lower.",
- "Show books which are rated not mature."
- ],
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Discoveryclusters"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "promooffer": {
- "methods": {
- "accept": {
- "id": "books.promooffer.accept",
- "path": "promooffer/accept",
- "httpMethod": "POST",
- "description": "",
- "parameters": {
- "androidId": {
- "type": "string",
- "description": "device android_id",
- "location": "query"
- },
- "device": {
- "type": "string",
- "description": "device device",
- "location": "query"
- },
- "manufacturer": {
- "type": "string",
- "description": "device manufacturer",
- "location": "query"
- },
- "model": {
- "type": "string",
- "description": "device model",
- "location": "query"
- },
- "offerId": {
- "type": "string",
- "location": "query"
- },
- "product": {
- "type": "string",
- "description": "device product",
- "location": "query"
- },
- "serial": {
- "type": "string",
- "description": "device serial",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "Volume id to exercise the offer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "dismiss": {
- "id": "books.promooffer.dismiss",
- "path": "promooffer/dismiss",
- "httpMethod": "POST",
- "description": "",
- "parameters": {
- "androidId": {
- "type": "string",
- "description": "device android_id",
- "location": "query"
- },
- "device": {
- "type": "string",
- "description": "device device",
- "location": "query"
- },
- "manufacturer": {
- "type": "string",
- "description": "device manufacturer",
- "location": "query"
- },
- "model": {
- "type": "string",
- "description": "device model",
- "location": "query"
- },
- "offerId": {
- "type": "string",
- "description": "Offer to dimiss",
- "location": "query"
- },
- "product": {
- "type": "string",
- "description": "device product",
- "location": "query"
- },
- "serial": {
- "type": "string",
- "description": "device serial",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "get": {
- "id": "books.promooffer.get",
- "path": "promooffer/get",
- "httpMethod": "GET",
- "description": "Returns a list of promo offers available to the user",
- "parameters": {
- "androidId": {
- "type": "string",
- "description": "device android_id",
- "location": "query"
- },
- "device": {
- "type": "string",
- "description": "device device",
- "location": "query"
- },
- "manufacturer": {
- "type": "string",
- "description": "device manufacturer",
- "location": "query"
- },
- "model": {
- "type": "string",
- "description": "device model",
- "location": "query"
- },
- "product": {
- "type": "string",
- "description": "device product",
- "location": "query"
- },
- "serial": {
- "type": "string",
- "description": "device serial",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Offers"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "series": {
- "methods": {
- "get": {
- "id": "books.series.get",
- "path": "series/get",
- "httpMethod": "GET",
- "description": "Returns Series metadata for the given series ids.",
- "parameters": {
- "series_id": {
- "type": "string",
- "description": "String that identifies the series",
- "required": true,
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "series_id"
- ],
- "response": {
- "$ref": "Series"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- },
- "resources": {
- "membership": {
- "methods": {
- "get": {
- "id": "books.series.membership.get",
- "path": "series/membership/get",
- "httpMethod": "GET",
- "description": "Returns Series membership data given the series id.",
- "parameters": {
- "page_size": {
- "type": "integer",
- "description": "Number of maximum results per page to be included in the response.",
- "format": "uint32",
- "location": "query"
+ "Review": {
+ "id": "Review",
+ "properties": {
+ "author": {
+ "description": "Author of this review.",
+ "properties": {
+ "displayName": {
+ "description": "Name of this person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "page_token": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
+ "content": {
+ "description": "Review text.",
+ "type": "string"
},
- "series_id": {
- "type": "string",
- "description": "String that identifies the series",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "series_id"
- ],
- "response": {
- "$ref": "Seriesmembership"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
- },
- "volumes": {
- "methods": {
- "get": {
- "id": "books.volumes.get",
- "path": "volumes/{volumeId}",
- "httpMethod": "GET",
- "description": "Gets volume information for a single volume.",
- "parameters": {
- "country": {
- "type": "string",
- "description": "ISO-3166-1 code to override the IP-based location.",
- "location": "query"
- },
- "includeNonComicsSeries": {
- "type": "boolean",
- "description": "Set to true to include non-comics series. Defaults to false.",
- "location": "query"
- },
- "partner": {
- "type": "string",
- "description": "Brand results for partner ID.",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "full",
- "lite"
- ],
- "enumDescriptions": [
- "Includes all volume data.",
- "Includes a subset of fields in volumeInfo and accessInfo."
- ],
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "user_library_consistent_read": {
- "type": "boolean",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId"
- ],
- "response": {
- "$ref": "Volume"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.volumes.list",
- "path": "volumes",
- "httpMethod": "GET",
- "description": "Performs a book search.",
- "parameters": {
- "download": {
- "type": "string",
- "description": "Restrict to volumes by download availability.",
- "enum": [
- "epub"
- ],
- "enumDescriptions": [
- "All volumes with epub."
- ],
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filter search results.",
- "enum": [
- "ebooks",
- "free-ebooks",
- "full",
- "paid-ebooks",
- "partial"
- ],
- "enumDescriptions": [
- "All Google eBooks.",
- "Google eBook with full volume text viewability.",
- "Public can view entire volume text.",
- "Google eBook with a price.",
- "Public able to see parts of text."
- ],
- "location": "query"
- },
- "langRestrict": {
- "type": "string",
- "description": "Restrict results to books with this language code.",
- "location": "query"
- },
- "libraryRestrict": {
- "type": "string",
- "description": "Restrict search to this user's library.",
- "enum": [
- "my-library",
- "no-restrict"
- ],
- "enumDescriptions": [
- "Restrict to the user's library, any shelf.",
- "Do not restrict based on user's library."
- ],
- "location": "query"
- },
- "maxAllowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- "enum": [
- "mature",
- "not-mature"
- ],
- "enumDescriptions": [
- "Show books which are rated mature or lower.",
- "Show books which are rated not mature."
- ],
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "40",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sort search results.",
- "enum": [
- "newest",
- "relevance"
- ],
- "enumDescriptions": [
- "Most recently published.",
- "Relevance to search terms."
- ],
- "location": "query"
- },
- "partner": {
- "type": "string",
- "description": "Restrict and brand results for partner ID.",
- "location": "query"
- },
- "printType": {
- "type": "string",
- "description": "Restrict to books or magazines.",
- "enum": [
- "all",
- "books",
- "magazines"
- ],
- "enumDescriptions": [
- "All volume content types.",
- "Just books.",
- "Just magazines."
- ],
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "full",
- "lite"
- ],
- "enumDescriptions": [
- "Includes all volume data.",
- "Includes a subset of fields in volumeInfo and accessInfo."
- ],
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Full-text search query string.",
- "required": true,
- "location": "query"
- },
- "showPreorders": {
- "type": "boolean",
- "description": "Set to true to show books available for preorder. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first result to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- }
- },
- "parameterOrder": [
- "q"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- },
- "resources": {
- "associated": {
- "methods": {
- "list": {
- "id": "books.volumes.associated.list",
- "path": "volumes/{volumeId}/associated",
- "httpMethod": "GET",
- "description": "Return a list of associated books.",
- "parameters": {
- "association": {
- "type": "string",
- "description": "Association type.",
- "enum": [
- "end-of-sample",
- "end-of-volume",
- "related-for-play"
- ],
- "enumDescriptions": [
- "Recommendations for display end-of-sample.",
- "Recommendations for display end-of-volume.",
- "Related volumes for Play Store."
- ],
- "location": "query"
+ "date": {
+ "description": "Date of this review.",
+ "type": "string"
},
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
+ "fullTextUrl": {
+ "description": "URL for the full review text, for reviews gathered from the web.",
+ "type": "string"
},
- "maxAllowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- "enum": [
- "mature",
- "not-mature"
- ],
- "enumDescriptions": [
- "Show books which are rated mature or lower.",
- "Show books which are rated not mature."
- ],
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of the source volume.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "mybooks": {
- "methods": {
- "list": {
- "id": "books.volumes.mybooks.list",
- "path": "volumes/mybooks",
- "httpMethod": "GET",
- "description": "Return a list of books in My Library.",
- "parameters": {
- "acquireMethod": {
- "type": "string",
- "description": "How the book was acquired",
- "enum": [
- "FAMILY_SHARED",
- "PREORDERED",
- "PREVIOUSLY_RENTED",
- "PUBLIC_DOMAIN",
- "PURCHASED",
- "RENTED",
- "SAMPLE",
- "UPLOADED"
- ],
- "enumDescriptions": [
- "Books acquired via Family Sharing",
- "Preordered books (not yet available)",
- "User-rented books past their expiration time",
- "Public domain books",
- "Purchased books",
- "User-rented books",
- "Sample books",
- "User uploaded books"
- ],
- "repeated": true,
- "location": "query"
- },
- "country": {
- "type": "string",
- "description": "ISO-3166-1 code to override the IP-based location.",
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "processingState": {
- "type": "string",
- "description": "The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.",
- "enum": [
- "COMPLETED_FAILED",
- "COMPLETED_SUCCESS",
- "RUNNING"
- ],
- "enumDescriptions": [
- "The volume processing hase failed.",
- "The volume processing was completed.",
- "The volume processing is not completed."
- ],
- "repeated": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first result to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "recommended": {
- "methods": {
- "list": {
- "id": "books.volumes.recommended.list",
- "path": "volumes/recommended",
- "httpMethod": "GET",
- "description": "Return a list of recommended books for the current user.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
- },
- "maxAllowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- "enum": [
- "mature",
- "not-mature"
- ],
- "enumDescriptions": [
- "Show books which are rated mature or lower.",
- "Show books which are rated not mature."
- ],
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "rate": {
- "id": "books.volumes.recommended.rate",
- "path": "volumes/recommended/rate",
- "httpMethod": "POST",
- "description": "Rate a recommended book for the current user.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
+ "kind": {
+ "default": "books#review",
+ "description": "Resource type for a review.",
+ "type": "string"
},
"rating": {
- "type": "string",
- "description": "Rating to be given to the volume.",
- "required": true,
- "enum": [
- "HAVE_IT",
- "NOT_INTERESTED"
- ],
- "enumDescriptions": [
- "Rating indicating a dismissal due to ownership.",
- "Rating indicating a negative dismissal of a volume."
- ],
- "location": "query"
+ "description": "Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.",
+ "type": "string"
},
"source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
+ "description": "Information regarding the source of this review, when the review is not from a Google Books user.",
+ "properties": {
+ "description": {
+ "description": "Name of the source.",
+ "type": "string"
+ },
+ "extraDescription": {
+ "description": "Extra text about the source of the review.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL of the source of the review.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "title": {
+ "description": "Title for this review.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.",
+ "type": "string"
},
"volumeId": {
- "type": "string",
- "description": "ID of the source volume.",
- "required": true,
- "location": "query"
+ "description": "Volume that this review is for.",
+ "type": "string"
}
- },
- "parameterOrder": [
- "rating",
- "volumeId"
- ],
- "response": {
- "$ref": "BooksVolumesRecommendedRateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
+ },
+ "type": "object"
},
- "useruploaded": {
- "methods": {
- "list": {
- "id": "books.volumes.useruploaded.list",
- "path": "volumes/useruploaded",
- "httpMethod": "GET",
- "description": "Return a list of books uploaded by the current user.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
+ "Series": {
+ "id": "Series",
+ "properties": {
+ "kind": {
+ "default": "books#series",
+ "description": "Resource type.",
+ "type": "string"
},
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "40",
- "location": "query"
+ "series": {
+ "items": {
+ "properties": {
+ "bannerImageUrl": {
+ "type": "string"
+ },
+ "imageUrl": {
+ "type": "string"
+ },
+ "seriesId": {
+ "type": "string"
+ },
+ "seriesType": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Seriesmembership": {
+ "id": "Seriesmembership",
+ "properties": {
+ "kind": {
+ "default": "books#series#membership",
+ "description": "Resorce type.",
+ "type": "string"
},
- "processingState": {
- "type": "string",
- "description": "The processing state of the user uploaded volumes to be returned.",
- "enum": [
- "COMPLETED_FAILED",
- "COMPLETED_SUCCESS",
- "RUNNING"
- ],
- "enumDescriptions": [
- "The volume processing hase failed.",
- "The volume processing was completed.",
- "The volume processing is not completed."
- ],
- "repeated": true,
- "location": "query"
+ "member": {
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
},
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
+ "nextPageToken": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Usersettings": {
+ "id": "Usersettings",
+ "properties": {
+ "kind": {
+ "default": "books#usersettings",
+ "description": "Resource type.",
+ "type": "string"
},
- "startIndex": {
- "type": "integer",
- "description": "Index of the first result to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
+ "notesExport": {
+ "description": "User settings in sub-objects, each for different purposes.",
+ "properties": {
+ "folderName": {
+ "type": "string"
+ },
+ "isEnabled": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "notification": {
+ "properties": {
+ "matchMyInterests": {
+ "properties": {
+ "opted_state": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "moreFromAuthors": {
+ "properties": {
+ "opted_state": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "moreFromSeries": {
+ "properties": {
+ "opted_state": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "priceDrop": {
+ "properties": {
+ "opted_state": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "rewardExpirations": {
+ "properties": {
+ "opted_state": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "Volume": {
+ "id": "Volume",
+ "properties": {
+ "accessInfo": {
+ "description": "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.).",
+ "properties": {
+ "accessViewStatus": {
+ "description": "Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)",
+ "type": "string"
+ },
+ "country": {
+ "description": "The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)",
+ "type": "string"
+ },
+ "downloadAccess": {
+ "$ref": "DownloadAccessRestriction",
+ "description": "Information about a volume's download license access restrictions."
+ },
+ "driveImportedContentLink": {
+ "description": "URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.",
+ "type": "string"
+ },
+ "embeddable": {
+ "description": "Whether this volume can be embedded in a viewport using the Embedded Viewer API.",
+ "type": "boolean"
+ },
+ "epub": {
+ "description": "Information about epub content. (In LITE projection.)",
+ "properties": {
+ "acsTokenLink": {
+ "description": "URL to retrieve ACS token for epub download. (In LITE projection.)",
+ "type": "string"
+ },
+ "downloadLink": {
+ "description": "URL to download epub. (In LITE projection.)",
+ "type": "string"
+ },
+ "isAvailable": {
+ "description": "Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "explicitOfflineLicenseManagement": {
+ "description": "Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.",
+ "type": "boolean"
+ },
+ "pdf": {
+ "description": "Information about pdf content. (In LITE projection.)",
+ "properties": {
+ "acsTokenLink": {
+ "description": "URL to retrieve ACS token for pdf download. (In LITE projection.)",
+ "type": "string"
+ },
+ "downloadLink": {
+ "description": "URL to download pdf. (In LITE projection.)",
+ "type": "string"
+ },
+ "isAvailable": {
+ "description": "Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "publicDomain": {
+ "description": "Whether or not this book is public domain in the country listed above.",
+ "type": "boolean"
+ },
+ "quoteSharingAllowed": {
+ "description": "Whether quote sharing is allowed for this volume.",
+ "type": "boolean"
+ },
+ "textToSpeechPermission": {
+ "description": "Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.",
+ "type": "string"
+ },
+ "viewOrderUrl": {
+ "description": "For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.",
+ "type": "string"
+ },
+ "viewability": {
+ "description": "The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.",
+ "type": "string"
+ },
+ "webReaderLink": {
+ "description": "URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "etag": {
+ "description": "Opaque identifier for a specific version of a volume resource. (In LITE projection)",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for a volume. (In LITE projection.)",
+ "type": "string"
+ },
+ "kind": {
+ "default": "books#volume",
+ "description": "Resource type for a volume. (In LITE projection.)",
+ "type": "string"
+ },
+ "layerInfo": {
+ "description": "What layers exist in this volume and high level information about them.",
+ "properties": {
+ "layers": {
+ "description": "A layer should appear here if and only if the layer exists for this book.",
+ "items": {
+ "properties": {
+ "layerId": {
+ "description": "The layer id of this layer (e.g. \"geo\").",
+ "type": "string"
+ },
+ "volumeAnnotationsVersion": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "recommendedInfo": {
+ "description": "Recommendation related information for this volume.",
+ "properties": {
+ "explanation": {
+ "description": "A text explaining why this volume is recommended.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "saleInfo": {
+ "description": "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).",
+ "properties": {
+ "buyLink": {
+ "description": "URL to purchase this volume on the Google Books site. (In LITE projection)",
+ "type": "string"
+ },
+ "country": {
+ "description": "The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)",
+ "type": "string"
+ },
+ "isEbook": {
+ "description": "Whether or not this volume is an eBook (can be added to the My eBooks shelf).",
+ "type": "boolean"
+ },
+ "listPrice": {
+ "description": "Suggested retail price. (In LITE projection.)",
+ "properties": {
+ "amount": {
+ "description": "Amount in the currency listed below. (In LITE projection.)",
+ "format": "double",
+ "type": "number"
+ },
+ "currencyCode": {
+ "description": "An ISO 4217, three-letter currency code. (In LITE projection.)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "offers": {
+ "description": "Offers available for this volume (sales and rentals).",
+ "items": {
+ "properties": {
+ "finskyOfferType": {
+ "description": "The finsky offer type (e.g., PURCHASE=0 RENTAL=3)",
+ "format": "int32",
+ "type": "integer"
+ },
+ "giftable": {
+ "description": "Indicates whether the offer is giftable.",
+ "type": "boolean"
+ },
+ "listPrice": {
+ "description": "Offer list (=undiscounted) price in Micros.",
+ "properties": {
+ "amountInMicros": {
+ "format": "double",
+ "type": "number"
+ },
+ "currencyCode": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "rentalDuration": {
+ "description": "The rental duration (for rental offers only).",
+ "properties": {
+ "count": {
+ "format": "double",
+ "type": "number"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "retailPrice": {
+ "description": "Offer retail (=discounted) price in Micros",
+ "properties": {
+ "amountInMicros": {
+ "format": "double",
+ "type": "number"
+ },
+ "currencyCode": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "onSaleDate": {
+ "description": "The date on which this book is available for sale.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "retailPrice": {
+ "description": "The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)",
+ "properties": {
+ "amount": {
+ "description": "Amount in the currency listed below. (In LITE projection.)",
+ "format": "double",
+ "type": "number"
+ },
+ "currencyCode": {
+ "description": "An ISO 4217, three-letter currency code. (In LITE projection.)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "saleability": {
+ "description": "Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "searchInfo": {
+ "description": "Search result information related to this volume.",
+ "properties": {
+ "textSnippet": {
+ "description": "A text snippet containing the search query.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "URL to this resource. (In LITE projection.)",
+ "type": "string"
+ },
+ "userInfo": {
+ "description": "User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)",
+ "properties": {
+ "acquiredTime": {
+ "description": "Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "acquisitionType": {
+ "description": "How this volume was acquired.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "copy": {
+ "description": "Copy/Paste accounting information.",
+ "properties": {
+ "allowedCharacterCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "limitType": {
+ "type": "string"
+ },
+ "remainingCharacterCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "updated": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "entitlementType": {
+ "description": "Whether this volume is purchased, sample, pd download etc.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "familySharing": {
+ "description": "Information on the ability to share with the family.",
+ "properties": {
+ "familyRole": {
+ "description": "The role of the user in the family.",
+ "type": "string"
+ },
+ "isSharingAllowed": {
+ "description": "Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.",
+ "type": "boolean"
+ },
+ "isSharingDisabledByFop": {
+ "description": "Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "isFamilySharedFromUser": {
+ "description": "Whether or not the user shared this volume with the family.",
+ "type": "boolean"
+ },
+ "isFamilySharedToUser": {
+ "description": "Whether or not the user received this volume through family sharing.",
+ "type": "boolean"
+ },
+ "isFamilySharingAllowed": {
+ "description": "Deprecated: Replaced by familySharing.",
+ "type": "boolean"
+ },
+ "isFamilySharingDisabledByFop": {
+ "description": "Deprecated: Replaced by familySharing.",
+ "type": "boolean"
+ },
+ "isInMyBooks": {
+ "description": "Whether or not this volume is currently in \"my books.\"",
+ "type": "boolean"
+ },
+ "isPreordered": {
+ "description": "Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)",
+ "type": "boolean"
+ },
+ "isPurchased": {
+ "description": "Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)",
+ "type": "boolean"
+ },
+ "isUploaded": {
+ "description": "Whether or not this volume was user uploaded.",
+ "type": "boolean"
+ },
+ "readingPosition": {
+ "$ref": "ReadingPosition",
+ "description": "The user's current reading position in the volume, if one is available. (In LITE projection.)"
+ },
+ "rentalPeriod": {
+ "description": "Period during this book is/was a valid rental.",
+ "properties": {
+ "endUtcSec": {
+ "format": "int64",
+ "type": "string"
+ },
+ "startUtcSec": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "rentalState": {
+ "description": "Whether this book is an active or an expired rental.",
+ "type": "string"
+ },
+ "review": {
+ "$ref": "Review",
+ "description": "This user's review of this volume, if one exists."
+ },
+ "updated": {
+ "description": "Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).",
+ "format": "date-time",
+ "type": "string"
+ },
+ "userUploadedVolumeInfo": {
+ "properties": {
+ "processingState": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "volumeInfo": {
+ "description": "General volume information.",
+ "properties": {
+ "allowAnonLogging": {
+ "description": "Whether anonymous logging should be allowed.",
+ "type": "boolean"
+ },
+ "authors": {
+ "description": "The names of the authors and/or editors for this volume. (In LITE projection)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "averageRating": {
+ "description": "The mean review rating for this volume. (min = 1.0, max = 5.0)",
+ "format": "double",
+ "type": "number"
+ },
+ "canonicalVolumeLink": {
+ "description": "Canonical URL for a volume. (In LITE projection.)",
+ "type": "string"
+ },
+ "categories": {
+ "description": "A list of subject categories, such as \"Fiction\", \"Suspense\", etc.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "contentVersion": {
+ "description": "An identifier for the version of the volume content (text \u0026 images). (In LITE projection)",
+ "type": "string"
+ },
+ "description": {
+ "description": "A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)",
+ "type": "string"
+ },
+ "dimensions": {
+ "description": "Physical dimensions of this volume.",
+ "properties": {
+ "height": {
+ "description": "Height or length of this volume (in cm).",
+ "type": "string"
+ },
+ "thickness": {
+ "description": "Thickness of this volume (in cm).",
+ "type": "string"
+ },
+ "width": {
+ "description": "Width of this volume (in cm).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "imageLinks": {
+ "description": "A list of image links for all the sizes that are available. (In LITE projection.)",
+ "properties": {
+ "extraLarge": {
+ "description": "Image link for extra large size (width of ~1280 pixels). (In LITE projection)",
+ "type": "string"
+ },
+ "large": {
+ "description": "Image link for large size (width of ~800 pixels). (In LITE projection)",
+ "type": "string"
+ },
+ "medium": {
+ "description": "Image link for medium size (width of ~575 pixels). (In LITE projection)",
+ "type": "string"
+ },
+ "small": {
+ "description": "Image link for small size (width of ~300 pixels). (In LITE projection)",
+ "type": "string"
+ },
+ "smallThumbnail": {
+ "description": "Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)",
+ "type": "string"
+ },
+ "thumbnail": {
+ "description": "Image link for thumbnail size (width of ~128 pixels). (In LITE projection)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "industryIdentifiers": {
+ "description": "Industry standard identifiers for this volume.",
+ "items": {
+ "properties": {
+ "identifier": {
+ "description": "Industry specific volume identifier.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "infoLink": {
+ "description": "URL to view information about this volume on the Google Books site. (In LITE projection)",
+ "type": "string"
+ },
+ "language": {
+ "description": "Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.",
+ "type": "string"
+ },
+ "mainCategory": {
+ "description": "The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.",
+ "type": "string"
+ },
+ "maturityRating": {
+ "type": "string"
+ },
+ "pageCount": {
+ "description": "Total number of pages as per publisher metadata.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "panelizationSummary": {
+ "description": "A top-level summary of the panelization info in this volume.",
+ "properties": {
+ "containsEpubBubbles": {
+ "type": "boolean"
+ },
+ "containsImageBubbles": {
+ "type": "boolean"
+ },
+ "epubBubbleVersion": {
+ "type": "string"
+ },
+ "imageBubbleVersion": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "previewLink": {
+ "description": "URL to preview this volume on the Google Books site.",
+ "type": "string"
+ },
+ "printType": {
+ "description": "Type of publication of this volume. Possible values are BOOK or MAGAZINE.",
+ "type": "string"
+ },
+ "printedPageCount": {
+ "description": "Total number of printed pages in generated pdf representation.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "publishedDate": {
+ "description": "Date of publication. (In LITE projection.)",
+ "type": "string"
+ },
+ "publisher": {
+ "description": "Publisher of this volume. (In LITE projection.)",
+ "type": "string"
+ },
+ "ratingsCount": {
+ "description": "The number of review ratings for this volume.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "readingModes": {
+ "description": "The reading modes available for this volume.",
+ "type": "any"
+ },
+ "samplePageCount": {
+ "description": "Total number of sample pages as per publisher metadata.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "seriesInfo": {
+ "$ref": "Volumeseriesinfo"
+ },
+ "subtitle": {
+ "description": "Volume subtitle. (In LITE projection.)",
+ "type": "string"
+ },
+ "title": {
+ "description": "Volume title. (In LITE projection.)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "Volume2": {
+ "id": "Volume2",
+ "properties": {
+ "items": {
+ "description": "A list of volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "onboarding#volume",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Volumeannotation": {
+ "id": "Volumeannotation",
+ "properties": {
+ "annotationDataId": {
+ "description": "The annotation data id for this volume annotation.",
+ "type": "string"
+ },
+ "annotationDataLink": {
+ "description": "Link to get data for this annotation.",
+ "type": "string"
+ },
+ "annotationType": {
+ "description": "The type of annotation this is.",
+ "type": "string"
+ },
+ "contentRanges": {
+ "description": "The content ranges to identify the selected text.",
+ "properties": {
+ "cfiRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in CFI format for this annotation for version above."
+ },
+ "contentVersion": {
+ "description": "Content version applicable to ranges below.",
+ "type": "string"
+ },
+ "gbImageRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in GB image format for this annotation for version above."
+ },
+ "gbTextRange": {
+ "$ref": "BooksAnnotationsRange",
+ "description": "Range in GB text format for this annotation for version above."
+ }
+ },
+ "type": "object"
+ },
+ "data": {
+ "description": "Data for this annotation.",
+ "type": "string"
+ },
+ "deleted": {
+ "description": "Indicates that this annotation is deleted.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Unique id of this volume annotation.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "books#volumeannotation",
+ "description": "Resource Type",
+ "type": "string"
+ },
+ "layerId": {
+ "description": "The Layer this annotation is for.",
+ "type": "string"
+ },
+ "pageIds": {
+ "description": "Pages the annotation spans.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "selectedText": {
+ "description": "Excerpt from the volume.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "URL to this resource.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).",
+ "format": "date-time",
+ "type": "string"
},
"volumeId": {
- "type": "string",
- "description": "The ids of the volumes to be returned. If not specified all that match the processingState are returned.",
- "repeated": true,
- "location": "query"
+ "description": "The Volume this annotation is for.",
+ "type": "string"
}
- },
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
+ },
+ "type": "object"
+ },
+ "Volumeannotations": {
+ "id": "Volumeannotations",
+ "properties": {
+ "items": {
+ "description": "A list of volume annotations.",
+ "items": {
+ "$ref": "Volumeannotation"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "books#volumeannotations",
+ "description": "Resource type",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The total number of volume annotations found.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "version": {
+ "description": "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).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Volumes": {
+ "id": "Volumes",
+ "properties": {
+ "items": {
+ "description": "A list of volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "books#volumes",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Volumeseriesinfo": {
+ "id": "Volumeseriesinfo",
+ "properties": {
+ "bookDisplayNumber": {
+ "description": "The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "books#volume_series_info",
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "shortSeriesBookTitle": {
+ "description": "Short book title in the context of the series.",
+ "type": "string"
+ },
+ "volumeSeries": {
+ "items": {
+ "properties": {
+ "issue": {
+ "description": "List of issues. Applicable only for Collection Edition and Omnibus.",
+ "items": {
+ "properties": {
+ "issueDisplayNumber": {
+ "type": "string"
+ },
+ "issueOrderNumber": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "orderNumber": {
+ "description": "The book order number in the series.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "seriesBookType": {
+ "description": "The book type in the context of series. Examples - Single Issue, Collection Edition, etc.",
+ "type": "string"
+ },
+ "seriesId": {
+ "description": "The series id.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
}
- }
- }
- }
-}
+ },
+ "servicePath": "books/v1/",
+ "title": "Books API",
+ "version": "v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/calendar/v3/calendar-api.json b/vendor/google.golang.org/api/calendar/v3/calendar-api.json
index 0203c781f..1240c04c4 100644
--- a/vendor/google.golang.org/api/calendar/v3/calendar-api.json
+++ b/vendor/google.golang.org/api/calendar/v3/calendar-api.json
@@ -1,2867 +1,2893 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/BXRSlYDfsDJfIj56UYVQoal0GSY\"",
- "discoveryVersion": "v1",
- "id": "calendar:v3",
- "name": "calendar",
- "version": "v3",
- "revision": "20180107",
- "title": "Calendar API",
- "description": "Manipulates events and other calendar data.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/calendar-16.png",
- "x32": "http://www.google.com/images/icons/product/calendar-32.png"
- },
- "documentationLink": "https://developers.google.com/google-apps/calendar/firstapp",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/calendar/v3/",
- "basePath": "/calendar/v3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "calendar/v3/",
- "batchPath": "batch/calendar/v3",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/calendar": {
- "description": "Manage your calendars"
- },
- "https://www.googleapis.com/auth/calendar.readonly": {
- "description": "View your calendars"
- }
- }
- }
- },
- "schemas": {
- "Acl": {
- "id": "Acl",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the collection."
- },
- "items": {
- "type": "array",
- "description": "List of rules on the access control list.",
- "items": {
- "$ref": "AclRule"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection (\"calendar#acl\").",
- "default": "calendar#acl"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
- },
- "nextSyncToken": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "AclRule": {
- "id": "AclRule",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Identifier of the ACL rule."
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#aclRule\").",
- "default": "calendar#aclRule"
- },
- "role": {
- "type": "string",
- "description": "The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"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.",
- "annotations": {
- "required": [
- "calendar.acl.insert"
- ]
- }
- },
- "scope": {
- "type": "object",
- "description": "The scope of the rule.",
- "properties": {
- "type": {
- "type": "string",
- "description": "The type of the scope. Possible values are: \n- \"default\" - The public scope. This is the default value. \n- \"user\" - Limits the scope to a single user. \n- \"group\" - Limits the scope to a group. \n- \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not.",
- "annotations": {
- "required": [
- "calendar.acl.insert"
- ]
- }
- },
- "value": {
- "type": "string",
- "description": "The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\"."
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/calendar": {
+ "description": "Manage your calendars"
+ },
+ "https://www.googleapis.com/auth/calendar.readonly": {
+ "description": "View your calendars"
+ }
}
- },
- "annotations": {
- "required": [
- "calendar.acl.insert"
- ]
- }
}
- }
},
- "Calendar": {
- "id": "Calendar",
- "type": "object",
- "properties": {
- "conferenceProperties": {
- "$ref": "ConferenceProperties",
- "description": "Conferencing properties for this calendar, for example what types of conferences are allowed."
- },
- "description": {
- "type": "string",
- "description": "Description of the calendar. Optional."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Identifier of the calendar. To retrieve IDs call the calendarList.list() method."
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#calendar\").",
- "default": "calendar#calendar"
- },
- "location": {
- "type": "string",
- "description": "Geographic location of the calendar as free-form text. Optional."
- },
- "summary": {
- "type": "string",
- "description": "Title of the calendar.",
- "annotations": {
- "required": [
- "calendar.calendars.insert"
- ]
- }
- },
- "timeZone": {
- "type": "string",
- "description": "The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional."
- }
- }
+ "basePath": "/calendar/v3/",
+ "baseUrl": "https://www.googleapis.com/calendar/v3/",
+ "batchPath": "batch/calendar/v3",
+ "description": "Manipulates events and other calendar data.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/google-apps/calendar/firstapp",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/kSq0jkvZ-MPIEPJItiswQ2txlEk\"",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/calendar-16.png",
+ "x32": "http://www.google.com/images/icons/product/calendar-32.png"
},
- "CalendarList": {
- "id": "CalendarList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the collection."
- },
- "items": {
- "type": "array",
- "description": "Calendars that are present on the user's calendar list.",
- "items": {
- "$ref": "CalendarListEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection (\"calendar#calendarList\").",
- "default": "calendar#calendarList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
- },
- "nextSyncToken": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "CalendarListEntry": {
- "id": "CalendarListEntry",
- "type": "object",
- "properties": {
- "accessRole": {
- "type": "string",
- "description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"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."
- },
- "backgroundColor": {
- "type": "string",
- "description": "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."
- },
- "colorId": {
- "type": "string",
- "description": "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."
- },
- "conferenceProperties": {
- "$ref": "ConferenceProperties",
- "description": "Conferencing properties for this calendar, for example what types of conferences are allowed."
- },
- "defaultReminders": {
- "type": "array",
- "description": "The default reminders that the authenticated user has for this calendar.",
- "items": {
- "$ref": "EventReminder"
- }
- },
- "deleted": {
- "type": "boolean",
- "description": "Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.",
- "default": "false"
- },
- "description": {
- "type": "string",
- "description": "Description of the calendar. Optional. Read-only."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "foregroundColor": {
- "type": "string",
- "description": "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."
- },
- "hidden": {
- "type": "boolean",
- "description": "Whether the calendar has been hidden from the list. Optional. The default is False.",
- "default": "false"
- },
- "id": {
- "type": "string",
- "description": "Identifier of the calendar.",
- "annotations": {
- "required": [
- "calendar.calendarList.insert"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#calendarListEntry\").",
- "default": "calendar#calendarListEntry"
- },
- "location": {
- "type": "string",
- "description": "Geographic location of the calendar as free-form text. Optional. Read-only."
- },
- "notificationSettings": {
- "type": "object",
- "description": "The notifications that the authenticated user is receiving for this calendar.",
- "properties": {
- "notifications": {
- "type": "array",
- "description": "The list of notifications set for this calendar.",
- "items": {
- "$ref": "CalendarNotification"
- }
- }
- }
- },
- "primary": {
- "type": "boolean",
- "description": "Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.",
- "default": "false"
- },
- "selected": {
- "type": "boolean",
- "description": "Whether the calendar content shows up in the calendar UI. Optional. The default is False.",
- "default": "false"
- },
- "summary": {
- "type": "string",
- "description": "Title of the calendar. Read-only."
- },
- "summaryOverride": {
- "type": "string",
- "description": "The summary that the authenticated user has set for this calendar. Optional."
- },
- "timeZone": {
- "type": "string",
- "description": "The time zone of the calendar. Optional. Read-only."
- }
- }
- },
- "CalendarNotification": {
- "id": "CalendarNotification",
- "type": "object",
- "properties": {
- "method": {
- "type": "string",
- "description": "The method used to deliver the notification. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"sms\" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for G Suite customers.",
- "annotations": {
- "required": [
- "calendar.calendarList.insert",
- "calendar.calendarList.update"
- ]
- }
- },
- "type": {
- "type": "string",
- "description": "The type of notification. Possible values are: \n- \"eventCreation\" - Notification sent when a new event is put on the calendar. \n- \"eventChange\" - Notification sent when an event is changed. \n- \"eventCancellation\" - Notification sent when an event is cancelled. \n- \"eventResponse\" - Notification sent when an event is changed. \n- \"agenda\" - An agenda with the events of the day (sent out in the morning).",
- "annotations": {
- "required": [
- "calendar.calendarList.insert",
- "calendar.calendarList.update"
- ]
- }
- }
- }
- },
- "Channel": {
- "id": "Channel",
- "type": "object",
- "properties": {
- "address": {
- "type": "string",
- "description": "The address where notifications are delivered for this channel."
- },
- "expiration": {
- "type": "string",
- "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "A UUID or similar unique string that identifies this channel."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
- "default": "api#channel"
- },
- "params": {
- "type": "object",
- "description": "Additional parameters controlling delivery channel behavior. Optional.",
- "additionalProperties": {
- "type": "string",
- "description": "Declares a new parameter by name."
- }
- },
- "payload": {
- "type": "boolean",
- "description": "A Boolean value to indicate whether payload is wanted. Optional."
- },
- "resourceId": {
- "type": "string",
- "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions."
- },
- "resourceUri": {
- "type": "string",
- "description": "A version-specific identifier for the watched resource."
- },
- "token": {
- "type": "string",
- "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional."
- },
- "type": {
- "type": "string",
- "description": "The type of delivery mechanism used for this channel."
- }
- }
- },
- "ColorDefinition": {
- "id": "ColorDefinition",
- "type": "object",
- "properties": {
- "background": {
- "type": "string",
- "description": "The background color associated with this color definition."
- },
- "foreground": {
- "type": "string",
- "description": "The foreground color that can be used to write on top of a background with 'background' color."
- }
- }
- },
- "Colors": {
- "id": "Colors",
- "type": "object",
- "properties": {
- "calendar": {
- "type": "object",
- "description": "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.",
- "additionalProperties": {
- "$ref": "ColorDefinition",
- "description": "A calendar color defintion."
- }
- },
- "event": {
- "type": "object",
- "description": "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.",
- "additionalProperties": {
- "$ref": "ColorDefinition",
- "description": "An event color definition."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#colors\").",
- "default": "calendar#colors"
- },
- "updated": {
- "type": "string",
- "description": "Last modification time of the color palette (as a RFC3339 timestamp). Read-only.",
- "format": "date-time"
- }
- }
- },
- "ConferenceData": {
- "id": "ConferenceData",
- "type": "object",
- "properties": {
- "conferenceId": {
- "type": "string",
- "description": "The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nValues for solution types: \n- \"eventHangout\": unset.\n- \"eventNamedHangout\": the name of the Hangout.\n- \"hangoutsMeet\": the 10-letter meeting code, for example \"aaa-bbbb-ccc\". Optional."
- },
- "conferenceSolution": {
- "$ref": "ConferenceSolution",
- "description": "The conference solution, such as Hangouts or Hangouts Meet.\nUnset for a conference with a failed create request.\nEither conferenceSolution and at least one entryPoint, or createRequest is required."
- },
- "createRequest": {
- "$ref": "CreateConferenceRequest",
- "description": "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.\nEither conferenceSolution and at least one entryPoint, or createRequest is required."
- },
- "entryPoints": {
- "type": "array",
- "description": "Information about individual conference entry points, such as URLs or phone numbers.\nAll of them must belong to the same conference.\nEither conferenceSolution and at least one entryPoint, or createRequest is required.",
- "items": {
- "$ref": "EntryPoint"
- }
- },
- "notes": {
- "type": "string",
- "description": "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."
- },
- "signature": {
- "type": "string",
- "description": "The signature of the conference data.\nGenereated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.\nUnset for a conference with a failed create request.\nOptional for a conference with a pending create request."
- }
- }
- },
- "ConferenceProperties": {
- "id": "ConferenceProperties",
- "type": "object",
- "properties": {
- "allowedConferenceSolutionTypes": {
- "type": "array",
- "description": "The types of conference solutions that are supported for this calendar.\nThe possible values are: \n- \"eventHangout\" \n- \"eventNamedHangout\" \n- \"hangoutsMeet\" Optional.",
- "items": {
+ "id": "calendar:v3",
+ "kind": "discovery#restDescription",
+ "name": "calendar",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
- }
- }
- },
- "ConferenceRequestStatus": {
- "id": "ConferenceRequestStatus",
- "type": "object",
- "properties": {
- "statusCode": {
- "type": "string",
- "description": "The current status of the conference create request. Read-only.\nThe possible values are: \n- \"pending\": the conference create request is still being processed.\n- \"success\": the conference create request succeeded, the entry points are populated.\n- \"failure\": the conference create request failed, there are no entry points."
- }
- }
- },
- "ConferenceSolution": {
- "id": "ConferenceSolution",
- "type": "object",
- "properties": {
- "iconUri": {
- "type": "string",
- "description": "The user-visible icon for this solution."
},
"key": {
- "$ref": "ConferenceSolutionKey",
- "description": "The key which can uniquely identify the conference solution for this event."
- },
- "name": {
- "type": "string",
- "description": "The user-visible name of this solution. Not localized."
- }
- }
- },
- "ConferenceSolutionKey": {
- "id": "ConferenceSolutionKey",
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (http://hangouts.google.com)\n- \"eventNamedHangout\" for classic Hangouts for G Suite users (http://hangouts.google.com)\n- \"hangoutsMeet\" for Hangouts Meet (http://meet.google.com)"
- }
- }
- },
- "CreateConferenceRequest": {
- "id": "CreateConferenceRequest",
- "type": "object",
- "properties": {
- "conferenceSolutionKey": {
- "$ref": "ConferenceSolutionKey",
- "description": "The conference solution, such as Hangouts or Hangouts Meet."
- },
- "requestId": {
- "type": "string",
- "description": "The client-generated unique ID for this request.\nClients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored."
- },
- "status": {
- "$ref": "ConferenceRequestStatus",
- "description": "The status of the conference create request."
- }
- }
- },
- "EntryPoint": {
- "id": "EntryPoint",
- "type": "object",
- "properties": {
- "accessCode": {
- "type": "string",
- "description": "The access code to access the conference. The maximum length is 128 characters.\nWhen 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.\nOptional."
- },
- "entryPointType": {
- "type": "string",
- "description": "The type of the conference entry point.\nPossible values are: \n- \"video\" - joining a conference over HTTP. A conference can have zero or one video entry point.\n- \"phone\" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.\n- \"sip\" - joining a conference over SIP. A conference can have zero or one sip entry point.\n- \"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."
- },
- "label": {
- "type": "string",
- "description": "The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.\nExamples: \n- for video: meet.google.com/aaa-bbbb-ccc\n- for phone: +1 123 268 2601\n- for sip: 12345678@altostrat.com\n- for more: should not be filled \nOptional."
- },
- "meetingCode": {
- "type": "string",
- "description": "The meeting code to access the conference. The maximum length is 128 characters.\nWhen 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.\nOptional."
- },
- "passcode": {
- "type": "string",
- "description": "The passcode to access the conference. The maximum length is 128 characters.\nWhen 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."
- },
- "password": {
- "type": "string",
- "description": "The password to access the conference. The maximum length is 128 characters.\nWhen 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.\nOptional."
- },
- "pin": {
- "type": "string",
- "description": "The PIN to access the conference. The maximum length is 128 characters.\nWhen 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.\nOptional."
- },
- "uri": {
- "type": "string",
- "description": "The URI of the entry point. The maximum length is 1300 characters.\nFormat: \n- for video, http: or https: schema is required.\n- for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).\n- for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.\n- for more, http: or https: schema is required."
- }
- }
- },
- "Error": {
- "id": "Error",
- "type": "object",
- "properties": {
- "domain": {
- "type": "string",
- "description": "Domain, or broad category, of the error."
- },
- "reason": {
- "type": "string",
- "description": "Specific reason for the error. Some of the possible values are: \n- \"groupTooBig\" - The group of users requested is too large for a single query. \n- \"tooManyCalendarsRequested\" - The number of calendars requested is too large for a single query. \n- \"notFound\" - The requested resource was not found. \n- \"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."
- }
- }
- },
- "Event": {
- "id": "Event",
- "type": "object",
- "properties": {
- "anyoneCanAddSelf": {
- "type": "boolean",
- "description": "Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.",
- "default": "false"
- },
- "attachments": {
- "type": "array",
- "description": "File attachments for the event. Currently only Google Drive attachments are supported.\nIn order to modify attachments the supportsAttachments request parameter should be set to true.\nThere can be at most 25 attachments per event,",
- "items": {
- "$ref": "EventAttachment"
- }
- },
- "attendees": {
- "type": "array",
- "description": "The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.",
- "items": {
- "$ref": "EventAttendee"
- }
- },
- "attendeesOmitted": {
- "type": "boolean",
- "description": "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.",
- "default": "false"
- },
- "colorId": {
- "type": "string",
- "description": "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."
- },
- "conferenceData": {
- "$ref": "ConferenceData",
- "description": "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."
- },
- "created": {
- "type": "string",
- "description": "Creation time of the event (as a RFC3339 timestamp). Read-only.",
- "format": "date-time"
- },
- "creator": {
- "type": "object",
- "description": "The creator of the event. Read-only.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The creator's name, if available."
- },
- "email": {
- "type": "string",
- "description": "The creator's email address, if available."
- },
- "id": {
- "type": "string",
- "description": "The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API"
- },
- "self": {
- "type": "boolean",
- "description": "Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.",
- "default": "false"
- }
- }
- },
- "description": {
- "type": "string",
- "description": "Description of the event. Optional."
- },
- "end": {
- "$ref": "EventDateTime",
- "description": "The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.",
- "annotations": {
- "required": [
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "endTimeUnspecified": {
- "type": "boolean",
- "description": "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.",
- "default": "false"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "extendedProperties": {
- "type": "object",
- "description": "Extended properties of the event.",
- "properties": {
- "private": {
- "type": "object",
- "description": "Properties that are private to the copy of the event that appears on this calendar.",
- "additionalProperties": {
- "type": "string",
- "description": "The name of the private property and the corresponding value."
- }
- },
- "shared": {
- "type": "object",
- "description": "Properties that are shared between copies of the event on other attendees' calendars.",
- "additionalProperties": {
- "type": "string",
- "description": "The name of the shared property and the corresponding value."
- }
- }
- }
- },
- "gadget": {
- "type": "object",
- "description": "A gadget that extends this event.",
- "properties": {
- "display": {
- "type": "string",
- "description": "The gadget's display mode. Optional. Possible values are: \n- \"icon\" - The gadget displays next to the event's title in the calendar view. \n- \"chip\" - The gadget displays when the event is clicked."
- },
- "height": {
- "type": "integer",
- "description": "The gadget's height in pixels. The height must be an integer greater than 0. Optional.",
- "format": "int32"
- },
- "iconLink": {
- "type": "string",
- "description": "The gadget's icon URL. The URL scheme must be HTTPS."
- },
- "link": {
- "type": "string",
- "description": "The gadget's URL. The URL scheme must be HTTPS."
- },
- "preferences": {
- "type": "object",
- "description": "Preferences.",
- "additionalProperties": {
- "type": "string",
- "description": "The preference name and corresponding value."
- }
- },
- "title": {
- "type": "string",
- "description": "The gadget's title."
- },
- "type": {
- "type": "string",
- "description": "The gadget's type."
- },
- "width": {
- "type": "integer",
- "description": "The gadget's width in pixels. The width must be an integer greater than 0. Optional.",
- "format": "int32"
- }
- }
- },
- "guestsCanInviteOthers": {
- "type": "boolean",
- "description": "Whether attendees other than the organizer can invite others to the event. Optional. The default is True.",
- "default": "true"
- },
- "guestsCanModify": {
- "type": "boolean",
- "description": "Whether attendees other than the organizer can modify the event. Optional. The default is False.",
- "default": "false"
- },
- "guestsCanSeeOtherGuests": {
- "type": "boolean",
- "description": "Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.",
- "default": "true"
- },
- "hangoutLink": {
- "type": "string",
- "description": "An absolute link to the Google+ hangout associated with this event. Read-only."
- },
- "htmlLink": {
- "type": "string",
- "description": "An absolute link to this event in the Google Calendar Web UI. Read-only."
- },
- "iCalUID": {
- "type": "string",
- "description": "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.\nNote 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.",
- "annotations": {
- "required": [
- "calendar.events.import"
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: \n- 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 \n- the length of the ID must be between 5 and 1024 characters \n- 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.\nIf you do not specify an ID, it will be automatically generated by the server.\nNote 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."
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#event\").",
- "default": "calendar#event"
- },
- "location": {
- "type": "string",
- "description": "Geographic location of the event as free-form text. Optional."
- },
- "locked": {
- "type": "boolean",
- "description": "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.",
- "default": "false"
- },
- "organizer": {
- "type": "object",
- "description": "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.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The organizer's name, if available."
- },
- "email": {
- "type": "string",
- "description": "The organizer's email address, if available. It must be a valid email address as per RFC5322."
- },
- "id": {
- "type": "string",
- "description": "The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API"
- },
- "self": {
- "type": "boolean",
- "description": "Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.",
- "default": "false"
- }
- }
- },
- "originalStartTime": {
- "$ref": "EventDateTime",
- "description": "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. Immutable."
- },
- "privateCopy": {
- "type": "boolean",
- "description": "Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.",
- "default": "false"
- },
- "recurrence": {
- "type": "array",
- "description": "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.",
- "items": {
+ "description": "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.",
+ "location": "query",
"type": "string"
- }
},
- "recurringEventId": {
- "type": "string",
- "description": "For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable."
- },
- "reminders": {
- "type": "object",
- "description": "Information about the event's reminders for the authenticated user.",
- "properties": {
- "overrides": {
- "type": "array",
- "description": "If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.",
- "items": {
- "$ref": "EventReminder"
- }
- },
- "useDefault": {
- "type": "boolean",
- "description": "Whether the default reminders of the calendar apply to the event."
- }
- }
- },
- "sequence": {
- "type": "integer",
- "description": "Sequence number as per iCalendar.",
- "format": "int32"
- },
- "source": {
- "type": "object",
- "description": "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.",
- "properties": {
- "title": {
- "type": "string",
- "description": "Title of the source; for example a title of a web page or an email subject."
- },
- "url": {
- "type": "string",
- "description": "URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS."
- }
- }
- },
- "start": {
- "$ref": "EventDateTime",
- "description": "The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.",
- "annotations": {
- "required": [
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "status": {
- "type": "string",
- "description": "Status of the event. Optional. Possible values are: \n- \"confirmed\" - The event is confirmed. This is the default status. \n- \"tentative\" - The event is tentatively confirmed. \n- \"cancelled\" - The event is cancelled."
- },
- "summary": {
- "type": "string",
- "description": "Title of the event."
- },
- "transparency": {
- "type": "string",
- "description": "Whether the event blocks time on the calendar. Optional. Possible values are: \n- \"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. \n- \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.",
- "default": "opaque"
- },
- "updated": {
- "type": "string",
- "description": "Last modification time of the event (as a RFC3339 timestamp). Read-only.",
- "format": "date-time"
- },
- "visibility": {
- "type": "string",
- "description": "Visibility of the event. Optional. Possible values are: \n- \"default\" - Uses the default visibility for events on the calendar. This is the default value. \n- \"public\" - The event is public and event details are visible to all readers of the calendar. \n- \"private\" - The event is private and only event attendees may view event details. \n- \"confidential\" - The event is private. This value is provided for compatibility reasons.",
- "default": "default"
- }
- }
- },
- "EventAttachment": {
- "id": "EventAttachment",
- "type": "object",
- "properties": {
- "fileId": {
- "type": "string",
- "description": "ID of the attached file. Read-only.\nFor Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API."
- },
- "fileUrl": {
- "type": "string",
- "description": "URL link to the attachment.\nFor adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.",
- "annotations": {
- "required": [
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "iconLink": {
- "type": "string",
- "description": "URL link to the attachment's icon. Read-only."
- },
- "mimeType": {
- "type": "string",
- "description": "Internet media type (MIME type) of the attachment."
- },
- "title": {
- "type": "string",
- "description": "Attachment title."
- }
- }
- },
- "EventAttendee": {
- "id": "EventAttendee",
- "type": "object",
- "properties": {
- "additionalGuests": {
- "type": "integer",
- "description": "Number of additional guests. Optional. The default is 0.",
- "default": "0",
- "format": "int32"
- },
- "comment": {
- "type": "string",
- "description": "The attendee's response comment. Optional."
- },
- "displayName": {
- "type": "string",
- "description": "The attendee's name, if available. Optional."
- },
- "email": {
- "type": "string",
- "description": "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.",
- "annotations": {
- "required": [
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API"
- },
- "optional": {
- "type": "boolean",
- "description": "Whether this is an optional attendee. Optional. The default is False.",
- "default": "false"
- },
- "organizer": {
- "type": "boolean",
- "description": "Whether the attendee is the organizer of the event. Read-only. The default is False."
- },
- "resource": {
- "type": "boolean",
- "description": "Whether the attendee is a resource. Read-only. The default is False.",
- "default": "false"
- },
- "responseStatus": {
- "type": "string",
- "description": "The attendee's response status. Possible values are: \n- \"needsAction\" - The attendee has not responded to the invitation. \n- \"declined\" - The attendee has declined the invitation. \n- \"tentative\" - The attendee has tentatively accepted the invitation. \n- \"accepted\" - The attendee has accepted the invitation."
- },
- "self": {
- "type": "boolean",
- "description": "Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.",
- "default": "false"
- }
- }
- },
- "EventDateTime": {
- "id": "EventDateTime",
- "type": "object",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date, in the format \"yyyy-mm-dd\", if this is an all-day event.",
- "format": "date"
- },
- "dateTime": {
- "type": "string",
- "description": "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.",
- "format": "date-time"
- },
- "timeZone": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "EventReminder": {
- "id": "EventReminder",
- "type": "object",
- "properties": {
- "method": {
- "type": "string",
- "description": "The method used by this reminder. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"sms\" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. \n- \"popup\" - Reminders are sent via a UI popup.",
- "annotations": {
- "required": [
- "calendar.calendarList.insert",
- "calendar.calendarList.update",
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "minutes": {
- "type": "integer",
- "description": "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).",
- "format": "int32",
- "annotations": {
- "required": [
- "calendar.calendarList.insert",
- "calendar.calendarList.update",
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- }
- }
- },
- "Events": {
- "id": "Events",
- "type": "object",
- "properties": {
- "accessRole": {
- "type": "string",
- "description": "The user's access role for this calendar. Read-only. Possible values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\" - The user has read access to free/busy information. \n- \"reader\" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"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. \n- \"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."
- },
- "defaultReminders": {
- "type": "array",
- "description": "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).",
- "items": {
- "$ref": "EventReminder"
- }
- },
- "description": {
- "type": "string",
- "description": "Description of the calendar. Read-only."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the collection."
- },
- "items": {
- "type": "array",
- "description": "List of events on the calendar.",
- "items": {
- "$ref": "Event"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection (\"calendar#events\").",
- "default": "calendar#events"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
- },
- "nextSyncToken": {
- "type": "string",
- "description": "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."
- },
- "summary": {
- "type": "string",
- "description": "Title of the calendar. Read-only."
- },
- "timeZone": {
- "type": "string",
- "description": "The time zone of the calendar. Read-only."
- },
- "updated": {
- "type": "string",
- "description": "Last modification time of the calendar (as a RFC3339 timestamp). Read-only.",
- "format": "date-time"
- }
- }
- },
- "FreeBusyCalendar": {
- "id": "FreeBusyCalendar",
- "type": "object",
- "properties": {
- "busy": {
- "type": "array",
- "description": "List of time ranges during which this calendar should be regarded as busy.",
- "items": {
- "$ref": "TimePeriod"
- }
- },
- "errors": {
- "type": "array",
- "description": "Optional error(s) (if computation for the calendar failed).",
- "items": {
- "$ref": "Error"
- }
- }
- }
- },
- "FreeBusyGroup": {
- "id": "FreeBusyGroup",
- "type": "object",
- "properties": {
- "calendars": {
- "type": "array",
- "description": "List of calendars' identifiers within a group.",
- "items": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
"type": "string"
- }
},
- "errors": {
- "type": "array",
- "description": "Optional error(s) (if computation for the group failed).",
- "items": {
- "$ref": "Error"
- }
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
+ "type": "string"
+ },
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
+ "type": "string"
}
- }
},
- "FreeBusyRequest": {
- "id": "FreeBusyRequest",
- "type": "object",
- "properties": {
- "calendarExpansionMax": {
- "type": "integer",
- "description": "Maximal number of calendars for which FreeBusy information is to be provided. Optional.",
- "format": "int32"
+ "protocol": "rest",
+ "resources": {
+ "acl": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an access control rule.",
+ "httpMethod": "DELETE",
+ "id": "calendar.acl.delete",
+ "parameterOrder": [
+ "calendarId",
+ "ruleId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ruleId": {
+ "description": "ACL rule identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/acl/{ruleId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "get": {
+ "description": "Returns an access control rule.",
+ "httpMethod": "GET",
+ "id": "calendar.acl.get",
+ "parameterOrder": [
+ "calendarId",
+ "ruleId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ruleId": {
+ "description": "ACL rule identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/acl/{ruleId}",
+ "response": {
+ "$ref": "AclRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Creates an access control rule.",
+ "httpMethod": "POST",
+ "id": "calendar.acl.insert",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sendNotifications": {
+ "description": "Whether to send notifications about the calendar sharing change. Optional. The default is True.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "calendars/{calendarId}/acl",
+ "request": {
+ "$ref": "AclRule"
+ },
+ "response": {
+ "$ref": "AclRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "list": {
+ "description": "Returns the rules in the access control list for the calendar.",
+ "httpMethod": "GET",
+ "id": "calendar.acl.list",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token specifying which result page to return. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "syncToken": {
+ "description": "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.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/acl",
+ "response": {
+ "$ref": "Acl"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ],
+ "supportsSubscription": true
+ },
+ "patch": {
+ "description": "Updates an access control rule. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "calendar.acl.patch",
+ "parameterOrder": [
+ "calendarId",
+ "ruleId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ruleId": {
+ "description": "ACL rule identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sendNotifications": {
+ "description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "calendars/{calendarId}/acl/{ruleId}",
+ "request": {
+ "$ref": "AclRule"
+ },
+ "response": {
+ "$ref": "AclRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "update": {
+ "description": "Updates an access control rule.",
+ "httpMethod": "PUT",
+ "id": "calendar.acl.update",
+ "parameterOrder": [
+ "calendarId",
+ "ruleId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "ruleId": {
+ "description": "ACL rule identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sendNotifications": {
+ "description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "calendars/{calendarId}/acl/{ruleId}",
+ "request": {
+ "$ref": "AclRule"
+ },
+ "response": {
+ "$ref": "AclRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "watch": {
+ "description": "Watch for changes to ACL resources.",
+ "httpMethod": "POST",
+ "id": "calendar.acl.watch",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token specifying which result page to return. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "syncToken": {
+ "description": "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.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/acl/watch",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "response": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ],
+ "supportsSubscription": true
+ }
+ }
},
- "groupExpansionMax": {
- "type": "integer",
- "description": "Maximal number of calendar identifiers to be provided for a single group. Optional. An error will be returned for a group with more members than this value.",
- "format": "int32"
+ "calendarList": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an entry on the user's calendar list.",
+ "httpMethod": "DELETE",
+ "id": "calendar.calendarList.delete",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/me/calendarList/{calendarId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "get": {
+ "description": "Returns an entry on the user's calendar list.",
+ "httpMethod": "GET",
+ "id": "calendar.calendarList.get",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/me/calendarList/{calendarId}",
+ "response": {
+ "$ref": "CalendarListEntry"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Adds an entry to the user's calendar list.",
+ "httpMethod": "POST",
+ "id": "calendar.calendarList.insert",
+ "parameters": {
+ "colorRgbFormat": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "users/me/calendarList",
+ "request": {
+ "$ref": "CalendarListEntry"
+ },
+ "response": {
+ "$ref": "CalendarListEntry"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "list": {
+ "description": "Returns entries on the user's calendar list.",
+ "httpMethod": "GET",
+ "id": "calendar.calendarList.list",
+ "parameters": {
+ "maxResults": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "minAccessRole": {
+ "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
+ "enum": [
+ "freeBusyReader",
+ "owner",
+ "reader",
+ "writer"
+ ],
+ "enumDescriptions": [
+ "The user can read free/busy information.",
+ "The user can read and modify events and access control lists.",
+ "The user can read events that are not private.",
+ "The user can read and modify events."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token specifying which result page to return. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "showHidden": {
+ "description": "Whether to show hidden entries. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "syncToken": {
+ "description": "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.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "users/me/calendarList",
+ "response": {
+ "$ref": "CalendarList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ],
+ "supportsSubscription": true
+ },
+ "patch": {
+ "description": "Updates an entry on the user's calendar list. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "calendar.calendarList.patch",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "colorRgbFormat": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "users/me/calendarList/{calendarId}",
+ "request": {
+ "$ref": "CalendarListEntry"
+ },
+ "response": {
+ "$ref": "CalendarListEntry"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "update": {
+ "description": "Updates an entry on the user's calendar list.",
+ "httpMethod": "PUT",
+ "id": "calendar.calendarList.update",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "colorRgbFormat": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "users/me/calendarList/{calendarId}",
+ "request": {
+ "$ref": "CalendarListEntry"
+ },
+ "response": {
+ "$ref": "CalendarListEntry"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "watch": {
+ "description": "Watch for changes to CalendarList resources.",
+ "httpMethod": "POST",
+ "id": "calendar.calendarList.watch",
+ "parameters": {
+ "maxResults": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "minAccessRole": {
+ "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
+ "enum": [
+ "freeBusyReader",
+ "owner",
+ "reader",
+ "writer"
+ ],
+ "enumDescriptions": [
+ "The user can read free/busy information.",
+ "The user can read and modify events and access control lists.",
+ "The user can read events that are not private.",
+ "The user can read and modify events."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token specifying which result page to return. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "showHidden": {
+ "description": "Whether to show hidden entries. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "syncToken": {
+ "description": "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.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "users/me/calendarList/watch",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "response": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ],
+ "supportsSubscription": true
+ }
+ }
},
- "items": {
- "type": "array",
- "description": "List of calendars and/or groups to query.",
- "items": {
- "$ref": "FreeBusyRequestItem"
- }
- },
- "timeMax": {
- "type": "string",
- "description": "The end of the interval for the query.",
- "format": "date-time"
- },
- "timeMin": {
- "type": "string",
- "description": "The start of the interval for the query.",
- "format": "date-time"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is UTC.",
- "default": "UTC"
- }
- }
- },
- "FreeBusyRequestItem": {
- "id": "FreeBusyRequestItem",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of a calendar or a group."
- }
- }
- },
- "FreeBusyResponse": {
- "id": "FreeBusyResponse",
- "type": "object",
- "properties": {
"calendars": {
- "type": "object",
- "description": "List of free/busy information for calendars.",
- "additionalProperties": {
- "$ref": "FreeBusyCalendar",
- "description": "Free/busy expansions for a single calendar."
- }
+ "methods": {
+ "clear": {
+ "description": "Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.",
+ "httpMethod": "POST",
+ "id": "calendar.calendars.clear",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/clear",
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.",
+ "httpMethod": "DELETE",
+ "id": "calendar.calendars.delete",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "get": {
+ "description": "Returns metadata for a calendar.",
+ "httpMethod": "GET",
+ "id": "calendar.calendars.get",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}",
+ "response": {
+ "$ref": "Calendar"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Creates a secondary calendar.",
+ "httpMethod": "POST",
+ "id": "calendar.calendars.insert",
+ "path": "calendars",
+ "request": {
+ "$ref": "Calendar"
+ },
+ "response": {
+ "$ref": "Calendar"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "patch": {
+ "description": "Updates metadata for a calendar. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "calendar.calendars.patch",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}",
+ "request": {
+ "$ref": "Calendar"
+ },
+ "response": {
+ "$ref": "Calendar"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "update": {
+ "description": "Updates metadata for a calendar.",
+ "httpMethod": "PUT",
+ "id": "calendar.calendars.update",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}",
+ "request": {
+ "$ref": "Calendar"
+ },
+ "response": {
+ "$ref": "Calendar"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ }
+ }
},
- "groups": {
- "type": "object",
- "description": "Expansion of groups.",
- "additionalProperties": {
- "$ref": "FreeBusyGroup",
- "description": "List of calendars that are members of this group."
- }
+ "channels": {
+ "methods": {
+ "stop": {
+ "description": "Stop watching resources through this channel",
+ "httpMethod": "POST",
+ "id": "calendar.channels.stop",
+ "path": "channels/stop",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ]
+ }
+ }
},
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#freeBusy\").",
- "default": "calendar#freeBusy"
+ "colors": {
+ "methods": {
+ "get": {
+ "description": "Returns the color definitions for calendars and events.",
+ "httpMethod": "GET",
+ "id": "calendar.colors.get",
+ "path": "colors",
+ "response": {
+ "$ref": "Colors"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ]
+ }
+ }
},
- "timeMax": {
- "type": "string",
- "description": "The end of the interval.",
- "format": "date-time"
+ "events": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an event.",
+ "httpMethod": "DELETE",
+ "id": "calendar.events.delete",
+ "parameterOrder": [
+ "calendarId",
+ "eventId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "eventId": {
+ "description": "Event identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sendNotifications": {
+ "description": "Whether to send notifications about the deletion of the event. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "calendars/{calendarId}/events/{eventId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "get": {
+ "description": "Returns an event.",
+ "httpMethod": "GET",
+ "id": "calendar.events.get",
+ "parameterOrder": [
+ "calendarId",
+ "eventId"
+ ],
+ "parameters": {
+ "alwaysIncludeEmail": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "eventId": {
+ "description": "Event identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxAttendees": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "timeZone": {
+ "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/events/{eventId}",
+ "response": {
+ "$ref": "Event"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ]
+ },
+ "import": {
+ "description": "Imports an event. This operation is used to add a private copy of an existing event to a calendar.",
+ "httpMethod": "POST",
+ "id": "calendar.events.import",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "conferenceDataVersion": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "supportsAttachments": {
+ "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "calendars/{calendarId}/events/import",
+ "request": {
+ "$ref": "Event"
+ },
+ "response": {
+ "$ref": "Event"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "insert": {
+ "description": "Creates an event.",
+ "httpMethod": "POST",
+ "id": "calendar.events.insert",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "conferenceDataVersion": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "maxAttendees": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "sendNotifications": {
+ "description": "Whether to send notifications about the creation of the new event. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "supportsAttachments": {
+ "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "calendars/{calendarId}/events",
+ "request": {
+ "$ref": "Event"
+ },
+ "response": {
+ "$ref": "Event"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "instances": {
+ "description": "Returns instances of the specified recurring event.",
+ "httpMethod": "GET",
+ "id": "calendar.events.instances",
+ "parameterOrder": [
+ "calendarId",
+ "eventId"
+ ],
+ "parameters": {
+ "alwaysIncludeEmail": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "eventId": {
+ "description": "Recurring event identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxAttendees": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "maxResults": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "originalStart": {
+ "description": "The original start time of the instance in the result. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token specifying which result page to return. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "timeMax": {
+ "description": "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.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "timeMin": {
+ "description": "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.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/events/{eventId}/instances",
+ "response": {
+ "$ref": "Events"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ],
+ "supportsSubscription": true
+ },
+ "list": {
+ "description": "Returns events on the specified calendar.",
+ "httpMethod": "GET",
+ "id": "calendar.events.list",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "alwaysIncludeEmail": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "iCalUID": {
+ "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxAttendees": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "maxResults": {
+ "default": "250",
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
+ "enum": [
+ "startTime",
+ "updated"
+ ],
+ "enumDescriptions": [
+ "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
+ "Order by last modification time (ascending)."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token specifying which result page to return. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "privateExtendedProperty": {
+ "description": "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.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "q": {
+ "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "sharedExtendedProperty": {
+ "description": "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.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "showHiddenInvitations": {
+ "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "singleEvents": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "syncToken": {
+ "description": "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.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
+ "location": "query",
+ "type": "string"
+ },
+ "timeMax": {
+ "description": "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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMin is set, timeMax must be greater than timeMin.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "timeMin": {
+ "description": "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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMax is set, timeMin must be smaller than timeMax.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
+ "location": "query",
+ "type": "string"
+ },
+ "updatedMin": {
+ "description": "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.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/events",
+ "response": {
+ "$ref": "Events"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ],
+ "supportsSubscription": true
+ },
+ "move": {
+ "description": "Moves an event to another calendar, i.e. changes an event's organizer.",
+ "httpMethod": "POST",
+ "id": "calendar.events.move",
+ "parameterOrder": [
+ "calendarId",
+ "eventId",
+ "destination"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "Calendar identifier of the source calendar where the event currently is on.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "destination": {
+ "description": "Calendar identifier of the target calendar where the event is to be moved to.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "eventId": {
+ "description": "Event identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sendNotifications": {
+ "description": "Whether to send notifications about the change of the event's organizer. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "calendars/{calendarId}/events/{eventId}/move",
+ "response": {
+ "$ref": "Event"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "patch": {
+ "description": "Updates an event. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "calendar.events.patch",
+ "parameterOrder": [
+ "calendarId",
+ "eventId"
+ ],
+ "parameters": {
+ "alwaysIncludeEmail": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "conferenceDataVersion": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "eventId": {
+ "description": "Event identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxAttendees": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "sendNotifications": {
+ "description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "supportsAttachments": {
+ "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "calendars/{calendarId}/events/{eventId}",
+ "request": {
+ "$ref": "Event"
+ },
+ "response": {
+ "$ref": "Event"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "quickAdd": {
+ "description": "Creates an event based on a simple text string.",
+ "httpMethod": "POST",
+ "id": "calendar.events.quickAdd",
+ "parameterOrder": [
+ "calendarId",
+ "text"
+ ],
+ "parameters": {
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "sendNotifications": {
+ "description": "Whether to send notifications about the creation of the event. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "text": {
+ "description": "The text describing the event to be created.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/events/quickAdd",
+ "response": {
+ "$ref": "Event"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "update": {
+ "description": "Updates an event.",
+ "httpMethod": "PUT",
+ "id": "calendar.events.update",
+ "parameterOrder": [
+ "calendarId",
+ "eventId"
+ ],
+ "parameters": {
+ "alwaysIncludeEmail": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "conferenceDataVersion": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "maximum": "1",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "eventId": {
+ "description": "Event identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxAttendees": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "sendNotifications": {
+ "description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "supportsAttachments": {
+ "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "calendars/{calendarId}/events/{eventId}",
+ "request": {
+ "$ref": "Event"
+ },
+ "response": {
+ "$ref": "Event"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar"
+ ]
+ },
+ "watch": {
+ "description": "Watch for changes to Events resources.",
+ "httpMethod": "POST",
+ "id": "calendar.events.watch",
+ "parameterOrder": [
+ "calendarId"
+ ],
+ "parameters": {
+ "alwaysIncludeEmail": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "calendarId": {
+ "description": "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "iCalUID": {
+ "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxAttendees": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "maxResults": {
+ "default": "250",
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
+ "enum": [
+ "startTime",
+ "updated"
+ ],
+ "enumDescriptions": [
+ "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
+ "Order by last modification time (ascending)."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token specifying which result page to return. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "privateExtendedProperty": {
+ "description": "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.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "q": {
+ "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "sharedExtendedProperty": {
+ "description": "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.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "showHiddenInvitations": {
+ "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "singleEvents": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "syncToken": {
+ "description": "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.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
+ "location": "query",
+ "type": "string"
+ },
+ "timeMax": {
+ "description": "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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMin is set, timeMax must be greater than timeMin.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "timeMin": {
+ "description": "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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMax is set, timeMin must be smaller than timeMax.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
+ "location": "query",
+ "type": "string"
+ },
+ "updatedMin": {
+ "description": "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.",
+ "format": "date-time",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "calendars/{calendarId}/events/watch",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "response": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ],
+ "supportsSubscription": true
+ }
+ }
},
- "timeMin": {
- "type": "string",
- "description": "The start of the interval.",
- "format": "date-time"
+ "freebusy": {
+ "methods": {
+ "query": {
+ "description": "Returns free/busy information for a set of calendars.",
+ "httpMethod": "POST",
+ "id": "calendar.freebusy.query",
+ "path": "freeBusy",
+ "request": {
+ "$ref": "FreeBusyRequest"
+ },
+ "response": {
+ "$ref": "FreeBusyResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ]
+ }
+ }
+ },
+ "settings": {
+ "methods": {
+ "get": {
+ "description": "Returns a single user setting.",
+ "httpMethod": "GET",
+ "id": "calendar.settings.get",
+ "parameterOrder": [
+ "setting"
+ ],
+ "parameters": {
+ "setting": {
+ "description": "The id of the user setting.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "users/me/settings/{setting}",
+ "response": {
+ "$ref": "Setting"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ]
+ },
+ "list": {
+ "description": "Returns all user settings for the authenticated user.",
+ "httpMethod": "GET",
+ "id": "calendar.settings.list",
+ "parameters": {
+ "maxResults": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token specifying which result page to return. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "syncToken": {
+ "description": "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.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "users/me/settings",
+ "response": {
+ "$ref": "Settings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ],
+ "supportsSubscription": true
+ },
+ "watch": {
+ "description": "Watch for changes to Settings resources.",
+ "httpMethod": "POST",
+ "id": "calendar.settings.watch",
+ "parameters": {
+ "maxResults": {
+ "description": "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.",
+ "format": "int32",
+ "location": "query",
+ "minimum": "1",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token specifying which result page to return. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "syncToken": {
+ "description": "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.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "users/me/settings/watch",
+ "request": {
+ "$ref": "Channel",
+ "parameterName": "resource"
+ },
+ "response": {
+ "$ref": "Channel"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/calendar",
+ "https://www.googleapis.com/auth/calendar.readonly"
+ ],
+ "supportsSubscription": true
+ }
+ }
}
- }
},
- "Setting": {
- "id": "Setting",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
+ "revision": "20180325",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "Acl": {
+ "id": "Acl",
+ "properties": {
+ "etag": {
+ "description": "ETag of the collection.",
+ "type": "string"
+ },
+ "items": {
+ "description": "List of rules on the access control list.",
+ "items": {
+ "$ref": "AclRule"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "calendar#acl",
+ "description": "Type of the collection (\"calendar#acl\").",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.",
+ "type": "string"
+ },
+ "nextSyncToken": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "id": {
- "type": "string",
- "description": "The id of the user setting."
+ "AclRule": {
+ "id": "AclRule",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the ACL rule.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "calendar#aclRule",
+ "description": "Type of the resource (\"calendar#aclRule\").",
+ "type": "string"
+ },
+ "role": {
+ "annotations": {
+ "required": [
+ "calendar.acl.insert"
+ ]
+ },
+ "description": "The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"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.",
+ "type": "string"
+ },
+ "scope": {
+ "annotations": {
+ "required": [
+ "calendar.acl.insert"
+ ]
+ },
+ "description": "The scope of the rule.",
+ "properties": {
+ "type": {
+ "annotations": {
+ "required": [
+ "calendar.acl.insert"
+ ]
+ },
+ "description": "The type of the scope. Possible values are: \n- \"default\" - The public scope. This is the default value. \n- \"user\" - Limits the scope to a single user. \n- \"group\" - Limits the scope to a group. \n- \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
},
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#setting\").",
- "default": "calendar#setting"
+ "Calendar": {
+ "id": "Calendar",
+ "properties": {
+ "conferenceProperties": {
+ "$ref": "ConferenceProperties",
+ "description": "Conferencing properties for this calendar, for example what types of conferences are allowed."
+ },
+ "description": {
+ "description": "Description of the calendar. Optional.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the calendar. To retrieve IDs call the calendarList.list() method.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "calendar#calendar",
+ "description": "Type of the resource (\"calendar#calendar\").",
+ "type": "string"
+ },
+ "location": {
+ "description": "Geographic location of the calendar as free-form text. Optional.",
+ "type": "string"
+ },
+ "summary": {
+ "annotations": {
+ "required": [
+ "calendar.calendars.insert"
+ ]
+ },
+ "description": "Title of the calendar.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "value": {
- "type": "string",
- "description": "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."
+ "CalendarList": {
+ "id": "CalendarList",
+ "properties": {
+ "etag": {
+ "description": "ETag of the collection.",
+ "type": "string"
+ },
+ "items": {
+ "description": "Calendars that are present on the user's calendar list.",
+ "items": {
+ "$ref": "CalendarListEntry"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "calendar#calendarList",
+ "description": "Type of the collection (\"calendar#calendarList\").",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.",
+ "type": "string"
+ },
+ "nextSyncToken": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CalendarListEntry": {
+ "id": "CalendarListEntry",
+ "properties": {
+ "accessRole": {
+ "description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"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.",
+ "type": "string"
+ },
+ "backgroundColor": {
+ "description": "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.",
+ "type": "string"
+ },
+ "colorId": {
+ "description": "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.",
+ "type": "string"
+ },
+ "conferenceProperties": {
+ "$ref": "ConferenceProperties",
+ "description": "Conferencing properties for this calendar, for example what types of conferences are allowed."
+ },
+ "defaultReminders": {
+ "description": "The default reminders that the authenticated user has for this calendar.",
+ "items": {
+ "$ref": "EventReminder"
+ },
+ "type": "array"
+ },
+ "deleted": {
+ "default": "false",
+ "description": "Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.",
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the calendar. Optional. Read-only.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "foregroundColor": {
+ "description": "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.",
+ "type": "string"
+ },
+ "hidden": {
+ "default": "false",
+ "description": "Whether the calendar has been hidden from the list. Optional. The default is False.",
+ "type": "boolean"
+ },
+ "id": {
+ "annotations": {
+ "required": [
+ "calendar.calendarList.insert"
+ ]
+ },
+ "description": "Identifier of the calendar.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "calendar#calendarListEntry",
+ "description": "Type of the resource (\"calendar#calendarListEntry\").",
+ "type": "string"
+ },
+ "location": {
+ "description": "Geographic location of the calendar as free-form text. Optional. Read-only.",
+ "type": "string"
+ },
+ "notificationSettings": {
+ "description": "The notifications that the authenticated user is receiving for this calendar.",
+ "properties": {
+ "notifications": {
+ "description": "The list of notifications set for this calendar.",
+ "items": {
+ "$ref": "CalendarNotification"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "primary": {
+ "default": "false",
+ "description": "Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.",
+ "type": "boolean"
+ },
+ "selected": {
+ "default": "false",
+ "description": "Whether the calendar content shows up in the calendar UI. Optional. The default is False.",
+ "type": "boolean"
+ },
+ "summary": {
+ "description": "Title of the calendar. Read-only.",
+ "type": "string"
+ },
+ "summaryOverride": {
+ "description": "The summary that the authenticated user has set for this calendar. Optional.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "The time zone of the calendar. Optional. Read-only.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CalendarNotification": {
+ "id": "CalendarNotification",
+ "properties": {
+ "method": {
+ "annotations": {
+ "required": [
+ "calendar.calendarList.insert",
+ "calendar.calendarList.update"
+ ]
+ },
+ "description": "The method used to deliver the notification. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"sms\" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for G Suite customers.",
+ "type": "string"
+ },
+ "type": {
+ "annotations": {
+ "required": [
+ "calendar.calendarList.insert",
+ "calendar.calendarList.update"
+ ]
+ },
+ "description": "The type of notification. Possible values are: \n- \"eventCreation\" - Notification sent when a new event is put on the calendar. \n- \"eventChange\" - Notification sent when an event is changed. \n- \"eventCancellation\" - Notification sent when an event is cancelled. \n- \"eventResponse\" - Notification sent when an event is changed. \n- \"agenda\" - An agenda with the events of the day (sent out in the morning).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Channel": {
+ "id": "Channel",
+ "properties": {
+ "address": {
+ "description": "The address where notifications are delivered for this channel.",
+ "type": "string"
+ },
+ "expiration": {
+ "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "A UUID or similar unique string that identifies this channel.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "api#channel",
+ "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "description": "Declares a new parameter by name.",
+ "type": "string"
+ },
+ "description": "Additional parameters controlling delivery channel behavior. Optional.",
+ "type": "object"
+ },
+ "payload": {
+ "description": "A Boolean value to indicate whether payload is wanted. Optional.",
+ "type": "boolean"
+ },
+ "resourceId": {
+ "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "A version-specific identifier for the watched resource.",
+ "type": "string"
+ },
+ "token": {
+ "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of delivery mechanism used for this channel.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ColorDefinition": {
+ "id": "ColorDefinition",
+ "properties": {
+ "background": {
+ "description": "The background color associated with this color definition.",
+ "type": "string"
+ },
+ "foreground": {
+ "description": "The foreground color that can be used to write on top of a background with 'background' color.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Colors": {
+ "id": "Colors",
+ "properties": {
+ "calendar": {
+ "additionalProperties": {
+ "$ref": "ColorDefinition",
+ "description": "A calendar color defintion."
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "event": {
+ "additionalProperties": {
+ "$ref": "ColorDefinition",
+ "description": "An event color definition."
+ },
+ "description": "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.",
+ "type": "object"
+ },
+ "kind": {
+ "default": "calendar#colors",
+ "description": "Type of the resource (\"calendar#colors\").",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Last modification time of the color palette (as a RFC3339 timestamp). Read-only.",
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConferenceData": {
+ "id": "ConferenceData",
+ "properties": {
+ "conferenceId": {
+ "description": "The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nValues for solution types: \n- \"eventHangout\": unset.\n- \"eventNamedHangout\": the name of the Hangout.\n- \"hangoutsMeet\": the 10-letter meeting code, for example \"aaa-bbbb-ccc\". Optional.",
+ "type": "string"
+ },
+ "conferenceSolution": {
+ "$ref": "ConferenceSolution",
+ "description": "The conference solution, such as Hangouts or Hangouts Meet.\nUnset for a conference with a failed create request.\nEither conferenceSolution and at least one entryPoint, or createRequest is required."
+ },
+ "createRequest": {
+ "$ref": "CreateConferenceRequest",
+ "description": "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.\nEither conferenceSolution and at least one entryPoint, or createRequest is required."
+ },
+ "entryPoints": {
+ "description": "Information about individual conference entry points, such as URLs or phone numbers.\nAll of them must belong to the same conference.\nEither conferenceSolution and at least one entryPoint, or createRequest is required.",
+ "items": {
+ "$ref": "EntryPoint"
+ },
+ "type": "array"
+ },
+ "notes": {
+ "description": "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.",
+ "type": "string"
+ },
+ "parameters": {
+ "$ref": "ConferenceParameters",
+ "description": "Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming."
+ },
+ "signature": {
+ "description": "The signature of the conference data.\nGenereated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.\nUnset for a conference with a failed create request.\nOptional for a conference with a pending create request.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConferenceParameters": {
+ "id": "ConferenceParameters",
+ "properties": {
+ "addOnParameters": {
+ "$ref": "ConferenceParametersAddOnParameters",
+ "description": "Additional add-on specific data."
+ }
+ },
+ "type": "object"
+ },
+ "ConferenceParametersAddOnParameters": {
+ "id": "ConferenceParametersAddOnParameters",
+ "properties": {
+ "parameters": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "ConferenceProperties": {
+ "id": "ConferenceProperties",
+ "properties": {
+ "allowedConferenceSolutionTypes": {
+ "description": "The types of conference solutions that are supported for this calendar.\nThe possible values are: \n- \"eventHangout\" \n- \"eventNamedHangout\" \n- \"hangoutsMeet\" Optional.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ConferenceRequestStatus": {
+ "id": "ConferenceRequestStatus",
+ "properties": {
+ "statusCode": {
+ "description": "The current status of the conference create request. Read-only.\nThe possible values are: \n- \"pending\": the conference create request is still being processed.\n- \"success\": the conference create request succeeded, the entry points are populated.\n- \"failure\": the conference create request failed, there are no entry points.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConferenceSolution": {
+ "id": "ConferenceSolution",
+ "properties": {
+ "iconUri": {
+ "description": "The user-visible icon for this solution.",
+ "type": "string"
+ },
+ "key": {
+ "$ref": "ConferenceSolutionKey",
+ "description": "The key which can uniquely identify the conference solution for this event."
+ },
+ "name": {
+ "description": "The user-visible name of this solution. Not localized.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ConferenceSolutionKey": {
+ "id": "ConferenceSolutionKey",
+ "properties": {
+ "type": {
+ "description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (http://hangouts.google.com)\n- \"eventNamedHangout\" for classic Hangouts for G Suite users (http://hangouts.google.com)\n- \"hangoutsMeet\" for Hangouts Meet (http://meet.google.com)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateConferenceRequest": {
+ "id": "CreateConferenceRequest",
+ "properties": {
+ "conferenceSolutionKey": {
+ "$ref": "ConferenceSolutionKey",
+ "description": "The conference solution, such as Hangouts or Hangouts Meet."
+ },
+ "requestId": {
+ "description": "The client-generated unique ID for this request.\nClients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.",
+ "type": "string"
+ },
+ "status": {
+ "$ref": "ConferenceRequestStatus",
+ "description": "The status of the conference create request."
+ }
+ },
+ "type": "object"
+ },
+ "EntryPoint": {
+ "id": "EntryPoint",
+ "properties": {
+ "accessCode": {
+ "description": "The access code to access the conference. The maximum length is 128 characters.\nWhen 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.\nOptional.",
+ "type": "string"
+ },
+ "entryPointType": {
+ "description": "The type of the conference entry point.\nPossible values are: \n- \"video\" - joining a conference over HTTP. A conference can have zero or one video entry point.\n- \"phone\" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.\n- \"sip\" - joining a conference over SIP. A conference can have zero or one sip entry point.\n- \"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.",
+ "type": "string"
+ },
+ "label": {
+ "description": "The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.\nExamples: \n- for video: meet.google.com/aaa-bbbb-ccc\n- for phone: +1 123 268 2601\n- for sip: 12345678@altostrat.com\n- for more: should not be filled \nOptional.",
+ "type": "string"
+ },
+ "meetingCode": {
+ "description": "The meeting code to access the conference. The maximum length is 128 characters.\nWhen 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.\nOptional.",
+ "type": "string"
+ },
+ "passcode": {
+ "description": "The passcode to access the conference. The maximum length is 128 characters.\nWhen 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.",
+ "type": "string"
+ },
+ "password": {
+ "description": "The password to access the conference. The maximum length is 128 characters.\nWhen 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.\nOptional.",
+ "type": "string"
+ },
+ "pin": {
+ "description": "The PIN to access the conference. The maximum length is 128 characters.\nWhen 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.\nOptional.",
+ "type": "string"
+ },
+ "uri": {
+ "description": "The URI of the entry point. The maximum length is 1300 characters.\nFormat: \n- for video, http: or https: schema is required.\n- for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).\n- for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.\n- for more, http: or https: schema is required.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Error": {
+ "id": "Error",
+ "properties": {
+ "domain": {
+ "description": "Domain, or broad category, of the error.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Specific reason for the error. Some of the possible values are: \n- \"groupTooBig\" - The group of users requested is too large for a single query. \n- \"tooManyCalendarsRequested\" - The number of calendars requested is too large for a single query. \n- \"notFound\" - The requested resource was not found. \n- \"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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Event": {
+ "id": "Event",
+ "properties": {
+ "anyoneCanAddSelf": {
+ "default": "false",
+ "description": "Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.",
+ "type": "boolean"
+ },
+ "attachments": {
+ "description": "File attachments for the event. Currently only Google Drive attachments are supported.\nIn order to modify attachments the supportsAttachments request parameter should be set to true.\nThere can be at most 25 attachments per event,",
+ "items": {
+ "$ref": "EventAttachment"
+ },
+ "type": "array"
+ },
+ "attendees": {
+ "description": "The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.",
+ "items": {
+ "$ref": "EventAttendee"
+ },
+ "type": "array"
+ },
+ "attendeesOmitted": {
+ "default": "false",
+ "description": "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.",
+ "type": "boolean"
+ },
+ "colorId": {
+ "description": "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.",
+ "type": "string"
+ },
+ "conferenceData": {
+ "$ref": "ConferenceData",
+ "description": "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."
+ },
+ "created": {
+ "description": "Creation time of the event (as a RFC3339 timestamp). Read-only.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "creator": {
+ "description": "The creator of the event. Read-only.",
+ "properties": {
+ "displayName": {
+ "description": "The creator's name, if available.",
+ "type": "string"
+ },
+ "email": {
+ "description": "The creator's email address, if available.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API",
+ "type": "string"
+ },
+ "self": {
+ "default": "false",
+ "description": "Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "description": {
+ "description": "Description of the event. Optional.",
+ "type": "string"
+ },
+ "end": {
+ "$ref": "EventDateTime",
+ "annotations": {
+ "required": [
+ "calendar.events.import",
+ "calendar.events.insert",
+ "calendar.events.update"
+ ]
+ },
+ "description": "The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance."
+ },
+ "endTimeUnspecified": {
+ "default": "false",
+ "description": "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.",
+ "type": "boolean"
+ },
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "extendedProperties": {
+ "description": "Extended properties of the event.",
+ "properties": {
+ "private": {
+ "additionalProperties": {
+ "description": "The name of the private property and the corresponding value.",
+ "type": "string"
+ },
+ "description": "Properties that are private to the copy of the event that appears on this calendar.",
+ "type": "object"
+ },
+ "shared": {
+ "additionalProperties": {
+ "description": "The name of the shared property and the corresponding value.",
+ "type": "string"
+ },
+ "description": "Properties that are shared between copies of the event on other attendees' calendars.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "gadget": {
+ "description": "A gadget that extends this event.",
+ "properties": {
+ "display": {
+ "description": "The gadget's display mode. Optional. Possible values are: \n- \"icon\" - The gadget displays next to the event's title in the calendar view. \n- \"chip\" - The gadget displays when the event is clicked.",
+ "type": "string"
+ },
+ "height": {
+ "description": "The gadget's height in pixels. The height must be an integer greater than 0. Optional.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "iconLink": {
+ "description": "The gadget's icon URL. The URL scheme must be HTTPS.",
+ "type": "string"
+ },
+ "link": {
+ "description": "The gadget's URL. The URL scheme must be HTTPS.",
+ "type": "string"
+ },
+ "preferences": {
+ "additionalProperties": {
+ "description": "The preference name and corresponding value.",
+ "type": "string"
+ },
+ "description": "Preferences.",
+ "type": "object"
+ },
+ "title": {
+ "description": "The gadget's title.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The gadget's type.",
+ "type": "string"
+ },
+ "width": {
+ "description": "The gadget's width in pixels. The width must be an integer greater than 0. Optional.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "guestsCanInviteOthers": {
+ "default": "true",
+ "description": "Whether attendees other than the organizer can invite others to the event. Optional. The default is True.",
+ "type": "boolean"
+ },
+ "guestsCanModify": {
+ "default": "false",
+ "description": "Whether attendees other than the organizer can modify the event. Optional. The default is False.",
+ "type": "boolean"
+ },
+ "guestsCanSeeOtherGuests": {
+ "default": "true",
+ "description": "Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.",
+ "type": "boolean"
+ },
+ "hangoutLink": {
+ "description": "An absolute link to the Google+ hangout associated with this event. Read-only.",
+ "type": "string"
+ },
+ "htmlLink": {
+ "description": "An absolute link to this event in the Google Calendar Web UI. Read-only.",
+ "type": "string"
+ },
+ "iCalUID": {
+ "annotations": {
+ "required": [
+ "calendar.events.import"
+ ]
+ },
+ "description": "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.\nNote 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.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: \n- 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 \n- the length of the ID must be between 5 and 1024 characters \n- 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.\nIf you do not specify an ID, it will be automatically generated by the server.\nNote 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.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "calendar#event",
+ "description": "Type of the resource (\"calendar#event\").",
+ "type": "string"
+ },
+ "location": {
+ "description": "Geographic location of the event as free-form text. Optional.",
+ "type": "string"
+ },
+ "locked": {
+ "default": "false",
+ "description": "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.",
+ "type": "boolean"
+ },
+ "organizer": {
+ "description": "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.",
+ "properties": {
+ "displayName": {
+ "description": "The organizer's name, if available.",
+ "type": "string"
+ },
+ "email": {
+ "description": "The organizer's email address, if available. It must be a valid email address as per RFC5322.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API",
+ "type": "string"
+ },
+ "self": {
+ "default": "false",
+ "description": "Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "originalStartTime": {
+ "$ref": "EventDateTime",
+ "description": "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. Immutable."
+ },
+ "privateCopy": {
+ "default": "false",
+ "description": "Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.",
+ "type": "boolean"
+ },
+ "recurrence": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "recurringEventId": {
+ "description": "For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.",
+ "type": "string"
+ },
+ "reminders": {
+ "description": "Information about the event's reminders for the authenticated user.",
+ "properties": {
+ "overrides": {
+ "description": "If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.",
+ "items": {
+ "$ref": "EventReminder"
+ },
+ "type": "array"
+ },
+ "useDefault": {
+ "description": "Whether the default reminders of the calendar apply to the event.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "sequence": {
+ "description": "Sequence number as per iCalendar.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "source": {
+ "description": "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.",
+ "properties": {
+ "title": {
+ "description": "Title of the source; for example a title of a web page or an email subject.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "start": {
+ "$ref": "EventDateTime",
+ "annotations": {
+ "required": [
+ "calendar.events.import",
+ "calendar.events.insert",
+ "calendar.events.update"
+ ]
+ },
+ "description": "The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance."
+ },
+ "status": {
+ "description": "Status of the event. Optional. Possible values are: \n- \"confirmed\" - The event is confirmed. This is the default status. \n- \"tentative\" - The event is tentatively confirmed. \n- \"cancelled\" - The event is cancelled.",
+ "type": "string"
+ },
+ "summary": {
+ "description": "Title of the event.",
+ "type": "string"
+ },
+ "transparency": {
+ "default": "opaque",
+ "description": "Whether the event blocks time on the calendar. Optional. Possible values are: \n- \"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. \n- \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Last modification time of the event (as a RFC3339 timestamp). Read-only.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "visibility": {
+ "default": "default",
+ "description": "Visibility of the event. Optional. Possible values are: \n- \"default\" - Uses the default visibility for events on the calendar. This is the default value. \n- \"public\" - The event is public and event details are visible to all readers of the calendar. \n- \"private\" - The event is private and only event attendees may view event details. \n- \"confidential\" - The event is private. This value is provided for compatibility reasons.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventAttachment": {
+ "id": "EventAttachment",
+ "properties": {
+ "fileId": {
+ "description": "ID of the attached file. Read-only.\nFor Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.",
+ "type": "string"
+ },
+ "fileUrl": {
+ "annotations": {
+ "required": [
+ "calendar.events.import",
+ "calendar.events.insert",
+ "calendar.events.update"
+ ]
+ },
+ "description": "URL link to the attachment.\nFor adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.",
+ "type": "string"
+ },
+ "iconLink": {
+ "description": "URL link to the attachment's icon. Read-only.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "Internet media type (MIME type) of the attachment.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Attachment title.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventAttendee": {
+ "id": "EventAttendee",
+ "properties": {
+ "additionalGuests": {
+ "default": "0",
+ "description": "Number of additional guests. Optional. The default is 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "comment": {
+ "description": "The attendee's response comment. Optional.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The attendee's name, if available. Optional.",
+ "type": "string"
+ },
+ "email": {
+ "annotations": {
+ "required": [
+ "calendar.events.import",
+ "calendar.events.insert",
+ "calendar.events.update"
+ ]
+ },
+ "description": "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.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API",
+ "type": "string"
+ },
+ "optional": {
+ "default": "false",
+ "description": "Whether this is an optional attendee. Optional. The default is False.",
+ "type": "boolean"
+ },
+ "organizer": {
+ "description": "Whether the attendee is the organizer of the event. Read-only. The default is False.",
+ "type": "boolean"
+ },
+ "resource": {
+ "default": "false",
+ "description": "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.",
+ "type": "boolean"
+ },
+ "responseStatus": {
+ "description": "The attendee's response status. Possible values are: \n- \"needsAction\" - The attendee has not responded to the invitation. \n- \"declined\" - The attendee has declined the invitation. \n- \"tentative\" - The attendee has tentatively accepted the invitation. \n- \"accepted\" - The attendee has accepted the invitation.",
+ "type": "string"
+ },
+ "self": {
+ "default": "false",
+ "description": "Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "EventDateTime": {
+ "id": "EventDateTime",
+ "properties": {
+ "date": {
+ "description": "The date, in the format \"yyyy-mm-dd\", if this is an all-day event.",
+ "format": "date",
+ "type": "string"
+ },
+ "dateTime": {
+ "description": "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.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventReminder": {
+ "id": "EventReminder",
+ "properties": {
+ "method": {
+ "annotations": {
+ "required": [
+ "calendar.calendarList.insert",
+ "calendar.calendarList.update",
+ "calendar.events.import",
+ "calendar.events.insert",
+ "calendar.events.update"
+ ]
+ },
+ "description": "The method used by this reminder. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"sms\" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. \n- \"popup\" - Reminders are sent via a UI popup.",
+ "type": "string"
+ },
+ "minutes": {
+ "annotations": {
+ "required": [
+ "calendar.calendarList.insert",
+ "calendar.calendarList.update",
+ "calendar.events.import",
+ "calendar.events.insert",
+ "calendar.events.update"
+ ]
+ },
+ "description": "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).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Events": {
+ "id": "Events",
+ "properties": {
+ "accessRole": {
+ "description": "The user's access role for this calendar. Read-only. Possible values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\" - The user has read access to free/busy information. \n- \"reader\" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"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. \n- \"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.",
+ "type": "string"
+ },
+ "defaultReminders": {
+ "description": "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).",
+ "items": {
+ "$ref": "EventReminder"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "Description of the calendar. Read-only.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "ETag of the collection.",
+ "type": "string"
+ },
+ "items": {
+ "description": "List of events on the calendar.",
+ "items": {
+ "$ref": "Event"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "calendar#events",
+ "description": "Type of the collection (\"calendar#events\").",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.",
+ "type": "string"
+ },
+ "nextSyncToken": {
+ "description": "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.",
+ "type": "string"
+ },
+ "summary": {
+ "description": "Title of the calendar. Read-only.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "The time zone of the calendar. Read-only.",
+ "type": "string"
+ },
+ "updated": {
+ "description": "Last modification time of the calendar (as a RFC3339 timestamp). Read-only.",
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FreeBusyCalendar": {
+ "id": "FreeBusyCalendar",
+ "properties": {
+ "busy": {
+ "description": "List of time ranges during which this calendar should be regarded as busy.",
+ "items": {
+ "$ref": "TimePeriod"
+ },
+ "type": "array"
+ },
+ "errors": {
+ "description": "Optional error(s) (if computation for the calendar failed).",
+ "items": {
+ "$ref": "Error"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FreeBusyGroup": {
+ "id": "FreeBusyGroup",
+ "properties": {
+ "calendars": {
+ "description": "List of calendars' identifiers within a group.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "errors": {
+ "description": "Optional error(s) (if computation for the group failed).",
+ "items": {
+ "$ref": "Error"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FreeBusyRequest": {
+ "id": "FreeBusyRequest",
+ "properties": {
+ "calendarExpansionMax": {
+ "description": "Maximal number of calendars for which FreeBusy information is to be provided. Optional.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupExpansionMax": {
+ "description": "Maximal number of calendar identifiers to be provided for a single group. Optional. An error will be returned for a group with more members than this value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "items": {
+ "description": "List of calendars and/or groups to query.",
+ "items": {
+ "$ref": "FreeBusyRequestItem"
+ },
+ "type": "array"
+ },
+ "timeMax": {
+ "description": "The end of the interval for the query.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "timeMin": {
+ "description": "The start of the interval for the query.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "timeZone": {
+ "default": "UTC",
+ "description": "Time zone used in the response. Optional. The default is UTC.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FreeBusyRequestItem": {
+ "id": "FreeBusyRequestItem",
+ "properties": {
+ "id": {
+ "description": "The identifier of a calendar or a group.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FreeBusyResponse": {
+ "id": "FreeBusyResponse",
+ "properties": {
+ "calendars": {
+ "additionalProperties": {
+ "$ref": "FreeBusyCalendar",
+ "description": "Free/busy expansions for a single calendar."
+ },
+ "description": "List of free/busy information for calendars.",
+ "type": "object"
+ },
+ "groups": {
+ "additionalProperties": {
+ "$ref": "FreeBusyGroup",
+ "description": "List of calendars that are members of this group."
+ },
+ "description": "Expansion of groups.",
+ "type": "object"
+ },
+ "kind": {
+ "default": "calendar#freeBusy",
+ "description": "Type of the resource (\"calendar#freeBusy\").",
+ "type": "string"
+ },
+ "timeMax": {
+ "description": "The end of the interval.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "timeMin": {
+ "description": "The start of the interval.",
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Setting": {
+ "id": "Setting",
+ "properties": {
+ "etag": {
+ "description": "ETag of the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The id of the user setting.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "calendar#setting",
+ "description": "Type of the resource (\"calendar#setting\").",
+ "type": "string"
+ },
+ "value": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Settings": {
+ "id": "Settings",
+ "properties": {
+ "etag": {
+ "description": "Etag of the collection.",
+ "type": "string"
+ },
+ "items": {
+ "description": "List of user settings.",
+ "items": {
+ "$ref": "Setting"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "calendar#settings",
+ "description": "Type of the collection (\"calendar#settings\").",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.",
+ "type": "string"
+ },
+ "nextSyncToken": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TimePeriod": {
+ "id": "TimePeriod",
+ "properties": {
+ "end": {
+ "description": "The (exclusive) end of the time period.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "start": {
+ "description": "The (inclusive) start of the time period.",
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
},
- "Settings": {
- "id": "Settings",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the collection."
- },
- "items": {
- "type": "array",
- "description": "List of user settings.",
- "items": {
- "$ref": "Setting"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection (\"calendar#settings\").",
- "default": "calendar#settings"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
- },
- "nextSyncToken": {
- "type": "string",
- "description": "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."
- }
- }
- },
- "TimePeriod": {
- "id": "TimePeriod",
- "type": "object",
- "properties": {
- "end": {
- "type": "string",
- "description": "The (exclusive) end of the time period.",
- "format": "date-time"
- },
- "start": {
- "type": "string",
- "description": "The (inclusive) start of the time period.",
- "format": "date-time"
- }
- }
- }
- },
- "resources": {
- "acl": {
- "methods": {
- "delete": {
- "id": "calendar.acl.delete",
- "path": "calendars/{calendarId}/acl/{ruleId}",
- "httpMethod": "DELETE",
- "description": "Deletes an access control rule.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "ruleId": {
- "type": "string",
- "description": "ACL rule identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId",
- "ruleId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "get": {
- "id": "calendar.acl.get",
- "path": "calendars/{calendarId}/acl/{ruleId}",
- "httpMethod": "GET",
- "description": "Returns an access control rule.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "ruleId": {
- "type": "string",
- "description": "ACL rule identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId",
- "ruleId"
- ],
- "response": {
- "$ref": "AclRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "insert": {
- "id": "calendar.acl.insert",
- "path": "calendars/{calendarId}/acl",
- "httpMethod": "POST",
- "description": "Creates an access control rule.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the calendar sharing change. Optional. The default is True.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "AclRule"
- },
- "response": {
- "$ref": "AclRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "list": {
- "id": "calendar.acl.list",
- "path": "calendars/{calendarId}/acl",
- "httpMethod": "GET",
- "description": "Returns the rules in the access control list for the calendar.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "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.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "response": {
- "$ref": "Acl"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ],
- "supportsSubscription": true
- },
- "patch": {
- "id": "calendar.acl.patch",
- "path": "calendars/{calendarId}/acl/{ruleId}",
- "httpMethod": "PATCH",
- "description": "Updates an access control rule. This method supports patch semantics.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "ruleId": {
- "type": "string",
- "description": "ACL rule identifier.",
- "required": true,
- "location": "path"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "ruleId"
- ],
- "request": {
- "$ref": "AclRule"
- },
- "response": {
- "$ref": "AclRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "update": {
- "id": "calendar.acl.update",
- "path": "calendars/{calendarId}/acl/{ruleId}",
- "httpMethod": "PUT",
- "description": "Updates an access control rule.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "ruleId": {
- "type": "string",
- "description": "ACL rule identifier.",
- "required": true,
- "location": "path"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "ruleId"
- ],
- "request": {
- "$ref": "AclRule"
- },
- "response": {
- "$ref": "AclRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "watch": {
- "id": "calendar.acl.watch",
- "path": "calendars/{calendarId}/acl/watch",
- "httpMethod": "POST",
- "description": "Watch for changes to ACL resources.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "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.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ],
- "supportsSubscription": true
- }
- }
- },
- "calendarList": {
- "methods": {
- "delete": {
- "id": "calendar.calendarList.delete",
- "path": "users/me/calendarList/{calendarId}",
- "httpMethod": "DELETE",
- "description": "Deletes an entry on the user's calendar list.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "get": {
- "id": "calendar.calendarList.get",
- "path": "users/me/calendarList/{calendarId}",
- "httpMethod": "GET",
- "description": "Returns an entry on the user's calendar list.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "response": {
- "$ref": "CalendarListEntry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "insert": {
- "id": "calendar.calendarList.insert",
- "path": "users/me/calendarList",
- "httpMethod": "POST",
- "description": "Adds an entry to the user's calendar list.",
- "parameters": {
- "colorRgbFormat": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "CalendarListEntry"
- },
- "response": {
- "$ref": "CalendarListEntry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "list": {
- "id": "calendar.calendarList.list",
- "path": "users/me/calendarList",
- "httpMethod": "GET",
- "description": "Returns entries on the user's calendar list.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "minAccessRole": {
- "type": "string",
- "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
- "enum": [
- "freeBusyReader",
- "owner",
- "reader",
- "writer"
- ],
- "enumDescriptions": [
- "The user can read free/busy information.",
- "The user can read and modify events and access control lists.",
- "The user can read events that are not private.",
- "The user can read and modify events."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.",
- "location": "query"
- },
- "showHidden": {
- "type": "boolean",
- "description": "Whether to show hidden entries. Optional. The default is False.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "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.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "CalendarList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- },
- "patch": {
- "id": "calendar.calendarList.patch",
- "path": "users/me/calendarList/{calendarId}",
- "httpMethod": "PATCH",
- "description": "Updates an entry on the user's calendar list. This method supports patch semantics.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "colorRgbFormat": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "CalendarListEntry"
- },
- "response": {
- "$ref": "CalendarListEntry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "update": {
- "id": "calendar.calendarList.update",
- "path": "users/me/calendarList/{calendarId}",
- "httpMethod": "PUT",
- "description": "Updates an entry on the user's calendar list.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "colorRgbFormat": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "CalendarListEntry"
- },
- "response": {
- "$ref": "CalendarListEntry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "watch": {
- "id": "calendar.calendarList.watch",
- "path": "users/me/calendarList/watch",
- "httpMethod": "POST",
- "description": "Watch for changes to CalendarList resources.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "minAccessRole": {
- "type": "string",
- "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
- "enum": [
- "freeBusyReader",
- "owner",
- "reader",
- "writer"
- ],
- "enumDescriptions": [
- "The user can read free/busy information.",
- "The user can read and modify events and access control lists.",
- "The user can read events that are not private.",
- "The user can read and modify events."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.",
- "location": "query"
- },
- "showHidden": {
- "type": "boolean",
- "description": "Whether to show hidden entries. Optional. The default is False.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "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.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- }
- }
- },
- "calendars": {
- "methods": {
- "clear": {
- "id": "calendar.calendars.clear",
- "path": "calendars/{calendarId}/clear",
- "httpMethod": "POST",
- "description": "Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "delete": {
- "id": "calendar.calendars.delete",
- "path": "calendars/{calendarId}",
- "httpMethod": "DELETE",
- "description": "Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "get": {
- "id": "calendar.calendars.get",
- "path": "calendars/{calendarId}",
- "httpMethod": "GET",
- "description": "Returns metadata for a calendar.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "response": {
- "$ref": "Calendar"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "insert": {
- "id": "calendar.calendars.insert",
- "path": "calendars",
- "httpMethod": "POST",
- "description": "Creates a secondary calendar.",
- "request": {
- "$ref": "Calendar"
- },
- "response": {
- "$ref": "Calendar"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "patch": {
- "id": "calendar.calendars.patch",
- "path": "calendars/{calendarId}",
- "httpMethod": "PATCH",
- "description": "Updates metadata for a calendar. This method supports patch semantics.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Calendar"
- },
- "response": {
- "$ref": "Calendar"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "update": {
- "id": "calendar.calendars.update",
- "path": "calendars/{calendarId}",
- "httpMethod": "PUT",
- "description": "Updates metadata for a calendar.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Calendar"
- },
- "response": {
- "$ref": "Calendar"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- }
- }
- },
- "channels": {
- "methods": {
- "stop": {
- "id": "calendar.channels.stop",
- "path": "channels/stop",
- "httpMethod": "POST",
- "description": "Stop watching resources through this channel",
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- }
- }
- },
- "colors": {
- "methods": {
- "get": {
- "id": "calendar.colors.get",
- "path": "colors",
- "httpMethod": "GET",
- "description": "Returns the color definitions for calendars and events.",
- "response": {
- "$ref": "Colors"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- }
- }
- },
- "events": {
- "methods": {
- "delete": {
- "id": "calendar.events.delete",
- "path": "calendars/{calendarId}/events/{eventId}",
- "httpMethod": "DELETE",
- "description": "Deletes an event.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the deletion of the event. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "get": {
- "id": "calendar.events.get",
- "path": "calendars/{calendarId}/events/{eventId}",
- "httpMethod": "GET",
- "description": "Returns an event.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "import": {
- "id": "calendar.events.import",
- "path": "calendars/{calendarId}/events/import",
- "httpMethod": "POST",
- "description": "Imports an event. This operation is used to add a private copy of an existing event to a calendar.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "conferenceDataVersion": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "0",
- "maximum": "1",
- "location": "query"
- },
- "supportsAttachments": {
- "type": "boolean",
- "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Event"
- },
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "insert": {
- "id": "calendar.events.insert",
- "path": "calendars/{calendarId}/events",
- "httpMethod": "POST",
- "description": "Creates an event.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "conferenceDataVersion": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "0",
- "maximum": "1",
- "location": "query"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the creation of the new event. Optional. The default is False.",
- "location": "query"
- },
- "supportsAttachments": {
- "type": "boolean",
- "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Event"
- },
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "instances": {
- "id": "calendar.events.instances",
- "path": "calendars/{calendarId}/events/{eventId}/instances",
- "httpMethod": "GET",
- "description": "Returns instances of the specified recurring event.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "eventId": {
- "type": "string",
- "description": "Recurring event identifier.",
- "required": true,
- "location": "path"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "originalStart": {
- "type": "string",
- "description": "The original start time of the instance in the result. Optional.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "timeMax": {
- "type": "string",
- "description": "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.",
- "format": "date-time",
- "location": "query"
- },
- "timeMin": {
- "type": "string",
- "description": "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.",
- "format": "date-time",
- "location": "query"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "response": {
- "$ref": "Events"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- },
- "list": {
- "id": "calendar.events.list",
- "path": "calendars/{calendarId}/events",
- "httpMethod": "GET",
- "description": "Returns events on the specified calendar.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "iCalUID": {
- "type": "string",
- "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
- "location": "query"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "default": "250",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
- "enum": [
- "startTime",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
- "Order by last modification time (ascending)."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "privateExtendedProperty": {
- "type": "string",
- "description": "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.",
- "repeated": true,
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
- "location": "query"
- },
- "sharedExtendedProperty": {
- "type": "string",
- "description": "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.",
- "repeated": true,
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "showHiddenInvitations": {
- "type": "boolean",
- "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
- "location": "query"
- },
- "singleEvents": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "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.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- },
- "timeMax": {
- "type": "string",
- "description": "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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMin is set, timeMax must be greater than timeMin.",
- "format": "date-time",
- "location": "query"
- },
- "timeMin": {
- "type": "string",
- "description": "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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMax is set, timeMin must be smaller than timeMax.",
- "format": "date-time",
- "location": "query"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "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.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "response": {
- "$ref": "Events"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- },
- "move": {
- "id": "calendar.events.move",
- "path": "calendars/{calendarId}/events/{eventId}/move",
- "httpMethod": "POST",
- "description": "Moves an event to another calendar, i.e. changes an event's organizer.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier of the source calendar where the event currently is on.",
- "required": true,
- "location": "path"
- },
- "destination": {
- "type": "string",
- "description": "Calendar identifier of the target calendar where the event is to be moved to.",
- "required": true,
- "location": "query"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the change of the event's organizer. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId",
- "destination"
- ],
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "patch": {
- "id": "calendar.events.patch",
- "path": "calendars/{calendarId}/events/{eventId}",
- "httpMethod": "PATCH",
- "description": "Updates an event. This method supports patch semantics.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "conferenceDataVersion": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "0",
- "maximum": "1",
- "location": "query"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.",
- "location": "query"
- },
- "supportsAttachments": {
- "type": "boolean",
- "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "request": {
- "$ref": "Event"
- },
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "quickAdd": {
- "id": "calendar.events.quickAdd",
- "path": "calendars/{calendarId}/events/quickAdd",
- "httpMethod": "POST",
- "description": "Creates an event based on a simple text string.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the creation of the event. Optional. The default is False.",
- "location": "query"
- },
- "text": {
- "type": "string",
- "description": "The text describing the event to be created.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "text"
- ],
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "update": {
- "id": "calendar.events.update",
- "path": "calendars/{calendarId}/events/{eventId}",
- "httpMethod": "PUT",
- "description": "Updates an event.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "conferenceDataVersion": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "0",
- "maximum": "1",
- "location": "query"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.",
- "location": "query"
- },
- "supportsAttachments": {
- "type": "boolean",
- "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "request": {
- "$ref": "Event"
- },
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "watch": {
- "id": "calendar.events.watch",
- "path": "calendars/{calendarId}/events/watch",
- "httpMethod": "POST",
- "description": "Watch for changes to Events resources.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "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.",
- "required": true,
- "location": "path"
- },
- "iCalUID": {
- "type": "string",
- "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
- "location": "query"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "default": "250",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
- "enum": [
- "startTime",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
- "Order by last modification time (ascending)."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "privateExtendedProperty": {
- "type": "string",
- "description": "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.",
- "repeated": true,
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
- "location": "query"
- },
- "sharedExtendedProperty": {
- "type": "string",
- "description": "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.",
- "repeated": true,
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "showHiddenInvitations": {
- "type": "boolean",
- "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
- "location": "query"
- },
- "singleEvents": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "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.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- },
- "timeMax": {
- "type": "string",
- "description": "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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMin is set, timeMax must be greater than timeMin.",
- "format": "date-time",
- "location": "query"
- },
- "timeMin": {
- "type": "string",
- "description": "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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMax is set, timeMin must be smaller than timeMax.",
- "format": "date-time",
- "location": "query"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "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.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- }
- }
- },
- "freebusy": {
- "methods": {
- "query": {
- "id": "calendar.freebusy.query",
- "path": "freeBusy",
- "httpMethod": "POST",
- "description": "Returns free/busy information for a set of calendars.",
- "request": {
- "$ref": "FreeBusyRequest"
- },
- "response": {
- "$ref": "FreeBusyResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- }
- }
- },
- "settings": {
- "methods": {
- "get": {
- "id": "calendar.settings.get",
- "path": "users/me/settings/{setting}",
- "httpMethod": "GET",
- "description": "Returns a single user setting.",
- "parameters": {
- "setting": {
- "type": "string",
- "description": "The id of the user setting.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "setting"
- ],
- "response": {
- "$ref": "Setting"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "list": {
- "id": "calendar.settings.list",
- "path": "users/me/settings",
- "httpMethod": "GET",
- "description": "Returns all user settings for the authenticated user.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "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.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Settings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- },
- "watch": {
- "id": "calendar.settings.watch",
- "path": "users/me/settings/watch",
- "httpMethod": "POST",
- "description": "Watch for changes to Settings resources.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "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.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "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.\nIf 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.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- }
- }
- }
- }
-}
+ "servicePath": "calendar/v3/",
+ "title": "Calendar API",
+ "version": "v3"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/calendar/v3/calendar-gen.go b/vendor/google.golang.org/api/calendar/v3/calendar-gen.go
index f9877250e..191b88061 100644
--- a/vendor/google.golang.org/api/calendar/v3/calendar-gen.go
+++ b/vendor/google.golang.org/api/calendar/v3/calendar-gen.go
@@ -787,6 +787,10 @@ type ConferenceData struct {
// HTML. The maximum length is 2048 characters. Optional.
Notes string `json:"notes,omitempty"`
+ // Parameters: Additional properties related to a conference. An example
+ // would be a solution-specific setting for enabling video streaming.
+ Parameters *ConferenceParameters `json:"parameters,omitempty"`
+
// Signature: 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
@@ -818,6 +822,60 @@ func (s *ConferenceData) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type ConferenceParameters struct {
+ // AddOnParameters: Additional add-on specific data.
+ AddOnParameters *ConferenceParametersAddOnParameters `json:"addOnParameters,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AddOnParameters") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "AddOnParameters") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ConferenceParameters) MarshalJSON() ([]byte, error) {
+ type NoMethod ConferenceParameters
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type ConferenceParametersAddOnParameters struct {
+ Parameters map[string]string `json:"parameters,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Parameters") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Parameters") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ConferenceParametersAddOnParameters) MarshalJSON() ([]byte, error) {
+ type NoMethod ConferenceParametersAddOnParameters
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type ConferenceProperties struct {
// AllowedConferenceSolutionTypes: The types of conference solutions
// that are supported for this calendar.
@@ -1689,8 +1747,9 @@ type EventAttendee struct {
// Read-only. The default is False.
Organizer bool `json:"organizer,omitempty"`
- // Resource: Whether the attendee is a resource. Read-only. The default
- // is False.
+ // Resource: 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 bool `json:"resource,omitempty"`
// ResponseStatus: The attendee's response status. Possible values are:
diff --git a/vendor/google.golang.org/api/chat/v1/chat-api.json b/vendor/google.golang.org/api/chat/v1/chat-api.json
new file mode 100644
index 000000000..1b7036c6a
--- /dev/null
+++ b/vendor/google.golang.org/api/chat/v1/chat-api.json
@@ -0,0 +1,1059 @@
+{
+ "basePath": "",
+ "baseUrl": "https://chat.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Hangouts Chat",
+ "description": "Enables bots to fetch information and perform actions in the new Hangouts Chat.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/hangouts/chat",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "chat:v1",
+ "kind": "discovery#restDescription",
+ "name": "chat",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "spaces": {
+ "methods": {
+ "get": {
+ "description": "Returns a space.",
+ "flatPath": "v1/spaces/{spacesId}",
+ "httpMethod": "GET",
+ "id": "chat.spaces.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Resource name of the space, in the form \"spaces/*\".\n\nExample: spaces/AAAAMpdlehY",
+ "location": "path",
+ "pattern": "^spaces/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Space"
+ }
+ },
+ "list": {
+ "description": "Lists spaces the caller is a member of.",
+ "flatPath": "v1/spaces",
+ "httpMethod": "GET",
+ "id": "chat.spaces.list",
+ "parameterOrder": [],
+ "parameters": {
+ "pageSize": {
+ "description": "Requested page size. The value is capped at 1000.\nServer may return fewer results than requested.\nIf unspecified, server will default to 100.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/spaces",
+ "response": {
+ "$ref": "ListSpacesResponse"
+ }
+ }
+ },
+ "resources": {
+ "members": {
+ "methods": {
+ "get": {
+ "description": "Returns a membership.",
+ "flatPath": "v1/spaces/{spacesId}/members/{membersId}",
+ "httpMethod": "GET",
+ "id": "chat.spaces.members.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Resource name of the membership to be retrieved, in the form\n\"spaces/*/members/*\".\n\nExample: spaces/AAAAMpdlehY/members/105115627578887013105",
+ "location": "path",
+ "pattern": "^spaces/[^/]+/members/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Membership"
+ }
+ },
+ "list": {
+ "description": "Lists human memberships in a space.",
+ "flatPath": "v1/spaces/{spacesId}/members",
+ "httpMethod": "GET",
+ "id": "chat.spaces.members.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Requested page size. The value is capped at 1000.\nServer may return fewer results than requested.\nIf unspecified, server will default to 100.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The resource name of the space for which membership list is to be\nfetched, in the form \"spaces/*\".\n\nExample: spaces/AAAAMpdlehY",
+ "location": "path",
+ "pattern": "^spaces/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/members",
+ "response": {
+ "$ref": "ListMembershipsResponse"
+ }
+ }
+ }
+ },
+ "messages": {
+ "methods": {
+ "create": {
+ "description": "Creates a message.",
+ "flatPath": "v1/spaces/{spacesId}/messages",
+ "httpMethod": "POST",
+ "id": "chat.spaces.messages.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. Space resource name, in the form \"spaces/*\".\nExample: spaces/AAAAMpdlehY",
+ "location": "path",
+ "pattern": "^spaces/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "threadKey": {
+ "description": "Opaque thread identifier string that can be specified to group messages\ninto a single thread. If this is the first message with a given thread\nidentifier, a new thread is created. Subsequent messages with the same\nthread identifier will be posted into the same thread. This relieves bots\nand webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post\nfurther updates to it.\n\nHas no effect if thread field,\ncorresponding to an existing thread, is set in message.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/messages",
+ "request": {
+ "$ref": "Message"
+ },
+ "response": {
+ "$ref": "Message"
+ }
+ },
+ "delete": {
+ "description": "Deletes a message.",
+ "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
+ "httpMethod": "DELETE",
+ "id": "chat.spaces.messages.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Resource name of the message to be deleted, in the form\n\"spaces/*/messages/*\"\n\nExample: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4",
+ "location": "path",
+ "pattern": "^spaces/[^/]+/messages/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ }
+ },
+ "get": {
+ "description": "Returns a message.",
+ "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
+ "httpMethod": "GET",
+ "id": "chat.spaces.messages.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Resource name of the message to be retrieved, in the form\n\"spaces/*/messages/*\".\n\nExample: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4",
+ "location": "path",
+ "pattern": "^spaces/[^/]+/messages/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Message"
+ }
+ },
+ "update": {
+ "description": "Updates a message.",
+ "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
+ "httpMethod": "PUT",
+ "id": "chat.spaces.messages.update",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name, in the form \"spaces/*/messages/*\".\n\nExample: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4",
+ "location": "path",
+ "pattern": "^spaces/[^/]+/messages/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Required. The field paths to be updated.\n\nCurrently supported field paths: \"text\", \"cards\".",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Message"
+ },
+ "response": {
+ "$ref": "Message"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20180326",
+ "rootUrl": "https://chat.googleapis.com/",
+ "schemas": {
+ "ActionParameter": {
+ "description": "List of string parameters to supply when the action method is invoked.\nFor example, consider three snooze buttons: snooze now, snooze 1 day,\nsnooze next week. You might use action method = snooze(), passing the\nsnooze type and snooze time in the list of string parameters.",
+ "id": "ActionParameter",
+ "properties": {
+ "key": {
+ "description": "The name of the parameter for the action script.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the parameter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ActionResponse": {
+ "description": "Parameters that a bot can use to configure how it's response is posted.",
+ "id": "ActionResponse",
+ "properties": {
+ "type": {
+ "description": "The type of bot response.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "NEW_MESSAGE",
+ "UPDATE_MESSAGE",
+ "REQUEST_CONFIG"
+ ],
+ "enumDescriptions": [
+ "Default type; will be handled as NEW_MESSAGE.",
+ "Post as a new message in the topic.",
+ "Update the bot's own message. (Only after CARD_CLICKED events.)",
+ "Privately ask the user for additional auth or config."
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for users to auth or config. (Only for REQUEST_CONFIG response types.)",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Annotation": {
+ "description": "Annotations associated with the plain-text body of the message.\n\nExample plain-text message body:\n```\nHello @FooBot how are you!\"\n```\n\nThe corresponding annotations metadata:\n```\n\"annotations\":[{\n \"type\":\"USER_MENTION\",\n \"startIndex\":6,\n \"length\":7,\n \"userMention\": {\n \"user\": {\n \"name\":\"users/107946847022116401880\",\n \"displayName\":\"FooBot\",\n \"avatarUrl\":\"https://goo.gl/aeDtrS\",\n \"type\":\"BOT\"\n },\n \"type\":\"MENTION\"\n }\n}]\n```",
+ "id": "Annotation",
+ "properties": {
+ "length": {
+ "description": "Length of the substring in the plain-text message body this annotation\ncorresponds to.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startIndex": {
+ "description": "Start index (0-based, inclusive) in the plain-text message body this\nannotation corresponds to.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": {
+ "description": "The type of this annotation.",
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "USER_MENTION"
+ ],
+ "enumDescriptions": [
+ "Default value for the enum. DO NOT USE.",
+ "A user is mentioned."
+ ],
+ "type": "string"
+ },
+ "userMention": {
+ "$ref": "UserMentionMetadata",
+ "description": "The metadata of user mention."
+ }
+ },
+ "type": "object"
+ },
+ "Button": {
+ "description": "A button. Can be a text button or an image button.",
+ "id": "Button",
+ "properties": {
+ "imageButton": {
+ "$ref": "ImageButton",
+ "description": "A button with image and onclick action."
+ },
+ "textButton": {
+ "$ref": "TextButton",
+ "description": "A button with text and onclick action."
+ }
+ },
+ "type": "object"
+ },
+ "Card": {
+ "description": "A card is a UI element that can contain UI widgets such as texts, images.",
+ "id": "Card",
+ "properties": {
+ "cardActions": {
+ "description": "The actions of this card.",
+ "items": {
+ "$ref": "CardAction"
+ },
+ "type": "array"
+ },
+ "header": {
+ "$ref": "CardHeader",
+ "description": "The header of the card. A header usually contains a title and an image."
+ },
+ "name": {
+ "description": "Name of the card.",
+ "type": "string"
+ },
+ "sections": {
+ "description": "Sections are separated by a line divider.",
+ "items": {
+ "$ref": "Section"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CardAction": {
+ "description": "A card action is\nthe action associated with the card. For an invoice card, a\ntypical action would be: delete invoice, email invoice or open the\ninvoice in browser.",
+ "id": "CardAction",
+ "properties": {
+ "actionLabel": {
+ "description": "The label used to be displayed in the action menu item.",
+ "type": "string"
+ },
+ "onClick": {
+ "$ref": "OnClick",
+ "description": "The onclick action for this action item."
+ }
+ },
+ "type": "object"
+ },
+ "CardHeader": {
+ "id": "CardHeader",
+ "properties": {
+ "imageStyle": {
+ "description": "The image's type (e.g. square border or circular border).",
+ "enum": [
+ "IMAGE_STYLE_UNSPECIFIED",
+ "IMAGE",
+ "AVATAR"
+ ],
+ "enumDescriptions": [
+ "",
+ "Square border.",
+ "Circular border."
+ ],
+ "type": "string"
+ },
+ "imageUrl": {
+ "description": "The URL of the image in the card header.",
+ "type": "string"
+ },
+ "subtitle": {
+ "description": "The subtitle of the card header.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title must be specified. The header has a fixed height: if both a\ntitle and subtitle is specified, each will take up 1 line. If only the\ntitle is specified, it will take up both lines.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "FormAction": {
+ "description": "A form action describes the behavior when the form is submitted.\nFor example, an Apps Script can be invoked to handle the form.",
+ "id": "FormAction",
+ "properties": {
+ "actionMethodName": {
+ "description": "Apps Script function to invoke when the containing element is\nclicked/activated.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "List of action parameters.",
+ "items": {
+ "$ref": "ActionParameter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Image": {
+ "description": "An image that is specified by a URL and can have an onclick action.",
+ "id": "Image",
+ "properties": {
+ "aspectRatio": {
+ "description": "The aspect ratio of this image (width/height).",
+ "format": "double",
+ "type": "number"
+ },
+ "imageUrl": {
+ "description": "The URL of the image.",
+ "type": "string"
+ },
+ "onClick": {
+ "$ref": "OnClick",
+ "description": "The onclick action."
+ }
+ },
+ "type": "object"
+ },
+ "ImageButton": {
+ "description": "An image button with an onclick action.",
+ "id": "ImageButton",
+ "properties": {
+ "icon": {
+ "description": "The icon specified by an enum that indices to an icon provided by Chat\nAPI.",
+ "enum": [
+ "ICON_UNSPECIFIED",
+ "AIRPLANE",
+ "BOOKMARK",
+ "BUS",
+ "CAR",
+ "CLOCK",
+ "CONFIRMATION_NUMBER_ICON",
+ "DOLLAR",
+ "DESCRIPTION",
+ "EMAIL",
+ "EVENT_PERFORMER",
+ "EVENT_SEAT",
+ "FLIGHT_ARRIVAL",
+ "FLIGHT_DEPARTURE",
+ "HOTEL",
+ "HOTEL_ROOM_TYPE",
+ "INVITE",
+ "MAP_PIN",
+ "MEMBERSHIP",
+ "MULTIPLE_PEOPLE",
+ "OFFER",
+ "PERSON",
+ "PHONE",
+ "RESTAURANT_ICON",
+ "SHOPPING_CART",
+ "STAR",
+ "STORE",
+ "TICKET",
+ "TRAIN",
+ "VIDEO_CAMERA",
+ "VIDEO_PLAY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "iconUrl": {
+ "description": "The icon specified by a URL.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of this image_button which will be used for accessibility.\nDefault value will be provided if developers don't specify.",
+ "type": "string"
+ },
+ "onClick": {
+ "$ref": "OnClick",
+ "description": "The onclick action."
+ }
+ },
+ "type": "object"
+ },
+ "KeyValue": {
+ "description": "A UI element contains a key (label) and a value (content). And this\nelement may also contain some actions such as onclick button.",
+ "id": "KeyValue",
+ "properties": {
+ "bottomLabel": {
+ "description": "The text of the bottom label. Formatted text supported.",
+ "type": "string"
+ },
+ "button": {
+ "$ref": "Button",
+ "description": "A button that can be clicked to trigger an action."
+ },
+ "content": {
+ "description": "The text of the content. Formatted text supported and always required.",
+ "type": "string"
+ },
+ "contentMultiline": {
+ "description": "If the content should be multiline.",
+ "type": "boolean"
+ },
+ "icon": {
+ "description": "An enum value that will be replaced by the Chat API with the\ncorresponding icon image.",
+ "enum": [
+ "ICON_UNSPECIFIED",
+ "AIRPLANE",
+ "BOOKMARK",
+ "BUS",
+ "CAR",
+ "CLOCK",
+ "CONFIRMATION_NUMBER_ICON",
+ "DOLLAR",
+ "DESCRIPTION",
+ "EMAIL",
+ "EVENT_PERFORMER",
+ "EVENT_SEAT",
+ "FLIGHT_ARRIVAL",
+ "FLIGHT_DEPARTURE",
+ "HOTEL",
+ "HOTEL_ROOM_TYPE",
+ "INVITE",
+ "MAP_PIN",
+ "MEMBERSHIP",
+ "MULTIPLE_PEOPLE",
+ "OFFER",
+ "PERSON",
+ "PHONE",
+ "RESTAURANT_ICON",
+ "SHOPPING_CART",
+ "STAR",
+ "STORE",
+ "TICKET",
+ "TRAIN",
+ "VIDEO_CAMERA",
+ "VIDEO_PLAY"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "iconUrl": {
+ "description": "The icon specified by a URL.",
+ "type": "string"
+ },
+ "onClick": {
+ "$ref": "OnClick",
+ "description": "The onclick action. Only the top label, bottom label and content region\nare clickable."
+ },
+ "topLabel": {
+ "description": "The text of the top label. Formatted text supported.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListMembershipsResponse": {
+ "id": "ListMembershipsResponse",
+ "properties": {
+ "memberships": {
+ "description": "List of memberships in the requested (or first) page.",
+ "items": {
+ "$ref": "Membership"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token to retrieve the next page of results. It will be empty\nfor the last page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListSpacesResponse": {
+ "id": "ListSpacesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token to retrieve the next page of results. It will be empty\nfor the last page of results. Tokens expire in an hour. An error is thrown\nif an expired token is passed.",
+ "type": "string"
+ },
+ "spaces": {
+ "description": "List of spaces in the requested (or first) page.",
+ "items": {
+ "$ref": "Space"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Membership": {
+ "description": "Represents a membership relation in Hangouts Chat.",
+ "id": "Membership",
+ "properties": {
+ "createTime": {
+ "description": "The creation time of the membership a.k.a the time at which the member\njoined the space, if applicable.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "member": {
+ "$ref": "User",
+ "description": "Member details."
+ },
+ "name": {
+ "description": "Resource name of the membership, in the form \"spaces/*/members/*\".\n\nExample: spaces/AAAAMpdlehY/members/105115627578887013105",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of the membership.",
+ "enum": [
+ "MEMBERSHIP_STATE_UNSPECIFIED",
+ "JOINED",
+ "INVITED",
+ "NOT_A_MEMBER"
+ ],
+ "enumDescriptions": [
+ "Default, do not use.",
+ "The user has joined the space.",
+ "The user has been invited, is able to join the space, but currently has\nnot joined.",
+ "The user is not a member of the space, has not been invited and is not\nable to join the space."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Message": {
+ "description": "A message in Hangouts Chat.",
+ "id": "Message",
+ "properties": {
+ "actionResponse": {
+ "$ref": "ActionResponse",
+ "description": "Input only. Parameters that a bot can use to configure how its response is\nposted."
+ },
+ "annotations": {
+ "description": "Output only. Annotations associated with the text in this message.",
+ "items": {
+ "$ref": "Annotation"
+ },
+ "type": "array"
+ },
+ "cards": {
+ "description": "Rich, formatted and interactive cards that can be used to display UI\nelements such as: formatted texts, buttons, clickable images. Cards are\nnormally displayed below the plain-text body of the message.",
+ "items": {
+ "$ref": "Card"
+ },
+ "type": "array"
+ },
+ "createTime": {
+ "description": "Output only. The time at which the message was created in Hangouts Chat\nserver.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "fallbackText": {
+ "description": "A plain-text description of the message's cards, used when the actual cards\ncannot be displayed (e.g. mobile notifications).",
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name, in the form \"spaces/*/messages/*\".\n\nExample: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4",
+ "type": "string"
+ },
+ "previewText": {
+ "description": "Text for generating preview chips. This text will not be displayed to the\nuser, but any links to images, web pages, videos, etc. included here will\ngenerate preview chips.",
+ "type": "string"
+ },
+ "sender": {
+ "$ref": "User",
+ "description": "The user who created the message."
+ },
+ "space": {
+ "$ref": "Space",
+ "description": "The space the message belongs to."
+ },
+ "text": {
+ "description": "Plain-text body of the message.",
+ "type": "string"
+ },
+ "thread": {
+ "$ref": "Thread",
+ "description": "The thread the message belongs to."
+ }
+ },
+ "type": "object"
+ },
+ "OnClick": {
+ "description": "An onclick action (e.g. open a link).",
+ "id": "OnClick",
+ "properties": {
+ "action": {
+ "$ref": "FormAction",
+ "description": "A form action will be trigger by this onclick if specified."
+ },
+ "openLink": {
+ "$ref": "OpenLink",
+ "description": "This onclick triggers an open link action if specified."
+ }
+ },
+ "type": "object"
+ },
+ "OpenLink": {
+ "description": "A link that opens a new window.",
+ "id": "OpenLink",
+ "properties": {
+ "url": {
+ "description": "The URL to open.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Section": {
+ "description": "A section contains a collection of widgets that are rendered\n(vertically) in the order that they are specified. Across all platforms,\ncards have a narrow fixed width, so\nthere is currently no need for layout properties (e.g. float).",
+ "id": "Section",
+ "properties": {
+ "header": {
+ "description": "The header of the section, text formatted supported.",
+ "type": "string"
+ },
+ "widgets": {
+ "description": "A section must contain at least 1 widget.",
+ "items": {
+ "$ref": "WidgetMarkup"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Space": {
+ "description": "A room or DM in Hangouts Chat.",
+ "id": "Space",
+ "properties": {
+ "displayName": {
+ "description": "Output only. The display name (only if the space is a room).",
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name of the space, in the form \"spaces/*\".\n\nExample: spaces/AAAAMpdlehYs",
+ "type": "string"
+ },
+ "type": {
+ "description": "Output only. The type of a space.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "ROOM",
+ "DM"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TextButton": {
+ "description": "A button with text and onclick action.",
+ "id": "TextButton",
+ "properties": {
+ "onClick": {
+ "$ref": "OnClick",
+ "description": "The onclick action of the button."
+ },
+ "text": {
+ "description": "The text of the button.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TextParagraph": {
+ "description": "A paragraph of text. Formatted text supported.",
+ "id": "TextParagraph",
+ "properties": {
+ "text": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Thread": {
+ "description": "A thread in Hangouts Chat.",
+ "id": "Thread",
+ "properties": {
+ "name": {
+ "description": "Resource name, in the form \"spaces/*/threads/*\".\n\nExample: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "User": {
+ "description": "A user in Hangouts Chat.",
+ "id": "User",
+ "properties": {
+ "displayName": {
+ "description": "The user's display name.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name, in the format \"users/*\".",
+ "type": "string"
+ },
+ "type": {
+ "description": "User type.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "HUMAN",
+ "BOT"
+ ],
+ "enumDescriptions": [
+ "Default value for the enum. DO NOT USE.",
+ "Human user.",
+ "Bot user."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserMentionMetadata": {
+ "description": "Annotation metadata for user mentions (@).",
+ "id": "UserMentionMetadata",
+ "properties": {
+ "type": {
+ "description": "The type of user mention.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "ADD",
+ "MENTION"
+ ],
+ "enumDescriptions": [
+ "Default value for the enum. DO NOT USE.",
+ "Add user to space.",
+ "Mention user in space."
+ ],
+ "type": "string"
+ },
+ "user": {
+ "$ref": "User",
+ "description": "The user mentioned."
+ }
+ },
+ "type": "object"
+ },
+ "WidgetMarkup": {
+ "description": "A widget is a UI element that presents texts, images, etc.",
+ "id": "WidgetMarkup",
+ "properties": {
+ "buttons": {
+ "description": "A list of buttons. Buttons is also oneof data and only one of these\nfields should be set.",
+ "items": {
+ "$ref": "Button"
+ },
+ "type": "array"
+ },
+ "image": {
+ "$ref": "Image",
+ "description": "Display an image in this widget."
+ },
+ "keyValue": {
+ "$ref": "KeyValue",
+ "description": "Display a key value item in this widget."
+ },
+ "textParagraph": {
+ "$ref": "TextParagraph",
+ "description": "Display a text paragraph in this widget."
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Hangouts Chat API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/chat/v1/chat-gen.go b/vendor/google.golang.org/api/chat/v1/chat-gen.go
new file mode 100644
index 000000000..cedf8991f
--- /dev/null
+++ b/vendor/google.golang.org/api/chat/v1/chat-gen.go
@@ -0,0 +1,2408 @@
+// Package chat provides access to the Hangouts Chat API.
+//
+// See https://developers.google.com/hangouts/chat
+//
+// Usage example:
+//
+// import "google.golang.org/api/chat/v1"
+// ...
+// chatService, err := chat.New(oauthHttpClient)
+package chat // import "google.golang.org/api/chat/v1"
+
+import (
+ "bytes"
+ "encoding/json"
+ "errors"
+ "fmt"
+ context "golang.org/x/net/context"
+ ctxhttp "golang.org/x/net/context/ctxhttp"
+ gensupport "google.golang.org/api/gensupport"
+ googleapi "google.golang.org/api/googleapi"
+ "io"
+ "net/http"
+ "net/url"
+ "strconv"
+ "strings"
+)
+
+// Always reference these packages, just in case the auto-generated code
+// below doesn't.
+var _ = bytes.NewBuffer
+var _ = strconv.Itoa
+var _ = fmt.Sprintf
+var _ = json.NewDecoder
+var _ = io.Copy
+var _ = url.Parse
+var _ = gensupport.MarshalJSON
+var _ = googleapi.Version
+var _ = errors.New
+var _ = strings.Replace
+var _ = context.Canceled
+var _ = ctxhttp.Do
+
+const apiId = "chat:v1"
+const apiName = "chat"
+const apiVersion = "v1"
+const basePath = "https://chat.googleapis.com/"
+
+func New(client *http.Client) (*Service, error) {
+ if client == nil {
+ return nil, errors.New("client is nil")
+ }
+ s := &Service{client: client, BasePath: basePath}
+ s.Spaces = NewSpacesService(s)
+ return s, nil
+}
+
+type Service struct {
+ client *http.Client
+ BasePath string // API endpoint base URL
+ UserAgent string // optional additional User-Agent fragment
+
+ Spaces *SpacesService
+}
+
+func (s *Service) userAgent() string {
+ if s.UserAgent == "" {
+ return googleapi.UserAgent
+ }
+ return googleapi.UserAgent + " " + s.UserAgent
+}
+
+func NewSpacesService(s *Service) *SpacesService {
+ rs := &SpacesService{s: s}
+ rs.Members = NewSpacesMembersService(s)
+ rs.Messages = NewSpacesMessagesService(s)
+ return rs
+}
+
+type SpacesService struct {
+ s *Service
+
+ Members *SpacesMembersService
+
+ Messages *SpacesMessagesService
+}
+
+func NewSpacesMembersService(s *Service) *SpacesMembersService {
+ rs := &SpacesMembersService{s: s}
+ return rs
+}
+
+type SpacesMembersService struct {
+ s *Service
+}
+
+func NewSpacesMessagesService(s *Service) *SpacesMessagesService {
+ rs := &SpacesMessagesService{s: s}
+ return rs
+}
+
+type SpacesMessagesService struct {
+ s *Service
+}
+
+// ActionParameter: 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.
+type ActionParameter struct {
+ // Key: The name of the parameter for the action script.
+ Key string `json:"key,omitempty"`
+
+ // Value: The value of the parameter.
+ Value string `json:"value,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Key") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Key") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ActionParameter) MarshalJSON() ([]byte, error) {
+ type NoMethod ActionParameter
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ActionResponse: Parameters that a bot can use to configure how it's
+// response is posted.
+type ActionResponse struct {
+ // Type: The type of bot response.
+ //
+ // Possible values:
+ // "TYPE_UNSPECIFIED" - Default type; will be handled as NEW_MESSAGE.
+ // "NEW_MESSAGE" - Post as a new message in the topic.
+ // "UPDATE_MESSAGE" - Update the bot's own message. (Only after
+ // CARD_CLICKED events.)
+ // "REQUEST_CONFIG" - Privately ask the user for additional auth or
+ // config.
+ Type string `json:"type,omitempty"`
+
+ // Url: URL for users to auth or config. (Only for REQUEST_CONFIG
+ // response types.)
+ Url string `json:"url,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Type") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Type") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ActionResponse) MarshalJSON() ([]byte, error) {
+ type NoMethod ActionResponse
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Annotation: 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"
+// }
+// }]
+// ```
+type Annotation struct {
+ // Length: Length of the substring in the plain-text message body this
+ // annotation
+ // corresponds to.
+ Length int64 `json:"length,omitempty"`
+
+ // StartIndex: Start index (0-based, inclusive) in the plain-text
+ // message body this
+ // annotation corresponds to.
+ StartIndex int64 `json:"startIndex,omitempty"`
+
+ // Type: The type of this annotation.
+ //
+ // Possible values:
+ // "ANNOTATION_TYPE_UNSPECIFIED" - Default value for the enum. DO NOT
+ // USE.
+ // "USER_MENTION" - A user is mentioned.
+ Type string `json:"type,omitempty"`
+
+ // UserMention: The metadata of user mention.
+ UserMention *UserMentionMetadata `json:"userMention,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Length") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Length") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Annotation) MarshalJSON() ([]byte, error) {
+ type NoMethod Annotation
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Button: A button. Can be a text button or an image button.
+type Button struct {
+ // ImageButton: A button with image and onclick action.
+ ImageButton *ImageButton `json:"imageButton,omitempty"`
+
+ // TextButton: A button with text and onclick action.
+ TextButton *TextButton `json:"textButton,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ImageButton") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "ImageButton") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Button) MarshalJSON() ([]byte, error) {
+ type NoMethod Button
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Card: A card is a UI element that can contain UI widgets such as
+// texts, images.
+type Card struct {
+ // CardActions: The actions of this card.
+ CardActions []*CardAction `json:"cardActions,omitempty"`
+
+ // Header: The header of the card. A header usually contains a title and
+ // an image.
+ Header *CardHeader `json:"header,omitempty"`
+
+ // Name: Name of the card.
+ Name string `json:"name,omitempty"`
+
+ // Sections: Sections are separated by a line divider.
+ Sections []*Section `json:"sections,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CardActions") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "CardActions") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Card) MarshalJSON() ([]byte, error) {
+ type NoMethod Card
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CardAction: 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.
+type CardAction struct {
+ // ActionLabel: The label used to be displayed in the action menu item.
+ ActionLabel string `json:"actionLabel,omitempty"`
+
+ // OnClick: The onclick action for this action item.
+ OnClick *OnClick `json:"onClick,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ActionLabel") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "ActionLabel") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *CardAction) MarshalJSON() ([]byte, error) {
+ type NoMethod CardAction
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type CardHeader struct {
+ // ImageStyle: The image's type (e.g. square border or circular border).
+ //
+ // Possible values:
+ // "IMAGE_STYLE_UNSPECIFIED"
+ // "IMAGE" - Square border.
+ // "AVATAR" - Circular border.
+ ImageStyle string `json:"imageStyle,omitempty"`
+
+ // ImageUrl: The URL of the image in the card header.
+ ImageUrl string `json:"imageUrl,omitempty"`
+
+ // Subtitle: The subtitle of the card header.
+ Subtitle string `json:"subtitle,omitempty"`
+
+ // Title: 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 `json:"title,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ImageStyle") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "ImageStyle") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *CardHeader) MarshalJSON() ([]byte, error) {
+ type NoMethod CardHeader
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Empty: 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 `{}`.
+type Empty struct {
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+}
+
+// FormAction: A form action describes the behavior when the form is
+// submitted.
+// For example, an Apps Script can be invoked to handle the form.
+type FormAction struct {
+ // ActionMethodName: Apps Script function to invoke when the containing
+ // element is
+ // clicked/activated.
+ ActionMethodName string `json:"actionMethodName,omitempty"`
+
+ // Parameters: List of action parameters.
+ Parameters []*ActionParameter `json:"parameters,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ActionMethodName") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "ActionMethodName") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *FormAction) MarshalJSON() ([]byte, error) {
+ type NoMethod FormAction
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Image: An image that is specified by a URL and can have an onclick
+// action.
+type Image struct {
+ // AspectRatio: The aspect ratio of this image (width/height).
+ AspectRatio float64 `json:"aspectRatio,omitempty"`
+
+ // ImageUrl: The URL of the image.
+ ImageUrl string `json:"imageUrl,omitempty"`
+
+ // OnClick: The onclick action.
+ OnClick *OnClick `json:"onClick,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AspectRatio") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "AspectRatio") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Image) MarshalJSON() ([]byte, error) {
+ type NoMethod Image
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+func (s *Image) UnmarshalJSON(data []byte) error {
+ type NoMethod Image
+ var s1 struct {
+ AspectRatio gensupport.JSONFloat64 `json:"aspectRatio"`
+ *NoMethod
+ }
+ s1.NoMethod = (*NoMethod)(s)
+ if err := json.Unmarshal(data, &s1); err != nil {
+ return err
+ }
+ s.AspectRatio = float64(s1.AspectRatio)
+ return nil
+}
+
+// ImageButton: An image button with an onclick action.
+type ImageButton struct {
+ // Icon: The icon specified by an enum that indices to an icon provided
+ // by Chat
+ // API.
+ //
+ // Possible values:
+ // "ICON_UNSPECIFIED"
+ // "AIRPLANE"
+ // "BOOKMARK"
+ // "BUS"
+ // "CAR"
+ // "CLOCK"
+ // "CONFIRMATION_NUMBER_ICON"
+ // "DOLLAR"
+ // "DESCRIPTION"
+ // "EMAIL"
+ // "EVENT_PERFORMER"
+ // "EVENT_SEAT"
+ // "FLIGHT_ARRIVAL"
+ // "FLIGHT_DEPARTURE"
+ // "HOTEL"
+ // "HOTEL_ROOM_TYPE"
+ // "INVITE"
+ // "MAP_PIN"
+ // "MEMBERSHIP"
+ // "MULTIPLE_PEOPLE"
+ // "OFFER"
+ // "PERSON"
+ // "PHONE"
+ // "RESTAURANT_ICON"
+ // "SHOPPING_CART"
+ // "STAR"
+ // "STORE"
+ // "TICKET"
+ // "TRAIN"
+ // "VIDEO_CAMERA"
+ // "VIDEO_PLAY"
+ Icon string `json:"icon,omitempty"`
+
+ // IconUrl: The icon specified by a URL.
+ IconUrl string `json:"iconUrl,omitempty"`
+
+ // Name: The name of this image_button which will be used for
+ // accessibility.
+ // Default value will be provided if developers don't specify.
+ Name string `json:"name,omitempty"`
+
+ // OnClick: The onclick action.
+ OnClick *OnClick `json:"onClick,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Icon") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Icon") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ImageButton) MarshalJSON() ([]byte, error) {
+ type NoMethod ImageButton
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// KeyValue: A UI element contains a key (label) and a value (content).
+// And this
+// element may also contain some actions such as onclick button.
+type KeyValue struct {
+ // BottomLabel: The text of the bottom label. Formatted text supported.
+ BottomLabel string `json:"bottomLabel,omitempty"`
+
+ // Button: A button that can be clicked to trigger an action.
+ Button *Button `json:"button,omitempty"`
+
+ // Content: The text of the content. Formatted text supported and always
+ // required.
+ Content string `json:"content,omitempty"`
+
+ // ContentMultiline: If the content should be multiline.
+ ContentMultiline bool `json:"contentMultiline,omitempty"`
+
+ // Icon: An enum value that will be replaced by the Chat API with
+ // the
+ // corresponding icon image.
+ //
+ // Possible values:
+ // "ICON_UNSPECIFIED"
+ // "AIRPLANE"
+ // "BOOKMARK"
+ // "BUS"
+ // "CAR"
+ // "CLOCK"
+ // "CONFIRMATION_NUMBER_ICON"
+ // "DOLLAR"
+ // "DESCRIPTION"
+ // "EMAIL"
+ // "EVENT_PERFORMER"
+ // "EVENT_SEAT"
+ // "FLIGHT_ARRIVAL"
+ // "FLIGHT_DEPARTURE"
+ // "HOTEL"
+ // "HOTEL_ROOM_TYPE"
+ // "INVITE"
+ // "MAP_PIN"
+ // "MEMBERSHIP"
+ // "MULTIPLE_PEOPLE"
+ // "OFFER"
+ // "PERSON"
+ // "PHONE"
+ // "RESTAURANT_ICON"
+ // "SHOPPING_CART"
+ // "STAR"
+ // "STORE"
+ // "TICKET"
+ // "TRAIN"
+ // "VIDEO_CAMERA"
+ // "VIDEO_PLAY"
+ Icon string `json:"icon,omitempty"`
+
+ // IconUrl: The icon specified by a URL.
+ IconUrl string `json:"iconUrl,omitempty"`
+
+ // OnClick: The onclick action. Only the top label, bottom label and
+ // content region
+ // are clickable.
+ OnClick *OnClick `json:"onClick,omitempty"`
+
+ // TopLabel: The text of the top label. Formatted text supported.
+ TopLabel string `json:"topLabel,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "BottomLabel") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "BottomLabel") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *KeyValue) MarshalJSON() ([]byte, error) {
+ type NoMethod KeyValue
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type ListMembershipsResponse struct {
+ // Memberships: List of memberships in the requested (or first) page.
+ Memberships []*Membership `json:"memberships,omitempty"`
+
+ // NextPageToken: Continuation token to retrieve the next page of
+ // results. It will be empty
+ // for the last page of results.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Memberships") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Memberships") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ListMembershipsResponse) MarshalJSON() ([]byte, error) {
+ type NoMethod ListMembershipsResponse
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type ListSpacesResponse struct {
+ // NextPageToken: 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 `json:"nextPageToken,omitempty"`
+
+ // Spaces: List of spaces in the requested (or first) page.
+ Spaces []*Space `json:"spaces,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "NextPageToken") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "NextPageToken") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ListSpacesResponse) MarshalJSON() ([]byte, error) {
+ type NoMethod ListSpacesResponse
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Membership: Represents a membership relation in Hangouts Chat.
+type Membership struct {
+ // CreateTime: The creation time of the membership a.k.a the time at
+ // which the member
+ // joined the space, if applicable.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // Member: Member details.
+ Member *User `json:"member,omitempty"`
+
+ // Name: Resource name of the membership, in the form
+ // "spaces/*/members/*".
+ //
+ // Example: spaces/AAAAMpdlehY/members/105115627578887013105
+ Name string `json:"name,omitempty"`
+
+ // State: State of the membership.
+ //
+ // Possible values:
+ // "MEMBERSHIP_STATE_UNSPECIFIED" - Default, do not use.
+ // "JOINED" - The user has joined the space.
+ // "INVITED" - The user has been invited, is able to join the space,
+ // but currently has
+ // not joined.
+ // "NOT_A_MEMBER" - The user is not a member of the space, has not
+ // been invited and is not
+ // able to join the space.
+ State string `json:"state,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "CreateTime") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Membership) MarshalJSON() ([]byte, error) {
+ type NoMethod Membership
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Message: A message in Hangouts Chat.
+type Message struct {
+ // ActionResponse: Input only. Parameters that a bot can use to
+ // configure how its response is
+ // posted.
+ ActionResponse *ActionResponse `json:"actionResponse,omitempty"`
+
+ // Annotations: Output only. Annotations associated with the text in
+ // this message.
+ Annotations []*Annotation `json:"annotations,omitempty"`
+
+ // Cards: 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 []*Card `json:"cards,omitempty"`
+
+ // CreateTime: Output only. The time at which the message was created in
+ // Hangouts Chat
+ // server.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // FallbackText: A plain-text description of the message's cards, used
+ // when the actual cards
+ // cannot be displayed (e.g. mobile notifications).
+ FallbackText string `json:"fallbackText,omitempty"`
+
+ // Name: Resource name, in the form "spaces/*/messages/*".
+ //
+ // Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ Name string `json:"name,omitempty"`
+
+ // PreviewText: 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 `json:"previewText,omitempty"`
+
+ // Sender: The user who created the message.
+ Sender *User `json:"sender,omitempty"`
+
+ // Space: The space the message belongs to.
+ Space *Space `json:"space,omitempty"`
+
+ // Text: Plain-text body of the message.
+ Text string `json:"text,omitempty"`
+
+ // Thread: The thread the message belongs to.
+ Thread *Thread `json:"thread,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "ActionResponse") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "ActionResponse") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Message) MarshalJSON() ([]byte, error) {
+ type NoMethod Message
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// OnClick: An onclick action (e.g. open a link).
+type OnClick struct {
+ // Action: A form action will be trigger by this onclick if specified.
+ Action *FormAction `json:"action,omitempty"`
+
+ // OpenLink: This onclick triggers an open link action if specified.
+ OpenLink *OpenLink `json:"openLink,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Action") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Action") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *OnClick) MarshalJSON() ([]byte, error) {
+ type NoMethod OnClick
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// OpenLink: A link that opens a new window.
+type OpenLink struct {
+ // Url: The URL to open.
+ Url string `json:"url,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Url") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Url") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *OpenLink) MarshalJSON() ([]byte, error) {
+ type NoMethod OpenLink
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Section: 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).
+type Section struct {
+ // Header: The header of the section, text formatted supported.
+ Header string `json:"header,omitempty"`
+
+ // Widgets: A section must contain at least 1 widget.
+ Widgets []*WidgetMarkup `json:"widgets,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Header") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Header") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Section) MarshalJSON() ([]byte, error) {
+ type NoMethod Section
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Space: A room or DM in Hangouts Chat.
+type Space struct {
+ // DisplayName: Output only. The display name (only if the space is a
+ // room).
+ DisplayName string `json:"displayName,omitempty"`
+
+ // Name: Resource name of the space, in the form "spaces/*".
+ //
+ // Example: spaces/AAAAMpdlehYs
+ Name string `json:"name,omitempty"`
+
+ // Type: Output only. The type of a space.
+ //
+ // Possible values:
+ // "TYPE_UNSPECIFIED"
+ // "ROOM"
+ // "DM"
+ Type string `json:"type,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Space) MarshalJSON() ([]byte, error) {
+ type NoMethod Space
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TextButton: A button with text and onclick action.
+type TextButton struct {
+ // OnClick: The onclick action of the button.
+ OnClick *OnClick `json:"onClick,omitempty"`
+
+ // Text: The text of the button.
+ Text string `json:"text,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "OnClick") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "OnClick") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *TextButton) MarshalJSON() ([]byte, error) {
+ type NoMethod TextButton
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TextParagraph: A paragraph of text. Formatted text supported.
+type TextParagraph struct {
+ Text string `json:"text,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Text") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Text") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *TextParagraph) MarshalJSON() ([]byte, error) {
+ type NoMethod TextParagraph
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Thread: A thread in Hangouts Chat.
+type Thread struct {
+ // Name: Resource name, in the form "spaces/*/threads/*".
+ //
+ // Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
+ Name string `json:"name,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Name") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Name") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Thread) MarshalJSON() ([]byte, error) {
+ type NoMethod Thread
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// User: A user in Hangouts Chat.
+type User struct {
+ // DisplayName: The user's display name.
+ DisplayName string `json:"displayName,omitempty"`
+
+ // Name: Resource name, in the format "users/*".
+ Name string `json:"name,omitempty"`
+
+ // Type: User type.
+ //
+ // Possible values:
+ // "TYPE_UNSPECIFIED" - Default value for the enum. DO NOT USE.
+ // "HUMAN" - Human user.
+ // "BOT" - Bot user.
+ Type string `json:"type,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *User) MarshalJSON() ([]byte, error) {
+ type NoMethod User
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// UserMentionMetadata: Annotation metadata for user mentions (@).
+type UserMentionMetadata struct {
+ // Type: The type of user mention.
+ //
+ // Possible values:
+ // "TYPE_UNSPECIFIED" - Default value for the enum. DO NOT USE.
+ // "ADD" - Add user to space.
+ // "MENTION" - Mention user in space.
+ Type string `json:"type,omitempty"`
+
+ // User: The user mentioned.
+ User *User `json:"user,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Type") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Type") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *UserMentionMetadata) MarshalJSON() ([]byte, error) {
+ type NoMethod UserMentionMetadata
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// WidgetMarkup: A widget is a UI element that presents texts, images,
+// etc.
+type WidgetMarkup struct {
+ // Buttons: A list of buttons. Buttons is also oneof data and only one
+ // of these
+ // fields should be set.
+ Buttons []*Button `json:"buttons,omitempty"`
+
+ // Image: Display an image in this widget.
+ Image *Image `json:"image,omitempty"`
+
+ // KeyValue: Display a key value item in this widget.
+ KeyValue *KeyValue `json:"keyValue,omitempty"`
+
+ // TextParagraph: Display a text paragraph in this widget.
+ TextParagraph *TextParagraph `json:"textParagraph,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Buttons") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Buttons") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *WidgetMarkup) MarshalJSON() ([]byte, error) {
+ type NoMethod WidgetMarkup
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// method id "chat.spaces.get":
+
+type SpacesGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Returns a space.
+func (r *SpacesService) Get(name string) *SpacesGetCall {
+ c := &SpacesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *SpacesGetCall) Fields(s ...googleapi.Field) *SpacesGetCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *SpacesGetCall) IfNoneMatch(entityTag string) *SpacesGetCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *SpacesGetCall) Context(ctx context.Context) *SpacesGetCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *SpacesGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SpacesGetCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "chat.spaces.get" call.
+// Exactly one of *Space or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Space.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *SpacesGetCall) Do(opts ...googleapi.CallOption) (*Space, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Space{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Returns a space.",
+ // "flatPath": "v1/spaces/{spacesId}",
+ // "httpMethod": "GET",
+ // "id": "chat.spaces.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. Resource name of the space, in the form \"spaces/*\".\n\nExample: spaces/AAAAMpdlehY",
+ // "location": "path",
+ // "pattern": "^spaces/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "Space"
+ // }
+ // }
+
+}
+
+// method id "chat.spaces.list":
+
+type SpacesListCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists spaces the caller is a member of.
+func (r *SpacesService) List() *SpacesListCall {
+ c := &SpacesListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": Requested page size.
+// The value is capped at 1000.
+// Server may return fewer results than requested.
+// If unspecified, server will default to 100.
+func (c *SpacesListCall) PageSize(pageSize int64) *SpacesListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": A token
+// identifying a page of results the server should return.
+func (c *SpacesListCall) PageToken(pageToken string) *SpacesListCall {
+ c.urlParams_.Set("pageToken", pageToken)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *SpacesListCall) Fields(s ...googleapi.Field) *SpacesListCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *SpacesListCall) IfNoneMatch(entityTag string) *SpacesListCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *SpacesListCall) Context(ctx context.Context) *SpacesListCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *SpacesListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SpacesListCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/spaces")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "chat.spaces.list" call.
+// Exactly one of *ListSpacesResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListSpacesResponse.ServerResponse.Header or (if a response was
+// returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *SpacesListCall) Do(opts ...googleapi.CallOption) (*ListSpacesResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &ListSpacesResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Lists spaces the caller is a member of.",
+ // "flatPath": "v1/spaces",
+ // "httpMethod": "GET",
+ // "id": "chat.spaces.list",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "Requested page size. The value is capped at 1000.\nServer may return fewer results than requested.\nIf unspecified, server will default to 100.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "A token identifying a page of results the server should return.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/spaces",
+ // "response": {
+ // "$ref": "ListSpacesResponse"
+ // }
+ // }
+
+}
+
+// Pages invokes f for each page of results.
+// A non-nil error returned from f will halt the iteration.
+// The provided context supersedes any context provided to the Context method.
+func (c *SpacesListCall) Pages(ctx context.Context, f func(*ListSpacesResponse) error) error {
+ c.ctx_ = ctx
+ defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point
+ for {
+ x, err := c.Do()
+ if err != nil {
+ return err
+ }
+ if err := f(x); err != nil {
+ return err
+ }
+ if x.NextPageToken == "" {
+ return nil
+ }
+ c.PageToken(x.NextPageToken)
+ }
+}
+
+// method id "chat.spaces.members.get":
+
+type SpacesMembersGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Returns a membership.
+func (r *SpacesMembersService) Get(name string) *SpacesMembersGetCall {
+ c := &SpacesMembersGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *SpacesMembersGetCall) Fields(s ...googleapi.Field) *SpacesMembersGetCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *SpacesMembersGetCall) IfNoneMatch(entityTag string) *SpacesMembersGetCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *SpacesMembersGetCall) Context(ctx context.Context) *SpacesMembersGetCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *SpacesMembersGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SpacesMembersGetCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "chat.spaces.members.get" call.
+// Exactly one of *Membership or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Membership.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *SpacesMembersGetCall) Do(opts ...googleapi.CallOption) (*Membership, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Membership{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Returns a membership.",
+ // "flatPath": "v1/spaces/{spacesId}/members/{membersId}",
+ // "httpMethod": "GET",
+ // "id": "chat.spaces.members.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. Resource name of the membership to be retrieved, in the form\n\"spaces/*/members/*\".\n\nExample: spaces/AAAAMpdlehY/members/105115627578887013105",
+ // "location": "path",
+ // "pattern": "^spaces/[^/]+/members/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "Membership"
+ // }
+ // }
+
+}
+
+// method id "chat.spaces.members.list":
+
+type SpacesMembersListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists human memberships in a space.
+func (r *SpacesMembersService) List(parent string) *SpacesMembersListCall {
+ c := &SpacesMembersListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": Requested page size.
+// The value is capped at 1000.
+// Server may return fewer results than requested.
+// If unspecified, server will default to 100.
+func (c *SpacesMembersListCall) PageSize(pageSize int64) *SpacesMembersListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": A token
+// identifying a page of results the server should return.
+func (c *SpacesMembersListCall) PageToken(pageToken string) *SpacesMembersListCall {
+ c.urlParams_.Set("pageToken", pageToken)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *SpacesMembersListCall) Fields(s ...googleapi.Field) *SpacesMembersListCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *SpacesMembersListCall) IfNoneMatch(entityTag string) *SpacesMembersListCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *SpacesMembersListCall) Context(ctx context.Context) *SpacesMembersListCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *SpacesMembersListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SpacesMembersListCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/members")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "chat.spaces.members.list" call.
+// Exactly one of *ListMembershipsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListMembershipsResponse.ServerResponse.Header or (if a response was
+// returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *SpacesMembersListCall) Do(opts ...googleapi.CallOption) (*ListMembershipsResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &ListMembershipsResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Lists human memberships in a space.",
+ // "flatPath": "v1/spaces/{spacesId}/members",
+ // "httpMethod": "GET",
+ // "id": "chat.spaces.members.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "Requested page size. The value is capped at 1000.\nServer may return fewer results than requested.\nIf unspecified, server will default to 100.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "A token identifying a page of results the server should return.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "Required. The resource name of the space for which membership list is to be\nfetched, in the form \"spaces/*\".\n\nExample: spaces/AAAAMpdlehY",
+ // "location": "path",
+ // "pattern": "^spaces/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/members",
+ // "response": {
+ // "$ref": "ListMembershipsResponse"
+ // }
+ // }
+
+}
+
+// Pages invokes f for each page of results.
+// A non-nil error returned from f will halt the iteration.
+// The provided context supersedes any context provided to the Context method.
+func (c *SpacesMembersListCall) Pages(ctx context.Context, f func(*ListMembershipsResponse) error) error {
+ c.ctx_ = ctx
+ defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point
+ for {
+ x, err := c.Do()
+ if err != nil {
+ return err
+ }
+ if err := f(x); err != nil {
+ return err
+ }
+ if x.NextPageToken == "" {
+ return nil
+ }
+ c.PageToken(x.NextPageToken)
+ }
+}
+
+// method id "chat.spaces.messages.create":
+
+type SpacesMessagesCreateCall struct {
+ s *Service
+ parent string
+ message *Message
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a message.
+func (r *SpacesMessagesService) Create(parent string, message *Message) *SpacesMessagesCreateCall {
+ c := &SpacesMessagesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.message = message
+ return c
+}
+
+// ThreadKey sets the optional parameter "threadKey": 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.
+func (c *SpacesMessagesCreateCall) ThreadKey(threadKey string) *SpacesMessagesCreateCall {
+ c.urlParams_.Set("threadKey", threadKey)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *SpacesMessagesCreateCall) Fields(s ...googleapi.Field) *SpacesMessagesCreateCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *SpacesMessagesCreateCall) Context(ctx context.Context) *SpacesMessagesCreateCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *SpacesMessagesCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SpacesMessagesCreateCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.message)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/messages")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "chat.spaces.messages.create" call.
+// Exactly one of *Message or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Message.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *SpacesMessagesCreateCall) Do(opts ...googleapi.CallOption) (*Message, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Message{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Creates a message.",
+ // "flatPath": "v1/spaces/{spacesId}/messages",
+ // "httpMethod": "POST",
+ // "id": "chat.spaces.messages.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "Required. Space resource name, in the form \"spaces/*\".\nExample: spaces/AAAAMpdlehY",
+ // "location": "path",
+ // "pattern": "^spaces/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "threadKey": {
+ // "description": "Opaque thread identifier string that can be specified to group messages\ninto a single thread. If this is the first message with a given thread\nidentifier, a new thread is created. Subsequent messages with the same\nthread identifier will be posted into the same thread. This relieves bots\nand webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post\nfurther updates to it.\n\nHas no effect if thread field,\ncorresponding to an existing thread, is set in message.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/messages",
+ // "request": {
+ // "$ref": "Message"
+ // },
+ // "response": {
+ // "$ref": "Message"
+ // }
+ // }
+
+}
+
+// method id "chat.spaces.messages.delete":
+
+type SpacesMessagesDeleteCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes a message.
+func (r *SpacesMessagesService) Delete(name string) *SpacesMessagesDeleteCall {
+ c := &SpacesMessagesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *SpacesMessagesDeleteCall) Fields(s ...googleapi.Field) *SpacesMessagesDeleteCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *SpacesMessagesDeleteCall) Context(ctx context.Context) *SpacesMessagesDeleteCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *SpacesMessagesDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SpacesMessagesDeleteCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "chat.spaces.messages.delete" call.
+// Exactly one of *Empty or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Empty.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *SpacesMessagesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Empty{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Deletes a message.",
+ // "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
+ // "httpMethod": "DELETE",
+ // "id": "chat.spaces.messages.delete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. Resource name of the message to be deleted, in the form\n\"spaces/*/messages/*\"\n\nExample: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4",
+ // "location": "path",
+ // "pattern": "^spaces/[^/]+/messages/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "Empty"
+ // }
+ // }
+
+}
+
+// method id "chat.spaces.messages.get":
+
+type SpacesMessagesGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Returns a message.
+func (r *SpacesMessagesService) Get(name string) *SpacesMessagesGetCall {
+ c := &SpacesMessagesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *SpacesMessagesGetCall) Fields(s ...googleapi.Field) *SpacesMessagesGetCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *SpacesMessagesGetCall) IfNoneMatch(entityTag string) *SpacesMessagesGetCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *SpacesMessagesGetCall) Context(ctx context.Context) *SpacesMessagesGetCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *SpacesMessagesGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SpacesMessagesGetCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "chat.spaces.messages.get" call.
+// Exactly one of *Message or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Message.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *SpacesMessagesGetCall) Do(opts ...googleapi.CallOption) (*Message, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Message{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Returns a message.",
+ // "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
+ // "httpMethod": "GET",
+ // "id": "chat.spaces.messages.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. Resource name of the message to be retrieved, in the form\n\"spaces/*/messages/*\".\n\nExample: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4",
+ // "location": "path",
+ // "pattern": "^spaces/[^/]+/messages/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "Message"
+ // }
+ // }
+
+}
+
+// method id "chat.spaces.messages.update":
+
+type SpacesMessagesUpdateCall struct {
+ s *Service
+ name string
+ message *Message
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Update: Updates a message.
+func (r *SpacesMessagesService) Update(name string, message *Message) *SpacesMessagesUpdateCall {
+ c := &SpacesMessagesUpdateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.message = message
+ return c
+}
+
+// UpdateMask sets the optional parameter "updateMask": Required. The
+// field paths to be updated.
+//
+// Currently supported field paths: "text", "cards".
+func (c *SpacesMessagesUpdateCall) UpdateMask(updateMask string) *SpacesMessagesUpdateCall {
+ c.urlParams_.Set("updateMask", updateMask)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *SpacesMessagesUpdateCall) Fields(s ...googleapi.Field) *SpacesMessagesUpdateCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *SpacesMessagesUpdateCall) Context(ctx context.Context) *SpacesMessagesUpdateCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *SpacesMessagesUpdateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SpacesMessagesUpdateCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.message)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PUT", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "chat.spaces.messages.update" call.
+// Exactly one of *Message or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Message.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *SpacesMessagesUpdateCall) Do(opts ...googleapi.CallOption) (*Message, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Message{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Updates a message.",
+ // "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
+ // "httpMethod": "PUT",
+ // "id": "chat.spaces.messages.update",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Resource name, in the form \"spaces/*/messages/*\".\n\nExample: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4",
+ // "location": "path",
+ // "pattern": "^spaces/[^/]+/messages/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "updateMask": {
+ // "description": "Required. The field paths to be updated.\n\nCurrently supported field paths: \"text\", \"cards\".",
+ // "format": "google-fieldmask",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "request": {
+ // "$ref": "Message"
+ // },
+ // "response": {
+ // "$ref": "Message"
+ // }
+ // }
+
+}
diff --git a/vendor/google.golang.org/api/civicinfo/v2/civicinfo-api.json b/vendor/google.golang.org/api/civicinfo/v2/civicinfo-api.json
index f09c4eb4c..318f4f430 100644
--- a/vendor/google.golang.org/api/civicinfo/v2/civicinfo-api.json
+++ b/vendor/google.golang.org/api/civicinfo/v2/civicinfo-api.json
@@ -1,1281 +1,1281 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/sNrwy4GBJh0JDl02KcW1-1MdJOM\"",
- "discoveryVersion": "v1",
- "id": "civicinfo:v2",
- "name": "civicinfo",
- "canonicalName": "Civic Info",
- "version": "v2",
- "revision": "20161102",
- "title": "Google Civic Information API",
- "description": "Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
- "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
- },
- "documentationLink": "https://developers.google.com/civic-information",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/civicinfo/v2/",
- "basePath": "/civicinfo/v2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "civicinfo/v2/",
- "batchPath": "batch/civicinfo/v2",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
+ "basePath": "/civicinfo/v2/",
+ "baseUrl": "https://www.googleapis.com/civicinfo/v2/",
+ "batchPath": "batch/civicinfo/v2",
+ "canonicalName": "Civic Info",
+ "description": "Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/civic-information",
+ "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/sNrwy4GBJh0JDl02KcW1-1MdJOM\"",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "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.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "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. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "schemas": {
- "AdministrationRegion": {
- "id": "AdministrationRegion",
- "type": "object",
- "description": "Describes information about a regional election administrative area.",
- "properties": {
- "electionAdministrationBody": {
- "$ref": "AdministrativeBody",
- "description": "The election administration body for this area."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "local_jurisdiction": {
- "$ref": "AdministrationRegion",
- "description": "The city or county that provides election information for this voter. This object can have the same elements as state."
- },
- "name": {
- "type": "string",
- "description": "The name of the jurisdiction."
- },
- "sources": {
- "type": "array",
- "description": "A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.",
- "items": {
- "$ref": "Source"
- }
- }
- }
- },
- "AdministrativeBody": {
- "id": "AdministrativeBody",
- "type": "object",
- "description": "Information about an election administrative body (e.g. County Board of Elections).",
- "properties": {
- "absenteeVotingInfoUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for information on absentee voting."
- },
- "addressLines": {
- "type": "array",
- "items": {
+ "id": "civicinfo:v2",
+ "kind": "discovery#restDescription",
+ "name": "civicinfo",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "alt": {
+ "default": "json",
+ "description": "Data format for the response.",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query",
"type": "string"
- }
},
- "ballotInfoUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body to give contest information to the voter."
- },
- "correspondenceAddress": {
- "$ref": "SimpleAddressType",
- "description": "The mailing address of this administrative body."
- },
- "electionInfoUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for looking up general election information."
- },
- "electionOfficials": {
- "type": "array",
- "description": "The election officials for this election administrative body.",
- "items": {
- "$ref": "ElectionOfficial"
- }
- },
- "electionRegistrationConfirmationUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for confirming that the voter is registered to vote."
- },
- "electionRegistrationUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for looking up how to register to vote."
- },
- "electionRulesUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body describing election rules to the voter."
- },
- "hoursOfOperation": {
- "type": "string",
- "description": "A description of the hours of operation for this administrative body."
- },
- "name": {
- "type": "string",
- "description": "The name of this election administrative body."
- },
- "physicalAddress": {
- "$ref": "SimpleAddressType",
- "description": "The physical address of this administrative body."
- },
- "voter_services": {
- "type": "array",
- "description": "A description of the services this administrative body may provide.",
- "items": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
- }
},
- "votingLocationFinderUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for looking up where to vote."
- }
- }
- },
- "Candidate": {
- "id": "Candidate",
- "type": "object",
- "description": "Information about a candidate running for elected office.",
- "properties": {
- "candidateUrl": {
- "type": "string",
- "description": "The URL for the candidate's campaign web site."
- },
- "channels": {
- "type": "array",
- "description": "A list of known (social) media channels for this candidate.",
- "items": {
- "$ref": "Channel"
- }
- },
- "email": {
- "type": "string",
- "description": "The email address for the candidate's campaign."
- },
- "name": {
- "type": "string",
- "description": "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\""
- },
- "orderOnBallot": {
- "type": "string",
- "description": "The order the candidate appears on the ballot for this contest.",
- "format": "int64"
- },
- "party": {
- "type": "string",
- "description": "The full name of the party the candidate is a member of."
- },
- "phone": {
- "type": "string",
- "description": "The voice phone number for the candidate's campaign office."
- },
- "photoUrl": {
- "type": "string",
- "description": "A URL for a photo of the candidate."
- }
- }
- },
- "Channel": {
- "id": "Channel",
- "type": "object",
- "description": "A social media or web channel for a candidate.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The unique public identifier for the candidate's channel."
- },
- "type": {
- "type": "string",
- "description": "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"
- }
- }
- },
- "Contest": {
- "id": "Contest",
- "type": "object",
- "description": "Information about a contest that appears on a voter's ballot.",
- "properties": {
- "ballotPlacement": {
- "type": "string",
- "description": "A number specifying the position of this contest on the voter's ballot.",
- "format": "int64"
- },
- "candidates": {
- "type": "array",
- "description": "The candidate choices for this contest.",
- "items": {
- "$ref": "Candidate"
- }
- },
- "district": {
- "$ref": "ElectoralDistrict",
- "description": "Information about the electoral district that this contest is in."
- },
- "electorateSpecifications": {
- "type": "string",
- "description": "A description of any additional eligibility requirements for voting in this contest."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "level": {
- "type": "array",
- "description": "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\".",
- "items": {
+ "key": {
+ "description": "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.",
+ "location": "query",
"type": "string"
- }
},
- "numberElected": {
- "type": "string",
- "description": "The number of candidates that will be elected to office in this contest.",
- "format": "int64"
- },
- "numberVotingFor": {
- "type": "string",
- "description": "The number of candidates that a voter may vote for in this contest.",
- "format": "int64"
- },
- "office": {
- "type": "string",
- "description": "The name of the office for this contest."
- },
- "primaryParty": {
- "type": "string",
- "description": "If this is a partisan election, the name of the party it is for."
- },
- "referendumBallotResponses": {
- "type": "array",
- "description": "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'.",
- "items": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
"type": "string"
- }
},
- "referendumBrief": {
- "type": "string",
- "description": "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'."
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
},
- "referendumConStatement": {
- "type": "string",
- "description": "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'."
- },
- "referendumEffectOfAbstain": {
- "type": "string",
- "description": "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'."
- },
- "referendumPassageThreshold": {
- "type": "string",
- "description": "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'."
- },
- "referendumProStatement": {
- "type": "string",
- "description": "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'."
- },
- "referendumSubtitle": {
- "type": "string",
- "description": "A brief description of the referendum. This field is only populated for contests of type 'Referendum'."
- },
- "referendumText": {
- "type": "string",
- "description": "The full text of the referendum. This field is only populated for contests of type 'Referendum'."
- },
- "referendumTitle": {
- "type": "string",
- "description": "The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'."
- },
- "referendumUrl": {
- "type": "string",
- "description": "A link to the referendum. This field is only populated for contests of type 'Referendum'."
- },
- "roles": {
- "type": "array",
- "description": "The roles which this office fulfills.",
- "items": {
+ "quotaUser": {
+ "description": "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. Overrides userIp if both are provided.",
+ "location": "query",
"type": "string"
- }
},
- "sources": {
- "type": "array",
- "description": "A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.",
- "items": {
- "$ref": "Source"
- }
- },
- "special": {
- "type": "string",
- "description": "\"Yes\" or \"No\" depending on whether this a contest being held outside the normal election cycle."
- },
- "type": {
- "type": "string",
- "description": "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'."
- }
- }
- },
- "ContextParams": {
- "id": "ContextParams",
- "type": "object",
- "properties": {
- "clientProfile": {
- "type": "string"
- }
- }
- },
- "DivisionRepresentativeInfoRequest": {
- "id": "DivisionRepresentativeInfoRequest",
- "type": "object",
- "description": "A request to look up representative information for a single division.",
- "properties": {
- "contextParams": {
- "$ref": "ContextParams"
- }
- }
- },
- "DivisionSearchRequest": {
- "id": "DivisionSearchRequest",
- "type": "object",
- "description": "A search request for political geographies.",
- "properties": {
- "contextParams": {
- "$ref": "ContextParams"
- }
- }
- },
- "DivisionSearchResponse": {
- "id": "DivisionSearchResponse",
- "type": "object",
- "description": "The result of a division search query.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#divisionSearchResponse\".",
- "default": "civicinfo#divisionSearchResponse"
- },
- "results": {
- "type": "array",
- "items": {
- "$ref": "DivisionSearchResult"
- }
- }
- }
- },
- "DivisionSearchResult": {
- "id": "DivisionSearchResult",
- "type": "object",
- "description": "Represents a political geographic division that matches the requested query.",
- "properties": {
- "aliases": {
- "type": "array",
- "description": "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.",
- "items": {
+ "userIp": {
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query",
"type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the division."
- },
- "ocdId": {
- "type": "string",
- "description": "The unique Open Civic Data identifier for this division."
}
- }
},
- "Election": {
- "id": "Election",
- "type": "object",
- "description": "Information about the election that was queried.",
- "properties": {
- "electionDay": {
- "type": "string",
- "description": "Day of the election in YYYY-MM-DD format."
+ "protocol": "rest",
+ "resources": {
+ "divisions": {
+ "methods": {
+ "search": {
+ "description": "Searches for political divisions by their natural name or OCD ID.",
+ "httpMethod": "GET",
+ "id": "civicinfo.divisions.search",
+ "parameters": {
+ "query": {
+ "description": "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",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "divisions",
+ "request": {
+ "$ref": "DivisionSearchRequest"
+ },
+ "response": {
+ "$ref": "DivisionSearchResponse"
+ }
+ }
+ }
},
- "id": {
- "type": "string",
- "description": "The unique ID of this election.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "A displayable name for the election."
- },
- "ocdDivisionId": {
- "type": "string",
- "description": "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)."
- }
- }
- },
- "ElectionOfficial": {
- "id": "ElectionOfficial",
- "type": "object",
- "description": "Information about individual election officials.",
- "properties": {
- "emailAddress": {
- "type": "string",
- "description": "The email address of the election official."
- },
- "faxNumber": {
- "type": "string",
- "description": "The fax number of the election official."
- },
- "name": {
- "type": "string",
- "description": "The full name of the election official."
- },
- "officePhoneNumber": {
- "type": "string",
- "description": "The office phone number of the election official."
- },
- "title": {
- "type": "string",
- "description": "The title of the election official."
- }
- }
- },
- "ElectionsQueryRequest": {
- "id": "ElectionsQueryRequest",
- "type": "object",
- "properties": {
- "contextParams": {
- "$ref": "ContextParams"
- }
- }
- },
- "ElectionsQueryResponse": {
- "id": "ElectionsQueryResponse",
- "type": "object",
- "description": "The list of elections available for this version of the API.",
- "properties": {
"elections": {
- "type": "array",
- "description": "A list of available elections",
- "items": {
- "$ref": "Election"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#electionsQueryResponse\".",
- "default": "civicinfo#electionsQueryResponse"
- }
- }
- },
- "ElectoralDistrict": {
- "id": "ElectoralDistrict",
- "type": "object",
- "description": "Describes the geographic scope of a contest.",
- "properties": {
- "id": {
- "type": "string",
- "description": "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."
- },
- "kgForeignKey": {
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The name of the district."
- },
- "scope": {
- "type": "string",
- "description": "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"
- }
- }
- },
- "GeographicDivision": {
- "id": "GeographicDivision",
- "type": "object",
- "description": "Describes a political geography.",
- "properties": {
- "alsoKnownAs": {
- "type": "array",
- "description": "Any other valid OCD IDs that refer to the same division.\n\nBecause 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.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the division."
- },
- "officeIndices": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "integer",
- "format": "uint32"
- }
- }
- }
- },
- "Office": {
- "id": "Office",
- "type": "object",
- "description": "Information about an Office held by one or more Officials.",
- "properties": {
- "divisionId": {
- "type": "string",
- "description": "The OCD ID of the division with which this office is associated."
- },
- "levels": {
- "type": "array",
- "description": "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\".",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The human-readable name of the office."
- },
- "officialIndices": {
- "type": "array",
- "description": "List of indices in the officials array of people who presently hold this office.",
- "items": {
- "type": "integer",
- "format": "uint32"
- }
- },
- "roles": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "sources": {
- "type": "array",
- "description": "A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.",
- "items": {
- "$ref": "Source"
- }
- }
- }
- },
- "Official": {
- "id": "Official",
- "type": "object",
- "description": "Information about a person holding an elected office.",
- "properties": {
- "address": {
- "type": "array",
- "description": "Addresses at which to contact the official.",
- "items": {
- "$ref": "SimpleAddressType"
- }
- },
- "channels": {
- "type": "array",
- "description": "A list of known (social) media channels for this official.",
- "items": {
- "$ref": "Channel"
- }
- },
- "emails": {
- "type": "array",
- "description": "The direct email addresses for the official.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The official's name."
- },
- "party": {
- "type": "string",
- "description": "The full name of the party the official belongs to."
- },
- "phones": {
- "type": "array",
- "description": "The official's public contact phone numbers.",
- "items": {
- "type": "string"
- }
- },
- "photoUrl": {
- "type": "string",
- "description": "A URL for a photo of the official."
- },
- "urls": {
- "type": "array",
- "description": "The official's public website URLs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "PollingLocation": {
- "id": "PollingLocation",
- "type": "object",
- "description": "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.",
- "properties": {
- "address": {
- "$ref": "SimpleAddressType",
- "description": "The address of the location."
- },
- "endDate": {
- "type": "string",
- "description": "The last date that this early vote site or drop off location may be used. This field is not populated for polling locations."
- },
- "id": {
- "type": "string",
- "description": "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."
- },
- "name": {
- "type": "string",
- "description": "The name of the early vote site or drop off location. This field is not populated for polling locations."
- },
- "notes": {
- "type": "string",
- "description": "Notes about this location (e.g. accessibility ramp or entrance to use)."
- },
- "pollingHours": {
- "type": "string",
- "description": "A description of when this location is open."
- },
- "sources": {
- "type": "array",
- "description": "A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.",
- "items": {
- "$ref": "Source"
- }
- },
- "startDate": {
- "type": "string",
- "description": "The first date that this early vote site or drop off location may be used. This field is not populated for polling locations."
- },
- "voterServices": {
- "type": "string",
- "description": "The services provided by this early vote site or drop off location. This field is not populated for polling locations."
- }
- }
- },
- "PostalAddress": {
- "id": "PostalAddress",
- "type": "object",
- "properties": {
- "addressLines": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "administrativeAreaName": {
- "type": "string"
- },
- "countryName": {
- "type": "string"
- },
- "countryNameCode": {
- "type": "string"
- },
- "dependentLocalityName": {
- "type": "string"
- },
- "dependentThoroughfareLeadingType": {
- "type": "string"
- },
- "dependentThoroughfareName": {
- "type": "string"
- },
- "dependentThoroughfarePostDirection": {
- "type": "string"
- },
- "dependentThoroughfarePreDirection": {
- "type": "string"
- },
- "dependentThoroughfareTrailingType": {
- "type": "string"
- },
- "dependentThoroughfaresConnector": {
- "type": "string"
- },
- "dependentThoroughfaresIndicator": {
- "type": "string"
- },
- "dependentThoroughfaresType": {
- "type": "string"
- },
- "firmName": {
- "type": "string"
- },
- "isDisputed": {
- "type": "boolean"
- },
- "languageCode": {
- "type": "string"
- },
- "localityName": {
- "type": "string"
- },
- "postBoxNumber": {
- "type": "string"
- },
- "postalCodeNumber": {
- "type": "string"
- },
- "postalCodeNumberExtension": {
- "type": "string"
- },
- "premiseName": {
- "type": "string"
- },
- "recipientName": {
- "type": "string"
- },
- "sortingCode": {
- "type": "string"
- },
- "subAdministrativeAreaName": {
- "type": "string"
- },
- "subPremiseName": {
- "type": "string"
- },
- "thoroughfareLeadingType": {
- "type": "string"
- },
- "thoroughfareName": {
- "type": "string"
- },
- "thoroughfareNumber": {
- "type": "string"
- },
- "thoroughfarePostDirection": {
- "type": "string"
- },
- "thoroughfarePreDirection": {
- "type": "string"
- },
- "thoroughfareTrailingType": {
- "type": "string"
- }
- }
- },
- "RepresentativeInfoData": {
- "id": "RepresentativeInfoData",
- "type": "object",
- "properties": {
- "divisions": {
- "type": "object",
- "description": "Political geographic divisions that contain the requested address.",
- "additionalProperties": {
- "$ref": "GeographicDivision",
- "description": "The unique Open Civic Data identifier for this division."
- }
- },
- "offices": {
- "type": "array",
- "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.",
- "items": {
- "$ref": "Office"
- }
- },
- "officials": {
- "type": "array",
- "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.",
- "items": {
- "$ref": "Official"
- }
- }
- }
- },
- "RepresentativeInfoRequest": {
- "id": "RepresentativeInfoRequest",
- "type": "object",
- "description": "A request for political geography and representative information for an address.",
- "properties": {
- "contextParams": {
- "$ref": "ContextParams"
- }
- }
- },
- "RepresentativeInfoResponse": {
- "id": "RepresentativeInfoResponse",
- "type": "object",
- "description": "The result of a representative info lookup query.",
- "properties": {
- "divisions": {
- "type": "object",
- "description": "Political geographic divisions that contain the requested address.",
- "additionalProperties": {
- "$ref": "GeographicDivision",
- "description": "The unique Open Civic Data identifier for this division."
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#representativeInfoResponse\".",
- "default": "civicinfo#representativeInfoResponse"
- },
- "normalizedInput": {
- "$ref": "SimpleAddressType",
- "description": "The normalized version of the requested address"
- },
- "offices": {
- "type": "array",
- "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.",
- "items": {
- "$ref": "Office"
- }
- },
- "officials": {
- "type": "array",
- "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.",
- "items": {
- "$ref": "Official"
- }
- }
- }
- },
- "SimpleAddressType": {
- "id": "SimpleAddressType",
- "type": "object",
- "description": "A simple representation of an address.",
- "properties": {
- "city": {
- "type": "string",
- "description": "The city or town for the address."
- },
- "line1": {
- "type": "string",
- "description": "The street name and number of this address."
- },
- "line2": {
- "type": "string",
- "description": "The second line the address, if needed."
- },
- "line3": {
- "type": "string",
- "description": "The third line of the address, if needed."
- },
- "locationName": {
- "type": "string",
- "description": "The name of the location."
- },
- "state": {
- "type": "string",
- "description": "The US two letter state abbreviation of the address."
- },
- "zip": {
- "type": "string",
- "description": "The US Postal Zip Code of the address."
- }
- }
- },
- "Source": {
- "id": "Source",
- "type": "object",
- "description": "Contains information about the data source for the element containing it.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the data source."
- },
- "official": {
- "type": "boolean",
- "description": "Whether this data comes from an official government source."
- }
- }
- },
- "VoterInfoRequest": {
- "id": "VoterInfoRequest",
- "type": "object",
- "description": "A request for information about a voter.",
- "properties": {
- "contextParams": {
- "$ref": "ContextParams"
- },
- "voterInfoSegmentResult": {
- "$ref": "VoterInfoSegmentResult"
- }
- }
- },
- "VoterInfoResponse": {
- "id": "VoterInfoResponse",
- "type": "object",
- "description": "The result of a voter info lookup query.",
- "properties": {
- "contests": {
- "type": "array",
- "description": "Contests that will appear on the voter's ballot.",
- "items": {
- "$ref": "Contest"
- }
- },
- "dropOffLocations": {
- "type": "array",
- "description": "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.",
- "items": {
- "$ref": "PollingLocation"
- }
- },
- "earlyVoteSites": {
- "type": "array",
- "description": "Locations where the voter is eligible to vote early, prior to election day.",
- "items": {
- "$ref": "PollingLocation"
- }
- },
- "election": {
- "$ref": "Election",
- "description": "The election that was queried."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#voterInfoResponse\".",
- "default": "civicinfo#voterInfoResponse"
- },
- "mailOnly": {
- "type": "boolean",
- "description": "Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well)."
- },
- "normalizedInput": {
- "$ref": "SimpleAddressType",
- "description": "The normalized version of the requested address"
- },
- "otherElections": {
- "type": "array",
- "description": "If no election ID was specified in the query, and there was more than one election with data for the given voter, this will contain information about the other elections that could apply.",
- "items": {
- "$ref": "Election"
- }
- },
- "pollingLocations": {
- "type": "array",
- "description": "Locations where the voter is eligible to vote on election day.",
- "items": {
- "$ref": "PollingLocation"
- }
- },
- "precinctId": {
- "type": "string"
- },
- "state": {
- "type": "array",
- "description": "Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.",
- "items": {
- "$ref": "AdministrationRegion"
- }
- }
- }
- },
- "VoterInfoSegmentResult": {
- "id": "VoterInfoSegmentResult",
- "type": "object",
- "properties": {
- "generatedMillis": {
- "type": "string",
- "format": "int64"
- },
- "postalAddress": {
- "$ref": "PostalAddress"
- },
- "request": {
- "$ref": "VoterInfoRequest"
- },
- "response": {
- "$ref": "VoterInfoResponse"
- }
- }
- }
- },
- "resources": {
- "divisions": {
- "methods": {
- "search": {
- "id": "civicinfo.divisions.search",
- "path": "divisions",
- "httpMethod": "GET",
- "description": "Searches for political divisions by their natural name or OCD ID.",
- "parameters": {
- "query": {
- "type": "string",
- "description": "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",
- "location": "query"
+ "methods": {
+ "electionQuery": {
+ "description": "List of available elections to query.",
+ "httpMethod": "GET",
+ "id": "civicinfo.elections.electionQuery",
+ "path": "elections",
+ "request": {
+ "$ref": "ElectionsQueryRequest"
+ },
+ "response": {
+ "$ref": "ElectionsQueryResponse"
+ }
+ },
+ "voterInfoQuery": {
+ "description": "Looks up information relevant to a voter based on the voter's registered address.",
+ "httpMethod": "GET",
+ "id": "civicinfo.elections.voterInfoQuery",
+ "parameterOrder": [
+ "address"
+ ],
+ "parameters": {
+ "address": {
+ "description": "The registered address of the voter to look up.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ },
+ "electionId": {
+ "default": "0",
+ "description": "The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections",
+ "format": "int64",
+ "location": "query",
+ "type": "string"
+ },
+ "officialOnly": {
+ "default": "false",
+ "description": "If set to true, only data from official state sources will be returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "returnAllAvailableData": {
+ "default": "false",
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "voterinfo",
+ "request": {
+ "$ref": "VoterInfoRequest"
+ },
+ "response": {
+ "$ref": "VoterInfoResponse"
+ }
+ }
}
- },
- "request": {
- "$ref": "DivisionSearchRequest"
- },
- "response": {
- "$ref": "DivisionSearchResponse"
- }
- }
- }
- },
- "elections": {
- "methods": {
- "electionQuery": {
- "id": "civicinfo.elections.electionQuery",
- "path": "elections",
- "httpMethod": "GET",
- "description": "List of available elections to query.",
- "request": {
- "$ref": "ElectionsQueryRequest"
- },
- "response": {
- "$ref": "ElectionsQueryResponse"
- }
},
- "voterInfoQuery": {
- "id": "civicinfo.elections.voterInfoQuery",
- "path": "voterinfo",
- "httpMethod": "GET",
- "description": "Looks up information relevant to a voter based on the voter's registered address.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "The registered address of the voter to look up.",
- "required": true,
- "location": "query"
- },
- "electionId": {
- "type": "string",
- "description": "The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections",
- "default": "0",
- "format": "int64",
- "location": "query"
- },
- "officialOnly": {
- "type": "boolean",
- "description": "If set to true, only data from official state sources will be returned.",
- "default": "false",
- "location": "query"
- },
- "returnAllAvailableData": {
- "type": "boolean",
- "description": "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.",
- "default": "false",
- "location": "query"
+ "representatives": {
+ "methods": {
+ "representativeInfoByAddress": {
+ "description": "Looks up political geography and representative information for a single address.",
+ "httpMethod": "GET",
+ "id": "civicinfo.representatives.representativeInfoByAddress",
+ "parameters": {
+ "address": {
+ "description": "The address to look up. May only be specified if the field ocdId is not given in the URL.",
+ "location": "query",
+ "type": "string"
+ },
+ "includeOffices": {
+ "default": "true",
+ "description": "Whether to return information about offices and officials. If false, only the top-level district information will be returned.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "levels": {
+ "description": "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.",
+ "enum": [
+ "administrativeArea1",
+ "administrativeArea2",
+ "country",
+ "international",
+ "locality",
+ "regional",
+ "special",
+ "subLocality1",
+ "subLocality2"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "roles": {
+ "description": "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.",
+ "enum": [
+ "deputyHeadOfGovernment",
+ "executiveCouncil",
+ "governmentOfficer",
+ "headOfGovernment",
+ "headOfState",
+ "highestCourtJudge",
+ "judge",
+ "legislatorLowerBody",
+ "legislatorUpperBody",
+ "schoolBoard",
+ "specialPurposeOfficer"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "representatives",
+ "request": {
+ "$ref": "RepresentativeInfoRequest"
+ },
+ "response": {
+ "$ref": "RepresentativeInfoResponse"
+ }
+ },
+ "representativeInfoByDivision": {
+ "description": "Looks up representative information for a single geographic division.",
+ "httpMethod": "GET",
+ "id": "civicinfo.representatives.representativeInfoByDivision",
+ "parameterOrder": [
+ "ocdId"
+ ],
+ "parameters": {
+ "levels": {
+ "description": "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.",
+ "enum": [
+ "administrativeArea1",
+ "administrativeArea2",
+ "country",
+ "international",
+ "locality",
+ "regional",
+ "special",
+ "subLocality1",
+ "subLocality2"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "ocdId": {
+ "description": "The Open Civic Data division identifier of the division to look up.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "recursive": {
+ "description": "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "roles": {
+ "description": "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.",
+ "enum": [
+ "deputyHeadOfGovernment",
+ "executiveCouncil",
+ "governmentOfficer",
+ "headOfGovernment",
+ "headOfState",
+ "highestCourtJudge",
+ "judge",
+ "legislatorLowerBody",
+ "legislatorUpperBody",
+ "schoolBoard",
+ "specialPurposeOfficer"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ }
+ },
+ "path": "representatives/{ocdId}",
+ "request": {
+ "$ref": "DivisionRepresentativeInfoRequest"
+ },
+ "response": {
+ "$ref": "RepresentativeInfoData"
+ }
+ }
}
- },
- "parameterOrder": [
- "address"
- ],
- "request": {
- "$ref": "VoterInfoRequest"
- },
- "response": {
- "$ref": "VoterInfoResponse"
- }
}
- }
},
- "representatives": {
- "methods": {
- "representativeInfoByAddress": {
- "id": "civicinfo.representatives.representativeInfoByAddress",
- "path": "representatives",
- "httpMethod": "GET",
- "description": "Looks up political geography and representative information for a single address.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "The address to look up. May only be specified if the field ocdId is not given in the URL.",
- "location": "query"
+ "revision": "20161102",
+ "rootUrl": "https://www.googleapis.com/",
+ "schemas": {
+ "AdministrationRegion": {
+ "description": "Describes information about a regional election administrative area.",
+ "id": "AdministrationRegion",
+ "properties": {
+ "electionAdministrationBody": {
+ "$ref": "AdministrativeBody",
+ "description": "The election administration body for this area."
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "local_jurisdiction": {
+ "$ref": "AdministrationRegion",
+ "description": "The city or county that provides election information for this voter. This object can have the same elements as state."
+ },
+ "name": {
+ "description": "The name of the jurisdiction.",
+ "type": "string"
+ },
+ "sources": {
+ "description": "A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.",
+ "items": {
+ "$ref": "Source"
+ },
+ "type": "array"
+ }
},
- "includeOffices": {
- "type": "boolean",
- "description": "Whether to return information about offices and officials. If false, only the top-level district information will be returned.",
- "default": "true",
- "location": "query"
- },
- "levels": {
- "type": "string",
- "description": "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.",
- "enum": [
- "administrativeArea1",
- "administrativeArea2",
- "country",
- "international",
- "locality",
- "regional",
- "special",
- "subLocality1",
- "subLocality2"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "roles": {
- "type": "string",
- "description": "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.",
- "enum": [
- "deputyHeadOfGovernment",
- "executiveCouncil",
- "governmentOfficer",
- "headOfGovernment",
- "headOfState",
- "highestCourtJudge",
- "judge",
- "legislatorLowerBody",
- "legislatorUpperBody",
- "schoolBoard",
- "specialPurposeOfficer"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "request": {
- "$ref": "RepresentativeInfoRequest"
- },
- "response": {
- "$ref": "RepresentativeInfoResponse"
- }
+ "type": "object"
},
- "representativeInfoByDivision": {
- "id": "civicinfo.representatives.representativeInfoByDivision",
- "path": "representatives/{ocdId}",
- "httpMethod": "GET",
- "description": "Looks up representative information for a single geographic division.",
- "parameters": {
- "levels": {
- "type": "string",
- "description": "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.",
- "enum": [
- "administrativeArea1",
- "administrativeArea2",
- "country",
- "international",
- "locality",
- "regional",
- "special",
- "subLocality1",
- "subLocality2"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
+ "AdministrativeBody": {
+ "description": "Information about an election administrative body (e.g. County Board of Elections).",
+ "id": "AdministrativeBody",
+ "properties": {
+ "absenteeVotingInfoUrl": {
+ "description": "A URL provided by this administrative body for information on absentee voting.",
+ "type": "string"
+ },
+ "addressLines": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "ballotInfoUrl": {
+ "description": "A URL provided by this administrative body to give contest information to the voter.",
+ "type": "string"
+ },
+ "correspondenceAddress": {
+ "$ref": "SimpleAddressType",
+ "description": "The mailing address of this administrative body."
+ },
+ "electionInfoUrl": {
+ "description": "A URL provided by this administrative body for looking up general election information.",
+ "type": "string"
+ },
+ "electionOfficials": {
+ "description": "The election officials for this election administrative body.",
+ "items": {
+ "$ref": "ElectionOfficial"
+ },
+ "type": "array"
+ },
+ "electionRegistrationConfirmationUrl": {
+ "description": "A URL provided by this administrative body for confirming that the voter is registered to vote.",
+ "type": "string"
+ },
+ "electionRegistrationUrl": {
+ "description": "A URL provided by this administrative body for looking up how to register to vote.",
+ "type": "string"
+ },
+ "electionRulesUrl": {
+ "description": "A URL provided by this administrative body describing election rules to the voter.",
+ "type": "string"
+ },
+ "hoursOfOperation": {
+ "description": "A description of the hours of operation for this administrative body.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of this election administrative body.",
+ "type": "string"
+ },
+ "physicalAddress": {
+ "$ref": "SimpleAddressType",
+ "description": "The physical address of this administrative body."
+ },
+ "voter_services": {
+ "description": "A description of the services this administrative body may provide.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "votingLocationFinderUrl": {
+ "description": "A URL provided by this administrative body for looking up where to vote.",
+ "type": "string"
+ }
},
- "ocdId": {
- "type": "string",
- "description": "The Open Civic Data division identifier of the division to look up.",
- "required": true,
- "location": "path"
+ "type": "object"
+ },
+ "Candidate": {
+ "description": "Information about a candidate running for elected office.",
+ "id": "Candidate",
+ "properties": {
+ "candidateUrl": {
+ "description": "The URL for the candidate's campaign web site.",
+ "type": "string"
+ },
+ "channels": {
+ "description": "A list of known (social) media channels for this candidate.",
+ "items": {
+ "$ref": "Channel"
+ },
+ "type": "array"
+ },
+ "email": {
+ "description": "The email address for the candidate's campaign.",
+ "type": "string"
+ },
+ "name": {
+ "description": "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\"",
+ "type": "string"
+ },
+ "orderOnBallot": {
+ "description": "The order the candidate appears on the ballot for this contest.",
+ "format": "int64",
+ "type": "string"
+ },
+ "party": {
+ "description": "The full name of the party the candidate is a member of.",
+ "type": "string"
+ },
+ "phone": {
+ "description": "The voice phone number for the candidate's campaign office.",
+ "type": "string"
+ },
+ "photoUrl": {
+ "description": "A URL for a photo of the candidate.",
+ "type": "string"
+ }
},
- "recursive": {
- "type": "boolean",
- "description": "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.",
- "location": "query"
+ "type": "object"
+ },
+ "Channel": {
+ "description": "A social media or web channel for a candidate.",
+ "id": "Channel",
+ "properties": {
+ "id": {
+ "description": "The unique public identifier for the candidate's channel.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ }
},
- "roles": {
- "type": "string",
- "description": "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.",
- "enum": [
- "deputyHeadOfGovernment",
- "executiveCouncil",
- "governmentOfficer",
- "headOfGovernment",
- "headOfState",
- "highestCourtJudge",
- "judge",
- "legislatorLowerBody",
- "legislatorUpperBody",
- "schoolBoard",
- "specialPurposeOfficer"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "ocdId"
- ],
- "request": {
- "$ref": "DivisionRepresentativeInfoRequest"
- },
- "response": {
- "$ref": "RepresentativeInfoData"
- }
+ "type": "object"
+ },
+ "Contest": {
+ "description": "Information about a contest that appears on a voter's ballot.",
+ "id": "Contest",
+ "properties": {
+ "ballotPlacement": {
+ "description": "A number specifying the position of this contest on the voter's ballot.",
+ "format": "int64",
+ "type": "string"
+ },
+ "candidates": {
+ "description": "The candidate choices for this contest.",
+ "items": {
+ "$ref": "Candidate"
+ },
+ "type": "array"
+ },
+ "district": {
+ "$ref": "ElectoralDistrict",
+ "description": "Information about the electoral district that this contest is in."
+ },
+ "electorateSpecifications": {
+ "description": "A description of any additional eligibility requirements for voting in this contest.",
+ "type": "string"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "level": {
+ "description": "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\".",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "numberElected": {
+ "description": "The number of candidates that will be elected to office in this contest.",
+ "format": "int64",
+ "type": "string"
+ },
+ "numberVotingFor": {
+ "description": "The number of candidates that a voter may vote for in this contest.",
+ "format": "int64",
+ "type": "string"
+ },
+ "office": {
+ "description": "The name of the office for this contest.",
+ "type": "string"
+ },
+ "primaryParty": {
+ "description": "If this is a partisan election, the name of the party it is for.",
+ "type": "string"
+ },
+ "referendumBallotResponses": {
+ "description": "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'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "referendumBrief": {
+ "description": "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'.",
+ "type": "string"
+ },
+ "referendumConStatement": {
+ "description": "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'.",
+ "type": "string"
+ },
+ "referendumEffectOfAbstain": {
+ "description": "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'.",
+ "type": "string"
+ },
+ "referendumPassageThreshold": {
+ "description": "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'.",
+ "type": "string"
+ },
+ "referendumProStatement": {
+ "description": "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'.",
+ "type": "string"
+ },
+ "referendumSubtitle": {
+ "description": "A brief description of the referendum. This field is only populated for contests of type 'Referendum'.",
+ "type": "string"
+ },
+ "referendumText": {
+ "description": "The full text of the referendum. This field is only populated for contests of type 'Referendum'.",
+ "type": "string"
+ },
+ "referendumTitle": {
+ "description": "The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.",
+ "type": "string"
+ },
+ "referendumUrl": {
+ "description": "A link to the referendum. This field is only populated for contests of type 'Referendum'.",
+ "type": "string"
+ },
+ "roles": {
+ "description": "The roles which this office fulfills.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sources": {
+ "description": "A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.",
+ "items": {
+ "$ref": "Source"
+ },
+ "type": "array"
+ },
+ "special": {
+ "description": "\"Yes\" or \"No\" depending on whether this a contest being held outside the normal election cycle.",
+ "type": "string"
+ },
+ "type": {
+ "description": "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"
+ }
+ },
+ "type": "object"
+ },
+ "ContextParams": {
+ "id": "ContextParams",
+ "properties": {
+ "clientProfile": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DivisionRepresentativeInfoRequest": {
+ "description": "A request to look up representative information for a single division.",
+ "id": "DivisionRepresentativeInfoRequest",
+ "properties": {
+ "contextParams": {
+ "$ref": "ContextParams"
+ }
+ },
+ "type": "object"
+ },
+ "DivisionSearchRequest": {
+ "description": "A search request for political geographies.",
+ "id": "DivisionSearchRequest",
+ "properties": {
+ "contextParams": {
+ "$ref": "ContextParams"
+ }
+ },
+ "type": "object"
+ },
+ "DivisionSearchResponse": {
+ "description": "The result of a division search query.",
+ "id": "DivisionSearchResponse",
+ "properties": {
+ "kind": {
+ "default": "civicinfo#divisionSearchResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#divisionSearchResponse\".",
+ "type": "string"
+ },
+ "results": {
+ "items": {
+ "$ref": "DivisionSearchResult"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DivisionSearchResult": {
+ "description": "Represents a political geographic division that matches the requested query.",
+ "id": "DivisionSearchResult",
+ "properties": {
+ "aliases": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the division.",
+ "type": "string"
+ },
+ "ocdId": {
+ "description": "The unique Open Civic Data identifier for this division.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Election": {
+ "description": "Information about the election that was queried.",
+ "id": "Election",
+ "properties": {
+ "electionDay": {
+ "description": "Day of the election in YYYY-MM-DD format.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID of this election.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "A displayable name for the election.",
+ "type": "string"
+ },
+ "ocdDivisionId": {
+ "description": "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).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ElectionOfficial": {
+ "description": "Information about individual election officials.",
+ "id": "ElectionOfficial",
+ "properties": {
+ "emailAddress": {
+ "description": "The email address of the election official.",
+ "type": "string"
+ },
+ "faxNumber": {
+ "description": "The fax number of the election official.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The full name of the election official.",
+ "type": "string"
+ },
+ "officePhoneNumber": {
+ "description": "The office phone number of the election official.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the election official.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ElectionsQueryRequest": {
+ "id": "ElectionsQueryRequest",
+ "properties": {
+ "contextParams": {
+ "$ref": "ContextParams"
+ }
+ },
+ "type": "object"
+ },
+ "ElectionsQueryResponse": {
+ "description": "The list of elections available for this version of the API.",
+ "id": "ElectionsQueryResponse",
+ "properties": {
+ "elections": {
+ "description": "A list of available elections",
+ "items": {
+ "$ref": "Election"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "civicinfo#electionsQueryResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#electionsQueryResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ElectoralDistrict": {
+ "description": "Describes the geographic scope of a contest.",
+ "id": "ElectoralDistrict",
+ "properties": {
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "kgForeignKey": {
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the district.",
+ "type": "string"
+ },
+ "scope": {
+ "description": "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",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GeographicDivision": {
+ "description": "Describes a political geography.",
+ "id": "GeographicDivision",
+ "properties": {
+ "alsoKnownAs": {
+ "description": "Any other valid OCD IDs that refer to the same division.\n\nBecause 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.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the division.",
+ "type": "string"
+ },
+ "officeIndices": {
+ "description": "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.",
+ "items": {
+ "format": "uint32",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Office": {
+ "description": "Information about an Office held by one or more Officials.",
+ "id": "Office",
+ "properties": {
+ "divisionId": {
+ "description": "The OCD ID of the division with which this office is associated.",
+ "type": "string"
+ },
+ "levels": {
+ "description": "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\".",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The human-readable name of the office.",
+ "type": "string"
+ },
+ "officialIndices": {
+ "description": "List of indices in the officials array of people who presently hold this office.",
+ "items": {
+ "format": "uint32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "roles": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sources": {
+ "description": "A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.",
+ "items": {
+ "$ref": "Source"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Official": {
+ "description": "Information about a person holding an elected office.",
+ "id": "Official",
+ "properties": {
+ "address": {
+ "description": "Addresses at which to contact the official.",
+ "items": {
+ "$ref": "SimpleAddressType"
+ },
+ "type": "array"
+ },
+ "channels": {
+ "description": "A list of known (social) media channels for this official.",
+ "items": {
+ "$ref": "Channel"
+ },
+ "type": "array"
+ },
+ "emails": {
+ "description": "The direct email addresses for the official.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The official's name.",
+ "type": "string"
+ },
+ "party": {
+ "description": "The full name of the party the official belongs to.",
+ "type": "string"
+ },
+ "phones": {
+ "description": "The official's public contact phone numbers.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "photoUrl": {
+ "description": "A URL for a photo of the official.",
+ "type": "string"
+ },
+ "urls": {
+ "description": "The official's public website URLs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PollingLocation": {
+ "description": "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.",
+ "id": "PollingLocation",
+ "properties": {
+ "address": {
+ "$ref": "SimpleAddressType",
+ "description": "The address of the location."
+ },
+ "endDate": {
+ "description": "The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.",
+ "type": "string"
+ },
+ "id": {
+ "description": "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.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the early vote site or drop off location. This field is not populated for polling locations.",
+ "type": "string"
+ },
+ "notes": {
+ "description": "Notes about this location (e.g. accessibility ramp or entrance to use).",
+ "type": "string"
+ },
+ "pollingHours": {
+ "description": "A description of when this location is open.",
+ "type": "string"
+ },
+ "sources": {
+ "description": "A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.",
+ "items": {
+ "$ref": "Source"
+ },
+ "type": "array"
+ },
+ "startDate": {
+ "description": "The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.",
+ "type": "string"
+ },
+ "voterServices": {
+ "description": "The services provided by this early vote site or drop off location. This field is not populated for polling locations.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostalAddress": {
+ "id": "PostalAddress",
+ "properties": {
+ "addressLines": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "administrativeAreaName": {
+ "type": "string"
+ },
+ "countryName": {
+ "type": "string"
+ },
+ "countryNameCode": {
+ "type": "string"
+ },
+ "dependentLocalityName": {
+ "type": "string"
+ },
+ "dependentThoroughfareLeadingType": {
+ "type": "string"
+ },
+ "dependentThoroughfareName": {
+ "type": "string"
+ },
+ "dependentThoroughfarePostDirection": {
+ "type": "string"
+ },
+ "dependentThoroughfarePreDirection": {
+ "type": "string"
+ },
+ "dependentThoroughfareTrailingType": {
+ "type": "string"
+ },
+ "dependentThoroughfaresConnector": {
+ "type": "string"
+ },
+ "dependentThoroughfaresIndicator": {
+ "type": "string"
+ },
+ "dependentThoroughfaresType": {
+ "type": "string"
+ },
+ "firmName": {
+ "type": "string"
+ },
+ "isDisputed": {
+ "type": "boolean"
+ },
+ "languageCode": {
+ "type": "string"
+ },
+ "localityName": {
+ "type": "string"
+ },
+ "postBoxNumber": {
+ "type": "string"
+ },
+ "postalCodeNumber": {
+ "type": "string"
+ },
+ "postalCodeNumberExtension": {
+ "type": "string"
+ },
+ "premiseName": {
+ "type": "string"
+ },
+ "recipientName": {
+ "type": "string"
+ },
+ "sortingCode": {
+ "type": "string"
+ },
+ "subAdministrativeAreaName": {
+ "type": "string"
+ },
+ "subPremiseName": {
+ "type": "string"
+ },
+ "thoroughfareLeadingType": {
+ "type": "string"
+ },
+ "thoroughfareName": {
+ "type": "string"
+ },
+ "thoroughfareNumber": {
+ "type": "string"
+ },
+ "thoroughfarePostDirection": {
+ "type": "string"
+ },
+ "thoroughfarePreDirection": {
+ "type": "string"
+ },
+ "thoroughfareTrailingType": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RepresentativeInfoData": {
+ "id": "RepresentativeInfoData",
+ "properties": {
+ "divisions": {
+ "additionalProperties": {
+ "$ref": "GeographicDivision",
+ "description": "The unique Open Civic Data identifier for this division."
+ },
+ "description": "Political geographic divisions that contain the requested address.",
+ "type": "object"
+ },
+ "offices": {
+ "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.",
+ "items": {
+ "$ref": "Office"
+ },
+ "type": "array"
+ },
+ "officials": {
+ "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.",
+ "items": {
+ "$ref": "Official"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RepresentativeInfoRequest": {
+ "description": "A request for political geography and representative information for an address.",
+ "id": "RepresentativeInfoRequest",
+ "properties": {
+ "contextParams": {
+ "$ref": "ContextParams"
+ }
+ },
+ "type": "object"
+ },
+ "RepresentativeInfoResponse": {
+ "description": "The result of a representative info lookup query.",
+ "id": "RepresentativeInfoResponse",
+ "properties": {
+ "divisions": {
+ "additionalProperties": {
+ "$ref": "GeographicDivision",
+ "description": "The unique Open Civic Data identifier for this division."
+ },
+ "description": "Political geographic divisions that contain the requested address.",
+ "type": "object"
+ },
+ "kind": {
+ "default": "civicinfo#representativeInfoResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#representativeInfoResponse\".",
+ "type": "string"
+ },
+ "normalizedInput": {
+ "$ref": "SimpleAddressType",
+ "description": "The normalized version of the requested address"
+ },
+ "offices": {
+ "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.",
+ "items": {
+ "$ref": "Office"
+ },
+ "type": "array"
+ },
+ "officials": {
+ "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.",
+ "items": {
+ "$ref": "Official"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SimpleAddressType": {
+ "description": "A simple representation of an address.",
+ "id": "SimpleAddressType",
+ "properties": {
+ "city": {
+ "description": "The city or town for the address.",
+ "type": "string"
+ },
+ "line1": {
+ "description": "The street name and number of this address.",
+ "type": "string"
+ },
+ "line2": {
+ "description": "The second line the address, if needed.",
+ "type": "string"
+ },
+ "line3": {
+ "description": "The third line of the address, if needed.",
+ "type": "string"
+ },
+ "locationName": {
+ "description": "The name of the location.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The US two letter state abbreviation of the address.",
+ "type": "string"
+ },
+ "zip": {
+ "description": "The US Postal Zip Code of the address.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Source": {
+ "description": "Contains information about the data source for the element containing it.",
+ "id": "Source",
+ "properties": {
+ "name": {
+ "description": "The name of the data source.",
+ "type": "string"
+ },
+ "official": {
+ "description": "Whether this data comes from an official government source.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "VoterInfoRequest": {
+ "description": "A request for information about a voter.",
+ "id": "VoterInfoRequest",
+ "properties": {
+ "contextParams": {
+ "$ref": "ContextParams"
+ },
+ "voterInfoSegmentResult": {
+ "$ref": "VoterInfoSegmentResult"
+ }
+ },
+ "type": "object"
+ },
+ "VoterInfoResponse": {
+ "description": "The result of a voter info lookup query.",
+ "id": "VoterInfoResponse",
+ "properties": {
+ "contests": {
+ "description": "Contests that will appear on the voter's ballot.",
+ "items": {
+ "$ref": "Contest"
+ },
+ "type": "array"
+ },
+ "dropOffLocations": {
+ "description": "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.",
+ "items": {
+ "$ref": "PollingLocation"
+ },
+ "type": "array"
+ },
+ "earlyVoteSites": {
+ "description": "Locations where the voter is eligible to vote early, prior to election day.",
+ "items": {
+ "$ref": "PollingLocation"
+ },
+ "type": "array"
+ },
+ "election": {
+ "$ref": "Election",
+ "description": "The election that was queried."
+ },
+ "kind": {
+ "default": "civicinfo#voterInfoResponse",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#voterInfoResponse\".",
+ "type": "string"
+ },
+ "mailOnly": {
+ "description": "Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).",
+ "type": "boolean"
+ },
+ "normalizedInput": {
+ "$ref": "SimpleAddressType",
+ "description": "The normalized version of the requested address"
+ },
+ "otherElections": {
+ "description": "If no election ID was specified in the query, and there was more than one election with data for the given voter, this will contain information about the other elections that could apply.",
+ "items": {
+ "$ref": "Election"
+ },
+ "type": "array"
+ },
+ "pollingLocations": {
+ "description": "Locations where the voter is eligible to vote on election day.",
+ "items": {
+ "$ref": "PollingLocation"
+ },
+ "type": "array"
+ },
+ "precinctId": {
+ "type": "string"
+ },
+ "state": {
+ "description": "Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.",
+ "items": {
+ "$ref": "AdministrationRegion"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VoterInfoSegmentResult": {
+ "id": "VoterInfoSegmentResult",
+ "properties": {
+ "generatedMillis": {
+ "format": "int64",
+ "type": "string"
+ },
+ "postalAddress": {
+ "$ref": "PostalAddress"
+ },
+ "request": {
+ "$ref": "VoterInfoRequest"
+ },
+ "response": {
+ "$ref": "VoterInfoResponse"
+ }
+ },
+ "type": "object"
}
- }
- }
- }
-}
+ },
+ "servicePath": "civicinfo/v2/",
+ "title": "Google Civic Information API",
+ "version": "v2"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/classroom/v1/classroom-api.json b/vendor/google.golang.org/api/classroom/v1/classroom-api.json
index 48960fec3..500737315 100644
--- a/vendor/google.golang.org/api/classroom/v1/classroom-api.json
+++ b/vendor/google.golang.org/api/classroom/v1/classroom-api.json
@@ -1,165 +1,247 @@
{
- "ownerDomain": "google.com",
- "name": "classroom",
- "batchPath": "batch",
- "id": "classroom:v1",
- "documentationLink": "https://developers.google.com/classroom/",
- "revision": "20180114",
- "title": "Google Classroom API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "resources": {
- "invitations": {
- "methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Invitation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/invitations",
- "id": "classroom.invitations.create",
- "path": "v1/invitations",
- "request": {
- "$ref": "Invitation"
- },
- "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists."
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/classroom.announcements": {
+ "description": "View and manage announcements in Google Classroom"
},
- "accept": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "POST",
- "parameters": {
- "id": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the invitation to accept."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/invitations/{id}:accept",
- "path": "v1/invitations/{id}:accept",
- "id": "classroom.invitations.accept",
- "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID."
+ "https://www.googleapis.com/auth/classroom.announcements.readonly": {
+ "description": "View announcements in Google Classroom"
},
- "delete": {
- "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the invitation to delete.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/invitations/{id}",
- "path": "v1/invitations/{id}",
- "id": "classroom.invitations.delete"
+ "https://www.googleapis.com/auth/classroom.courses": {
+ "description": "Manage your Google Classroom classes"
},
- "get": {
- "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "response": {
- "$ref": "Invitation"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the invitation to return.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/invitations/{id}",
- "path": "v1/invitations/{id}",
- "id": "classroom.invitations.get"
+ "https://www.googleapis.com/auth/classroom.courses.readonly": {
+ "description": "View your Google Classroom classes"
},
- "list": {
- "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
- "response": {
- "$ref": "ListInvitationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "courseId": {
- "location": "query",
- "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
- "type": "string"
- },
- "userId": {
- "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/invitations",
- "path": "v1/invitations",
- "id": "classroom.invitations.list"
+ "https://www.googleapis.com/auth/classroom.coursework.me": {
+ "description": "Manage your course work and view your grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
+ "description": "View your course work and grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.students": {
+ "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
+ "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
+ },
+ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": {
+ "description": "View your Google Classroom guardians"
+ },
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students": {
+ "description": "View and manage guardians for students in your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
+ "description": "View guardians for students in your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.profile.emails": {
+ "description": "View the email addresses of people in your classes"
+ },
+ "https://www.googleapis.com/auth/classroom.profile.photos": {
+ "description": "View the profile photos of people in your classes"
+ },
+ "https://www.googleapis.com/auth/classroom.push-notifications": {
+ "description": "Receive notifications about your Google Classroom data"
+ },
+ "https://www.googleapis.com/auth/classroom.rosters": {
+ "description": "Manage your Google Classroom class rosters"
+ },
+ "https://www.googleapis.com/auth/classroom.rosters.readonly": {
+ "description": "View your Google Classroom class rosters"
+ },
+ "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
+ "description": "View your course work and grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
+ "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
}
}
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://classroom.googleapis.com/",
+ "batchPath": "batch",
+ "description": "Manages classes, rosters, and invitations in Google Classroom.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/classroom/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "classroom:v1",
+ "kind": "discovery#restDescription",
+ "name": "classroom",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
"courses": {
"methods": {
- "list": {
- "response": {
- "$ref": "ListCoursesResponse"
- },
+ "create": {
+ "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.",
+ "flatPath": "v1/courses",
+ "httpMethod": "POST",
+ "id": "classroom.courses.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/courses",
+ "request": {
+ "$ref": "Course"
+ },
+ "response": {
+ "$ref": "Course"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
+ "flatPath": "v1/courses/{id}",
+ "httpMethod": "DELETE",
+ "id": "classroom.courses.delete",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{id}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ]
+ },
+ "get": {
+ "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
+ "flatPath": "v1/courses/{id}",
+ "httpMethod": "GET",
+ "id": "classroom.courses.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{id}",
+ "response": {
+ "$ref": "Course"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ]
+ },
+ "list": {
+ "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.",
+ "flatPath": "v1/courses",
+ "httpMethod": "GET",
+ "id": "classroom.courses.list",
"parameterOrder": [],
- "httpMethod": "GET",
"parameters": {
- "teacherId": {
- "type": "string",
- "location": "query",
- "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- },
"courseStates": {
- "type": "string",
- "repeated": true,
- "location": "query",
+ "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
"enum": [
"COURSE_STATE_UNSPECIFIED",
"ACTIVE",
@@ -168,936 +250,683 @@
"DECLINED",
"SUSPENDED"
],
- "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED."
- },
- "studentId": {
- "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
"location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "repeated": true,
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
"format": "int32",
+ "location": "query",
"type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "flatPath": "v1/courses",
- "path": "v1/courses",
- "id": "classroom.courses.list",
- "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist."
- },
- "create": {
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "flatPath": "v1/courses",
- "path": "v1/courses",
- "id": "classroom.courses.create",
- "request": {
- "$ref": "Course"
- },
- "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists."
- },
- "get": {
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
+ },
+ "studentId": {
+ "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "query",
+ "type": "string"
+ },
+ "teacherId": {
+ "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "query",
"type": "string"
}
},
+ "path": "v1/courses",
+ "response": {
+ "$ref": "ListCoursesResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.courses",
"https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.get",
- "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "GET"
+ ]
},
"patch": {
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.patch",
- "request": {
- "$ref": "Course"
- },
"description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
- "response": {
- "$ref": "Course"
- },
+ "flatPath": "v1/courses/{id}",
+ "httpMethod": "PATCH",
+ "id": "classroom.courses.patch",
"parameterOrder": [
"id"
],
- "httpMethod": "PATCH",
"parameters": {
"id": {
- "location": "path",
"description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
"required": true,
"type": "string"
},
"updateMask": {
- "location": "query",
"description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
"format": "google-fieldmask",
+ "location": "query",
"type": "string"
}
},
+ "path": "v1/courses/{id}",
+ "request": {
+ "$ref": "Course"
+ },
+ "response": {
+ "$ref": "Course"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
]
},
"update": {
- "path": "v1/courses/{id}",
- "id": "classroom.courses.update",
"description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
+ "flatPath": "v1/courses/{id}",
+ "httpMethod": "PUT",
+ "id": "classroom.courses.update",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{id}",
"request": {
"$ref": "Course"
},
"response": {
"$ref": "Course"
},
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "id": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- }
- },
- "flatPath": "v1/courses/{id}"
- },
- "delete": {
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.delete",
- "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
]
}
},
"resources": {
- "announcements": {
+ "aliases": {
"methods": {
- "list": {
- "description": "Returns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers\nand domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
- "response": {
- "$ref": "ListAnnouncementsResponse"
- },
+ "create": {
+ "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).",
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "httpMethod": "POST",
+ "id": "classroom.courses.aliases.create",
"parameterOrder": [
"courseId"
],
- "httpMethod": "GET",
"parameters": {
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported field is `updateTime`.\nSupported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `updateTime asc`, `updateTime`"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token."
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer"
+ "courseId": {
+ "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/aliases",
+ "request": {
+ "$ref": "CourseAlias"
+ },
+ "response": {
+ "$ref": "CourseAlias"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).",
+ "flatPath": "v1/courses/{courseId}/aliases/{alias}",
+ "httpMethod": "DELETE",
+ "id": "classroom.courses.aliases.delete",
+ "parameterOrder": [
+ "courseId",
+ "alias"
+ ],
+ "parameters": {
+ "alias": {
+ "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
"courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/aliases/{alias}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ]
+ },
+ "list": {
+ "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.",
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "httpMethod": "GET",
+ "id": "classroom.courses.aliases.list",
+ "parameterOrder": [
+ "courseId"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "announcementStates": {
- "type": "string",
- "repeated": true,
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
"location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/aliases",
+ "response": {
+ "$ref": "ListCourseAliasesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ]
+ }
+ }
+ },
+ "announcements": {
+ "methods": {
+ "create": {
+ "description": "Creates an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create announcements in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
+ "flatPath": "v1/courses/{courseId}/announcements",
+ "httpMethod": "POST",
+ "id": "classroom.courses.announcements.create",
+ "parameterOrder": [
+ "courseId"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/announcements",
+ "request": {
+ "$ref": "Announcement"
+ },
+ "response": {
+ "$ref": "Announcement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an announcement.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding announcement item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "httpMethod": "DELETE",
+ "id": "classroom.courses.announcements.delete",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ]
+ },
+ "get": {
+ "description": "Returns an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or announcement, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or announcement does not exist.",
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "httpMethod": "GET",
+ "id": "classroom.courses.announcements.get",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the announcement.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "response": {
+ "$ref": "Announcement"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements",
+ "https://www.googleapis.com/auth/classroom.announcements.readonly"
+ ]
+ },
+ "list": {
+ "description": "Returns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers\nand domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
+ "flatPath": "v1/courses/{courseId}/announcements",
+ "httpMethod": "GET",
+ "id": "classroom.courses.announcements.list",
+ "parameterOrder": [
+ "courseId"
+ ],
+ "parameters": {
+ "announcementStates": {
+ "description": "Restriction on the `state` of announcements returned.\nIf this argument is left unspecified, the default value is `PUBLISHED`.",
"enum": [
"ANNOUNCEMENT_STATE_UNSPECIFIED",
"PUBLISHED",
"DRAFT",
"DELETED"
],
- "description": "Restriction on the `state` of announcements returned.\nIf this argument is left unspecified, the default value is `PUBLISHED`."
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported field is `updateTime`.\nSupported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `updateTime asc`, `updateTime`",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
}
},
+ "path": "v1/courses/{courseId}/announcements",
+ "response": {
+ "$ref": "ListAnnouncementsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements",
"https://www.googleapis.com/auth/classroom.announcements.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/announcements",
- "path": "v1/courses/{courseId}/announcements",
- "id": "classroom.courses.announcements.list"
+ ]
},
- "create": {
- "request": {
- "$ref": "Announcement"
- },
- "description": "Creates an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create announcements in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
+ "modifyAssignees": {
+ "description": "Modifies assignee mode and options of an announcement.\n\nOnly a teacher of the course that contains the announcement may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
+ "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
"httpMethod": "POST",
+ "id": "classroom.courses.announcements.modifyAssignees",
"parameterOrder": [
- "courseId"
+ "courseId",
+ "id"
],
- "response": {
- "$ref": "Announcement"
- },
"parameters": {
"courseId": {
- "location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the announcement.",
+ "location": "path",
"required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ],
- "flatPath": "v1/courses/{courseId}/announcements",
- "id": "classroom.courses.announcements.create",
- "path": "v1/courses/{courseId}/announcements"
- },
- "modifyAssignees": {
"path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
- "id": "classroom.courses.announcements.modifyAssignees",
"request": {
"$ref": "ModifyAnnouncementAssigneesRequest"
},
- "description": "Modifies assignee mode and options of an announcement.\n\nOnly a teacher of the course that contains the announcement may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
"response": {
"$ref": "Announcement"
},
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "Identifier of the announcement.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements"
- ],
- "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees"
- },
- "get": {
- "response": {
- "$ref": "Announcement"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the announcement.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements",
- "https://www.googleapis.com/auth/classroom.announcements.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/announcements/{id}",
- "path": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.get",
- "description": "Returns an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or announcement, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or announcement does not exist."
+ ]
},
"patch": {
- "request": {
- "$ref": "Announcement"
- },
"description": "Updates one or more fields of an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if the requested course or announcement does not exist",
- "response": {
- "$ref": "Announcement"
- },
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "httpMethod": "PATCH",
+ "id": "classroom.courses.announcements.patch",
"parameterOrder": [
"courseId",
"id"
],
- "httpMethod": "PATCH",
"parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
"id": {
"description": "Identifier of the announcement.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"updateMask": {
- "location": "query",
"description": "Mask that identifies which fields on the announcement to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Announcement object. If\na field that does not support empty values is included in the update mask\nand not set in the Announcement object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `text`\n* `state`\n* `scheduled_time`",
"format": "google-fieldmask",
- "type": "string"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
+ "location": "query",
"type": "string"
}
},
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "request": {
+ "$ref": "Announcement"
+ },
+ "response": {
+ "$ref": "Announcement"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements"
- ],
- "flatPath": "v1/courses/{courseId}/announcements/{id}",
- "path": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.patch"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ],
- "flatPath": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.delete",
- "path": "v1/courses/{courseId}/announcements/{id}",
- "description": "Deletes an announcement.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding announcement item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID."
- }
- }
- },
- "students": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Student"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "path": "v1/courses/{courseId}/students/{userId}",
- "id": "classroom.courses.students.get",
- "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist."
- },
- "list": {
- "id": "classroom.courses.students.list",
- "path": "v1/courses/{courseId}/students",
- "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListStudentsResponse"
- },
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer"
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/students"
- },
- "create": {
- "response": {
- "$ref": "Student"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "enrollmentCode": {
- "location": "query",
- "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.",
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/courses/{courseId}/students",
- "path": "v1/courses/{courseId}/students",
- "id": "classroom.courses.students.create",
- "request": {
- "$ref": "Student"
- },
- "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "userId": {
- "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "path": "v1/courses/{courseId}/students/{userId}",
- "id": "classroom.courses.students.delete",
- "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist."
- }
- }
- },
- "topics": {
- "methods": {
- "get": {
- "id": "classroom.courses.topics.get",
- "path": "v1/courses/{courseId}/topics/{id}",
- "description": "Returns a topic.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or topic, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or topic does not exist.",
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "response": {
- "$ref": "Topic"
- },
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "Identifier of the topic.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/topics/{id}"
- },
- "list": {
- "description": "Returns the list of topics that the requester is permitted to view.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
- "response": {
- "$ref": "ListTopicResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer"
- },
- "courseId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- }
- },
- "flatPath": "v1/courses/{courseId}/topics",
- "path": "v1/courses/{courseId}/topics",
- "id": "classroom.courses.topics.list"
- }
- }
- },
- "aliases": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "alias"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "alias": {
- "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "courseId": {
- "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "flatPath": "v1/courses/{courseId}/aliases/{alias}",
- "path": "v1/courses/{courseId}/aliases/{alias}",
- "id": "classroom.courses.aliases.delete",
- "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias)."
- },
- "list": {
- "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.",
- "response": {
- "$ref": "ListCourseAliasesResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer"
- },
- "courseId": {
- "location": "path",
- "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/aliases",
- "path": "v1/courses/{courseId}/aliases",
- "id": "classroom.courses.aliases.list"
- },
- "create": {
- "flatPath": "v1/courses/{courseId}/aliases",
- "path": "v1/courses/{courseId}/aliases",
- "id": "classroom.courses.aliases.create",
- "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).",
- "request": {
- "$ref": "CourseAlias"
- },
- "response": {
- "$ref": "CourseAlias"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "courseId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- }
- }
+ ]
}
}
},
"courseWork": {
"methods": {
- "modifyAssignees": {
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
+ "create": {
+ "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
+ "flatPath": "v1/courses/{courseId}/courseWork",
"httpMethod": "POST",
+ "id": "classroom.courses.courseWork.create",
+ "parameterOrder": [
+ "courseId"
+ ],
"parameters": {
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "description": "Identifier of the coursework.",
- "required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
- "path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
- "id": "classroom.courses.courseWork.modifyAssignees",
+ "path": "v1/courses/{courseId}/courseWork",
"request": {
- "$ref": "ModifyCourseWorkAssigneesRequest"
+ "$ref": "CourseWork"
},
- "description": "Modifies assignee mode and options of a coursework.\n\nOnly a teacher of the course that contains the coursework may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist."
- },
- "patch": {
"response": {
"$ref": "CourseWork"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "httpMethod": "DELETE",
+ "id": "classroom.courses.courseWork.delete",
"parameterOrder": [
"courseId",
"id"
],
- "httpMethod": "PATCH",
"parameters": {
"courseId": {
- "location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
"required": true,
"type": "string"
},
"id": {
+ "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
"location": "path",
- "description": "Identifier of the course work.",
"required": true,
"type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`",
- "format": "google-fieldmask",
- "type": "string"
}
},
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.patch",
- "request": {
- "$ref": "CourseWork"
- },
- "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
+ ]
},
"get": {
"description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
"httpMethod": "GET",
+ "id": "classroom.courses.courseWork.get",
"parameterOrder": [
"courseId",
"id"
],
- "response": {
- "$ref": "CourseWork"
- },
"parameters": {
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"id": {
"description": "Identifier of the course work.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "response": {
+ "$ref": "CourseWork"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.me.readonly",
"https://www.googleapis.com/auth/classroom.coursework.students",
"https://www.googleapis.com/auth/classroom.coursework.students.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.get",
- "path": "v1/courses/{courseId}/courseWork/{id}"
- },
- "delete": {
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.delete",
- "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}"
+ ]
},
"list": {
- "response": {
- "$ref": "ListCourseWorkResponse"
- },
+ "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "httpMethod": "GET",
+ "id": "classroom.courses.courseWork.list",
"parameterOrder": [
"courseId"
],
- "httpMethod": "GET",
"parameters": {
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
- },
- "orderBy": {
- "location": "query",
- "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
"type": "string"
},
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32"
- },
"courseWorkStates": {
"description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.",
- "type": "string",
- "repeated": true,
- "location": "query",
"enum": [
"COURSE_WORK_STATE_UNSPECIFIED",
"PUBLISHED",
"DRAFT",
"DELETED"
- ]
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
}
},
+ "path": "v1/courses/{courseId}/courseWork",
+ "response": {
+ "$ref": "ListCourseWorkResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.me.readonly",
"https://www.googleapis.com/auth/classroom.coursework.students",
"https://www.googleapis.com/auth/classroom.coursework.students.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork",
- "path": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.list",
- "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
+ ]
},
- "create": {
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId"
- ],
+ "modifyAssignees": {
+ "description": "Modifies assignee mode and options of a coursework.\n\nOnly a teacher of the course that contains the coursework may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
"httpMethod": "POST",
+ "id": "classroom.courses.courseWork.modifyAssignees",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
"parameters": {
"courseId": {
- "location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the coursework.",
+ "location": "path",
"required": true,
"type": "string"
}
},
+ "path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
+ "request": {
+ "$ref": "ModifyCourseWorkAssigneesRequest"
+ },
+ "response": {
+ "$ref": "CourseWork"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
+ "patch": {
+ "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "httpMethod": "PATCH",
+ "id": "classroom.courses.courseWork.patch",
+ "parameterOrder": [
+ "courseId",
+ "id"
],
- "flatPath": "v1/courses/{courseId}/courseWork",
- "path": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.create",
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the course work.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/courseWork/{id}",
"request": {
"$ref": "CourseWork"
},
- "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible"
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
}
},
"resources": {
"studentSubmissions": {
"methods": {
"get": {
- "response": {
- "$ref": "StudentSubmission"
- },
+ "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "httpMethod": "GET",
+ "id": "classroom.courses.courseWork.studentSubmissions.get",
"parameterOrder": [
"courseId",
"courseWorkId",
"id"
],
- "httpMethod": "GET",
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "response": {
+ "$ref": "StudentSubmission"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.me.readonly",
@@ -1105,272 +934,53 @@
"https://www.googleapis.com/auth/classroom.coursework.students.readonly",
"https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
"https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "id": "classroom.courses.courseWork.studentSubmissions.get",
- "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
- },
- "patch": {
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n\n* `draft_grade`\n* `assigned_grade`",
- "format": "google-fieldmask",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "id": "classroom.courses.courseWork.studentSubmissions.patch",
- "request": {
- "$ref": "StudentSubmission"
- },
- "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
- },
- "return": {
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
- "id": "classroom.courses.courseWork.studentSubmissions.return",
- "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "ReturnStudentSubmissionRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST"
- },
- "reclaim": {
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string"
- },
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
- "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
- "request": {
- "$ref": "ReclaimStudentSubmissionRequest"
- },
- "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
- },
- "turnIn": {
- "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "TurnInStudentSubmissionRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ],
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "id": "classroom.courses.courseWork.studentSubmissions.turnIn"
- },
- "modifyAttachments": {
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
- "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
- "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "ModifyAttachmentsRequest"
- },
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST"
+ ]
},
"list": {
"description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
"httpMethod": "GET",
+ "id": "classroom.courses.courseWork.studentSubmissions.list",
"parameterOrder": [
"courseId",
"courseWorkId"
],
- "response": {
- "$ref": "ListStudentSubmissionsResponse"
- },
"parameters": {
- "pageToken": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "late": {
+ "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
+ "enum": [
+ "LATE_VALUES_UNSPECIFIED",
+ "LATE_ONLY",
+ "NOT_LATE_ONLY"
+ ],
"location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
"type": "string"
},
"pageSize": {
- "type": "integer",
- "location": "query",
"description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32"
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
},
"states": {
"description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
- "type": "string",
- "repeated": true,
- "location": "query",
"enum": [
"SUBMISSION_STATE_UNSPECIFIED",
"NEW",
@@ -1378,36 +988,21 @@
"TURNED_IN",
"RETURNED",
"RECLAIMED_BY_STUDENT"
- ]
- },
- "userId": {
- "type": "string",
+ ],
"location": "query",
- "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- },
- "courseWorkId": {
- "description": "Identifier of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
+ "repeated": true,
"type": "string"
},
- "late": {
- "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
- "type": "string",
+ "userId": {
+ "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"location": "query",
- "enum": [
- "LATE_VALUES_UNSPECIFIED",
- "LATE_ONLY",
- "NOT_LATE_ONLY"
- ]
+ "type": "string"
}
},
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
+ "response": {
+ "$ref": "ListStudentSubmissionsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.me.readonly",
@@ -1415,150 +1010,760 @@
"https://www.googleapis.com/auth/classroom.coursework.students.readonly",
"https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
"https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
+ ]
+ },
+ "modifyAttachments": {
+ "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
+ "httpMethod": "POST",
+ "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "id": "classroom.courses.courseWork.studentSubmissions.list",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions"
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
+ "request": {
+ "$ref": "ModifyAttachmentsRequest"
+ },
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
+ "patch": {
+ "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "httpMethod": "PATCH",
+ "id": "classroom.courses.courseWork.studentSubmissions.patch",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n\n* `draft_grade`\n* `assigned_grade`",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "request": {
+ "$ref": "StudentSubmission"
+ },
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
+ "reclaim": {
+ "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
+ "httpMethod": "POST",
+ "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
+ "request": {
+ "$ref": "ReclaimStudentSubmissionRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ]
+ },
+ "return": {
+ "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
+ "httpMethod": "POST",
+ "id": "classroom.courses.courseWork.studentSubmissions.return",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
+ "request": {
+ "$ref": "ReturnStudentSubmissionRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
+ "turnIn": {
+ "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "httpMethod": "POST",
+ "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "request": {
+ "$ref": "TurnInStudentSubmissionRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ]
}
}
}
}
},
- "teachers": {
+ "students": {
"methods": {
- "delete": {
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.delete",
- "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
- "response": {
- "$ref": "Empty"
+ "create": {
+ "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.",
+ "flatPath": "v1/courses/{courseId}/students",
+ "httpMethod": "POST",
+ "id": "classroom.courses.students.create",
+ "parameterOrder": [
+ "courseId"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "enrollmentCode": {
+ "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.",
+ "location": "query",
+ "type": "string"
+ }
},
+ "path": "v1/courses/{courseId}/students",
+ "request": {
+ "$ref": "Student"
+ },
+ "response": {
+ "$ref": "Student"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "httpMethod": "DELETE",
+ "id": "classroom.courses.students.delete",
"parameterOrder": [
"courseId",
"userId"
],
- "httpMethod": "DELETE",
"parameters": {
- "userId": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"location": "path",
- "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"required": true,
"type": "string"
},
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "userId": {
+ "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1/courses/{courseId}/students/{userId}",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters"
]
},
"get": {
- "response": {
- "$ref": "Teacher"
- },
+ "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "httpMethod": "GET",
+ "id": "classroom.courses.students.get",
"parameterOrder": [
"courseId",
"userId"
],
- "httpMethod": "GET",
"parameters": {
- "userId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- },
"courseId": {
- "location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
"required": true,
"type": "string"
}
},
+ "path": "v1/courses/{courseId}/students/{userId}",
+ "response": {
+ "$ref": "Student"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.profile.emails",
"https://www.googleapis.com/auth/classroom.profile.photos",
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.get",
- "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist."
+ ]
},
"list": {
- "flatPath": "v1/courses/{courseId}/teachers",
- "path": "v1/courses/{courseId}/teachers",
- "id": "classroom.courses.teachers.list",
- "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
- "response": {
- "$ref": "ListTeachersResponse"
- },
+ "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
+ "flatPath": "v1/courses/{courseId}/students",
+ "httpMethod": "GET",
+ "id": "classroom.courses.students.list",
"parameterOrder": [
"courseId"
],
- "httpMethod": "GET",
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/students",
+ "response": {
+ "$ref": "ListStudentsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.profile.emails",
"https://www.googleapis.com/auth/classroom.profile.photos",
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ]
+ }
+ }
+ },
+ "teachers": {
+ "methods": {
+ "create": {
+ "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "httpMethod": "POST",
+ "id": "classroom.courses.teachers.create",
+ "parameterOrder": [
+ "courseId"
],
"parameters": {
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer"
- },
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
- }
- },
- "create": {
+ },
+ "path": "v1/courses/{courseId}/teachers",
+ "request": {
+ "$ref": "Teacher"
+ },
"response": {
"$ref": "Teacher"
},
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/classroom.profile.emails",
"https://www.googleapis.com/auth/classroom.profile.photos",
"https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "httpMethod": "DELETE",
+ "id": "classroom.courses.teachers.delete",
+ "parameterOrder": [
+ "courseId",
+ "userId"
],
"parameters": {
"courseId": {
- "location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
"required": true,
"type": "string"
}
},
- "flatPath": "v1/courses/{courseId}/teachers",
- "path": "v1/courses/{courseId}/teachers",
- "id": "classroom.courses.teachers.create",
- "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
- "request": {
+ "path": "v1/courses/{courseId}/teachers/{userId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "get": {
+ "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "httpMethod": "GET",
+ "id": "classroom.courses.teachers.get",
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/teachers/{userId}",
+ "response": {
"$ref": "Teacher"
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ]
+ },
+ "list": {
+ "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "httpMethod": "GET",
+ "id": "classroom.courses.teachers.list",
+ "parameterOrder": [
+ "courseId"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/teachers",
+ "response": {
+ "$ref": "ListTeachersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ]
}
}
+ },
+ "topics": {
+ "methods": {
+ "get": {
+ "description": "Returns a topic.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or topic, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or topic does not exist.",
+ "flatPath": "v1/courses/{courseId}/topics/{id}",
+ "httpMethod": "GET",
+ "id": "classroom.courses.topics.get",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the topic.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/topics/{id}",
+ "response": {
+ "$ref": "Topic"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ ]
+ },
+ "list": {
+ "description": "Returns the list of topics that the requester is permitted to view.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
+ "flatPath": "v1/courses/{courseId}/topics",
+ "httpMethod": "GET",
+ "id": "classroom.courses.topics.list",
+ "parameterOrder": [
+ "courseId"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/topics",
+ "response": {
+ "$ref": "ListTopicResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "invitations": {
+ "methods": {
+ "accept": {
+ "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "flatPath": "v1/invitations/{id}:accept",
+ "httpMethod": "POST",
+ "id": "classroom.invitations.accept",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to accept.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/invitations/{id}:accept",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "create": {
+ "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
+ "flatPath": "v1/invitations",
+ "httpMethod": "POST",
+ "id": "classroom.invitations.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/invitations",
+ "request": {
+ "$ref": "Invitation"
+ },
+ "response": {
+ "$ref": "Invitation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "flatPath": "v1/invitations/{id}",
+ "httpMethod": "DELETE",
+ "id": "classroom.invitations.delete",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/invitations/{id}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "get": {
+ "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "flatPath": "v1/invitations/{id}",
+ "httpMethod": "GET",
+ "id": "classroom.invitations.get",
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to return.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/invitations/{id}",
+ "response": {
+ "$ref": "Invitation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ]
+ },
+ "list": {
+ "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
+ "flatPath": "v1/invitations",
+ "httpMethod": "GET",
+ "id": "classroom.invitations.list",
+ "parameterOrder": [],
+ "parameters": {
+ "courseId": {
+ "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
+ },
+ "userId": {
+ "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/invitations",
+ "response": {
+ "$ref": "ListInvitationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ]
+ }
+ }
+ },
+ "registrations": {
+ "methods": {
+ "create": {
+ "description": "Creates a `Registration`, causing Classroom to start sending notifications\nfrom the provided `feed` to the provided `destination`.\n\nReturns the created `Registration`. Currently, this will be the same as\nthe argument, but with server-assigned fields such as `expiry_time` and\n`id` filled in.\n\nNote that any value specified for the `expiry_time` or `id` fields will be\nignored.\n\nWhile Classroom may validate the `destination` and return errors on a best\neffort basis, it is the caller's responsibility to ensure that it exists\nand that Classroom has permission to publish to it.\n\nThis method may return the following error codes:\n\n* `PERMISSION_DENIED` if:\n * the authenticated user does not have permission to receive\n notifications from the requested field; or\n * the credential provided does not include the appropriate scope for the\n requested feed.\n * another access error is encountered.\n* `INVALID_ARGUMENT` if:\n * no `destination` is specified, or the specified `destination` is not\n valid; or\n * no `feed` is specified, or the specified `feed` is not valid.\n* `NOT_FOUND` if:\n * the specified `feed` cannot be located, or the requesting user does not\n have permission to determine whether or not it exists; or\n * the specified `destination` cannot be located, or Classroom has not\n been granted permission to publish to it.",
+ "flatPath": "v1/registrations",
+ "httpMethod": "POST",
+ "id": "classroom.registrations.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/registrations",
+ "request": {
+ "$ref": "Registration"
+ },
+ "response": {
+ "$ref": "Registration"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.push-notifications",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`.",
+ "flatPath": "v1/registrations/{registrationId}",
+ "httpMethod": "DELETE",
+ "id": "classroom.registrations.delete",
+ "parameterOrder": [
+ "registrationId"
+ ],
+ "parameters": {
+ "registrationId": {
+ "description": "The `registration_id` of the `Registration` to be deleted.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/registrations/{registrationId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.push-notifications",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ]
}
}
},
@@ -1566,185 +1771,185 @@
"methods": {
"get": {
"description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.",
- "response": {
- "$ref": "UserProfile"
- },
+ "flatPath": "v1/userProfiles/{userId}",
+ "httpMethod": "GET",
+ "id": "classroom.userProfiles.get",
"parameterOrder": [
"userId"
],
- "httpMethod": "GET",
+ "parameters": {
+ "userId": {
+ "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/userProfiles/{userId}",
+ "response": {
+ "$ref": "UserProfile"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.profile.emails",
"https://www.googleapis.com/auth/classroom.profile.photos",
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "userId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- }
- },
- "flatPath": "v1/userProfiles/{userId}",
- "path": "v1/userProfiles/{userId}",
- "id": "classroom.userProfiles.get"
+ ]
}
},
"resources": {
"guardianInvitations": {
"methods": {
"create": {
- "request": {
- "$ref": "GuardianInvitation"
- },
"description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.",
- "response": {
- "$ref": "GuardianInvitation"
- },
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
+ "httpMethod": "POST",
+ "id": "classroom.userProfiles.guardianInvitations.create",
"parameterOrder": [
"studentId"
],
- "httpMethod": "POST",
"parameters": {
"studentId": {
"description": "ID of the student (in standard format)",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "request": {
+ "$ref": "GuardianInvitation"
+ },
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ]
+ },
+ "get": {
+ "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.",
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "httpMethod": "GET",
+ "id": "classroom.userProfiles.guardianInvitations.get",
+ "parameterOrder": [
+ "studentId",
+ "invitationId"
],
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
- "path": "v1/userProfiles/{studentId}/guardianInvitations",
- "id": "classroom.userProfiles.guardianInvitations.create"
+ "parameters": {
+ "invitationId": {
+ "description": "The `id` field of the `GuardianInvitation` being requested.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "studentId": {
+ "description": "The ID of the student whose guardian invitation is being requested.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ]
},
"list": {
- "response": {
- "$ref": "ListGuardianInvitationsResponse"
- },
+ "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
+ "httpMethod": "GET",
+ "id": "classroom.userProfiles.guardianInvitations.list",
"parameterOrder": [
"studentId"
],
- "httpMethod": "GET",
"parameters": {
- "studentId": {
- "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
"invitedEmailAddress": {
- "location": "query",
"description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
- "type": "string"
- },
- "states": {
- "repeated": true,
"location": "query",
- "enum": [
- "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
- "PENDING",
- "COMPLETE"
- ],
- "description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
+ },
+ "states": {
+ "description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
+ "enum": [
+ "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
+ "PENDING",
+ "COMPLETE"
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "studentId": {
+ "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
},
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "response": {
+ "$ref": "ListGuardianInvitationsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students",
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
- "path": "v1/userProfiles/{studentId}/guardianInvitations",
- "id": "classroom.userProfiles.guardianInvitations.list",
- "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student."
+ ]
},
- "get": {
- "id": "classroom.userProfiles.guardianInvitations.get",
- "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.",
- "httpMethod": "GET",
+ "patch": {
+ "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "httpMethod": "PATCH",
+ "id": "classroom.userProfiles.guardianInvitations.patch",
"parameterOrder": [
"studentId",
"invitationId"
],
- "response": {
- "$ref": "GuardianInvitation"
- },
"parameters": {
- "studentId": {
+ "invitationId": {
+ "description": "The `id` field of the `GuardianInvitation` to be modified.",
"location": "path",
- "description": "The ID of the student whose guardian invitation is being requested.",
"required": true,
"type": "string"
},
- "invitationId": {
- "required": true,
- "type": "string",
+ "studentId": {
+ "description": "The ID of the student whose guardian invitation is to be modified.",
"location": "path",
- "description": "The `id` field of the `GuardianInvitation` being requested."
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students",
- "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
- },
- "patch": {
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
"path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "id": "classroom.userProfiles.guardianInvitations.patch",
- "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
"request": {
"$ref": "GuardianInvitation"
},
"response": {
"$ref": "GuardianInvitation"
},
- "parameterOrder": [
- "studentId",
- "invitationId"
- ],
- "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "parameters": {
- "invitationId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The `id` field of the `GuardianInvitation` to be modified."
- },
- "updateMask": {
- "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "studentId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the student whose guardian invitation is to be modified."
- }
- }
+ ]
}
}
},
@@ -1752,104 +1957,104 @@
"methods": {
"delete": {
"description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.",
- "response": {
- "$ref": "Empty"
- },
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "httpMethod": "DELETE",
+ "id": "classroom.userProfiles.guardians.delete",
"parameterOrder": [
"studentId",
"guardianId"
],
- "httpMethod": "DELETE",
"parameters": {
- "studentId": {
+ "guardianId": {
+ "description": "The `id` field from a `Guardian`.",
"location": "path",
- "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"required": true,
"type": "string"
},
- "guardianId": {
- "description": "The `id` field from a `Guardian`.",
+ "studentId": {
+ "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "id": "classroom.userProfiles.guardians.delete"
+ ]
},
- "list": {
- "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
- "response": {
- "$ref": "ListGuardiansResponse"
- },
- "parameterOrder": [
- "studentId"
- ],
+ "get": {
+ "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
"httpMethod": "GET",
+ "id": "classroom.userProfiles.guardians.get",
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "parameters": {
+ "guardianId": {
+ "description": "The `id` field from a `Guardian`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "studentId": {
+ "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "response": {
+ "$ref": "Guardian"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
"https://www.googleapis.com/auth/classroom.guardianlinks.students",
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ]
+ },
+ "list": {
+ "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
+ "flatPath": "v1/userProfiles/{studentId}/guardians",
+ "httpMethod": "GET",
+ "id": "classroom.userProfiles.guardians.list",
+ "parameterOrder": [
+ "studentId"
],
"parameters": {
- "studentId": {
- "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.",
- "required": true,
- "type": "string",
- "location": "path"
+ "invitedEmailAddress": {
+ "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
"pageToken": {
"description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "invitedEmailAddress": {
- "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
"location": "query",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/userProfiles/{studentId}/guardians",
- "path": "v1/userProfiles/{studentId}/guardians",
- "id": "classroom.userProfiles.guardians.list"
- },
- "get": {
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "id": "classroom.userProfiles.guardians.get",
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
- "httpMethod": "GET",
- "parameterOrder": [
- "studentId",
- "guardianId"
- ],
- "response": {
- "$ref": "Guardian"
- },
- "parameters": {
- "studentId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
+ "type": "string"
},
- "guardianId": {
+ "studentId": {
+ "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.",
"location": "path",
- "description": "The `id` field from a `Guardian`.",
"required": true,
"type": "string"
}
},
+ "path": "v1/userProfiles/{studentId}/guardians",
+ "response": {
+ "$ref": "ListGuardiansResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
"https://www.googleapis.com/auth/classroom.guardianlinks.students",
@@ -1859,152 +2064,467 @@
}
}
}
- },
- "registrations": {
- "methods": {
- "create": {
- "request": {
- "$ref": "Registration"
- },
- "description": "Creates a `Registration`, causing Classroom to start sending notifications\nfrom the provided `feed` to the provided `destination`.\n\nReturns the created `Registration`. Currently, this will be the same as\nthe argument, but with server-assigned fields such as `expiry_time` and\n`id` filled in.\n\nNote that any value specified for the `expiry_time` or `id` fields will be\nignored.\n\nWhile Classroom may validate the `destination` and return errors on a best\neffort basis, it is the caller's responsibility to ensure that it exists\nand that Classroom has permission to publish to it.\n\nThis method may return the following error codes:\n\n* `PERMISSION_DENIED` if:\n * the authenticated user does not have permission to receive\n notifications from the requested field; or\n * the credential provided does not include the appropriate scope for the\n requested feed.\n * another access error is encountered.\n* `INVALID_ARGUMENT` if:\n * no `destination` is specified, or the specified `destination` is not\n valid; or\n * no `feed` is specified, or the specified `feed` is not valid.\n* `NOT_FOUND` if:\n * the specified `feed` cannot be located, or the requesting user does not\n have permission to determine whether or not it exists; or\n * the specified `destination` cannot be located, or Classroom has not\n been granted permission to publish to it.",
- "response": {
- "$ref": "Registration"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.push-notifications",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/registrations",
- "path": "v1/registrations",
- "id": "classroom.registrations.create"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "registrationId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.push-notifications",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "registrationId": {
- "description": "The `registration_id` of the `Registration` to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/registrations/{registrationId}",
- "path": "v1/registrations/{registrationId}",
- "id": "classroom.registrations.delete",
- "description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`."
- }
- }
- }
- },
- "parameters": {
- "key": {
- "type": "string",
- "location": "query",
- "description": "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."
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
}
},
+ "revision": "20180203",
+ "rootUrl": "https://classroom.googleapis.com/",
"schemas": {
- "Date": {
- "id": "Date",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object",
+ "Announcement": {
+ "description": "Announcement created by a teacher for students of the course",
+ "id": "Announcement",
"properties": {
+ "alternateLink": {
+ "description": "Absolute link to this announcement in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
+ "type": "string"
+ },
+ "assigneeMode": {
+ "description": "Assignee mode of the announcement.\nIf unspecified, the default value is `ALL_STUDENTS`.",
+ "enum": [
+ "ASSIGNEE_MODE_UNSPECIFIED",
+ "ALL_STUDENTS",
+ "INDIVIDUAL_STUDENTS"
+ ],
+ "enumDescriptions": [
+ "No mode specified. This is never returned.",
+ "All students can see the item.\nThis is the default state.",
+ "A subset of the students can see the item."
+ ],
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Timestamp when this announcement was created.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "creatorUserId": {
+ "description": "Identifier for the user that created the announcement.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Classroom-assigned identifier of this announcement, unique per course.\n\nRead-only.",
+ "type": "string"
+ },
+ "individualStudentsOptions": {
+ "$ref": "IndividualStudentsOptions",
+ "description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this\nfield will be able to see the announcement."
+ },
+ "materials": {
+ "description": "Additional materials.\n\nAnnouncements must have no more than 20 material items.",
+ "items": {
+ "$ref": "Material"
+ },
+ "type": "array"
+ },
+ "scheduledTime": {
+ "description": "Optional timestamp when this announcement is scheduled to be published.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "description": "Status of this announcement.\nIf unspecified, the default state is `DRAFT`.",
+ "enum": [
+ "ANNOUNCEMENT_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ],
+ "enumDescriptions": [
+ "No state specified. This is never returned.",
+ "Status for announcement that has been published.\nThis is the default state.",
+ "Status for an announcement that is not yet published.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.",
+ "Status for announcement that was published but is now deleted.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.\nAnnouncement in this state is deleted after some time."
+ ],
+ "type": "string"
+ },
+ "text": {
+ "description": "Description of this announcement.\nThe text must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Timestamp of the most recent change to this announcement.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Assignment": {
+ "description": "Additional details for assignments.",
+ "id": "Assignment",
+ "properties": {
+ "studentWorkFolder": {
+ "$ref": "DriveFolder",
+ "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers and administrators."
+ }
+ },
+ "type": "object"
+ },
+ "AssignmentSubmission": {
+ "description": "Student work for an assignment.",
+ "id": "AssignmentSubmission",
+ "properties": {
+ "attachments": {
+ "description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (e.g. title) may not be.",
+ "items": {
+ "$ref": "Attachment"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Attachment": {
+ "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
+ "id": "Attachment",
+ "properties": {
+ "driveFile": {
+ "$ref": "DriveFile",
+ "description": "Google Drive file attachment."
+ },
+ "form": {
+ "$ref": "Form",
+ "description": "Google Forms attachment."
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "Link attachment."
+ },
+ "youTubeVideo": {
+ "$ref": "YouTubeVideo",
+ "description": "Youtube video attachment."
+ }
+ },
+ "type": "object"
+ },
+ "CloudPubsubTopic": {
+ "description": "A reference to a Cloud Pub/Sub topic.\n\nTo register for notifications, the owner of the topic must grant\n`classroom-notifications@system.gserviceaccount.com` the\n `projects.topics.publish` permission.",
+ "id": "CloudPubsubTopic",
+ "properties": {
+ "topicName": {
+ "description": "The `name` field of a Cloud Pub/Sub\n[Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Course": {
+ "description": "A Course in Classroom.",
+ "id": "Course",
+ "properties": {
+ "alternateLink": {
+ "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
+ "type": "string"
+ },
+ "calendarId": {
+ "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseGroupEmail": {
+ "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseMaterialSets": {
+ "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
+ "items": {
+ "$ref": "CourseMaterialSet"
+ },
+ "type": "array"
+ },
+ "courseState": {
+ "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
+ "enum": [
+ "COURSE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "ARCHIVED",
+ "PROVISIONED",
+ "DECLINED",
+ "SUSPENDED"
+ ],
+ "enumDescriptions": [
+ "No course state. No returned Course message will use this value.",
+ "The course is active.",
+ "The course has been archived. You cannot modify it except to change it\nto a different state.",
+ "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
+ "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
+ "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
+ ],
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",
+ "type": "string"
+ },
+ "descriptionHeading": {
+ "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
+ "type": "string"
+ },
+ "enrollmentCode": {
+ "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "type": "string"
+ },
+ "guardiansEnabled": {
+ "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.",
+ "type": "string"
+ },
+ "ownerId": {
+ "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.",
+ "type": "string"
+ },
+ "room": {
+ "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
+ "type": "string"
+ },
+ "section": {
+ "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.",
+ "type": "string"
+ },
+ "teacherFolder": {
+ "$ref": "DriveFolder",
+ "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only."
+ },
+ "teacherGroupEmail": {
+ "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CourseAlias": {
+ "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.",
+ "id": "CourseAlias",
+ "properties": {
+ "alias": {
+ "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:\u003cname\u003e` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:\u003cname\u003e` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CourseMaterial": {
+ "description": "A material attached to a course as part of a material set.",
+ "id": "CourseMaterial",
+ "properties": {
+ "driveFile": {
+ "$ref": "DriveFile",
+ "description": "Google Drive file attachment."
+ },
+ "form": {
+ "$ref": "Form",
+ "description": "Google Forms attachment."
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "Link atatchment."
+ },
+ "youTubeVideo": {
+ "$ref": "YouTubeVideo",
+ "description": "Youtube video attachment."
+ }
+ },
+ "type": "object"
+ },
+ "CourseMaterialSet": {
+ "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
+ "id": "CourseMaterialSet",
+ "properties": {
+ "materials": {
+ "description": "Materials attached to this set.",
+ "items": {
+ "$ref": "CourseMaterial"
+ },
+ "type": "array"
+ },
+ "title": {
+ "description": "Title for this set.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CourseRosterChangesInfo": {
+ "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.",
+ "id": "CourseRosterChangesInfo",
+ "properties": {
+ "courseId": {
+ "description": "The `course_id` of the course to subscribe to roster changes for.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CourseWork": {
+ "description": "Course work created by a teacher for students of the course.",
+ "id": "CourseWork",
+ "properties": {
+ "alternateLink": {
+ "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
+ "type": "string"
+ },
+ "assigneeMode": {
+ "description": "Assignee mode of the coursework.\nIf unspecified, the default value is `ALL_STUDENTS`.",
+ "enum": [
+ "ASSIGNEE_MODE_UNSPECIFIED",
+ "ALL_STUDENTS",
+ "INDIVIDUAL_STUDENTS"
+ ],
+ "enumDescriptions": [
+ "No mode specified. This is never returned.",
+ "All students can see the item.\nThis is the default state.",
+ "A subset of the students can see the item."
+ ],
+ "type": "string"
+ },
+ "assignment": {
+ "$ref": "Assignment",
+ "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
+ },
+ "associatedWithDeveloper": {
+ "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Timestamp when this course work was created.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "creatorUserId": {
+ "description": "Identifier for the user that created the coursework.\n\nRead-only.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
+ "type": "string"
+ },
+ "dueDate": {
+ "$ref": "Date",
+ "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified."
+ },
+ "dueTime": {
+ "$ref": "TimeOfDay",
+ "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified."
+ },
+ "id": {
+ "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
+ "type": "string"
+ },
+ "individualStudentsOptions": {
+ "$ref": "IndividualStudentsOptions",
+ "description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field will be assigned the coursework."
+ },
+ "materials": {
+ "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
+ "items": {
+ "$ref": "Material"
+ },
+ "type": "array"
+ },
+ "maxPoints": {
+ "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
+ "format": "double",
+ "type": "number"
+ },
+ "multipleChoiceQuestion": {
+ "$ref": "MultipleChoiceQuestion",
+ "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise."
+ },
+ "scheduledTime": {
+ "description": "Optional timestamp when this course work is scheduled to be published.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
+ "enum": [
+ "COURSE_WORK_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ],
+ "enumDescriptions": [
+ "No state specified. This is never returned.",
+ "Status for work that has been published.\nThis is the default state.",
+ "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.",
+ "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
+ ],
+ "type": "string"
+ },
+ "submissionModificationMode": {
+ "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
+ "enum": [
+ "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
+ "MODIFIABLE_UNTIL_TURNED_IN",
+ "MODIFIABLE"
+ ],
+ "enumDescriptions": [
+ "No modification mode specified. This is never returned.",
+ "Submisisons can be modified before being turned in.",
+ "Submisisons can be modified at any time."
+ ],
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "workType": {
+ "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
+ "enum": [
+ "COURSE_WORK_TYPE_UNSPECIFIED",
+ "ASSIGNMENT",
+ "SHORT_ANSWER_QUESTION",
+ "MULTIPLE_CHOICE_QUESTION"
+ ],
+ "enumDescriptions": [
+ "No work type specified. This is never returned.",
+ "An assignment.",
+ "A short answer question.",
+ "A multiple-choice question."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "id": "Date",
+ "properties": {
+ "day": {
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "format": "int32",
+ "type": "integer"
+ },
"month": {
"description": "Month of year. Must be from 1 to 12.",
"format": "int32",
@@ -2014,168 +2534,153 @@
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
"type": "integer"
- },
- "day": {
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
- "format": "int32",
- "type": "integer"
}
- }
+ },
+ "type": "object"
},
- "Name": {
- "description": "Details of the user's name.",
- "type": "object",
+ "DriveFile": {
+ "description": "Representation of a Google Drive file.",
+ "id": "DriveFile",
"properties": {
- "givenName": {
- "description": "The user's first name.\n\nRead-only.",
+ "alternateLink": {
+ "description": "URL that can be used to access the Drive item.\n\nRead-only.",
"type": "string"
},
- "familyName": {
- "description": "The user's last name.\n\nRead-only.",
+ "id": {
+ "description": "Drive API resource ID.",
"type": "string"
},
- "fullName": {
- "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of the Drive item.\n\nRead-only.",
"type": "string"
}
},
- "id": "Name"
+ "type": "object"
},
- "Assignment": {
- "description": "Additional details for assignments.",
- "type": "object",
+ "DriveFolder": {
+ "description": "Representation of a Google Drive folder.",
+ "id": "DriveFolder",
"properties": {
- "studentWorkFolder": {
- "$ref": "DriveFolder",
- "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers and administrators."
- }
- },
- "id": "Assignment"
- },
- "SharedDriveFile": {
- "description": "Drive file that is used as material for course work.",
- "type": "object",
- "properties": {
- "driveFile": {
- "description": "Drive file details.",
- "$ref": "DriveFile"
+ "alternateLink": {
+ "description": "URL that can be used to access the Drive folder.\n\nRead-only.",
+ "type": "string"
},
- "shareMode": {
- "enum": [
- "UNKNOWN_SHARE_MODE",
- "VIEW",
- "EDIT",
- "STUDENT_COPY"
- ],
- "description": "Mechanism by which students access the Drive item.",
- "type": "string",
- "enumDescriptions": [
- "No sharing mode specified. This should never be returned.",
- "Students can view the shared file.",
- "Students can edit the shared file.",
- "Students have a personal copy of the shared file."
- ]
+ "id": {
+ "description": "Drive API resource ID.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of the Drive folder.\n\nRead-only.",
+ "type": "string"
}
},
- "id": "SharedDriveFile"
+ "type": "object"
},
"Empty": {
- "id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {}
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "Feed": {
+ "description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".",
+ "id": "Feed",
+ "properties": {
+ "courseRosterChangesInfo": {
+ "$ref": "CourseRosterChangesInfo",
+ "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`."
+ },
+ "feedType": {
+ "description": "The type of feed.",
+ "enum": [
+ "FEED_TYPE_UNSPECIFIED",
+ "DOMAIN_ROSTER_CHANGES",
+ "COURSE_ROSTER_CHANGES"
+ ],
+ "enumDescriptions": [
+ "Should never be returned or provided.",
+ "All roster changes for a particular domain.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation.",
+ "All roster changes for a particular course.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Form": {
+ "description": "Google Forms item.",
+ "id": "Form",
+ "properties": {
+ "formUrl": {
+ "description": "URL of the form.",
+ "type": "string"
+ },
+ "responseUrl": {
+ "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.",
+ "type": "string"
+ },
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the Form.\n\nRead-only.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of the Form.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"GlobalPermission": {
- "type": "object",
+ "description": "Global user permission description.",
+ "id": "GlobalPermission",
"properties": {
"permission": {
- "enumDescriptions": [
- "No permission is specified. This is not returned and is not a\nvalid value.",
- "User is permitted to create a course."
- ],
+ "description": "Permission value.",
"enum": [
"PERMISSION_UNSPECIFIED",
"CREATE_COURSE"
],
- "description": "Permission value.",
- "type": "string"
- }
- },
- "id": "GlobalPermission",
- "description": "Global user permission description."
- },
- "ModifyAnnouncementAssigneesRequest": {
- "description": "Request to modify assignee mode and options of an announcement.",
- "type": "object",
- "properties": {
- "assigneeMode": {
- "description": "Mode of the announcement describing whether it will be accessible by all\nstudents or specified individual students.",
- "type": "string",
"enumDescriptions": [
- "No mode specified. This is never returned.",
- "All students can see the item.\nThis is the default state.",
- "A subset of the students can see the item."
+ "No permission is specified. This is not returned and is not a\nvalid value.",
+ "User is permitted to create a course."
],
- "enum": [
- "ASSIGNEE_MODE_UNSPECIFIED",
- "ALL_STUDENTS",
- "INDIVIDUAL_STUDENTS"
- ]
- },
- "modifyIndividualStudentsOptions": {
- "description": "Set which students can view or cannot view the announcement.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
- "$ref": "ModifyIndividualStudentsOptions"
- }
- },
- "id": "ModifyAnnouncementAssigneesRequest"
- },
- "Teacher": {
- "id": "Teacher",
- "description": "Teacher of a course.",
- "type": "object",
- "properties": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course.\n\nRead-only."
- },
- "profile": {
- "description": "Global user information for the teacher.\n\nRead-only.",
- "$ref": "UserProfile"
- },
- "userId": {
- "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"type": "string"
}
- }
+ },
+ "type": "object"
},
"GradeHistory": {
"description": "The history of each grade on this submission.",
- "type": "object",
+ "id": "GradeHistory",
"properties": {
"actorUserId": {
"description": "The teacher who made the grade change.",
"type": "string"
},
- "gradeTimestamp": {
- "type": "string",
- "description": "When the grade of the submission was changed.",
- "format": "google-datetime"
- },
"gradeChangeType": {
"description": "The type of grade change at this time in the submission grade history.",
- "type": "string",
+ "enum": [
+ "UNKNOWN_GRADE_CHANGE_TYPE",
+ "DRAFT_GRADE_POINTS_EARNED_CHANGE",
+ "ASSIGNED_GRADE_POINTS_EARNED_CHANGE",
+ "MAX_POINTS_CHANGE"
+ ],
"enumDescriptions": [
"No grade change type specified. This should never be returned.",
"A change in the numerator of the draft grade.",
"A change in the numerator of the assigned grade.",
"A change in the denominator of the grade."
],
- "enum": [
- "UNKNOWN_GRADE_CHANGE_TYPE",
- "DRAFT_GRADE_POINTS_EARNED_CHANGE",
- "ASSIGNED_GRADE_POINTS_EARNED_CHANGE",
- "MAX_POINTS_CHANGE"
- ]
+ "type": "string"
+ },
+ "gradeTimestamp": {
+ "description": "When the grade of the submission was changed.",
+ "format": "google-datetime",
+ "type": "string"
},
"maxPoints": {
"description": "The denominator of the grade at this time in the submission grade\nhistory.",
@@ -2188,1187 +2693,34 @@
"type": "number"
}
},
- "id": "GradeHistory"
- },
- "AssignmentSubmission": {
- "description": "Student work for an assignment.",
- "type": "object",
- "properties": {
- "attachments": {
- "description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (e.g. title) may not be.",
- "type": "array",
- "items": {
- "$ref": "Attachment"
- }
- }
- },
- "id": "AssignmentSubmission"
- },
- "Material": {
- "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
- "type": "object",
- "properties": {
- "form": {
- "$ref": "Form",
- "description": "Google Forms material."
- },
- "link": {
- "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response.",
- "$ref": "Link"
- },
- "youtubeVideo": {
- "description": "YouTube video material.",
- "$ref": "YouTubeVideo"
- },
- "driveFile": {
- "description": "Google Drive file material.",
- "$ref": "SharedDriveFile"
- }
- },
- "id": "Material"
- },
- "Feed": {
- "properties": {
- "feedType": {
- "enumDescriptions": [
- "Should never be returned or provided.",
- "All roster changes for a particular domain.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation.",
- "All roster changes for a particular course.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation."
- ],
- "enum": [
- "FEED_TYPE_UNSPECIFIED",
- "DOMAIN_ROSTER_CHANGES",
- "COURSE_ROSTER_CHANGES"
- ],
- "description": "The type of feed.",
- "type": "string"
- },
- "courseRosterChangesInfo": {
- "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.",
- "$ref": "CourseRosterChangesInfo"
- }
- },
- "id": "Feed",
- "description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".",
"type": "object"
},
- "Student": {
- "type": "object",
- "properties": {
- "userId": {
- "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
- },
- "courseId": {
- "type": "string",
- "description": "Identifier of the course.\n\nRead-only."
- },
- "profile": {
- "$ref": "UserProfile",
- "description": "Global user information for the student.\n\nRead-only."
- },
- "studentWorkFolder": {
- "$ref": "DriveFolder",
- "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only."
- }
- },
- "id": "Student",
- "description": "Student in a course."
- },
- "Invitation": {
- "properties": {
- "courseId": {
- "description": "Identifier of the course to invite the user to.",
- "type": "string"
- },
- "id": {
- "description": "Identifier assigned by Classroom.\n\nRead-only.",
- "type": "string"
- },
- "role": {
- "enumDescriptions": [
- "No course role.",
- "Student in the course.",
- "Teacher of the course.",
- "Owner of the course."
- ],
- "enum": [
- "COURSE_ROLE_UNSPECIFIED",
- "STUDENT",
- "TEACHER",
- "OWNER"
- ],
- "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
- "type": "string"
- },
- "userId": {
- "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
- }
- },
- "id": "Invitation",
- "description": "An invitation to join a course.",
- "type": "object"
- },
- "TurnInStudentSubmissionRequest": {
- "description": "Request to turn in a student submission.",
- "type": "object",
- "properties": {},
- "id": "TurnInStudentSubmissionRequest"
- },
- "ListCourseWorkResponse": {
- "description": "Response when listing course work.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "courseWork": {
- "description": "Course work items that match the request.",
- "type": "array",
- "items": {
- "$ref": "CourseWork"
- }
- }
- },
- "id": "ListCourseWorkResponse"
- },
- "Attachment": {
- "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
- "type": "object",
- "properties": {
- "driveFile": {
- "$ref": "DriveFile",
- "description": "Google Drive file attachment."
- },
- "youTubeVideo": {
- "$ref": "YouTubeVideo",
- "description": "Youtube video attachment."
- },
- "form": {
- "$ref": "Form",
- "description": "Google Forms attachment."
- },
- "link": {
- "$ref": "Link",
- "description": "Link attachment."
- }
- },
- "id": "Attachment"
- },
- "ListTopicResponse": {
- "description": "Response when listing topics.",
- "type": "object",
- "properties": {
- "topic": {
- "description": "Topic items that match the request.",
- "type": "array",
- "items": {
- "$ref": "Topic"
- }
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- }
- },
- "id": "ListTopicResponse"
- },
- "ListAnnouncementsResponse": {
- "description": "Response when listing course work.",
- "type": "object",
- "properties": {
- "announcements": {
- "type": "array",
- "items": {
- "$ref": "Announcement"
- },
- "description": "Announcement items that match the request."
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- }
- },
- "id": "ListAnnouncementsResponse"
- },
- "TimeOfDay": {
- "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
- "type": "object",
- "properties": {
- "minutes": {
- "description": "Minutes of hour of day. Must be from 0 to 59.",
- "format": "int32",
- "type": "integer"
- },
- "hours": {
- "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
- "format": "int32",
- "type": "integer"
- },
- "nanos": {
- "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
- "format": "int32",
- "type": "integer"
- },
- "seconds": {
- "type": "integer",
- "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
- "format": "int32"
- }
- },
- "id": "TimeOfDay"
- },
- "ListCoursesResponse": {
- "description": "Response when listing courses.",
- "type": "object",
- "properties": {
- "courses": {
- "description": "Courses that match the list request.",
- "type": "array",
- "items": {
- "$ref": "Course"
- }
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- }
- },
- "id": "ListCoursesResponse"
- },
- "Form": {
- "description": "Google Forms item.",
- "type": "object",
- "properties": {
- "title": {
- "description": "Title of the Form.\n\nRead-only.",
- "type": "string"
- },
- "thumbnailUrl": {
- "type": "string",
- "description": "URL of a thumbnail image of the Form.\n\nRead-only."
- },
- "responseUrl": {
- "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.",
- "type": "string"
- },
- "formUrl": {
- "description": "URL of the form.",
- "type": "string"
- }
- },
- "id": "Form"
- },
- "ModifyCourseWorkAssigneesRequest": {
- "properties": {
- "modifyIndividualStudentsOptions": {
- "$ref": "ModifyIndividualStudentsOptions",
- "description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`."
- },
- "assigneeMode": {
- "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.",
- "type": "string",
- "enumDescriptions": [
- "No mode specified. This is never returned.",
- "All students can see the item.\nThis is the default state.",
- "A subset of the students can see the item."
- ],
- "enum": [
- "ASSIGNEE_MODE_UNSPECIFIED",
- "ALL_STUDENTS",
- "INDIVIDUAL_STUDENTS"
- ]
- }
- },
- "id": "ModifyCourseWorkAssigneesRequest",
- "description": "Request to modify assignee mode and options of a coursework.",
- "type": "object"
- },
- "ListGuardiansResponse": {
- "properties": {
- "guardians": {
- "description": "Guardians on this page of results that met the criteria specified in\nthe request.",
- "type": "array",
- "items": {
- "$ref": "Guardian"
- }
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- }
- },
- "id": "ListGuardiansResponse",
- "description": "Response when listing guardians.",
- "type": "object"
- },
- "CourseAlias": {
- "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.",
- "type": "object",
- "properties": {
- "alias": {
- "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:\u003cname\u003e` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:\u003cname\u003e` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
- "type": "string"
- }
- },
- "id": "CourseAlias"
- },
- "ListCourseAliasesResponse": {
- "description": "Response when listing course aliases.",
- "type": "object",
- "properties": {
- "aliases": {
- "description": "The course aliases.",
- "type": "array",
- "items": {
- "$ref": "CourseAlias"
- }
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- }
- },
- "id": "ListCourseAliasesResponse"
- },
- "ListGuardianInvitationsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "guardianInvitations": {
- "description": "Guardian invitations that matched the list request.",
- "type": "array",
- "items": {
- "$ref": "GuardianInvitation"
- }
- }
- },
- "id": "ListGuardianInvitationsResponse",
- "description": "Response when listing guardian invitations.",
- "type": "object"
- },
- "IndividualStudentsOptions": {
- "description": "Assignee details about a coursework/announcement.\nThis field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
- "type": "object",
- "properties": {
- "studentIds": {
- "description": "Identifiers for the students that have access to the\ncoursework/announcement.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "IndividualStudentsOptions"
- },
- "MultipleChoiceSubmission": {
- "description": "Student work for a multiple-choice question.",
- "type": "object",
- "properties": {
- "answer": {
- "description": "Student's select choice.",
- "type": "string"
- }
- },
- "id": "MultipleChoiceSubmission"
- },
- "Registration": {
- "type": "object",
- "properties": {
- "registrationId": {
- "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.",
- "type": "string"
- },
- "cloudPubsubTopic": {
- "$ref": "CloudPubsubTopic",
- "description": "The Cloud Pub/Sub topic that notifications are to be sent to."
- },
- "expiryTime": {
- "description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server.",
- "format": "google-datetime",
- "type": "string"
- },
- "feed": {
- "description": "Specification for the class of notifications that Classroom should deliver\nto the `destination`.",
- "$ref": "Feed"
- }
- },
- "id": "Registration",
- "description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`."
- },
- "CourseMaterial": {
- "description": "A material attached to a course as part of a material set.",
- "type": "object",
- "properties": {
- "driveFile": {
- "$ref": "DriveFile",
- "description": "Google Drive file attachment."
- },
- "youTubeVideo": {
- "description": "Youtube video attachment.",
- "$ref": "YouTubeVideo"
- },
- "form": {
- "description": "Google Forms attachment.",
- "$ref": "Form"
- },
- "link": {
- "$ref": "Link",
- "description": "Link atatchment."
- }
- },
- "id": "CourseMaterial"
- },
- "MultipleChoiceQuestion": {
- "id": "MultipleChoiceQuestion",
- "description": "Additional details for multiple-choice questions.",
- "type": "object",
- "properties": {
- "choices": {
- "description": "Possible choices.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Course": {
- "type": "object",
- "properties": {
- "calendarId": {
- "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
- "type": "string"
- },
- "updateTime": {
- "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "alternateLink": {
- "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
- "type": "string"
- },
- "guardiansEnabled": {
- "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
- "type": "boolean"
- },
- "courseState": {
- "enumDescriptions": [
- "No course state. No returned Course message will use this value.",
- "The course is active.",
- "The course has been archived. You cannot modify it except to change it\nto a different state.",
- "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
- "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
- "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
- ],
- "enum": [
- "COURSE_STATE_UNSPECIFIED",
- "ACTIVE",
- "ARCHIVED",
- "PROVISIONED",
- "DECLINED",
- "SUSPENDED"
- ],
- "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
- "type": "string"
- },
- "ownerId": {
- "type": "string",
- "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only."
- },
- "description": {
- "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",
- "type": "string"
- },
- "teacherGroupEmail": {
- "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
- "type": "string"
- },
- "creationTime": {
- "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string."
- },
- "teacherFolder": {
- "$ref": "DriveFolder",
- "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only."
- },
- "section": {
- "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.",
- "type": "string"
- },
- "id": {
- "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.",
- "type": "string"
- },
- "room": {
- "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
- "type": "string"
- },
- "courseGroupEmail": {
- "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
- "type": "string"
- },
- "courseMaterialSets": {
- "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
- "type": "array",
- "items": {
- "$ref": "CourseMaterialSet"
- }
- },
- "enrollmentCode": {
- "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "type": "string"
- },
- "descriptionHeading": {
- "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
- "type": "string"
- }
- },
- "id": "Course",
- "description": "A Course in Classroom."
- },
- "DriveFile": {
- "description": "Representation of a Google Drive file.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Drive API resource ID.",
- "type": "string"
- },
- "title": {
- "description": "Title of the Drive item.\n\nRead-only.",
- "type": "string"
- },
- "alternateLink": {
- "description": "URL that can be used to access the Drive item.\n\nRead-only.",
- "type": "string"
- },
- "thumbnailUrl": {
- "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "DriveFile"
- },
- "ReturnStudentSubmissionRequest": {
- "description": "Request to return a student submission.",
- "type": "object",
- "properties": {},
- "id": "ReturnStudentSubmissionRequest"
- },
- "ReclaimStudentSubmissionRequest": {
- "description": "Request to reclaim a student submission.",
- "type": "object",
- "properties": {},
- "id": "ReclaimStudentSubmissionRequest"
- },
- "CourseRosterChangesInfo": {
- "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.",
- "type": "object",
- "properties": {
- "courseId": {
- "description": "The `course_id` of the course to subscribe to roster changes for.",
- "type": "string"
- }
- },
- "id": "CourseRosterChangesInfo"
- },
- "Topic": {
- "description": "Topic created by a teacher for the course",
- "type": "object",
- "properties": {
- "updateTime": {
- "description": "The time the topic was last updated by the system.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "The name of the topic, generated by the user.\nLeading and trailing whitespaces, if any, will be trimmed. Also, multiple\nconsecutive whitespaces will be collapsed into one inside the name.\nTopic names are case sensitive, and must be no longer than 100 characters.",
- "type": "string"
- },
- "topicId": {
- "description": "Unique identifier for the topic.\n\nRead-only.",
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "Topic"
- },
- "CourseWork": {
- "type": "object",
- "properties": {
- "materials": {
- "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
- "type": "array",
- "items": {
- "$ref": "Material"
- }
- },
- "associatedWithDeveloper": {
- "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
- "type": "boolean"
- },
- "updateTime": {
- "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "alternateLink": {
- "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
- "type": "string"
- },
- "assigneeMode": {
- "enumDescriptions": [
- "No mode specified. This is never returned.",
- "All students can see the item.\nThis is the default state.",
- "A subset of the students can see the item."
- ],
- "enum": [
- "ASSIGNEE_MODE_UNSPECIFIED",
- "ALL_STUDENTS",
- "INDIVIDUAL_STUDENTS"
- ],
- "description": "Assignee mode of the coursework.\nIf unspecified, the default value is `ALL_STUDENTS`.",
- "type": "string"
- },
- "maxPoints": {
- "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
- "format": "double",
- "type": "number"
- },
- "multipleChoiceQuestion": {
- "$ref": "MultipleChoiceQuestion",
- "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise."
- },
- "assignment": {
- "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only.",
- "$ref": "Assignment"
- },
- "workType": {
- "enumDescriptions": [
- "No work type specified. This is never returned.",
- "An assignment.",
- "A short answer question.",
- "A multiple-choice question."
- ],
- "enum": [
- "COURSE_WORK_TYPE_UNSPECIFIED",
- "ASSIGNMENT",
- "SHORT_ANSWER_QUESTION",
- "MULTIPLE_CHOICE_QUESTION"
- ],
- "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
- "type": "string"
- },
- "scheduledTime": {
- "description": "Optional timestamp when this course work is scheduled to be published.",
- "format": "google-datetime",
- "type": "string"
- },
- "description": {
- "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
- "type": "string"
- },
- "creationTime": {
- "description": "Timestamp when this course work was created.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "dueDate": {
- "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified.",
- "$ref": "Date"
- },
- "individualStudentsOptions": {
- "description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field will be assigned the coursework.",
- "$ref": "IndividualStudentsOptions"
- },
- "creatorUserId": {
- "description": "Identifier for the user that created the coursework.\n\nRead-only.",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "No state specified. This is never returned.",
- "Status for work that has been published.\nThis is the default state.",
- "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.",
- "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
- ],
- "enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
- "type": "string"
- },
- "submissionModificationMode": {
- "enumDescriptions": [
- "No modification mode specified. This is never returned.",
- "Submisisons can be modified before being turned in.",
- "Submisisons can be modified at any time."
- ],
- "enum": [
- "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
- "MODIFIABLE_UNTIL_TURNED_IN",
- "MODIFIABLE"
- ],
- "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
- "type": "string"
- },
- "dueTime": {
- "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified.",
- "$ref": "TimeOfDay"
- },
- "title": {
- "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
- "type": "string"
- }
- },
- "id": "CourseWork",
- "description": "Course work created by a teacher for students of the course."
- },
"Guardian": {
- "type": "object",
+ "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.",
+ "id": "Guardian",
"properties": {
- "studentId": {
- "description": "Identifier for the student to whom the guardian relationship applies.",
- "type": "string"
- },
"guardianId": {
"description": "Identifier for the guardian.",
"type": "string"
},
+ "guardianProfile": {
+ "$ref": "UserProfile",
+ "description": "User profile for the guardian."
+ },
"invitedEmailAddress": {
"description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
"type": "string"
},
- "guardianProfile": {
- "description": "User profile for the guardian.",
- "$ref": "UserProfile"
- }
- },
- "id": "Guardian",
- "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work."
- },
- "ListStudentsResponse": {
- "type": "object",
- "properties": {
- "students": {
- "description": "Students who match the list request.",
- "type": "array",
- "items": {
- "$ref": "Student"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
- }
- },
- "id": "ListStudentsResponse",
- "description": "Response when listing students."
- },
- "UserProfile": {
- "properties": {
- "photoUrl": {
- "description": "URL of user's profile photo.\n\nRead-only.",
- "type": "string"
- },
- "permissions": {
- "description": "Global permissions of the user.\n\nRead-only.",
- "type": "array",
- "items": {
- "$ref": "GlobalPermission"
- }
- },
- "name": {
- "description": "Name of the user.\n\nRead-only.",
- "$ref": "Name"
- },
- "id": {
- "description": "Identifier of the user.\n\nRead-only.",
- "type": "string"
- },
- "verifiedTeacher": {
- "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
- "type": "boolean"
- },
- "emailAddress": {
- "description": "Email address of the user.\n\nRead-only.",
+ "studentId": {
+ "description": "Identifier for the student to whom the guardian relationship applies.",
"type": "string"
}
},
- "id": "UserProfile",
- "description": "Global information for a user.",
"type": "object"
},
- "Announcement": {
- "description": "Announcement created by a teacher for students of the course",
- "type": "object",
- "properties": {
- "scheduledTime": {
- "description": "Optional timestamp when this announcement is scheduled to be published.",
- "format": "google-datetime",
- "type": "string"
- },
- "creationTime": {
- "description": "Timestamp when this announcement was created.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "individualStudentsOptions": {
- "$ref": "IndividualStudentsOptions",
- "description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this\nfield will be able to see the announcement."
- },
- "creatorUserId": {
- "description": "Identifier for the user that created the announcement.\n\nRead-only.",
- "type": "string"
- },
- "state": {
- "enum": [
- "ANNOUNCEMENT_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "description": "Status of this announcement.\nIf unspecified, the default state is `DRAFT`.",
- "type": "string",
- "enumDescriptions": [
- "No state specified. This is never returned.",
- "Status for announcement that has been published.\nThis is the default state.",
- "Status for an announcement that is not yet published.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.",
- "Status for announcement that was published but is now deleted.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.\nAnnouncement in this state is deleted after some time."
- ]
- },
- "text": {
- "description": "Description of this announcement.\nThe text must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "description": "Classroom-assigned identifier of this announcement, unique per course.\n\nRead-only.",
- "type": "string"
- },
- "materials": {
- "description": "Additional materials.\n\nAnnouncements must have no more than 20 material items.",
- "type": "array",
- "items": {
- "$ref": "Material"
- }
- },
- "updateTime": {
- "description": "Timestamp of the most recent change to this announcement.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "assigneeMode": {
- "enumDescriptions": [
- "No mode specified. This is never returned.",
- "All students can see the item.\nThis is the default state.",
- "A subset of the students can see the item."
- ],
- "enum": [
- "ASSIGNEE_MODE_UNSPECIFIED",
- "ALL_STUDENTS",
- "INDIVIDUAL_STUDENTS"
- ],
- "description": "Assignee mode of the announcement.\nIf unspecified, the default value is `ALL_STUDENTS`.",
- "type": "string"
- },
- "alternateLink": {
- "description": "Absolute link to this announcement in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "Announcement"
- },
- "ModifyIndividualStudentsOptions": {
- "description": "Contains fields to add or remove students from a course work or announcement\nwhere the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.",
- "type": "object",
- "properties": {
- "addStudentIds": {
- "description": "Ids of students to be added as having access to this\ncoursework/announcement.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "removeStudentIds": {
- "description": "Ids of students to be removed from having access to this\ncoursework/announcement.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ModifyIndividualStudentsOptions"
- },
- "DriveFolder": {
- "description": "Representation of a Google Drive folder.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Drive API resource ID.",
- "type": "string"
- },
- "title": {
- "description": "Title of the Drive folder.\n\nRead-only.",
- "type": "string"
- },
- "alternateLink": {
- "description": "URL that can be used to access the Drive folder.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "DriveFolder"
- },
- "SubmissionHistory": {
- "description": "The history of the submission. This currently includes state and grade\nhistories.",
- "type": "object",
- "properties": {
- "gradeHistory": {
- "$ref": "GradeHistory",
- "description": "The grade history information of the submission, if present."
- },
- "stateHistory": {
- "description": "The state history information of the submission, if present.",
- "$ref": "StateHistory"
- }
- },
- "id": "SubmissionHistory"
- },
- "ShortAnswerSubmission": {
- "type": "object",
- "properties": {
- "answer": {
- "description": "Student response to a short-answer question.",
- "type": "string"
- }
- },
- "id": "ShortAnswerSubmission",
- "description": "Student work for a short answer question."
- },
- "StudentSubmission": {
- "id": "StudentSubmission",
- "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
- "type": "object",
- "properties": {
- "state": {
- "enumDescriptions": [
- "No state specified. This should never be returned.",
- "The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.",
- "Has been created.",
- "Has been turned in to the teacher.",
- "Has been returned to the student.",
- "Student chose to \"unsubmit\" the assignment."
- ],
- "enum": [
- "SUBMISSION_STATE_UNSPECIFIED",
- "NEW",
- "CREATED",
- "TURNED_IN",
- "RETURNED",
- "RECLAIMED_BY_STUDENT"
- ],
- "description": "State of this submission.\n\nRead-only.",
- "type": "string"
- },
- "userId": {
- "description": "Identifier for the student that owns this submission.\n\nRead-only.",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
- "type": "string"
- },
- "submissionHistory": {
- "description": "The history of the submission (includes state and grade histories).\n\nRead-only.",
- "type": "array",
- "items": {
- "$ref": "SubmissionHistory"
- }
- },
- "assignedGrade": {
- "description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis may be modified only by course teachers.",
- "format": "double",
- "type": "number"
- },
- "multipleChoiceSubmission": {
- "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.",
- "$ref": "MultipleChoiceSubmission"
- },
- "assignmentSubmission": {
- "$ref": "AssignmentSubmission",
- "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments."
- },
- "shortAnswerSubmission": {
- "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION.",
- "$ref": "ShortAnswerSubmission"
- },
- "associatedWithDeveloper": {
- "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
- "type": "boolean"
- },
- "updateTime": {
- "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "alternateLink": {
- "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
- "type": "string"
- },
- "draftGrade": {
- "description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.",
- "format": "double",
- "type": "number"
- },
- "late": {
- "type": "boolean",
- "description": "Whether this submission is late.\n\nRead-only."
- },
- "courseWorkType": {
- "description": "Type of course work this submission is for.\n\nRead-only.",
- "type": "string",
- "enumDescriptions": [
- "No work type specified. This is never returned.",
- "An assignment.",
- "A short answer question.",
- "A multiple-choice question."
- ],
- "enum": [
- "COURSE_WORK_TYPE_UNSPECIFIED",
- "ASSIGNMENT",
- "SHORT_ANSWER_QUESTION",
- "MULTIPLE_CHOICE_QUESTION"
- ]
- },
- "creationTime": {
- "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "ListStudentSubmissionsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
- },
- "studentSubmissions": {
- "description": "Student work that matches the request.",
- "type": "array",
- "items": {
- "$ref": "StudentSubmission"
- }
- }
- },
- "id": "ListStudentSubmissionsResponse",
- "description": "Response when listing student submissions."
- },
- "ModifyAttachmentsRequest": {
- "description": "Request to modify the attachments of a student submission.",
- "type": "object",
- "properties": {
- "addAttachments": {
- "description": "Attachments to add.\nA student submission may not have more than 20 attachments.\n\nForm attachments are not supported.",
- "type": "array",
- "items": {
- "$ref": "Attachment"
- }
- }
- },
- "id": "ModifyAttachmentsRequest"
- },
- "YouTubeVideo": {
- "description": "YouTube video item.",
- "type": "object",
- "properties": {
- "alternateLink": {
- "description": "URL that can be used to view the YouTube video.\n\nRead-only.",
- "type": "string"
- },
- "thumbnailUrl": {
- "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "description": "YouTube API resource ID.",
- "type": "string"
- },
- "title": {
- "type": "string",
- "description": "Title of the YouTube video.\n\nRead-only."
- }
- },
- "id": "YouTubeVideo"
- },
- "ListInvitationsResponse": {
- "description": "Response when listing invitations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "invitations": {
- "description": "Invitations that match the list request.",
- "type": "array",
- "items": {
- "$ref": "Invitation"
- }
- }
- },
- "id": "ListInvitationsResponse"
- },
- "CloudPubsubTopic": {
- "type": "object",
- "properties": {
- "topicName": {
- "description": "The `name` field of a Cloud Pub/Sub\n[Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).",
- "type": "string"
- }
- },
- "id": "CloudPubsubTopic",
- "description": "A reference to a Cloud Pub/Sub topic.\n\nTo register for notifications, the owner of the topic must grant\n`classroom-notifications@system.gserviceaccount.com` the\n `projects.topics.publish` permission."
- },
"GuardianInvitation": {
- "type": "object",
+ "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
+ "id": "GuardianInvitation",
"properties": {
"creationTime": {
"description": "The time that this invitation was created.\n\nRead-only.",
@@ -3379,37 +2731,533 @@
"description": "Unique identifier for this invitation.\n\nRead-only.",
"type": "string"
},
- "studentId": {
- "description": "ID of the student (in standard format)",
+ "invitedEmailAddress": {
+ "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
"type": "string"
},
"state": {
"description": "The state that this invitation is in.",
- "type": "string",
+ "enum": [
+ "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
+ "PENDING",
+ "COMPLETE"
+ ],
"enumDescriptions": [
"Should never be returned.",
"The invitation is active and awaiting a response.",
"The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired."
],
- "enum": [
- "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
- "PENDING",
- "COMPLETE"
- ]
+ "type": "string"
},
- "invitedEmailAddress": {
- "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
+ "studentId": {
+ "description": "ID of the student (in standard format)",
"type": "string"
}
},
- "id": "GuardianInvitation",
- "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address."
+ "type": "object"
+ },
+ "IndividualStudentsOptions": {
+ "description": "Assignee details about a coursework/announcement.\nThis field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
+ "id": "IndividualStudentsOptions",
+ "properties": {
+ "studentIds": {
+ "description": "Identifiers for the students that have access to the\ncoursework/announcement.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Invitation": {
+ "description": "An invitation to join a course.",
+ "id": "Invitation",
+ "properties": {
+ "courseId": {
+ "description": "Identifier of the course to invite the user to.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier assigned by Classroom.\n\nRead-only.",
+ "type": "string"
+ },
+ "role": {
+ "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
+ "enum": [
+ "COURSE_ROLE_UNSPECIFIED",
+ "STUDENT",
+ "TEACHER",
+ "OWNER"
+ ],
+ "enumDescriptions": [
+ "No course role.",
+ "Student in the course.",
+ "Teacher of the course.",
+ "Owner of the course."
+ ],
+ "type": "string"
+ },
+ "userId": {
+ "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Link": {
+ "description": "URL item.",
+ "id": "Link",
+ "properties": {
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of the target of the URL.\n\nRead-only.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListAnnouncementsResponse": {
+ "description": "Response when listing course work.",
+ "id": "ListAnnouncementsResponse",
+ "properties": {
+ "announcements": {
+ "description": "Announcement items that match the request.",
+ "items": {
+ "$ref": "Announcement"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListCourseAliasesResponse": {
+ "description": "Response when listing course aliases.",
+ "id": "ListCourseAliasesResponse",
+ "properties": {
+ "aliases": {
+ "description": "The course aliases.",
+ "items": {
+ "$ref": "CourseAlias"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListCourseWorkResponse": {
+ "description": "Response when listing course work.",
+ "id": "ListCourseWorkResponse",
+ "properties": {
+ "courseWork": {
+ "description": "Course work items that match the request.",
+ "items": {
+ "$ref": "CourseWork"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListCoursesResponse": {
+ "description": "Response when listing courses.",
+ "id": "ListCoursesResponse",
+ "properties": {
+ "courses": {
+ "description": "Courses that match the list request.",
+ "items": {
+ "$ref": "Course"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListGuardianInvitationsResponse": {
+ "description": "Response when listing guardian invitations.",
+ "id": "ListGuardianInvitationsResponse",
+ "properties": {
+ "guardianInvitations": {
+ "description": "Guardian invitations that matched the list request.",
+ "items": {
+ "$ref": "GuardianInvitation"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListGuardiansResponse": {
+ "description": "Response when listing guardians.",
+ "id": "ListGuardiansResponse",
+ "properties": {
+ "guardians": {
+ "description": "Guardians on this page of results that met the criteria specified in\nthe request.",
+ "items": {
+ "$ref": "Guardian"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListInvitationsResponse": {
+ "description": "Response when listing invitations.",
+ "id": "ListInvitationsResponse",
+ "properties": {
+ "invitations": {
+ "description": "Invitations that match the list request.",
+ "items": {
+ "$ref": "Invitation"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListStudentSubmissionsResponse": {
+ "description": "Response when listing student submissions.",
+ "id": "ListStudentSubmissionsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "studentSubmissions": {
+ "description": "Student work that matches the request.",
+ "items": {
+ "$ref": "StudentSubmission"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListStudentsResponse": {
+ "description": "Response when listing students.",
+ "id": "ListStudentsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "students": {
+ "description": "Students who match the list request.",
+ "items": {
+ "$ref": "Student"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListTeachersResponse": {
+ "description": "Response when listing teachers.",
+ "id": "ListTeachersResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "teachers": {
+ "description": "Teachers who match the list request.",
+ "items": {
+ "$ref": "Teacher"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListTopicResponse": {
+ "description": "Response when listing topics.",
+ "id": "ListTopicResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "topic": {
+ "description": "Topic items that match the request.",
+ "items": {
+ "$ref": "Topic"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Material": {
+ "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
+ "id": "Material",
+ "properties": {
+ "driveFile": {
+ "$ref": "SharedDriveFile",
+ "description": "Google Drive file material."
+ },
+ "form": {
+ "$ref": "Form",
+ "description": "Google Forms material."
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response."
+ },
+ "youtubeVideo": {
+ "$ref": "YouTubeVideo",
+ "description": "YouTube video material."
+ }
+ },
+ "type": "object"
+ },
+ "ModifyAnnouncementAssigneesRequest": {
+ "description": "Request to modify assignee mode and options of an announcement.",
+ "id": "ModifyAnnouncementAssigneesRequest",
+ "properties": {
+ "assigneeMode": {
+ "description": "Mode of the announcement describing whether it will be accessible by all\nstudents or specified individual students.",
+ "enum": [
+ "ASSIGNEE_MODE_UNSPECIFIED",
+ "ALL_STUDENTS",
+ "INDIVIDUAL_STUDENTS"
+ ],
+ "enumDescriptions": [
+ "No mode specified. This is never returned.",
+ "All students can see the item.\nThis is the default state.",
+ "A subset of the students can see the item."
+ ],
+ "type": "string"
+ },
+ "modifyIndividualStudentsOptions": {
+ "$ref": "ModifyIndividualStudentsOptions",
+ "description": "Set which students can view or cannot view the announcement.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`."
+ }
+ },
+ "type": "object"
+ },
+ "ModifyAttachmentsRequest": {
+ "description": "Request to modify the attachments of a student submission.",
+ "id": "ModifyAttachmentsRequest",
+ "properties": {
+ "addAttachments": {
+ "description": "Attachments to add.\nA student submission may not have more than 20 attachments.\n\nForm attachments are not supported.",
+ "items": {
+ "$ref": "Attachment"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ModifyCourseWorkAssigneesRequest": {
+ "description": "Request to modify assignee mode and options of a coursework.",
+ "id": "ModifyCourseWorkAssigneesRequest",
+ "properties": {
+ "assigneeMode": {
+ "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.",
+ "enum": [
+ "ASSIGNEE_MODE_UNSPECIFIED",
+ "ALL_STUDENTS",
+ "INDIVIDUAL_STUDENTS"
+ ],
+ "enumDescriptions": [
+ "No mode specified. This is never returned.",
+ "All students can see the item.\nThis is the default state.",
+ "A subset of the students can see the item."
+ ],
+ "type": "string"
+ },
+ "modifyIndividualStudentsOptions": {
+ "$ref": "ModifyIndividualStudentsOptions",
+ "description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`."
+ }
+ },
+ "type": "object"
+ },
+ "ModifyIndividualStudentsOptions": {
+ "description": "Contains fields to add or remove students from a course work or announcement\nwhere the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.",
+ "id": "ModifyIndividualStudentsOptions",
+ "properties": {
+ "addStudentIds": {
+ "description": "Ids of students to be added as having access to this\ncoursework/announcement.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "removeStudentIds": {
+ "description": "Ids of students to be removed from having access to this\ncoursework/announcement.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MultipleChoiceQuestion": {
+ "description": "Additional details for multiple-choice questions.",
+ "id": "MultipleChoiceQuestion",
+ "properties": {
+ "choices": {
+ "description": "Possible choices.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "MultipleChoiceSubmission": {
+ "description": "Student work for a multiple-choice question.",
+ "id": "MultipleChoiceSubmission",
+ "properties": {
+ "answer": {
+ "description": "Student's select choice.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Name": {
+ "description": "Details of the user's name.",
+ "id": "Name",
+ "properties": {
+ "familyName": {
+ "description": "The user's last name.\n\nRead-only.",
+ "type": "string"
+ },
+ "fullName": {
+ "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",
+ "type": "string"
+ },
+ "givenName": {
+ "description": "The user's first name.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReclaimStudentSubmissionRequest": {
+ "description": "Request to reclaim a student submission.",
+ "id": "ReclaimStudentSubmissionRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "Registration": {
+ "description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`.",
+ "id": "Registration",
+ "properties": {
+ "cloudPubsubTopic": {
+ "$ref": "CloudPubsubTopic",
+ "description": "The Cloud Pub/Sub topic that notifications are to be sent to."
+ },
+ "expiryTime": {
+ "description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "feed": {
+ "$ref": "Feed",
+ "description": "Specification for the class of notifications that Classroom should deliver\nto the `destination`."
+ },
+ "registrationId": {
+ "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReturnStudentSubmissionRequest": {
+ "description": "Request to return a student submission.",
+ "id": "ReturnStudentSubmissionRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "SharedDriveFile": {
+ "description": "Drive file that is used as material for course work.",
+ "id": "SharedDriveFile",
+ "properties": {
+ "driveFile": {
+ "$ref": "DriveFile",
+ "description": "Drive file details."
+ },
+ "shareMode": {
+ "description": "Mechanism by which students access the Drive item.",
+ "enum": [
+ "UNKNOWN_SHARE_MODE",
+ "VIEW",
+ "EDIT",
+ "STUDENT_COPY"
+ ],
+ "enumDescriptions": [
+ "No sharing mode specified. This should never be returned.",
+ "Students can view the shared file.",
+ "Students can edit the shared file.",
+ "Students have a personal copy of the shared file."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ShortAnswerSubmission": {
+ "description": "Student work for a short answer question.",
+ "id": "ShortAnswerSubmission",
+ "properties": {
+ "answer": {
+ "description": "Student response to a short-answer question.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"StateHistory": {
"description": "The history of each state this submission has been in.",
- "type": "object",
+ "id": "StateHistory",
"properties": {
+ "actorUserId": {
+ "description": "The teacher or student who made the change",
+ "type": "string"
+ },
"state": {
+ "description": "The workflow pipeline stage.",
"enum": [
"STATE_UNSPECIFIED",
"CREATED",
@@ -3418,8 +3266,6 @@
"RECLAIMED_BY_STUDENT",
"STUDENT_EDITED_AFTER_TURN_IN"
],
- "description": "The workflow pipeline stage.",
- "type": "string",
"enumDescriptions": [
"No state specified. This should never be returned.",
"The Submission has been created.",
@@ -3427,146 +3273,300 @@
"The teacher has returned the assigned document to the student.",
"The student turned in the assigned document, and then chose to\n\"unsubmit\" the assignment, giving the student control again as the\nowner.",
"The student edited their submission after turning it in. Currently,\nonly used by Questions, when the student edits their answer."
- ]
+ ],
+ "type": "string"
},
"stateTimestamp": {
"description": "When the submission entered this state.",
"format": "google-datetime",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Student": {
+ "description": "Student in a course.",
+ "id": "Student",
+ "properties": {
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
},
- "actorUserId": {
- "description": "The teacher or student who made the change",
+ "profile": {
+ "$ref": "UserProfile",
+ "description": "Global user information for the student.\n\nRead-only."
+ },
+ "studentWorkFolder": {
+ "$ref": "DriveFolder",
+ "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only."
+ },
+ "userId": {
+ "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"type": "string"
}
},
- "id": "StateHistory"
+ "type": "object"
},
- "CourseMaterialSet": {
- "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
- "type": "object",
+ "StudentSubmission": {
+ "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
+ "id": "StudentSubmission",
"properties": {
- "title": {
- "description": "Title for this set.",
+ "alternateLink": {
+ "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
"type": "string"
},
- "materials": {
- "description": "Materials attached to this set.",
- "type": "array",
+ "assignedGrade": {
+ "description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis may be modified only by course teachers.",
+ "format": "double",
+ "type": "number"
+ },
+ "assignmentSubmission": {
+ "$ref": "AssignmentSubmission",
+ "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments."
+ },
+ "associatedWithDeveloper": {
+ "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseWorkType": {
+ "description": "Type of course work this submission is for.\n\nRead-only.",
+ "enum": [
+ "COURSE_WORK_TYPE_UNSPECIFIED",
+ "ASSIGNMENT",
+ "SHORT_ANSWER_QUESTION",
+ "MULTIPLE_CHOICE_QUESTION"
+ ],
+ "enumDescriptions": [
+ "No work type specified. This is never returned.",
+ "An assignment.",
+ "A short answer question.",
+ "A multiple-choice question."
+ ],
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "draftGrade": {
+ "description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.",
+ "format": "double",
+ "type": "number"
+ },
+ "id": {
+ "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
+ "type": "string"
+ },
+ "late": {
+ "description": "Whether this submission is late.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "multipleChoiceSubmission": {
+ "$ref": "MultipleChoiceSubmission",
+ "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
+ },
+ "shortAnswerSubmission": {
+ "$ref": "ShortAnswerSubmission",
+ "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
+ },
+ "state": {
+ "description": "State of this submission.\n\nRead-only.",
+ "enum": [
+ "SUBMISSION_STATE_UNSPECIFIED",
+ "NEW",
+ "CREATED",
+ "TURNED_IN",
+ "RETURNED",
+ "RECLAIMED_BY_STUDENT"
+ ],
+ "enumDescriptions": [
+ "No state specified. This should never be returned.",
+ "The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.",
+ "Has been created.",
+ "Has been turned in to the teacher.",
+ "Has been returned to the student.",
+ "Student chose to \"unsubmit\" the assignment."
+ ],
+ "type": "string"
+ },
+ "submissionHistory": {
+ "description": "The history of the submission (includes state and grade histories).\n\nRead-only.",
"items": {
- "$ref": "CourseMaterial"
- }
- }
- },
- "id": "CourseMaterialSet"
- },
- "ListTeachersResponse": {
- "description": "Response when listing teachers.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "$ref": "SubmissionHistory"
+ },
+ "type": "array"
+ },
+ "updateTime": {
+ "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
+ "format": "google-datetime",
"type": "string"
},
- "teachers": {
- "description": "Teachers who match the list request.",
- "type": "array",
- "items": {
- "$ref": "Teacher"
- }
+ "userId": {
+ "description": "Identifier for the student that owns this submission.\n\nRead-only.",
+ "type": "string"
}
},
- "id": "ListTeachersResponse"
+ "type": "object"
},
- "Link": {
- "description": "URL item.",
- "type": "object",
+ "SubmissionHistory": {
+ "description": "The history of the submission. This currently includes state and grade\nhistories.",
+ "id": "SubmissionHistory",
"properties": {
+ "gradeHistory": {
+ "$ref": "GradeHistory",
+ "description": "The grade history information of the submission, if present."
+ },
+ "stateHistory": {
+ "$ref": "StateHistory",
+ "description": "The state history information of the submission, if present."
+ }
+ },
+ "type": "object"
+ },
+ "Teacher": {
+ "description": "Teacher of a course.",
+ "id": "Teacher",
+ "properties": {
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "profile": {
+ "$ref": "UserProfile",
+ "description": "Global user information for the teacher.\n\nRead-only."
+ },
+ "userId": {
+ "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TimeOfDay": {
+ "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
+ "id": "TimeOfDay",
+ "properties": {
+ "hours": {
+ "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minutes": {
+ "description": "Minutes of hour of day. Must be from 0 to 59.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nanos": {
+ "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "seconds": {
+ "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Topic": {
+ "description": "Topic created by a teacher for the course",
+ "id": "Topic",
+ "properties": {
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the topic, generated by the user.\nLeading and trailing whitespaces, if any, will be trimmed. Also, multiple\nconsecutive whitespaces will be collapsed into one inside the name.\nTopic names are case sensitive, and must be no longer than 100 characters.",
+ "type": "string"
+ },
+ "topicId": {
+ "description": "Unique identifier for the topic.\n\nRead-only.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "The time the topic was last updated by the system.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TurnInStudentSubmissionRequest": {
+ "description": "Request to turn in a student submission.",
+ "id": "TurnInStudentSubmissionRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "UserProfile": {
+ "description": "Global information for a user.",
+ "id": "UserProfile",
+ "properties": {
+ "emailAddress": {
+ "description": "Email address of the user.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the user.\n\nRead-only.",
+ "type": "string"
+ },
+ "name": {
+ "$ref": "Name",
+ "description": "Name of the user.\n\nRead-only."
+ },
+ "permissions": {
+ "description": "Global permissions of the user.\n\nRead-only.",
+ "items": {
+ "$ref": "GlobalPermission"
+ },
+ "type": "array"
+ },
+ "photoUrl": {
+ "description": "URL of user's profile photo.\n\nRead-only.",
+ "type": "string"
+ },
+ "verifiedTeacher": {
+ "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "YouTubeVideo": {
+ "description": "YouTube video item.",
+ "id": "YouTubeVideo",
+ "properties": {
+ "alternateLink": {
+ "description": "URL that can be used to view the YouTube video.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "YouTube API resource ID.",
+ "type": "string"
+ },
"thumbnailUrl": {
- "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
- "type": "string"
- },
- "url": {
- "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
+ "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
"type": "string"
},
"title": {
- "description": "Title of the target of the URL.\n\nRead-only.",
+ "description": "Title of the YouTube video.\n\nRead-only.",
"type": "string"
}
},
- "id": "Link"
+ "type": "object"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "version": "v1",
- "baseUrl": "https://classroom.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/classroom.courses.readonly": {
- "description": "View your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.announcements": {
- "description": "View and manage announcements in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.profile.photos": {
- "description": "View the profile photos of people in your classes"
- },
- "https://www.googleapis.com/auth/classroom.rosters.readonly": {
- "description": "View your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.guardianlinks.students": {
- "description": "View and manage guardians for students in your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.announcements.readonly": {
- "description": "View announcements in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
- "description": "View your course work and grades in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
- "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
- },
- "https://www.googleapis.com/auth/classroom.coursework.students": {
- "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer"
- },
- "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": {
- "description": "View your Google Classroom guardians"
- },
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
- "description": "View your course work and grades in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.profile.emails": {
- "description": "View the email addresses of people in your classes"
- },
- "https://www.googleapis.com/auth/classroom.coursework.me": {
- "description": "Manage your course work and view your grades in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.rosters": {
- "description": "Manage your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.push-notifications": {
- "description": "Receive notifications about your Google Classroom data"
- },
- "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
- "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
- },
- "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
- "description": "View guardians for students in your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.courses": {
- "description": "Manage your Google Classroom classes"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "Manages classes, rosters, and invitations in Google Classroom.",
"servicePath": "",
- "rootUrl": "https://classroom.googleapis.com/",
- "basePath": ""
-}
+ "title": "Google Classroom API",
+ "version": "v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-api.json b/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-api.json
index 33733c261..4022f823a 100644
--- a/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-api.json
+++ b/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-api.json
@@ -1,116 +1,308 @@
{
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Billing API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "getBillingInfo": {
- "response": {
- "$ref": "ProjectBillingInfo"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the project for which billing information is\nretrieved. For example, `projects/tokyo-rain-123`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/billingInfo",
- "path": "v1/{+name}/billingInfo",
- "id": "cloudbilling.projects.getBillingInfo",
- "description": "Gets the billing information for a project. The current authenticated user\nmust have [permission to view the\nproject](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n)."
- },
- "updateBillingInfo": {
- "request": {
- "$ref": "ProjectBillingInfo"
- },
- "description": "Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the Google Cloud Console may be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://support.google.com/cloud/answer/4430947).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.",
- "response": {
- "$ref": "ProjectBillingInfo"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the project associated with the billing information\nthat you want to update. For example, `projects/tokyo-rain-123`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/billingInfo",
- "path": "v1/{+name}/billingInfo",
- "id": "cloudbilling.projects.updateBillingInfo"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://cloudbilling.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloudbilling",
+ "description": "Allows developers to manage billing for their Google Cloud Platform projects\n programmatically.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/billing/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudbilling:v1",
+ "kind": "discovery#restDescription",
+ "name": "cloudbilling",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
"billingAccounts": {
"methods": {
- "get": {
- "description": "Gets information about a billing account. The current authenticated user\nmust be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
+ "create": {
+ "description": "Creates a billing account.\nThis method can only be used to create\n[billing subaccounts](https://cloud.google.com/billing/docs/concepts).\nWhen creating a subaccount, the current authenticated user must have the\n`billing.accounts.update` IAM permission on the master account, which is\ntypically given to billing account\n[administrators](https://cloud.google.com/billing/docs/how-to/billing-access).\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ "flatPath": "v1/billingAccounts",
+ "httpMethod": "POST",
+ "id": "cloudbilling.billingAccounts.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/billingAccounts",
+ "request": {
+ "$ref": "BillingAccount"
+ },
"response": {
"$ref": "BillingAccount"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets information about a billing account. The current authenticated user\nmust be a [viewer of the billing\naccount](https://cloud.google.com/billing/docs/how-to/billing-access).",
+ "flatPath": "v1/billingAccounts/{billingAccountsId}",
+ "httpMethod": "GET",
+ "id": "cloudbilling.billingAccounts.get",
+ "parameterOrder": [
+ "name"
+ ],
"parameters": {
"name": {
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+$",
+ "description": "The resource name of the billing account to retrieve. For example,\n`billingAccounts/012345-567890-ABCDEF`.",
"location": "path",
- "description": "The resource name of the billing account to retrieve. For example,\n`billingAccounts/012345-567890-ABCDEF`."
+ "pattern": "^billingAccounts/[^/]+$",
+ "required": true,
+ "type": "string"
}
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "BillingAccount"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a billing account.\nThe caller must have the `billing.accounts.getIamPolicy` permission on the\naccount, which is often given to billing account\n[viewers](https://cloud.google.com/billing/docs/how-to/billing-access).\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ "flatPath": "v1/billingAccounts/{billingAccountsId}:getIamPolicy",
+ "httpMethod": "GET",
+ "id": "cloudbilling.billingAccounts.getIamPolicy",
+ "parameterOrder": [
+ "resource"
],
- "flatPath": "v1/billingAccounts/{billingAccountsId}",
- "id": "cloudbilling.billingAccounts.get",
- "path": "v1/{+name}"
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^billingAccounts/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"list": {
+ "description": "Lists the billing accounts that the current authenticated user has\npermission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).",
"flatPath": "v1/billingAccounts",
- "path": "v1/billingAccounts",
+ "httpMethod": "GET",
"id": "cloudbilling.billingAccounts.list",
- "description": "Lists the billing accounts that the current authenticated user\n[owns](https://support.google.com/cloud/answer/4430947).",
+ "parameterOrder": [],
+ "parameters": {
+ "filter": {
+ "description": "Options for how to filter the returned billing accounts.\nCurrently this only supports filtering for\n[subaccounts](https://cloud.google.com/billing/docs/concepts) under a\nsingle provided reseller billing account.\n(e.g. \"master_billing_account=billingAccounts/012345-678901-ABCDEF\").\nBoolean algebra and other fields are not currently supported.\n\n\u003e This field is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListBillingAccounts`\ncall. If unspecified, the first page of results is returned.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/billingAccounts",
"response": {
"$ref": "ListBillingAccountsResponse"
},
- "parameterOrder": [],
- "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates a billing account's fields.\nCurrently the only field that can be edited is `display_name`.\nThe current authenticated user must have the `billing.accounts.update`\nIAM permission, which is typically given to the\n[administrator](https://cloud.google.com/billing/docs/how-to/billing-access)\nof the billing account.\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ "flatPath": "v1/billingAccounts/{billingAccountsId}",
+ "httpMethod": "PATCH",
+ "id": "cloudbilling.billingAccounts.patch",
+ "parameterOrder": [
+ "name"
+ ],
"parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListBillingAccounts`\ncall. If unspecified, the first page of results is returned."
+ "name": {
+ "description": "The name of the billing account resource to be updated.",
+ "location": "path",
+ "pattern": "^billingAccounts/[^/]+$",
+ "required": true,
+ "type": "string"
},
- "pageSize": {
- "type": "integer",
+ "updateMask": {
+ "description": "The update mask applied to the resource.\nOnly \"display_name\" is currently supported.",
+ "format": "google-fieldmask",
"location": "query",
- "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
- "format": "int32"
+ "type": "string"
}
},
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "BillingAccount"
+ },
+ "response": {
+ "$ref": "BillingAccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy for a billing account. Replaces any existing\npolicy.\nThe caller must have the `billing.accounts.setIamPolicy` permission on the\naccount, which is often given to billing account\n[administrators](https://cloud.google.com/billing/docs/how-to/billing-access).\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ "flatPath": "v1/billingAccounts/{billingAccountsId}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudbilling.billingAccounts.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^billingAccounts/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Tests the access control policy for a billing account. This method takes\nthe resource and a set of permissions as input and returns the subset of\nthe input permissions that the caller is allowed for that resource.\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ "flatPath": "v1/billingAccounts/{billingAccountsId}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudbilling.billingAccounts.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^billingAccounts/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
@@ -120,69 +312,126 @@
"projects": {
"methods": {
"list": {
- "response": {
- "$ref": "ListProjectBillingInfoResponse"
- },
+ "description": "Lists the projects associated with a billing account. The current\nauthenticated user must have the `billing.resourceAssociations.list` IAM\npermission, which is often given to billing account\n[viewers](https://cloud.google.com/billing/docs/how-to/billing-access).",
+ "flatPath": "v1/billingAccounts/{billingAccountsId}/projects",
+ "httpMethod": "GET",
+ "id": "cloudbilling.billingAccounts.projects.list",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
- "location": "path",
"description": "The resource name of the billing account associated with the projects that\nyou want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
+ "location": "path",
+ "pattern": "^billingAccounts/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+$"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous `ListProjectBillingInfo`\ncall. If unspecified, the first page of results is returned."
+ "type": "string"
},
"pageSize": {
- "type": "integer",
- "location": "query",
"description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
- "format": "int32"
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous `ListProjectBillingInfo`\ncall. If unspecified, the first page of results is returned.",
+ "location": "query",
+ "type": "string"
}
},
+ "path": "v1/{+name}/projects",
+ "response": {
+ "$ref": "ListProjectBillingInfoResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/billingAccounts/{billingAccountsId}/projects",
- "path": "v1/{+name}/projects",
- "id": "cloudbilling.billingAccounts.projects.list",
- "description": "Lists the projects associated with a billing account. The current\nauthenticated user must have the \"billing.resourceAssociations.list\" IAM\npermission, which is often given to billing account\n[viewers](https://support.google.com/cloud/answer/4430947)."
+ ]
}
}
}
}
},
+ "projects": {
+ "methods": {
+ "getBillingInfo": {
+ "description": "Gets the billing information for a project. The current authenticated user\nmust have [permission to view the\nproject](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n).",
+ "flatPath": "v1/projects/{projectsId}/billingInfo",
+ "httpMethod": "GET",
+ "id": "cloudbilling.projects.getBillingInfo",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the project for which billing information is\nretrieved. For example, `projects/tokyo-rain-123`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}/billingInfo",
+ "response": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "updateBillingInfo": {
+ "description": "Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the GCP Console might be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://cloud.google.com/billing/docs/how-to/billing-access).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.",
+ "flatPath": "v1/projects/{projectsId}/billingInfo",
+ "httpMethod": "PUT",
+ "id": "cloudbilling.projects.updateBillingInfo",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the project associated with the billing information\nthat you want to update. For example, `projects/tokyo-rain-123`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}/billingInfo",
+ "request": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "response": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
"services": {
"methods": {
"list": {
- "flatPath": "v1/services",
- "path": "v1/services",
- "id": "cloudbilling.services.list",
"description": "Lists all public cloud services.",
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [],
+ "flatPath": "v1/services",
"httpMethod": "GET",
+ "id": "cloudbilling.services.list",
+ "parameterOrder": [],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListServices`\ncall. If unspecified, the first page of results is returned.",
- "type": "string"
- },
"pageSize": {
- "location": "query",
"description": "Requested page size. Defaults to 5000.",
"format": "int32",
+ "location": "query",
"type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListServices`\ncall. If unspecified, the first page of results is returned.",
+ "location": "query",
+ "type": "string"
}
+ },
+ "path": "v1/services",
+ "response": {
+ "$ref": "ListServicesResponse"
}
}
},
@@ -191,230 +440,83 @@
"methods": {
"list": {
"description": "Lists all publicly available SKUs for a given cloud service.",
- "response": {
- "$ref": "ListSkusResponse"
- },
+ "flatPath": "v1/services/{servicesId}/skus",
+ "httpMethod": "GET",
+ "id": "cloudbilling.services.skus.list",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
"parameters": {
"currencyCode": {
- "type": "string",
+ "description": "The ISO 4217 currency code for the pricing info in the response proto.\nWill use the conversion rate as of start_time.\nOptional. If not specified USD will be used.",
"location": "query",
- "description": "The ISO 4217 currency code for the pricing info in the response proto.\nWill use the conversion rate as of start_time.\nOptional. If not specified USD will be used."
- },
- "endTime": {
- "location": "query",
- "description": "Optional exclusive end time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).",
- "format": "google-datetime",
"type": "string"
},
- "pageToken": {
+ "endTime": {
+ "description": "Optional exclusive end time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).",
+ "format": "google-datetime",
"location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. Defaults to 5000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
"description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListSkus`\ncall. If unspecified, the first page of results is returned.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The name of the service.\nExample: \"services/DA34-426B-A397\"",
+ "location": "path",
+ "pattern": "^services/[^/]+$",
+ "required": true,
"type": "string"
},
"startTime": {
- "type": "string",
- "location": "query",
"description": "Optional inclusive start time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).",
- "format": "google-datetime"
- },
- "pageSize": {
+ "format": "google-datetime",
"location": "query",
- "description": "Requested page size. Defaults to 5000.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "The name of the service.\nExample: \"services/DA34-426B-A397\"",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+$"
+ "type": "string"
}
},
- "flatPath": "v1/services/{servicesId}/skus",
"path": "v1/{+parent}/skus",
- "id": "cloudbilling.services.skus.list"
+ "response": {
+ "$ref": "ListSkusResponse"
+ }
}
}
}
}
}
},
- "parameters": {
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "alt": {
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response."
- },
- "key": {
- "type": "string",
- "location": "query",
- "description": "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."
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudbilling.googleapis.com/",
- "servicePath": "",
- "description": "Allows developers to manage billing for their Google Cloud Platform projects\n programmatically.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "revision": "20180116",
- "documentationLink": "https://cloud.google.com/billing/",
- "id": "cloudbilling:v1",
- "discoveryVersion": "v1",
+ "revision": "20180307",
+ "rootUrl": "https://cloudbilling.googleapis.com/",
"schemas": {
- "TierRate": {
- "description": "The price rate indicating starting usage and its corresponding price.",
- "type": "object",
- "properties": {
- "unitPrice": {
- "$ref": "Money",
- "description": "The price per unit of usage.\nExample: unit_price of amount $10 indicates that each unit will cost $10."
- },
- "startUsageAmount": {
- "type": "number",
- "description": "Usage is priced at this rate only after this amount.\nExample: start_usage_amount of 10 indicates that the usage will be priced\nat the unit_price after the first 10 usage_units.",
- "format": "double"
- }
- },
- "id": "TierRate"
- },
- "ListServicesResponse": {
- "type": "object",
- "properties": {
- "services": {
- "type": "array",
- "items": {
- "$ref": "Service"
- },
- "description": "A list of services."
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListServices` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve."
- }
- },
- "id": "ListServicesResponse",
- "description": "Response message for `ListServices`."
- },
- "ListBillingAccountsResponse": {
- "description": "Response message for `ListBillingAccounts`.",
- "type": "object",
- "properties": {
- "billingAccounts": {
- "description": "A list of billing accounts.",
- "type": "array",
- "items": {
- "$ref": "BillingAccount"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListBillingAccounts` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve."
- }
- },
- "id": "ListBillingAccountsResponse"
- },
"AggregationInfo": {
- "type": "object",
+ "description": "Represents the aggregation level and interval for pricing of a single SKU.",
+ "id": "AggregationInfo",
"properties": {
+ "aggregationCount": {
+ "description": "The number of intervals to aggregate over.\nExample: If aggregation_level is \"DAILY\" and aggregation_count is 14,\naggregation will be over 14 days.",
+ "format": "int32",
+ "type": "integer"
+ },
"aggregationInterval": {
"enum": [
"AGGREGATION_INTERVAL_UNSPECIFIED",
"DAILY",
"MONTHLY"
],
- "type": "string",
"enumDescriptions": [
"",
"",
""
- ]
- },
- "aggregationCount": {
- "description": "The number of intervals to aggregate over.\nExample: If aggregation_level is \"DAILY\" and aggregation_count is 14,\naggregation will be over 14 days.",
- "format": "int32",
- "type": "integer"
+ ],
+ "type": "string"
},
"aggregationLevel": {
"enum": [
@@ -422,147 +524,112 @@
"ACCOUNT",
"PROJECT"
],
- "type": "string",
"enumDescriptions": [
"",
"",
""
- ]
- }
- },
- "id": "AggregationInfo",
- "description": "Represents the aggregation level and interval for pricing of a single SKU."
- },
- "Service": {
- "description": "Encapsulates a single service in Google Cloud Platform.",
- "type": "object",
- "properties": {
- "serviceId": {
- "description": "The identifier for the service.\nExample: \"DA34-426B-A397\"",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The resource name for the service.\nExample: \"services/DA34-426B-A397\""
- },
- "displayName": {
- "type": "string",
- "description": "A human readable display name for this service."
- }
- },
- "id": "Service"
- },
- "ProjectBillingInfo": {
- "description": "Encapsulation of billing information for a Cloud Console project. A project\nhas at most one associated billing account at a time (but a billing account\ncan be assigned to multiple projects).",
- "type": "object",
- "properties": {
- "projectId": {
- "type": "string",
- "description": "The ID of the project that this `ProjectBillingInfo` represents, such as\n`tokyo-rain-123`. This is a convenience field so that you don't need to\nparse the `name` field to obtain a project ID. This field is read-only."
- },
- "billingAccountName": {
- "description": "The resource name of the billing account associated with the project, if\nany. For example, `billingAccounts/012345-567890-ABCDEF`.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The resource name for the `ProjectBillingInfo`; has the form\n`projects/{project_id}/billingInfo`. For example, the resource name for the\nbilling information for project `tokyo-rain-123` would be\n`projects/tokyo-rain-123/billingInfo`. This field is read-only."
- },
- "billingEnabled": {
- "type": "boolean",
- "description": "True if the project is associated with an open billing account, to which\nusage on the project is charged. False if the project is associated with a\nclosed billing account, or no billing account at all, and therefore cannot\nuse paid services. This field is read-only."
- }
- },
- "id": "ProjectBillingInfo"
- },
- "Money": {
- "description": "Represents an amount of money with its currency type.",
- "type": "object",
- "properties": {
- "units": {
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
- "type": "string"
- },
- "currencyCode": {
- "type": "string",
- "description": "The 3-letter currency code defined in ISO 4217."
- },
- "nanos": {
- "type": "integer",
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32"
- }
- },
- "id": "Money"
- },
- "BillingAccount": {
- "description": "A billing account in [Google Cloud\nConsole](https://console.cloud.google.com/). You can assign a billing account\nto one or more projects.",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The resource name of the billing account. The resource name has the form\n`billingAccounts/{billing_account_id}`. For example,\n`billingAccounts/012345-567890-ABCDEF` would be the resource name for\nbilling account `012345-567890-ABCDEF`."
- },
- "open": {
- "type": "boolean",
- "description": "True if the billing account is open, and will therefore be charged for any\nusage on associated projects. False if the billing account is closed, and\ntherefore projects associated with it will be unable to use paid services."
- },
- "displayName": {
- "description": "The display name given to the billing account, such as `My Billing\nAccount`. This name is displayed in the Google Cloud Console.",
+ ],
"type": "string"
}
},
- "id": "BillingAccount"
+ "type": "object"
},
- "Sku": {
- "description": "Encapsulates a single SKU in Google Cloud Platform",
- "type": "object",
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "id": "AuditConfig",
"properties": {
- "name": {
- "type": "string",
- "description": "The resource name for the SKU.\nExample: \"services/DA34-426B-A397/skus/AA95-CD31-42FE\""
- },
- "pricingInfo": {
- "description": "A timeline of pricing info for this SKU in chronological order.",
- "type": "array",
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
"items": {
- "$ref": "PricingInfo"
- }
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
},
- "category": {
- "$ref": "Category",
- "description": "The category hierarchy of this SKU, purely for organizational purpose."
- },
- "skuId": {
- "description": "The identifier for the SKU.\nExample: \"AA95-CD31-42FE\"",
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
- },
- "description": {
- "description": "A human readable description of the SKU, has a maximum length of 256\ncharacters.",
- "type": "string"
- },
- "serviceProviderName": {
- "description": "Identifies the service provider.\nThis is 'Google' for first party services in Google Cloud Platform.",
- "type": "string"
- },
- "serviceRegions": {
- "type": "array",
+ }
+ },
+ "type": "object"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "id": "AuditLogConfig",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
"items": {
"type": "string"
},
- "description": "List of service regions this SKU is offered at.\nExample: \"asia-east1\"\nService regions can be found at https://cloud.google.com/about/locations/"
+ "type": "array"
+ },
+ "logType": {
+ "description": "The log type that this config enables.",
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "type": "string"
}
},
- "id": "Sku"
+ "type": "object"
+ },
+ "BillingAccount": {
+ "description": "A billing account in [GCP Console](https://console.cloud.google.com/).\nYou can assign a billing account to one or more projects.",
+ "id": "BillingAccount",
+ "properties": {
+ "displayName": {
+ "description": "The display name given to the billing account, such as `My Billing\nAccount`. This name is displayed in the GCP Console.",
+ "type": "string"
+ },
+ "masterBillingAccount": {
+ "description": "If this account is a\n[subaccount](https://cloud.google.com/billing/docs/concepts), then this\nwill be the resource name of the master billing account that it is being\nresold through.\nOtherwise this will be empty.\n\n\u003e This field is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the billing account. The resource name has the form\n`billingAccounts/{billing_account_id}`. For example,\n`billingAccounts/012345-567890-ABCDEF` would be the resource name for\nbilling account `012345-567890-ABCDEF`.",
+ "type": "string"
+ },
+ "open": {
+ "description": "True if the billing account is open, and will therefore be charged for any\nusage on associated projects. False if the billing account is closed, and\ntherefore projects associated with it will be unable to use paid services.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"Category": {
"description": "Represents the category hierarchy of a SKU.",
- "type": "object",
+ "id": "Category",
"properties": {
"resourceFamily": {
- "type": "string",
- "description": "The type of product the SKU refers to.\nExample: \"Compute\", \"Storage\", \"Network\", \"ApplicationServices\" etc."
+ "description": "The type of product the SKU refers to.\nExample: \"Compute\", \"Storage\", \"Network\", \"ApplicationServices\" etc.",
+ "type": "string"
},
"resourceGroup": {
"description": "A group classification for related SKUs.\nExample: \"RAM\", \"GPU\", \"Prediction\", \"Ops\", \"GoogleEgress\" etc.",
@@ -573,134 +640,350 @@
"type": "string"
},
"usageType": {
- "type": "string",
- "description": "Represents how the SKU is consumed.\nExample: \"OnDemand\", \"Preemptible\", \"Commit1Mo\", \"Commit1Yr\" etc."
+ "description": "Represents how the SKU is consumed.\nExample: \"OnDemand\", \"Preemptible\", \"Commit1Mo\", \"Commit1Yr\" etc.",
+ "type": "string"
}
},
- "id": "Category"
+ "type": "object"
+ },
+ "ListBillingAccountsResponse": {
+ "description": "Response message for `ListBillingAccounts`.",
+ "id": "ListBillingAccountsResponse",
+ "properties": {
+ "billingAccounts": {
+ "description": "A list of billing accounts.",
+ "items": {
+ "$ref": "BillingAccount"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListBillingAccounts` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListProjectBillingInfoResponse": {
+ "description": "Request message for `ListProjectBillingInfoResponse`.",
+ "id": "ListProjectBillingInfoResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListProjectBillingInfo` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
+ "type": "string"
+ },
+ "projectBillingInfo": {
+ "description": "A list of `ProjectBillingInfo` resources representing the projects\nassociated with the billing account.",
+ "items": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for `ListServices`.",
+ "id": "ListServicesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListServices` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
+ "type": "string"
+ },
+ "services": {
+ "description": "A list of services.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"ListSkusResponse": {
"description": "Response message for `ListSkus`.",
- "type": "object",
+ "id": "ListSkusResponse",
"properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListSkus` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
+ "type": "string"
+ },
"skus": {
"description": "The list of public SKUs of the given service.",
- "type": "array",
"items": {
"$ref": "Sku"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListSkus` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve."
+ },
+ "type": "array"
}
},
- "id": "ListSkusResponse"
+ "type": "object"
+ },
+ "Money": {
+ "description": "Represents an amount of money with its currency type.",
+ "id": "Money",
+ "properties": {
+ "currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string"
+ },
+ "nanos": {
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "units": {
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "id": "Policy",
+ "properties": {
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "AuditConfig"
+ },
+ "type": "array"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "PricingExpression": {
+ "description": "Expresses a mathematical pricing formula. For Example:-\n\n`usage_unit: GBy`\n`tiered_rates:`\n `[start_usage_amount: 20, unit_price: $10]`\n `[start_usage_amount: 100, unit_price: $5]`\n\nThe above expresses a pricing formula where the first 20GB is free, the\nnext 80GB is priced at $10 per GB followed by $5 per GB for additional\nusage.",
+ "id": "PricingExpression",
+ "properties": {
+ "baseUnit": {
+ "description": "The base unit for the SKU which is the unit used in usage exports.\nExample: \"By\"",
+ "type": "string"
+ },
+ "baseUnitConversionFactor": {
+ "description": "Conversion factor for converting from price per usage_unit to price per\nbase_unit, and start_usage_amount to start_usage_amount in base_unit.\nunit_price / base_unit_conversion_factor = price per base_unit.\nstart_usage_amount * base_unit_conversion_factor = start_usage_amount in\nbase_unit.",
+ "format": "double",
+ "type": "number"
+ },
+ "baseUnitDescription": {
+ "description": "The base unit in human readable form.\nExample: \"byte\".",
+ "type": "string"
+ },
+ "displayQuantity": {
+ "description": "The recommended quantity of units for displaying pricing info. When\ndisplaying pricing info it is recommended to display:\n(unit_price * display_quantity) per display_quantity usage_unit.\nThis field does not affect the pricing formula and is for display purposes\nonly.\nExample: If the unit_price is \"0.0001 USD\", the usage_unit is \"GB\" and\nthe display_quantity is \"1000\" then the recommended way of displaying the\npricing info is \"0.10 USD per 1000 GB\"",
+ "format": "double",
+ "type": "number"
+ },
+ "tieredRates": {
+ "description": "The list of tiered rates for this pricing. The total cost is computed by\napplying each of the tiered rates on usage. This repeated list is sorted\nby ascending order of start_usage_amount.",
+ "items": {
+ "$ref": "TierRate"
+ },
+ "type": "array"
+ },
+ "usageUnit": {
+ "description": "The short hand for unit of usage this pricing is specified in.\nExample: usage_unit of \"GiBy\" means that usage is specified in \"Gibi Byte\".",
+ "type": "string"
+ },
+ "usageUnitDescription": {
+ "description": "The unit of usage in human readable form.\nExample: \"gibi byte\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"PricingInfo": {
"description": "Represents the pricing information for a SKU at a single point of time.",
- "type": "object",
+ "id": "PricingInfo",
"properties": {
- "effectiveTime": {
- "type": "string",
- "description": "The timestamp from which this pricing was effective within the requested\ntime range. This is guaranteed to be greater than or equal to the\nstart_time field in the request and less than the end_time field in the\nrequest. If a time range was not specified in the request this field will\nbe equivalent to a time within the last 12 hours, indicating the latest\npricing info.",
- "format": "google-datetime"
+ "aggregationInfo": {
+ "$ref": "AggregationInfo",
+ "description": "Aggregation Info. This can be left unspecified if the pricing expression\ndoesn't require aggregation."
},
"currencyConversionRate": {
- "type": "number",
"description": "Conversion rate used for currency conversion, from USD to the currency\nspecified in the request. This includes any surcharge collected for billing\nin non USD currency. If a currency is not specified in the request this\ndefaults to 1.0.\nExample: USD * currency_conversion_rate = JPY",
- "format": "double"
+ "format": "double",
+ "type": "number"
+ },
+ "effectiveTime": {
+ "description": "The timestamp from which this pricing was effective within the requested\ntime range. This is guaranteed to be greater than or equal to the\nstart_time field in the request and less than the end_time field in the\nrequest. If a time range was not specified in the request this field will\nbe equivalent to a time within the last 12 hours, indicating the latest\npricing info.",
+ "format": "google-datetime",
+ "type": "string"
},
"pricingExpression": {
"$ref": "PricingExpression",
"description": "Expresses the pricing formula. See `PricingExpression` for an example."
},
- "aggregationInfo": {
- "$ref": "AggregationInfo",
- "description": "Aggregation Info. This can be left unspecified if the pricing expression\ndoesn't require aggregation."
- },
"summary": {
- "type": "string",
- "description": "An optional human readable summary of the pricing information, has a\nmaximum length of 256 characters."
+ "description": "An optional human readable summary of the pricing information, has a\nmaximum length of 256 characters.",
+ "type": "string"
}
},
- "id": "PricingInfo"
+ "type": "object"
},
- "ListProjectBillingInfoResponse": {
- "type": "object",
+ "ProjectBillingInfo": {
+ "description": "Encapsulation of billing information for a GCP Console project. A project\nhas at most one associated billing account at a time (but a billing account\ncan be assigned to multiple projects).",
+ "id": "ProjectBillingInfo",
"properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListProjectBillingInfo` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve."
- },
- "projectBillingInfo": {
- "description": "A list of `ProjectBillingInfo` resources representing the projects\nassociated with the billing account.",
- "type": "array",
- "items": {
- "$ref": "ProjectBillingInfo"
- }
- }
- },
- "id": "ListProjectBillingInfoResponse",
- "description": "Request message for `ListProjectBillingInfoResponse`."
- },
- "PricingExpression": {
- "description": "Expresses a mathematical pricing formula. For Example:-\n\n`usage_unit: GBy`\n`tiered_rates:`\n `[start_usage_amount: 20, unit_price: $10]`\n `[start_usage_amount: 100, unit_price: $5]`\n\nThe above expresses a pricing formula where the first 20GB is free, the\nnext 80GB is priced at $10 per GB followed by $5 per GB for additional\nusage.",
- "type": "object",
- "properties": {
- "baseUnitDescription": {
- "description": "The base unit in human readable form.\nExample: \"byte\".",
+ "billingAccountName": {
+ "description": "The resource name of the billing account associated with the project, if\nany. For example, `billingAccounts/012345-567890-ABCDEF`.",
"type": "string"
},
- "tieredRates": {
- "type": "array",
+ "billingEnabled": {
+ "description": "True if the project is associated with an open billing account, to which\nusage on the project is charged. False if the project is associated with a\nclosed billing account, or no billing account at all, and therefore cannot\nuse paid services. This field is read-only.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The resource name for the `ProjectBillingInfo`; has the form\n`projects/{project_id}/billingInfo`. For example, the resource name for the\nbilling information for project `tokyo-rain-123` would be\n`projects/tokyo-rain-123/billingInfo`. This field is read-only.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the project that this `ProjectBillingInfo` represents, such as\n`tokyo-rain-123`. This is a convenience field so that you don't need to\nparse the `name` field to obtain a project ID. This field is read-only.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Service": {
+ "description": "Encapsulates a single service in Google Cloud Platform.",
+ "id": "Service",
+ "properties": {
+ "displayName": {
+ "description": "A human readable display name for this service.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name for the service.\nExample: \"services/DA34-426B-A397\"",
+ "type": "string"
+ },
+ "serviceId": {
+ "description": "The identifier for the service.\nExample: \"DA34-426B-A397\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "id": "SetIamPolicyRequest",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Sku": {
+ "description": "Encapsulates a single SKU in Google Cloud Platform",
+ "id": "Sku",
+ "properties": {
+ "category": {
+ "$ref": "Category",
+ "description": "The category hierarchy of this SKU, purely for organizational purpose."
+ },
+ "description": {
+ "description": "A human readable description of the SKU, has a maximum length of 256\ncharacters.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name for the SKU.\nExample: \"services/DA34-426B-A397/skus/AA95-CD31-42FE\"",
+ "type": "string"
+ },
+ "pricingInfo": {
+ "description": "A timeline of pricing info for this SKU in chronological order.",
"items": {
- "$ref": "TierRate"
+ "$ref": "PricingInfo"
},
- "description": "The list of tiered rates for this pricing. The total cost is computed by\napplying each of the tiered rates on usage. This repeated list is sorted\nby ascending order of start_usage_amount."
+ "type": "array"
},
- "usageUnit": {
- "type": "string",
- "description": "The short hand for unit of usage this pricing is specified in.\nExample: usage_unit of \"GiBy\" means that usage is specified in \"Gibi Byte\"."
- },
- "baseUnitConversionFactor": {
- "type": "number",
- "description": "Conversion factor for converting from price per usage_unit to price per\nbase_unit, and start_usage_amount to start_usage_amount in base_unit.\nunit_price / base_unit_conversion_factor = price per base_unit.\nstart_usage_amount * base_unit_conversion_factor = start_usage_amount in\nbase_unit.",
- "format": "double"
- },
- "usageUnitDescription": {
- "description": "The unit of usage in human readable form.\nExample: \"gibi byte\".",
+ "serviceProviderName": {
+ "description": "Identifies the service provider.\nThis is 'Google' for first party services in Google Cloud Platform.",
"type": "string"
},
- "displayQuantity": {
- "type": "number",
- "description": "The recommended quantity of units for displaying pricing info. When\ndisplaying pricing info it is recommended to display:\n(unit_price * display_quantity) per display_quantity usage_unit.\nThis field does not affect the pricing formula and is for display purposes\nonly.\nExample: If the unit_price is \"0.0001 USD\", the usage_unit is \"GB\" and\nthe display_quantity is \"1000\" then the recommended way of displaying the\npricing info is \"0.10 USD per 1000 GB\"",
- "format": "double"
+ "serviceRegions": {
+ "description": "List of service regions this SKU is offered at.\nExample: \"asia-east1\"\nService regions can be found at https://cloud.google.com/about/locations/",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "baseUnit": {
- "type": "string",
- "description": "The base unit for the SKU which is the unit used in usage exports.\nExample: \"By\""
+ "skuId": {
+ "description": "The identifier for the SKU.\nExample: \"AA95-CD31-42FE\"",
+ "type": "string"
}
},
- "id": "PricingExpression"
- }
- },
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloudbilling",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ "type": "object"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
- }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TierRate": {
+ "description": "The price rate indicating starting usage and its corresponding price.",
+ "id": "TierRate",
+ "properties": {
+ "startUsageAmount": {
+ "description": "Usage is priced at this rate only after this amount.\nExample: start_usage_amount of 10 indicates that the usage will be priced\nat the unit_price after the first 10 usage_units.",
+ "format": "double",
+ "type": "number"
+ },
+ "unitPrice": {
+ "$ref": "Money",
+ "description": "The price per unit of usage.\nExample: unit_price of amount $10 indicates that each unit will cost $10."
+ }
+ },
+ "type": "object"
}
},
- "rootUrl": "https://cloudbilling.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudbilling"
-}
+ "servicePath": "",
+ "title": "Cloud Billing API",
+ "version": "v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-gen.go b/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-gen.go
index 239ffeb28..f85561fe4 100644
--- a/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-gen.go
+++ b/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-gen.go
@@ -1,4 +1,4 @@
-// Package cloudbilling provides access to the Google Cloud Billing API.
+// Package cloudbilling provides access to the Cloud Billing API.
//
// See https://cloud.google.com/billing/
//
@@ -177,17 +177,183 @@ func (s *AggregationInfo) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// BillingAccount: A billing account in [Google
-// Cloud
-// Console](https://console.cloud.google.com/). You can assign a billing
-// account
-// to one or more projects.
+// AuditConfig: 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.
+type AuditConfig struct {
+ // AuditLogConfigs: The configuration for logging of each type of
+ // permission.
+ // Next ID: 4
+ AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
+
+ // Service: 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 `json:"service,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "AuditLogConfigs") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *AuditConfig) MarshalJSON() ([]byte, error) {
+ type NoMethod AuditConfig
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AuditLogConfig: 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.
+type AuditLogConfig struct {
+ // ExemptedMembers: Specifies the identities that do not cause logging
+ // for this type of
+ // permission.
+ // Follows the same format of Binding.members.
+ ExemptedMembers []string `json:"exemptedMembers,omitempty"`
+
+ // LogType: The log type that this config enables.
+ //
+ // Possible values:
+ // "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
+ // "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
+ // "DATA_WRITE" - Data writes. Example: CloudSQL Users create
+ // "DATA_READ" - Data reads. Example: CloudSQL Users list
+ LogType string `json:"logType,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "ExemptedMembers") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *AuditLogConfig) MarshalJSON() ([]byte, error) {
+ type NoMethod AuditLogConfig
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// BillingAccount: A billing account in [GCP
+// Console](https://console.cloud.google.com/).
+// You can assign a billing account to one or more projects.
type BillingAccount struct {
// DisplayName: The display name given to the billing account, such as
// `My Billing
- // Account`. This name is displayed in the Google Cloud Console.
+ // Account`. This name is displayed in the GCP Console.
DisplayName string `json:"displayName,omitempty"`
+ // MasterBillingAccount: If this account is
+ // a
+ // [subaccount](https://cloud.google.com/billing/docs/concepts), then
+ // this
+ // will be the resource name of the master billing account that it is
+ // being
+ // resold through.
+ // Otherwise this will be empty.
+ //
+ // > This field is currently in
+ // > [Beta](https://cloud.google.com/terms/launch-stages).
+ MasterBillingAccount string `json:"masterBillingAccount,omitempty"`
+
// Name: The resource name of the billing account. The resource name has
// the form
// `billingAccounts/{billing_account_id}`. For
@@ -232,6 +398,72 @@ func (s *BillingAccount) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// Binding: Associates `members` with a `role`.
+type Binding struct {
+ // Members: 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` or `joe@example.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}`: A Google Apps domain name that represents all
+ // the
+ // users of that domain. For example, `google.com` or
+ // `example.com`.
+ //
+ //
+ Members []string `json:"members,omitempty"`
+
+ // Role: Role that is assigned to `members`.
+ // For example, `roles/viewer`, `roles/editor`, or
+ // `roles/owner`.
+ // Required
+ Role string `json:"role,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Members") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Members") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Binding) MarshalJSON() ([]byte, error) {
+ type NoMethod Binding
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Category: Represents the category hierarchy of a SKU.
type Category struct {
// ResourceFamily: The type of product the SKU refers to.
@@ -476,6 +708,101 @@ func (s *Money) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// Policy: 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.
+//
+// **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"]
+// }
+// ]
+// }
+//
+// For a description of IAM and its features, see the
+// [IAM developer's guide](https://cloud.google.com/iam/docs).
+type Policy struct {
+ // AuditConfigs: Specifies cloud audit logging configuration for this
+ // policy.
+ AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
+
+ // Bindings: Associates a list of `members` to a `role`.
+ // `bindings` with no members will result in an error.
+ Bindings []*Binding `json:"bindings,omitempty"`
+
+ // Etag: `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 `json:"etag,omitempty"`
+
+ // Version: Deprecated.
+ Version int64 `json:"version,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "AuditConfigs") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "AuditConfigs") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Policy) MarshalJSON() ([]byte, error) {
+ type NoMethod Policy
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// PricingExpression: Expresses a mathematical pricing formula. For
// Example:-
//
@@ -659,7 +986,7 @@ func (s *PricingInfo) UnmarshalJSON(data []byte) error {
return nil
}
-// ProjectBillingInfo: Encapsulation of billing information for a Cloud
+// ProjectBillingInfo: Encapsulation of billing information for a GCP
// Console project. A project
// has at most one associated billing account at a time (but a billing
// account
@@ -760,6 +1087,48 @@ func (s *Service) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// SetIamPolicyRequest: Request message for `SetIamPolicy` method.
+type SetIamPolicyRequest struct {
+ // Policy: 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 *Policy `json:"policy,omitempty"`
+
+ // UpdateMask: 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 `json:"updateMask,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Policy") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Policy") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error) {
+ type NoMethod SetIamPolicyRequest
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Sku: Encapsulates a single SKU in Google Cloud Platform
type Sku struct {
// Category: The category hierarchy of this SKU, purely for
@@ -817,6 +1186,76 @@ func (s *Sku) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// TestIamPermissionsRequest: Request message for `TestIamPermissions`
+// method.
+type TestIamPermissionsRequest struct {
+ // 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 `json:"permissions,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Permissions") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Permissions") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error) {
+ type NoMethod TestIamPermissionsRequest
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TestIamPermissionsResponse: Response message for `TestIamPermissions`
+// method.
+type TestIamPermissionsResponse struct {
+ // Permissions: A subset of `TestPermissionsRequest.permissions` that
+ // the caller is
+ // allowed.
+ Permissions []string `json:"permissions,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Permissions") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Permissions") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error) {
+ type NoMethod TestIamPermissionsResponse
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// TierRate: The price rate indicating starting usage and its
// corresponding price.
type TierRate struct {
@@ -870,6 +1309,140 @@ func (s *TierRate) UnmarshalJSON(data []byte) error {
return nil
}
+// method id "cloudbilling.billingAccounts.create":
+
+type BillingAccountsCreateCall struct {
+ s *APIService
+ billingaccount *BillingAccount
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a billing account.
+// This method can only be used to create
+// [billing
+// subaccounts](https://cloud.google.com/billing/docs/concepts).
+// When creating a subaccount, the current authenticated user must have
+// the
+// `billing.accounts.update` IAM permission on the master account, which
+// is
+// typically given to billing
+// account
+// [administrators](https://cloud.google.com/billing/docs/how-to/
+// billing-access).
+//
+// > This method is currently in
+// > [Beta](https://cloud.google.com/terms/launch-stages).
+func (r *BillingAccountsService) Create(billingaccount *BillingAccount) *BillingAccountsCreateCall {
+ c := &BillingAccountsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.billingaccount = billingaccount
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *BillingAccountsCreateCall) Fields(s ...googleapi.Field) *BillingAccountsCreateCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *BillingAccountsCreateCall) Context(ctx context.Context) *BillingAccountsCreateCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *BillingAccountsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *BillingAccountsCreateCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.billingaccount)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/billingAccounts")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudbilling.billingAccounts.create" call.
+// Exactly one of *BillingAccount or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *BillingAccount.ServerResponse.Header or (if a response was returned
+// at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *BillingAccountsCreateCall) Do(opts ...googleapi.CallOption) (*BillingAccount, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &BillingAccount{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Creates a billing account.\nThis method can only be used to create\n[billing subaccounts](https://cloud.google.com/billing/docs/concepts).\nWhen creating a subaccount, the current authenticated user must have the\n`billing.accounts.update` IAM permission on the master account, which is\ntypically given to billing account\n[administrators](https://cloud.google.com/billing/docs/how-to/billing-access).\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ // "flatPath": "v1/billingAccounts",
+ // "httpMethod": "POST",
+ // "id": "cloudbilling.billingAccounts.create",
+ // "parameterOrder": [],
+ // "parameters": {},
+ // "path": "v1/billingAccounts",
+ // "request": {
+ // "$ref": "BillingAccount"
+ // },
+ // "response": {
+ // "$ref": "BillingAccount"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
// method id "cloudbilling.billingAccounts.get":
type BillingAccountsGetCall struct {
@@ -883,9 +1456,10 @@ type BillingAccountsGetCall struct {
// Get: Gets information about a billing account. The current
// authenticated user
-// must be an [owner of the
+// must be a [viewer of the
// billing
-// account](https://support.google.com/cloud/answer/4430947).
+// account](https://cloud.google.com/billing/docs/how-to/billing-
+// access).
func (r *BillingAccountsService) Get(name string) *BillingAccountsGetCall {
c := &BillingAccountsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -986,7 +1560,7 @@ func (c *BillingAccountsGetCall) Do(opts ...googleapi.CallOption) (*BillingAccou
}
return ret, nil
// {
- // "description": "Gets information about a billing account. The current authenticated user\nmust be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).",
+ // "description": "Gets information about a billing account. The current authenticated user\nmust be a [viewer of the billing\naccount](https://cloud.google.com/billing/docs/how-to/billing-access).",
// "flatPath": "v1/billingAccounts/{billingAccountsId}",
// "httpMethod": "GET",
// "id": "cloudbilling.billingAccounts.get",
@@ -1013,6 +1587,155 @@ func (c *BillingAccountsGetCall) Do(opts ...googleapi.CallOption) (*BillingAccou
}
+// method id "cloudbilling.billingAccounts.getIamPolicy":
+
+type BillingAccountsGetIamPolicyCall struct {
+ s *APIService
+ resource string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetIamPolicy: Gets the access control policy for a billing
+// account.
+// The caller must have the `billing.accounts.getIamPolicy` permission
+// on the
+// account, which is often given to billing
+// account
+// [viewers](https://cloud.google.com/billing/docs/how-to/billing
+// -access).
+//
+// > This method is currently in
+// > [Beta](https://cloud.google.com/terms/launch-stages).
+func (r *BillingAccountsService) GetIamPolicy(resource string) *BillingAccountsGetIamPolicyCall {
+ c := &BillingAccountsGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *BillingAccountsGetIamPolicyCall) Fields(s ...googleapi.Field) *BillingAccountsGetIamPolicyCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *BillingAccountsGetIamPolicyCall) IfNoneMatch(entityTag string) *BillingAccountsGetIamPolicyCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *BillingAccountsGetIamPolicyCall) Context(ctx context.Context) *BillingAccountsGetIamPolicyCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *BillingAccountsGetIamPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *BillingAccountsGetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:getIamPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudbilling.billingAccounts.getIamPolicy" call.
+// Exactly one of *Policy or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Policy.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *BillingAccountsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Policy{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Gets the access control policy for a billing account.\nThe caller must have the `billing.accounts.getIamPolicy` permission on the\naccount, which is often given to billing account\n[viewers](https://cloud.google.com/billing/docs/how-to/billing-access).\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ // "flatPath": "v1/billingAccounts/{billingAccountsId}:getIamPolicy",
+ // "httpMethod": "GET",
+ // "id": "cloudbilling.billingAccounts.getIamPolicy",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "parameters": {
+ // "resource": {
+ // "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ // "location": "path",
+ // "pattern": "^billingAccounts/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+resource}:getIamPolicy",
+ // "response": {
+ // "$ref": "Policy"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
// method id "cloudbilling.billingAccounts.list":
type BillingAccountsListCall struct {
@@ -1023,14 +1746,34 @@ type BillingAccountsListCall struct {
header_ http.Header
}
-// List: Lists the billing accounts that the current authenticated
-// user
-// [owns](https://support.google.com/cloud/answer/4430947).
+// List: Lists the billing accounts that the current authenticated user
+// has
+// permission to
+// [view](https://cloud.google.com/billing/docs/how-to/billing-access).
func (r *BillingAccountsService) List() *BillingAccountsListCall {
c := &BillingAccountsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
return c
}
+// Filter sets the optional parameter "filter": Options for how to
+// filter the returned billing accounts.
+// Currently this only supports filtering
+// for
+// [subaccounts](https://cloud.google.com/billing/docs/concepts) under
+// a
+// single provided reseller billing account.
+// (e.g.
+// "master_billing_account=billingAccounts/012345-678901-ABCDEF").
+// Boolea
+// n algebra and other fields are not currently supported.
+//
+// > This field is currently in
+// > [Beta](https://cloud.google.com/terms/launch-stages).
+func (c *BillingAccountsListCall) Filter(filter string) *BillingAccountsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
// PageSize sets the optional parameter "pageSize": Requested page size.
// The maximum page size is 100; this is also the
// default.
@@ -1141,12 +1884,17 @@ func (c *BillingAccountsListCall) Do(opts ...googleapi.CallOption) (*ListBilling
}
return ret, nil
// {
- // "description": "Lists the billing accounts that the current authenticated user\n[owns](https://support.google.com/cloud/answer/4430947).",
+ // "description": "Lists the billing accounts that the current authenticated user has\npermission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).",
// "flatPath": "v1/billingAccounts",
// "httpMethod": "GET",
// "id": "cloudbilling.billingAccounts.list",
// "parameterOrder": [],
// "parameters": {
+ // "filter": {
+ // "description": "Options for how to filter the returned billing accounts.\nCurrently this only supports filtering for\n[subaccounts](https://cloud.google.com/billing/docs/concepts) under a\nsingle provided reseller billing account.\n(e.g. \"master_billing_account=billingAccounts/012345-678901-ABCDEF\").\nBoolean algebra and other fields are not currently supported.\n\n\u003e This field is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ // "location": "query",
+ // "type": "string"
+ // },
// "pageSize": {
// "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
// "format": "int32",
@@ -1191,6 +1939,455 @@ func (c *BillingAccountsListCall) Pages(ctx context.Context, f func(*ListBilling
}
}
+// method id "cloudbilling.billingAccounts.patch":
+
+type BillingAccountsPatchCall struct {
+ s *APIService
+ name string
+ billingaccount *BillingAccount
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Patch: Updates a billing account's fields.
+// Currently the only field that can be edited is `display_name`.
+// The current authenticated user must have the
+// `billing.accounts.update`
+// IAM permission, which is typically given to
+// the
+// [administrator](https://cloud.google.com/billing/docs/how-to/billi
+// ng-access)
+// of the billing account.
+//
+// > This method is currently in
+// > [Beta](https://cloud.google.com/terms/launch-stages).
+func (r *BillingAccountsService) Patch(name string, billingaccount *BillingAccount) *BillingAccountsPatchCall {
+ c := &BillingAccountsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.billingaccount = billingaccount
+ return c
+}
+
+// UpdateMask sets the optional parameter "updateMask": The update mask
+// applied to the resource.
+// Only "display_name" is currently supported.
+func (c *BillingAccountsPatchCall) UpdateMask(updateMask string) *BillingAccountsPatchCall {
+ c.urlParams_.Set("updateMask", updateMask)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *BillingAccountsPatchCall) Fields(s ...googleapi.Field) *BillingAccountsPatchCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *BillingAccountsPatchCall) Context(ctx context.Context) *BillingAccountsPatchCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *BillingAccountsPatchCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *BillingAccountsPatchCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.billingaccount)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PATCH", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudbilling.billingAccounts.patch" call.
+// Exactly one of *BillingAccount or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *BillingAccount.ServerResponse.Header or (if a response was returned
+// at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *BillingAccountsPatchCall) Do(opts ...googleapi.CallOption) (*BillingAccount, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &BillingAccount{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Updates a billing account's fields.\nCurrently the only field that can be edited is `display_name`.\nThe current authenticated user must have the `billing.accounts.update`\nIAM permission, which is typically given to the\n[administrator](https://cloud.google.com/billing/docs/how-to/billing-access)\nof the billing account.\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ // "flatPath": "v1/billingAccounts/{billingAccountsId}",
+ // "httpMethod": "PATCH",
+ // "id": "cloudbilling.billingAccounts.patch",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the billing account resource to be updated.",
+ // "location": "path",
+ // "pattern": "^billingAccounts/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "updateMask": {
+ // "description": "The update mask applied to the resource.\nOnly \"display_name\" is currently supported.",
+ // "format": "google-fieldmask",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "request": {
+ // "$ref": "BillingAccount"
+ // },
+ // "response": {
+ // "$ref": "BillingAccount"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudbilling.billingAccounts.setIamPolicy":
+
+type BillingAccountsSetIamPolicyCall struct {
+ s *APIService
+ resource string
+ setiampolicyrequest *SetIamPolicyRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetIamPolicy: Sets the access control policy for a billing account.
+// Replaces any existing
+// policy.
+// The caller must have the `billing.accounts.setIamPolicy` permission
+// on the
+// account, which is often given to billing
+// account
+// [administrators](https://cloud.google.com/billing/docs/how-to/
+// billing-access).
+//
+// > This method is currently in
+// > [Beta](https://cloud.google.com/terms/launch-stages).
+func (r *BillingAccountsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *BillingAccountsSetIamPolicyCall {
+ c := &BillingAccountsSetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ c.setiampolicyrequest = setiampolicyrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *BillingAccountsSetIamPolicyCall) Fields(s ...googleapi.Field) *BillingAccountsSetIamPolicyCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *BillingAccountsSetIamPolicyCall) Context(ctx context.Context) *BillingAccountsSetIamPolicyCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *BillingAccountsSetIamPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *BillingAccountsSetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.setiampolicyrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:setIamPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudbilling.billingAccounts.setIamPolicy" call.
+// Exactly one of *Policy or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Policy.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *BillingAccountsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Policy{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Sets the access control policy for a billing account. Replaces any existing\npolicy.\nThe caller must have the `billing.accounts.setIamPolicy` permission on the\naccount, which is often given to billing account\n[administrators](https://cloud.google.com/billing/docs/how-to/billing-access).\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ // "flatPath": "v1/billingAccounts/{billingAccountsId}:setIamPolicy",
+ // "httpMethod": "POST",
+ // "id": "cloudbilling.billingAccounts.setIamPolicy",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "parameters": {
+ // "resource": {
+ // "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ // "location": "path",
+ // "pattern": "^billingAccounts/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+resource}:setIamPolicy",
+ // "request": {
+ // "$ref": "SetIamPolicyRequest"
+ // },
+ // "response": {
+ // "$ref": "Policy"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudbilling.billingAccounts.testIamPermissions":
+
+type BillingAccountsTestIamPermissionsCall struct {
+ s *APIService
+ resource string
+ testiampermissionsrequest *TestIamPermissionsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// TestIamPermissions: Tests the access control policy for a billing
+// account. This method takes
+// the resource and a set of permissions as input and returns the subset
+// of
+// the input permissions that the caller is allowed for that
+// resource.
+//
+// > This method is currently in
+// > [Beta](https://cloud.google.com/terms/launch-stages).
+func (r *BillingAccountsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *BillingAccountsTestIamPermissionsCall {
+ c := &BillingAccountsTestIamPermissionsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ c.testiampermissionsrequest = testiampermissionsrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *BillingAccountsTestIamPermissionsCall) Fields(s ...googleapi.Field) *BillingAccountsTestIamPermissionsCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *BillingAccountsTestIamPermissionsCall) Context(ctx context.Context) *BillingAccountsTestIamPermissionsCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *BillingAccountsTestIamPermissionsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *BillingAccountsTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.testiampermissionsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:testIamPermissions")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudbilling.billingAccounts.testIamPermissions" call.
+// Exactly one of *TestIamPermissionsResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *TestIamPermissionsResponse.ServerResponse.Header or (if a response
+// was returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *BillingAccountsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &TestIamPermissionsResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Tests the access control policy for a billing account. This method takes\nthe resource and a set of permissions as input and returns the subset of\nthe input permissions that the caller is allowed for that resource.\n\n\u003e This method is currently in\n\u003e [Beta](https://cloud.google.com/terms/launch-stages).",
+ // "flatPath": "v1/billingAccounts/{billingAccountsId}:testIamPermissions",
+ // "httpMethod": "POST",
+ // "id": "cloudbilling.billingAccounts.testIamPermissions",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "parameters": {
+ // "resource": {
+ // "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ // "location": "path",
+ // "pattern": "^billingAccounts/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+resource}:testIamPermissions",
+ // "request": {
+ // "$ref": "TestIamPermissionsRequest"
+ // },
+ // "response": {
+ // "$ref": "TestIamPermissionsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
// method id "cloudbilling.billingAccounts.projects.list":
type BillingAccountsProjectsListCall struct {
@@ -1204,11 +2401,12 @@ type BillingAccountsProjectsListCall struct {
// List: Lists the projects associated with a billing account. The
// current
-// authenticated user must have the "billing.resourceAssociations.list"
+// authenticated user must have the `billing.resourceAssociations.list`
// IAM
// permission, which is often given to billing
// account
-// [viewers](https://support.google.com/cloud/answer/4430947).
+// [viewers](https://cloud.google.com/billing/docs/how-to/billing
+// -access).
func (r *BillingAccountsProjectsService) List(name string) *BillingAccountsProjectsListCall {
c := &BillingAccountsProjectsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -1328,7 +2526,7 @@ func (c *BillingAccountsProjectsListCall) Do(opts ...googleapi.CallOption) (*Lis
}
return ret, nil
// {
- // "description": "Lists the projects associated with a billing account. The current\nauthenticated user must have the \"billing.resourceAssociations.list\" IAM\npermission, which is often given to billing account\n[viewers](https://support.google.com/cloud/answer/4430947).",
+ // "description": "Lists the projects associated with a billing account. The current\nauthenticated user must have the `billing.resourceAssociations.list` IAM\npermission, which is often given to billing account\n[viewers](https://cloud.google.com/billing/docs/how-to/billing-access).",
// "flatPath": "v1/billingAccounts/{billingAccountsId}/projects",
// "httpMethod": "GET",
// "id": "cloudbilling.billingAccounts.projects.list",
@@ -1559,7 +2757,7 @@ type ProjectsUpdateBillingInfoCall struct {
//
// *Note:* Incurred charges that have not yet been reported in the
// transaction
-// history of the Google Cloud Console may be billed to the new
+// history of the GCP Console might be billed to the new
// billing
// account, even if the charge occurred before the new billing account
// was
@@ -1572,10 +2770,10 @@ type ProjectsUpdateBillingInfoCall struct {
// 0oxofvnoo
// ) and the
// [billing
-// account](https://support.google.com/cloud/answer/4430947).
+// account](https://cloud.google.com/billing/docs/how-to/billing
+// -access).
//
-// Y
-// ou can disable billing on the project by setting
+// You can disable billing on the project by setting
// the
// `billing_account_name` field to empty. This action disassociates
// the
@@ -1692,7 +2890,7 @@ func (c *ProjectsUpdateBillingInfoCall) Do(opts ...googleapi.CallOption) (*Proje
}
return ret, nil
// {
- // "description": "Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the Google Cloud Console may be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://support.google.com/cloud/answer/4430947).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.",
+ // "description": "Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the GCP Console might be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://cloud.google.com/billing/docs/how-to/billing-access).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.",
// "flatPath": "v1/projects/{projectsId}/billingInfo",
// "httpMethod": "PUT",
// "id": "cloudbilling.projects.updateBillingInfo",
diff --git a/vendor/google.golang.org/api/cloudbuild/v1/cloudbuild-api.json b/vendor/google.golang.org/api/cloudbuild/v1/cloudbuild-api.json
index 62c1e0c1b..f2883f928 100644
--- a/vendor/google.golang.org/api/cloudbuild/v1/cloudbuild-api.json
+++ b/vendor/google.golang.org/api/cloudbuild/v1/cloudbuild-api.json
@@ -1,611 +1,1110 @@
{
- "ownerDomain": "google.com",
- "name": "cloudbuild",
- "batchPath": "batch",
- "title": "Google Cloud Container Builder API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "builds": {
- "methods": {
- "cancel": {
- "description": "Cancels a requested build in progress.",
- "request": {
- "$ref": "CancelBuildRequest"
- },
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "description": "ID of the build.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
- "path": "v1/projects/{projectId}/builds/{id}:cancel",
- "id": "cloudbuild.projects.builds.cancel"
- },
- "retry": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "location": "path",
- "description": "Build ID of the original build.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds/{id}:retry",
- "path": "v1/projects/{projectId}/builds/{id}:retry",
- "id": "cloudbuild.projects.builds.retry",
- "request": {
- "$ref": "RetryBuildRequest"
- },
- "description": "Creates a new build based on the given build.\n\nThis API creates a new build using the original build request, which may\nor may not result in an identical build.\n\nFor triggered builds:\n\n* Triggered builds resolve to a precise revision, so a retry of a triggered\nbuild will result in a build that uses the same revision.\n\nFor non-triggered builds that specify RepoSource:\n\n* If the original build built from the tip of a branch, the retried build\nwill build from the tip of that branch, which may not be the same revision\nas the original build.\n* If the original build specified a commit sha or revision ID, the retried\nbuild will use the identical source.\n\nFor builds that specify StorageSource:\n\n* If the original build pulled source from Cloud Storage without specifying\nthe generation of the object, the new build will use the current object,\nwhich may be different from the original build source.\n* If the original build pulled source from Cloud Storage and specified the\ngeneration of the object, the new build will attempt to use the same\nobject, which may or may not be available depending on the bucket's\nlifecycle management settings."
- },
- "get": {
- "id": "cloudbuild.projects.builds.get",
- "path": "v1/projects/{projectId}/builds/{id}",
- "description": "Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "location": "path",
- "description": "ID of the build.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds/{id}"
- },
- "list": {
- "flatPath": "v1/projects/{projectId}/builds",
- "path": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.list",
- "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.",
- "response": {
- "$ref": "ListBuildsResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "description": "The raw filter text to constrain the results.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Token to provide to skip to a particular spot in the list.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of results to return in the list.",
- "format": "int32",
- "type": "integer"
- },
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "create": {
- "request": {
- "$ref": "Build"
- },
- "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the project.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds",
- "path": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.create"
- }
- }
- },
- "triggers": {
- "methods": {
- "get": {
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "triggerId": {
- "description": "ID of the BuildTrigger to get.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.get",
- "description": "Gets information about a BuildTrigger.\n\nThis API is experimental."
- },
- "patch": {
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "triggerId": {
- "description": "ID of the BuildTrigger to update.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.patch",
- "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
- "request": {
- "$ref": "BuildTrigger"
- }
- },
- "delete": {
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.delete",
- "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "triggerId": {
- "location": "path",
- "description": "ID of the BuildTrigger to delete.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}"
- },
- "list": {
- "response": {
- "$ref": "ListBuildTriggersResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the project for which to list BuildTriggers.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers",
- "path": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.list",
- "description": "Lists existing BuildTrigger.\n\nThis API is experimental."
- },
- "create": {
- "flatPath": "v1/projects/{projectId}/triggers",
- "path": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.create",
- "description": "Creates a new BuildTrigger.\n\nThis API is experimental.",
- "request": {
- "$ref": "BuildTrigger"
- },
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "ID of the project for which to configure automatic builds.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "run": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "triggerId": {
- "location": "path",
- "description": "ID of the trigger.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "ID of the project.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run",
- "path": "v1/projects/{projectId}/triggers/{triggerId}:run",
- "id": "cloudbuild.projects.triggers.run",
- "description": "Runs a BuildTrigger at a particular source revision.",
- "request": {
- "$ref": "RepoSource"
- }
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "cloudbuild.operations.cancel"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations$"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations",
- "id": "cloudbuild.operations.list",
- "path": "v1/{+name}",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudbuild.operations.get"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
+ "basePath": "",
+ "baseUrl": "https://cloudbuild.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Build",
+ "description": "Builds container images in the cloud.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/container-builder/docs/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudbuild:v1",
+ "kind": "discovery#restDescription",
+ "name": "cloudbuild",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
},
"alt": {
- "type": "string",
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"bearer_token": {
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
}
},
- "version": "v1",
- "baseUrl": "https://cloudbuild.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Builds container images in the cloud.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180121",
- "documentationLink": "https://cloud.google.com/container-builder/docs/",
- "id": "cloudbuild:v1",
- "discoveryVersion": "v1",
- "version_module": true,
+ "protocol": "rest",
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "httpMethod": "POST",
+ "id": "cloudbuild.operations.cancel",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "location": "path",
+ "pattern": "^operations/.+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "flatPath": "v1/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "cloudbuild.operations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "location": "path",
+ "pattern": "^operations/.+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "flatPath": "v1/operations",
+ "httpMethod": "GET",
+ "id": "cloudbuild.operations.list",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "location": "path",
+ "pattern": "^operations$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "builds": {
+ "methods": {
+ "cancel": {
+ "description": "Cancels a build in progress.",
+ "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
+ "httpMethod": "POST",
+ "id": "cloudbuild.projects.builds.cancel",
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "ID of the build.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "ID of the project.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/builds/{id}:cancel",
+ "request": {
+ "$ref": "CancelBuildRequest"
+ },
+ "response": {
+ "$ref": "Build"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "description": "Starts a build with the specified configuration.\n\nThis method returns a long-running `Operation`, which includes the build\nID. Pass the build ID to `GetBuild` to determine the build status (such as\n`SUCCESS` or `FAILURE`).",
+ "flatPath": "v1/projects/{projectId}/builds",
+ "httpMethod": "POST",
+ "id": "cloudbuild.projects.builds.create",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/builds",
+ "request": {
+ "$ref": "Build"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Returns information about a previously requested build.\n\nThe `Build` that is returned includes its status (such as `SUCCESS`,\n`FAILURE`, or `WORKING`), and timing information.",
+ "flatPath": "v1/projects/{projectId}/builds/{id}",
+ "httpMethod": "GET",
+ "id": "cloudbuild.projects.builds.get",
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "ID of the build.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "ID of the project.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/builds/{id}",
+ "response": {
+ "$ref": "Build"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.",
+ "flatPath": "v1/projects/{projectId}/builds",
+ "httpMethod": "GET",
+ "id": "cloudbuild.projects.builds.list",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The raw filter text to constrain the results.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Number of results to return in the list.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token to provide to skip to a particular spot in the list.",
+ "location": "query",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "ID of the project.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/builds",
+ "response": {
+ "$ref": "ListBuildsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "retry": {
+ "description": "Creates a new build based on the specified build.\n\nThis method creates a new build using the original build request, which may\nor may not result in an identical build.\n\nFor triggered builds:\n\n* Triggered builds resolve to a precise revision; therefore a retry of a\ntriggered build will result in a build that uses the same revision.\n\nFor non-triggered builds that specify `RepoSource`:\n\n* If the original build built from the tip of a branch, the retried build\nwill build from the tip of that branch, which may not be the same revision\nas the original build.\n* If the original build specified a commit sha or revision ID, the retried\nbuild will use the identical source.\n\nFor builds that specify `StorageSource`:\n\n* If the original build pulled source from Google Cloud Storage without\nspecifying the generation of the object, the new build will use the current\nobject, which may be different from the original build source.\n* If the original build pulled source from Cloud Storage and specified the\ngeneration of the object, the new build will attempt to use the same\nobject, which may or may not be available depending on the bucket's\nlifecycle management settings.",
+ "flatPath": "v1/projects/{projectId}/builds/{id}:retry",
+ "httpMethod": "POST",
+ "id": "cloudbuild.projects.builds.retry",
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Build ID of the original build.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "ID of the project.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/builds/{id}:retry",
+ "request": {
+ "$ref": "RetryBuildRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "triggers": {
+ "methods": {
+ "create": {
+ "description": "Creates a new `BuildTrigger`.\n\nThis API is experimental.",
+ "flatPath": "v1/projects/{projectId}/triggers",
+ "httpMethod": "POST",
+ "id": "cloudbuild.projects.triggers.create",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project for which to configure automatic builds.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/triggers",
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a `BuildTrigger` by its project ID and trigger ID.\n\nThis API is experimental.",
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "httpMethod": "DELETE",
+ "id": "cloudbuild.projects.triggers.delete",
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project that owns the trigger.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "triggerId": {
+ "description": "ID of the `BuildTrigger` to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Returns information about a `BuildTrigger`.\n\nThis API is experimental.",
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "httpMethod": "GET",
+ "id": "cloudbuild.projects.triggers.get",
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project that owns the trigger.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "triggerId": {
+ "description": "ID of the `BuildTrigger` to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists existing `BuildTrigger`s.\n\nThis API is experimental.",
+ "flatPath": "v1/projects/{projectId}/triggers",
+ "httpMethod": "GET",
+ "id": "cloudbuild.projects.triggers.list",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project for which to list BuildTriggers.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/triggers",
+ "response": {
+ "$ref": "ListBuildTriggersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates a `BuildTrigger` by its project ID and trigger ID.\n\nThis API is experimental.",
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "httpMethod": "PATCH",
+ "id": "cloudbuild.projects.triggers.patch",
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project that owns the trigger.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "triggerId": {
+ "description": "ID of the `BuildTrigger` to update.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "run": {
+ "description": "Runs a `BuildTrigger` at a particular source revision.",
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run",
+ "httpMethod": "POST",
+ "id": "cloudbuild.projects.triggers.run",
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "triggerId": {
+ "description": "ID of the trigger.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/triggers/{triggerId}:run",
+ "request": {
+ "$ref": "RepoSource"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20180329",
+ "rootUrl": "https://cloudbuild.googleapis.com/",
"schemas": {
- "BuildOperationMetadata": {
- "description": "Metadata for build operations.",
- "type": "object",
+ "ArtifactObjects": {
+ "description": "Files in the workspace to upload to Cloud Storage upon successful\ncompletion of all build steps.",
+ "id": "ArtifactObjects",
"properties": {
- "build": {
- "description": "The build that the operation is tracking.",
- "$ref": "Build"
+ "location": {
+ "description": "Cloud Storage bucket and optional object path, in the form\n\"gs://bucket/path/to/somewhere/\". (see [Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\n\nFiles in the workspace matching any path pattern will be uploaded to\nCloud Storage with this location as a prefix.",
+ "type": "string"
+ },
+ "paths": {
+ "description": "Path globs used to match files in the build's workspace.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "BuildOperationMetadata"
+ "type": "object"
},
- "SourceProvenance": {
- "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
- "type": "object",
+ "Artifacts": {
+ "description": "Artifacts produced by a build that should be uploaded upon\nsuccessful completion of all build steps.",
+ "id": "Artifacts",
"properties": {
- "fileHashes": {
- "additionalProperties": {
- "$ref": "FileHashes"
+ "images": {
+ "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.",
+ "items": {
+ "type": "string"
},
- "description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build. Note that FileHashes will\nonly be populated if BuildOptions has requested a SourceProvenanceHash.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will be for the single path to that file.\n@OutputOnly",
+ "type": "array"
+ },
+ "objects": {
+ "$ref": "ArtifactObjects",
+ "description": "A list of objects to be uploaded to Cloud Storage upon successful\ncompletion of all build steps.\n\nFiles in the workspace matching specified paths globs will be uploaded to\nthe specified Cloud Storage location using the builder service account's\ncredentials.\n\nThe location and generation of the uploaded objects will be stored in the\nBuild resource's results field.\n\nIf any objects fail to be pushed, the build is marked FAILURE."
+ }
+ },
+ "type": "object"
+ },
+ "Build": {
+ "description": "A build resource in the Container Builder API.\n\nAt a high level, a `Build` describes where to find source code, how to build\nit (for example, the builder image to run on the source), and where to store\nthe built artifacts.\n\nFields can include the following variables, which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.\n- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
+ "id": "Build",
+ "properties": {
+ "artifacts": {
+ "$ref": "Artifacts",
+ "description": "Artifacts produced by the build that should be uploaded upon\nsuccessful completion of all build steps."
+ },
+ "buildTriggerId": {
+ "description": "The ID of the `BuildTrigger` that triggered this build, if it was\ntriggered automatically.\n@OutputOnly",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Time at which the request to create the build was received.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "finishTime": {
+ "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the build.\n@OutputOnly",
+ "type": "string"
+ },
+ "images": {
+ "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images are pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the `Build` resource's\nresults field.\n\nIf any of the images fail to be pushed, the build status is marked\n`FAILURE`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logUrl": {
+ "description": "URL to logs for this build in Google Cloud Console.\n@OutputOnly",
+ "type": "string"
+ },
+ "logsBucket": {
+ "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.",
+ "type": "string"
+ },
+ "options": {
+ "$ref": "BuildOptions",
+ "description": "Special options for this build."
+ },
+ "projectId": {
+ "description": "ID of the project.\n@OutputOnly.",
+ "type": "string"
+ },
+ "results": {
+ "$ref": "Results",
+ "description": "Results of the build.\n@OutputOnly"
+ },
+ "secrets": {
+ "description": "Secrets to decrypt using Cloud Key Management Service.",
+ "items": {
+ "$ref": "Secret"
+ },
+ "type": "array"
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "The location of the source files to build."
+ },
+ "sourceProvenance": {
+ "$ref": "SourceProvenance",
+ "description": "A permanent fixed identifier for source.\n@OutputOnly"
+ },
+ "startTime": {
+ "description": "Time at which execution of the build was started.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the build.\n@OutputOnly",
+ "enum": [
+ "STATUS_UNKNOWN",
+ "QUEUED",
+ "WORKING",
+ "SUCCESS",
+ "FAILURE",
+ "INTERNAL_ERROR",
+ "TIMEOUT",
+ "CANCELLED"
+ ],
+ "enumDescriptions": [
+ "Status of the build is unknown.",
+ "Build or step is queued; work has not yet begun.",
+ "Build or step is being executed.",
+ "Build or step finished successfully.",
+ "Build or step failed to complete successfully.",
+ "Build or step failed due to an internal cause.",
+ "Build or step took longer than was allowed.",
+ "Build or step was canceled by a user."
+ ],
+ "type": "string"
+ },
+ "statusDetail": {
+ "description": "Customer-readable message about the current status.\n@OutputOnly",
+ "type": "string"
+ },
+ "steps": {
+ "description": "Required. The operations to be performed on the workspace.",
+ "items": {
+ "$ref": "BuildStep"
+ },
+ "type": "array"
+ },
+ "substitutions": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for `Build` resource.",
"type": "object"
},
- "resolvedRepoSource": {
- "description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved.",
- "$ref": "RepoSource"
+ "tags": {
+ "description": "Tags for annotation of a `Build`. These are not docker tags.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "resolvedStorageSource": {
- "$ref": "StorageSource",
- "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved."
+ "timeout": {
+ "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be `TIMEOUT`.\n\nDefault time is ten minutes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "timing": {
+ "additionalProperties": {
+ "$ref": "TimeSpan"
+ },
+ "description": "Stores timing information for phases of the build. Valid keys are:\n\n* BUILD: time to execute all build steps\n* PUSH: time to push all specified images.\n* FETCHSOURCE: time to fetch source.\n\nIf the build does not specify source or images,\nthese keys will not be included.\n@OutputOnly",
+ "type": "object"
}
},
- "id": "SourceProvenance"
+ "type": "object"
+ },
+ "BuildOperationMetadata": {
+ "description": "Metadata for build operations.",
+ "id": "BuildOperationMetadata",
+ "properties": {
+ "build": {
+ "$ref": "Build",
+ "description": "The build that the operation is tracking."
+ }
+ },
+ "type": "object"
+ },
+ "BuildOptions": {
+ "description": "Optional arguments to enable specific features of builds.",
+ "id": "BuildOptions",
+ "properties": {
+ "diskSizeGb": {
+ "description": "Requested disk size for the VM that runs the build. Note that this is *NOT*\n\"disk free\"; some of the space will be used by the operating system and\nbuild utilities. Also note that this is the minimum disk size that will be\nallocated for the build -- the build may run with a larger disk than\nrequested. At present, the maximum disk size is 1000GB; builds that request\nmore than the maximum are rejected with an error.",
+ "format": "int64",
+ "type": "string"
+ },
+ "logStreamingOption": {
+ "description": "Option to define build log streaming behavior to Google Cloud\nStorage.",
+ "enum": [
+ "STREAM_DEFAULT",
+ "STREAM_ON",
+ "STREAM_OFF"
+ ],
+ "enumDescriptions": [
+ "Service may automatically determine build log streaming behavior.",
+ "Build logs should be streamed to Google Cloud Storage.",
+ "Build logs should not be streamed to Google Cloud Storage; they will be\nwritten when the build is completed."
+ ],
+ "type": "string"
+ },
+ "machineType": {
+ "description": "Compute Engine machine type on which to run the build.",
+ "enum": [
+ "UNSPECIFIED",
+ "N1_HIGHCPU_8",
+ "N1_HIGHCPU_32"
+ ],
+ "enumDescriptions": [
+ "Standard machine type.",
+ "Highcpu machine with 8 CPUs.",
+ "Highcpu machine with 32 CPUs."
+ ],
+ "type": "string"
+ },
+ "requestedVerifyOption": {
+ "description": "Requested verifiability options.",
+ "enum": [
+ "NOT_VERIFIED",
+ "VERIFIED"
+ ],
+ "enumDescriptions": [
+ "Not a verifiable build. (default)",
+ "Verified build."
+ ],
+ "type": "string"
+ },
+ "sourceProvenanceHash": {
+ "description": "Requested hash for SourceProvenance.",
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ],
+ "items": {
+ "enum": [
+ "NONE",
+ "SHA256"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "substitutionOption": {
+ "description": "Option to specify behavior when there is an error in the substitution\nchecks.",
+ "enum": [
+ "MUST_MATCH",
+ "ALLOW_LOOSE"
+ ],
+ "enumDescriptions": [
+ "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.",
+ "Do not fail the build if error in substitutions checks."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BuildStep": {
+ "description": "A step in the build pipeline.",
+ "id": "BuildStep",
+ "properties": {
+ "args": {
+ "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, the `args`\nare used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args is used as the entrypoint,\nand the remainder will be used as arguments.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dir": {
+ "description": "Working directory to use when running this step's container.\n\nIf this value is a relative path, it is relative to the build's working\ndirectory. If this value is absolute, it may be outside the build's working\ndirectory, in which case the contents of the path may not be persisted\nacross build step executions, unless a `volume` for that path is specified.\n\nIf the build specifies a `RepoSource` with `dir` and a step with a `dir`,\nwhich specifies an absolute path, the `RepoSource` `dir` is ignored for\nthe step's execution.",
+ "type": "string"
+ },
+ "entrypoint": {
+ "description": "Entrypoint to be used instead of the build step image's default entrypoint.\nIf unset, the image's default entrypoint is used.",
+ "type": "string"
+ },
+ "env": {
+ "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for this build step, used in `wait_for` to\nreference this build step as a dependency.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The name of the container image that will run this particular\nbuild step.\n\nIf the image is available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.",
+ "type": "string"
+ },
+ "secretEnv": {
+ "description": "A list of environment variables which are encrypted using a Cloud Key\nManagement Service crypto key. These values must be specified in the\nbuild's `Secret`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "Status of the build step. At this time, build step status is only updated\non build completion; step status is not updated in real-time as the build\nprogresses.\n@OutputOnly",
+ "enum": [
+ "STATUS_UNKNOWN",
+ "QUEUED",
+ "WORKING",
+ "SUCCESS",
+ "FAILURE",
+ "INTERNAL_ERROR",
+ "TIMEOUT",
+ "CANCELLED"
+ ],
+ "enumDescriptions": [
+ "Status of the build is unknown.",
+ "Build or step is queued; work has not yet begun.",
+ "Build or step is being executed.",
+ "Build or step finished successfully.",
+ "Build or step failed to complete successfully.",
+ "Build or step failed due to an internal cause.",
+ "Build or step took longer than was allowed.",
+ "Build or step was canceled by a user."
+ ],
+ "type": "string"
+ },
+ "timeout": {
+ "description": "Time limit for executing this build step. If not defined, the step has no\ntime limit and will be allowed to continue to run until either it completes\nor the build itself times out.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "timing": {
+ "$ref": "TimeSpan",
+ "description": "Stores timing information for executing this build step.\n@OutputOnly"
+ },
+ "volumes": {
+ "description": "List of volumes to mount into the build step.\n\nEach volume will be created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents will\nbe discarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a mis-configured build request.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ },
+ "waitFor": {
+ "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in `wait_for`\nhave completed successfully. If `wait_for` is empty, this build step will\nstart when all previous build steps in the `Build.Steps` list have\ncompleted successfully.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "BuildTrigger": {
+ "description": "Configuration for an automated build in response to source repository\nchanges.",
+ "id": "BuildTrigger",
+ "properties": {
+ "build": {
+ "$ref": "Build",
+ "description": "Contents of the build template."
+ },
+ "createTime": {
+ "description": "Time when the trigger was created.\n\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "description": {
+ "description": "Human-readable description of this trigger.",
+ "type": "string"
+ },
+ "disabled": {
+ "description": "If true, the trigger will never result in a build.",
+ "type": "boolean"
+ },
+ "filename": {
+ "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the trigger.\n\n@OutputOnly",
+ "type": "string"
+ },
+ "substitutions": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for Build resource.",
+ "type": "object"
+ },
+ "triggerTemplate": {
+ "$ref": "RepoSource",
+ "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build."
+ }
+ },
+ "type": "object"
+ },
+ "BuiltImage": {
+ "description": "An image built by the pipeline.",
+ "id": "BuiltImage",
+ "properties": {
+ "digest": {
+ "description": "Docker Registry 2.0 digest.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`.",
+ "type": "string"
+ },
+ "pushTiming": {
+ "$ref": "TimeSpan",
+ "description": "Stores timing information for pushing the specified image.\n@OutputOnly"
+ }
+ },
+ "type": "object"
+ },
+ "CancelBuildRequest": {
+ "description": "Request to cancel an ongoing build.",
+ "id": "CancelBuildRequest",
+ "properties": {},
+ "type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
- "type": "object",
+ "id": "CancelOperationRequest",
"properties": {},
- "id": "CancelOperationRequest"
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "FileHashes": {
+ "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.",
+ "id": "FileHashes",
+ "properties": {
+ "fileHash": {
+ "description": "Collection of file hashes.",
+ "items": {
+ "$ref": "Hash"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Hash": {
+ "description": "Container message for hash values.",
+ "id": "Hash",
+ "properties": {
+ "type": {
+ "description": "The type of hash that was performed.",
+ "enum": [
+ "NONE",
+ "SHA256"
+ ],
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The hash value.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListBuildTriggersResponse": {
+ "description": "Response containing existing `BuildTriggers`.",
+ "id": "ListBuildTriggersResponse",
+ "properties": {
+ "triggers": {
+ "description": "`BuildTriggers` for the project, sorted by `create_time` descending.",
+ "items": {
+ "$ref": "BuildTrigger"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListBuildsResponse": {
+ "description": "Response including listed builds.",
+ "id": "ListBuildsResponse",
+ "properties": {
+ "builds": {
+ "description": "Builds will be sorted by `create_time`, descending.",
+ "items": {
+ "$ref": "Build"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token to receive the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
+ "id": "Operation",
"properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
@@ -618,9 +1117,9 @@
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
},
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
},
"response": {
"additionalProperties": {
@@ -629,88 +1128,16 @@
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
}
},
- "id": "Operation"
- },
- "BuildStep": {
- "properties": {
- "volumes": {
- "description": "List of volumes to mount into the build step.\n\nEach volume will be created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents will\nbe discarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a mis-configured build request.",
- "type": "array",
- "items": {
- "$ref": "Volume"
- }
- },
- "dir": {
- "description": "Working directory (relative to project source root) to use when running\nthis operation's container.",
- "type": "string"
- },
- "env": {
- "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "waitFor": {
- "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in wait_for\nhave completed successfully. If wait_for is empty, this build step will\nstart when all previous build steps in the Build.Steps list have completed\nsuccessfully.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "timing": {
- "description": "Stores timing information for executing this build step.",
- "$ref": "TimeSpan"
- },
- "args": {
- "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "description": "The name of the container image that will run this particular build step.\n\nIf the image is already available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.",
- "type": "string"
- },
- "entrypoint": {
- "description": "Optional entrypoint to be used instead of the build step image's default\nIf unset, the image's default will be used.",
- "type": "string"
- },
- "secretEnv": {
- "description": "A list of environment variables which are encrypted using a Cloud KMS\ncrypto key. These values must be specified in the build's secrets.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.",
- "type": "string"
- }
- },
- "id": "BuildStep",
- "description": "BuildStep describes a step to perform in the build pipeline.",
"type": "object"
},
"RepoSource": {
+ "description": "Location of the source in a Google Cloud Source Repository.",
+ "id": "RepoSource",
"properties": {
- "tagName": {
- "description": "Name of the tag to build.",
- "type": "string"
- },
- "projectId": {
- "description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed.",
- "type": "string"
- },
- "repoName": {
- "description": "Name of the repo. If omitted, the name \"default\" is assumed.",
+ "branchName": {
+ "description": "Name of the branch to build.",
"type": "string"
},
"commitSha": {
@@ -718,489 +1145,63 @@
"type": "string"
},
"dir": {
- "description": "Directory, relative to the source root, in which to run the build.",
+ "description": "Directory, relative to the source root, in which to run the build.\n\nThis must be a relative path. If a step's `dir` is specified and is an\nabsolute path, this value is ignored for that step's execution.",
"type": "string"
},
- "branchName": {
- "description": "Name of the branch to build.",
- "type": "string"
- }
- },
- "id": "RepoSource",
- "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
- "type": "object"
- },
- "FileHashes": {
- "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.",
- "type": "object",
- "properties": {
- "fileHash": {
- "description": "Collection of file hashes.",
- "type": "array",
- "items": {
- "$ref": "Hash"
- }
- }
- },
- "id": "FileHashes"
- },
- "Status": {
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "BuildTrigger": {
- "properties": {
- "triggerTemplate": {
- "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build.",
- "$ref": "RepoSource"
- },
- "filename": {
- "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier of the trigger.\n\n@OutputOnly",
- "type": "string"
- },
- "build": {
- "$ref": "Build",
- "description": "Contents of the build template."
- },
- "substitutions": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Substitutions data for Build resource.",
- "type": "object"
- },
- "description": {
- "description": "Human-readable description of this trigger.",
- "type": "string"
- },
- "createTime": {
- "description": "Time when the trigger was created.\n\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "disabled": {
- "description": "If true, the trigger will never result in a build.",
- "type": "boolean"
- }
- },
- "id": "BuildTrigger",
- "description": "Configuration for an automated build in response to source repository\nchanges.",
- "type": "object"
- },
- "Build": {
- "description": "A build resource in the Container Builder API.\n\nAt a high level, a Build describes where to find source code, how to build\nit (for example, the builder image to run on the source), and what tag to\napply to the built image when it is pushed to Google Container Registry.\n\nFields can include the following variables which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.\n- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
- "type": "object",
- "properties": {
- "buildTriggerId": {
- "description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly",
- "type": "string"
- },
- "tags": {
- "description": "Tags for annotation of a Build. These are not docker tags.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "description": "Unique identifier of the build.\n@OutputOnly",
- "type": "string"
- },
- "substitutions": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Substitutions data for Build resource.",
- "type": "object"
- },
- "startTime": {
- "description": "Time at which execution of the build was started.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "timing": {
- "additionalProperties": {
- "$ref": "TimeSpan"
- },
- "description": "Stores timing information for phases of the build. Valid keys are:\n\n* BUILD: time to execute all build steps\n* PUSH: time to push all specified images.\n* FETCHSOURCE: time to fetch source.\n\nIf the build does not specify source, or does not specify images,\nthese keys will not be included.",
- "type": "object"
- },
- "createTime": {
- "description": "Time at which the request to create the build was received.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "sourceProvenance": {
- "$ref": "SourceProvenance",
- "description": "A permanent fixed identifier for source.\n@OutputOnly"
- },
- "images": {
- "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"projectId": {
- "description": "ID of the project.\n@OutputOnly.",
+ "description": "ID of the project that owns the Cloud Source Repository. If omitted, the\nproject ID requesting the build is assumed.",
"type": "string"
},
- "finishTime": {
- "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly",
- "format": "google-datetime",
+ "repoName": {
+ "description": "Name of the Cloud Source Repository. If omitted, the name \"default\" is\nassumed.",
"type": "string"
},
- "logUrl": {
- "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly",
- "type": "string"
- },
- "source": {
- "$ref": "Source",
- "description": "Describes where to find the source files to build."
- },
- "options": {
- "$ref": "BuildOptions",
- "description": "Special options for this build."
- },
- "timeout": {
- "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be TIMEOUT.\n\nDefault time is ten minutes.",
- "format": "google-duration",
- "type": "string"
- },
- "status": {
- "description": "Status of the build.\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "Status of the build is unknown.",
- "Build is queued; work has not yet begun.",
- "Build is being executed.",
- "Build finished successfully.",
- "Build failed to complete successfully.",
- "Build failed due to an internal cause.",
- "Build took longer than was allowed.",
- "Build was canceled by a user."
- ],
- "enum": [
- "STATUS_UNKNOWN",
- "QUEUED",
- "WORKING",
- "SUCCESS",
- "FAILURE",
- "INTERNAL_ERROR",
- "TIMEOUT",
- "CANCELLED"
- ]
- },
- "statusDetail": {
- "description": "Customer-readable message about the current status.\n@OutputOnly",
- "type": "string"
- },
- "secrets": {
- "description": "Secrets to decrypt using Cloud KMS.",
- "type": "array",
- "items": {
- "$ref": "Secret"
- }
- },
- "results": {
- "description": "Results of the build.\n@OutputOnly",
- "$ref": "Results"
- },
- "logsBucket": {
- "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.",
- "type": "string"
- },
- "steps": {
- "description": "Describes the operations to be performed on the workspace.",
- "type": "array",
- "items": {
- "$ref": "BuildStep"
- }
- }
- },
- "id": "Build"
- },
- "CancelBuildRequest": {
- "description": "Request to cancel an ongoing build.",
- "type": "object",
- "properties": {},
- "id": "CancelBuildRequest"
- },
- "Volume": {
- "properties": {
- "name": {
- "description": "Name of the volume to mount.\n\nVolume names must be unique per build step and must be valid names for\nDocker volumes. Each named volume must be used by at least two build steps.",
- "type": "string"
- },
- "path": {
- "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.",
+ "tagName": {
+ "description": "Name of the tag to build.",
"type": "string"
}
},
- "id": "Volume",
- "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.",
"type": "object"
},
- "ListBuildsResponse": {
- "description": "Response including listed builds.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token to receive the next page of results.",
- "type": "string"
- },
- "builds": {
- "description": "Builds will be sorted by create_time, descending.",
- "type": "array",
- "items": {
- "$ref": "Build"
- }
- }
- },
- "id": "ListBuildsResponse"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "TimeSpan": {
- "properties": {
- "endTime": {
- "description": "End of time span.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Start of time span.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "TimeSpan",
- "description": "Stores start and end times for a build execution phase.",
- "type": "object"
- },
- "BuildOptions": {
- "description": "Optional arguments to enable specific features of builds.",
- "type": "object",
- "properties": {
- "requestedVerifyOption": {
- "enum": [
- "NOT_VERIFIED",
- "VERIFIED"
- ],
- "description": "Requested verifiability options.",
- "type": "string",
- "enumDescriptions": [
- "Not a verifiable build. (default)",
- "Verified build."
- ]
- },
- "substitutionOption": {
- "enumDescriptions": [
- "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.",
- "Do not fail the build if error in substitutions checks."
- ],
- "enum": [
- "MUST_MATCH",
- "ALLOW_LOOSE"
- ],
- "description": "SubstitutionOption to allow unmatch substitutions.",
- "type": "string"
- },
- "diskSizeGb": {
- "description": "Requested disk size for the VM that runs the build. Note that this is *NOT*\n\"disk free\"; some of the space will be used by the operating system and\nbuild utilities. Also note that this is the minimum disk size that will be\nallocated for the build -- the build may run with a larger disk than\nrequested. At present, the maximum disk size is 1000GB; builds that request\nmore than the maximum are rejected with an error.",
- "format": "int64",
- "type": "string"
- },
- "sourceProvenanceHash": {
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ],
- "description": "Requested hash for SourceProvenance.",
- "type": "array",
- "items": {
- "enum": [
- "NONE",
- "SHA256"
- ],
- "type": "string"
- }
- },
- "machineType": {
- "enum": [
- "UNSPECIFIED",
- "N1_HIGHCPU_8",
- "N1_HIGHCPU_32"
- ],
- "description": "Compute Engine machine type on which to run the build.",
- "type": "string",
- "enumDescriptions": [
- "Standard machine type.",
- "Highcpu machine with 8 CPUs.",
- "Highcpu machine with 32 CPUs."
- ]
- },
- "logStreamingOption": {
- "enum": [
- "STREAM_DEFAULT",
- "STREAM_ON",
- "STREAM_OFF"
- ],
- "description": "LogStreamingOption to define build log streaming behavior to Google Cloud\nStorage.",
- "type": "string",
- "enumDescriptions": [
- "Service may automatically determine build log streaming behavior.",
- "Build logs should be streamed to Google Cloud Storage.",
- "Build logs should not be streamed to Google Cloud Storage; they will be\nwritten when the build is completed."
- ]
- }
- },
- "id": "BuildOptions"
- },
- "StorageSource": {
- "description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage.",
- "type": "object",
- "properties": {
- "bucket": {
- "description": "Google Cloud Storage bucket containing source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
- "type": "string"
- },
- "object": {
- "description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild.",
- "type": "string"
- },
- "generation": {
- "description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "StorageSource"
- },
"Results": {
- "description": "Results describes the artifacts created by the build pipeline.",
- "type": "object",
+ "description": "Artifacts created by the build pipeline.",
+ "id": "Results",
"properties": {
+ "artifactManifest": {
+ "description": "Path to the artifact manifest. Only populated when artifacts are uploaded.",
+ "type": "string"
+ },
"buildStepImages": {
- "description": "List of build step digests, in order corresponding to build step indices.",
- "type": "array",
+ "description": "List of build step digests, in the order corresponding to build step\nindices.",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
},
"images": {
- "description": "Images that were built as a part of the build.",
- "type": "array",
+ "description": "Container images that were built as a part of the build.",
"items": {
"$ref": "BuiltImage"
- }
- }
- },
- "id": "Results"
- },
- "ListBuildTriggersResponse": {
- "description": "Response containing existing BuildTriggers.",
- "type": "object",
- "properties": {
- "triggers": {
- "description": "BuildTriggers for the project, sorted by create_time descending.",
- "type": "array",
- "items": {
- "$ref": "BuildTrigger"
- }
- }
- },
- "id": "ListBuildTriggersResponse"
- },
- "BuiltImage": {
- "description": "BuiltImage describes an image built by the pipeline.",
- "type": "object",
- "properties": {
- "digest": {
- "description": "Docker Registry 2.0 digest.",
- "type": "string"
+ },
+ "type": "array"
},
- "pushTiming": {
- "description": "Stores timing information for pushing the specified image.",
- "$ref": "TimeSpan"
- },
- "name": {
- "description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`.",
+ "numArtifacts": {
+ "description": "Number of artifacts uploaded. Only populated when artifacts are uploaded.",
+ "format": "int64",
"type": "string"
}
},
- "id": "BuiltImage"
+ "type": "object"
},
- "Hash": {
- "description": "Container message for hash values.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The hash value.",
- "format": "byte",
- "type": "string"
- },
- "type": {
- "description": "The type of hash that was performed.",
- "type": "string",
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ],
- "enum": [
- "NONE",
- "SHA256"
- ]
- }
- },
- "id": "Hash"
+ "RetryBuildRequest": {
+ "description": "Specifies a build to retry.",
+ "id": "RetryBuildRequest",
+ "properties": {},
+ "type": "object"
},
"Secret": {
- "description": "Secret pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.",
- "type": "object",
+ "description": "Pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.",
+ "id": "Secret",
"properties": {
"kmsKeyName": {
"description": "Cloud KMS key name to use to decrypt these envs.",
@@ -1215,50 +1216,127 @@
"type": "object"
}
},
- "id": "Secret"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "type": "object"
},
"Source": {
- "description": "Source describes the location of the source in a supported storage\nservice.",
- "type": "object",
+ "description": "Location of the source in a supported storage service.",
+ "id": "Source",
"properties": {
+ "repoSource": {
+ "$ref": "RepoSource",
+ "description": "If provided, get the source from this location in a Cloud Source\nRepository."
+ },
"storageSource": {
"$ref": "StorageSource",
"description": "If provided, get the source from this location in Google Cloud Storage."
- },
- "repoSource": {
- "$ref": "RepoSource",
- "description": "If provided, get source from this location in a Cloud Repo."
}
},
- "id": "Source"
+ "type": "object"
},
- "RetryBuildRequest": {
- "description": "RetryBuildRequest specifies a build to retry.",
- "type": "object",
- "properties": {},
- "id": "RetryBuildRequest"
- }
- },
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud Build",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ "SourceProvenance": {
+ "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
+ "id": "SourceProvenance",
+ "properties": {
+ "fileHashes": {
+ "additionalProperties": {
+ "$ref": "FileHashes"
+ },
+ "description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build. Note that `FileHashes` will\nonly be populated if `BuildOptions` has requested a `SourceProvenanceHash`.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(`.tar.gz`), the `FileHash` will be for the single path to that file.\n@OutputOnly",
+ "type": "object"
+ },
+ "resolvedRepoSource": {
+ "$ref": "RepoSource",
+ "description": "A copy of the build's `source.repo_source`, if exists, with any\nrevisions resolved."
+ },
+ "resolvedStorageSource": {
+ "$ref": "StorageSource",
+ "description": "A copy of the build's `source.storage_source`, if exists, with any\ngenerations resolved."
}
- }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StorageSource": {
+ "description": "Location of the source in an archive file in Google Cloud Storage.",
+ "id": "StorageSource",
+ "properties": {
+ "bucket": {
+ "description": "Google Cloud Storage bucket containing the source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
+ "type": "string"
+ },
+ "generation": {
+ "description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used.",
+ "format": "int64",
+ "type": "string"
+ },
+ "object": {
+ "description": "Google Cloud Storage object containing the source.\n\nThis object must be a gzipped archive file (`.tar.gz`) containing source to\nbuild.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TimeSpan": {
+ "description": "Start and end times for a build execution phase.",
+ "id": "TimeSpan",
+ "properties": {
+ "endTime": {
+ "description": "End of time span.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start of time span.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Volume": {
+ "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.",
+ "id": "Volume",
+ "properties": {
+ "name": {
+ "description": "Name of the volume to mount.\n\nVolume names must be unique per build step and must be valid names for\nDocker volumes. Each named volume must be used by at least two build steps.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
},
- "rootUrl": "https://cloudbuild.googleapis.com/"
-}
+ "servicePath": "",
+ "title": "Cloud Container Builder API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudbuild/v1/cloudbuild-gen.go b/vendor/google.golang.org/api/cloudbuild/v1/cloudbuild-gen.go
index 205616fc6..683cd700b 100644
--- a/vendor/google.golang.org/api/cloudbuild/v1/cloudbuild-gen.go
+++ b/vendor/google.golang.org/api/cloudbuild/v1/cloudbuild-gen.go
@@ -1,4 +1,4 @@
-// Package cloudbuild provides access to the Google Cloud Container Builder API.
+// Package cloudbuild provides access to the Cloud Container Builder API.
//
// See https://cloud.google.com/container-builder/docs/
//
@@ -120,16 +120,115 @@ type ProjectsTriggersService struct {
s *Service
}
+// ArtifactObjects: Files in the workspace to upload to Cloud Storage
+// upon successful
+// completion of all build steps.
+type ArtifactObjects struct {
+ // Location: Cloud Storage bucket and optional object path, in the
+ // form
+ // "gs://bucket/path/to/somewhere/". (see [Bucket
+ // Name
+ // Requirements](https://cloud.google.com/storage/docs/bucket-naming
+ // #requirements)).
+ //
+ // Files in the workspace matching any path pattern will be uploaded
+ // to
+ // Cloud Storage with this location as a prefix.
+ Location string `json:"location,omitempty"`
+
+ // Paths: Path globs used to match files in the build's workspace.
+ Paths []string `json:"paths,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Location") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Location") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ArtifactObjects) MarshalJSON() ([]byte, error) {
+ type NoMethod ArtifactObjects
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Artifacts: Artifacts produced by a build that should be uploaded
+// upon
+// successful completion of all build steps.
+type Artifacts struct {
+ // Images: A list of images to be pushed upon the successful completion
+ // of all build
+ // steps.
+ //
+ // The images will be pushed using the builder service account's
+ // credentials.
+ //
+ // The digests of the pushed images will be stored in the Build
+ // resource's
+ // results field.
+ //
+ // If any of the images fail to be pushed, the build is marked FAILURE.
+ Images []string `json:"images,omitempty"`
+
+ // Objects: A list of objects to be uploaded to Cloud Storage upon
+ // successful
+ // completion of all build steps.
+ //
+ // Files in the workspace matching specified paths globs will be
+ // uploaded to
+ // the specified Cloud Storage location using the builder service
+ // account's
+ // credentials.
+ //
+ // The location and generation of the uploaded objects will be stored in
+ // the
+ // Build resource's results field.
+ //
+ // If any objects fail to be pushed, the build is marked FAILURE.
+ Objects *ArtifactObjects `json:"objects,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Images") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Images") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Artifacts) MarshalJSON() ([]byte, error) {
+ type NoMethod Artifacts
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Build: A build resource in the Container Builder API.
//
-// At a high level, a Build describes where to find source code, how to
-// build
-// it (for example, the builder image to run on the source), and what
-// tag to
-// apply to the built image when it is pushed to Google Container
-// Registry.
+// At a high level, a `Build` describes where to find source code, how
+// to build
+// it (for example, the builder image to run on the source), and where
+// to store
+// the built artifacts.
//
-// Fields can include the following variables which will be expanded
+// Fields can include the following variables, which will be expanded
// when the
// build is created:
//
@@ -143,8 +242,13 @@ type ProjectsTriggersService struct {
// resolved from the specified branch or tag.
// - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
type Build struct {
- // BuildTriggerId: The ID of the BuildTrigger that triggered this build,
- // if it was
+ // Artifacts: Artifacts produced by the build that should be uploaded
+ // upon
+ // successful completion of all build steps.
+ Artifacts *Artifacts `json:"artifacts,omitempty"`
+
+ // BuildTriggerId: The ID of the `BuildTrigger` that triggered this
+ // build, if it was
// triggered automatically.
// @OutputOnly
BuildTriggerId string `json:"buildTriggerId,omitempty"`
@@ -170,18 +274,20 @@ type Build struct {
// of all build
// steps.
//
- // The images will be pushed using the builder service account's
+ // The images are pushed using the builder service account's
// credentials.
//
- // The digests of the pushed images will be stored in the Build
+ // The digests of the pushed images will be stored in the `Build`
// resource's
// results field.
//
- // If any of the images fail to be pushed, the build is marked FAILURE.
+ // If any of the images fail to be pushed, the build status is
+ // marked
+ // `FAILURE`.
Images []string `json:"images,omitempty"`
// LogUrl: URL to logs for this build in Google Cloud
- // Logging.
+ // Console.
// @OutputOnly
LogUrl string `json:"logUrl,omitempty"`
@@ -206,10 +312,10 @@ type Build struct {
// @OutputOnly
Results *Results `json:"results,omitempty"`
- // Secrets: Secrets to decrypt using Cloud KMS.
+ // Secrets: Secrets to decrypt using Cloud Key Management Service.
Secrets []*Secret `json:"secrets,omitempty"`
- // Source: Describes where to find the source files to build.
+ // Source: The location of the source files to build.
Source *Source `json:"source,omitempty"`
// SourceProvenance: A permanent fixed identifier for
@@ -227,13 +333,13 @@ type Build struct {
//
// Possible values:
// "STATUS_UNKNOWN" - Status of the build is unknown.
- // "QUEUED" - Build is queued; work has not yet begun.
- // "WORKING" - Build is being executed.
- // "SUCCESS" - Build finished successfully.
- // "FAILURE" - Build failed to complete successfully.
- // "INTERNAL_ERROR" - Build failed due to an internal cause.
- // "TIMEOUT" - Build took longer than was allowed.
- // "CANCELLED" - Build was canceled by a user.
+ // "QUEUED" - Build or step is queued; work has not yet begun.
+ // "WORKING" - Build or step is being executed.
+ // "SUCCESS" - Build or step finished successfully.
+ // "FAILURE" - Build or step failed to complete successfully.
+ // "INTERNAL_ERROR" - Build or step failed due to an internal cause.
+ // "TIMEOUT" - Build or step took longer than was allowed.
+ // "CANCELLED" - Build or step was canceled by a user.
Status string `json:"status,omitempty"`
// StatusDetail: Customer-readable message about the current
@@ -241,20 +347,20 @@ type Build struct {
// @OutputOnly
StatusDetail string `json:"statusDetail,omitempty"`
- // Steps: Describes the operations to be performed on the workspace.
+ // Steps: Required. The operations to be performed on the workspace.
Steps []*BuildStep `json:"steps,omitempty"`
- // Substitutions: Substitutions data for Build resource.
+ // Substitutions: Substitutions data for `Build` resource.
Substitutions map[string]string `json:"substitutions,omitempty"`
- // Tags: Tags for annotation of a Build. These are not docker tags.
+ // Tags: Tags for annotation of a `Build`. These are not docker tags.
Tags []string `json:"tags,omitempty"`
// Timeout: Amount of time that this build should be allowed to run, to
// second
// granularity. If this amount of time elapses, work on the build will
// cease
- // and the build status will be TIMEOUT.
+ // and the build status will be `TIMEOUT`.
//
// Default time is ten minutes.
Timeout string `json:"timeout,omitempty"`
@@ -266,16 +372,16 @@ type Build struct {
// * PUSH: time to push all specified images.
// * FETCHSOURCE: time to fetch source.
//
- // If the build does not specify source, or does not specify
- // images,
+ // If the build does not specify source or images,
// these keys will not be included.
+ // @OutputOnly
Timing map[string]TimeSpan `json:"timing,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "BuildTriggerId") to
+ // ForceSendFields is a list of field names (e.g. "Artifacts") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -283,13 +389,12 @@ type Build struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "BuildTriggerId") to
- // include in API requests with the JSON null value. By default, fields
- // with empty values are omitted from API requests. However, any field
- // with an empty value appearing in NullFields will be sent to the
- // server as null. It is an error if a field in this list has a
- // non-empty value. This may be used to include null fields in Patch
- // requests.
+ // NullFields is a list of field names (e.g. "Artifacts") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
@@ -343,8 +448,8 @@ type BuildOptions struct {
// more than the maximum are rejected with an error.
DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
- // LogStreamingOption: LogStreamingOption to define build log streaming
- // behavior to Google Cloud
+ // LogStreamingOption: Option to define build log streaming behavior to
+ // Google Cloud
// Storage.
//
// Possible values:
@@ -379,8 +484,9 @@ type BuildOptions struct {
// "SHA256" - Use a sha256 hash.
SourceProvenanceHash []string `json:"sourceProvenanceHash,omitempty"`
- // SubstitutionOption: SubstitutionOption to allow unmatch
- // substitutions.
+ // SubstitutionOption: Option to specify behavior when there is an error
+ // in the substitution
+ // checks.
//
// Possible values:
// "MUST_MATCH" - Fails the build if error in substitutions checks,
@@ -413,29 +519,41 @@ func (s *BuildOptions) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// BuildStep: BuildStep describes a step to perform in the build
-// pipeline.
+// BuildStep: A step in the build pipeline.
type BuildStep struct {
// Args: A list of arguments that will be presented to the step when it
// is started.
//
- // If the image used to run the step's container has an entrypoint,
- // these args
- // will be used as arguments to that entrypoint. If the image does not
+ // If the image used to run the step's container has an entrypoint, the
+ // `args`
+ // are used as arguments to that entrypoint. If the image does not
// define
- // an entrypoint, the first element in args will be used as the
+ // an entrypoint, the first element in args is used as the
// entrypoint,
// and the remainder will be used as arguments.
Args []string `json:"args,omitempty"`
- // Dir: Working directory (relative to project source root) to use when
- // running
- // this operation's container.
+ // Dir: Working directory to use when running this step's container.
+ //
+ // If this value is a relative path, it is relative to the build's
+ // working
+ // directory. If this value is absolute, it may be outside the build's
+ // working
+ // directory, in which case the contents of the path may not be
+ // persisted
+ // across build step executions, unless a `volume` for that path is
+ // specified.
+ //
+ // If the build specifies a `RepoSource` with `dir` and a step with a
+ // `dir`,
+ // which specifies an absolute path, the `RepoSource` `dir` is ignored
+ // for
+ // the step's execution.
Dir string `json:"dir,omitempty"`
- // Entrypoint: Optional entrypoint to be used instead of the build step
- // image's default
- // If unset, the image's default will be used.
+ // Entrypoint: Entrypoint to be used instead of the build step image's
+ // default entrypoint.
+ // If unset, the image's default entrypoint is used.
Entrypoint string `json:"entrypoint,omitempty"`
// Env: A list of environment variable definitions to be used when
@@ -446,16 +564,17 @@ type BuildStep struct {
// being given the value "VALUE".
Env []string `json:"env,omitempty"`
- // Id: Optional unique identifier for this build step, used in wait_for
+ // Id: Unique identifier for this build step, used in `wait_for`
// to
// reference this build step as a dependency.
Id string `json:"id,omitempty"`
- // Name: The name of the container image that will run this particular
+ // Name: Required. The name of the container image that will run this
+ // particular
// build step.
//
- // If the image is already available in the host's Docker daemon's
- // cache, it
+ // If the image is available in the host's Docker daemon's cache,
+ // it
// will be run directly. If not, the host will attempt to pull the
// image
// first, using the builder service account's credentials if
@@ -481,11 +600,40 @@ type BuildStep struct {
Name string `json:"name,omitempty"`
// SecretEnv: A list of environment variables which are encrypted using
- // a Cloud KMS
- // crypto key. These values must be specified in the build's secrets.
+ // a Cloud Key
+ // Management Service crypto key. These values must be specified in
+ // the
+ // build's `Secret`.
SecretEnv []string `json:"secretEnv,omitempty"`
- // Timing: Stores timing information for executing this build step.
+ // Status: Status of the build step. At this time, build step status is
+ // only updated
+ // on build completion; step status is not updated in real-time as the
+ // build
+ // progresses.
+ // @OutputOnly
+ //
+ // Possible values:
+ // "STATUS_UNKNOWN" - Status of the build is unknown.
+ // "QUEUED" - Build or step is queued; work has not yet begun.
+ // "WORKING" - Build or step is being executed.
+ // "SUCCESS" - Build or step finished successfully.
+ // "FAILURE" - Build or step failed to complete successfully.
+ // "INTERNAL_ERROR" - Build or step failed due to an internal cause.
+ // "TIMEOUT" - Build or step took longer than was allowed.
+ // "CANCELLED" - Build or step was canceled by a user.
+ Status string `json:"status,omitempty"`
+
+ // Timeout: Time limit for executing this build step. If not defined,
+ // the step has no
+ // time limit and will be allowed to continue to run until either it
+ // completes
+ // or the build itself times out.
+ Timeout string `json:"timeout,omitempty"`
+
+ // Timing: Stores timing information for executing this build
+ // step.
+ // @OutputOnly
Timing *TimeSpan `json:"timing,omitempty"`
// Volumes: List of volumes to mount into the build step.
@@ -504,12 +652,12 @@ type BuildStep struct {
// WaitFor: The ID(s) of the step(s) that this build step depends
// on.
// This build step will not start until all the build steps in
- // wait_for
- // have completed successfully. If wait_for is empty, this build step
+ // `wait_for`
+ // have completed successfully. If `wait_for` is empty, this build step
// will
- // start when all previous build steps in the Build.Steps list have
- // completed
- // successfully.
+ // start when all previous build steps in the `Build.Steps` list
+ // have
+ // completed successfully.
WaitFor []string `json:"waitFor,omitempty"`
// ForceSendFields is a list of field names (e.g. "Args") to
@@ -603,7 +751,7 @@ func (s *BuildTrigger) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// BuiltImage: BuiltImage describes an image built by the pipeline.
+// BuiltImage: An image built by the pipeline.
type BuiltImage struct {
// Digest: Docker Registry 2.0 digest.
Digest string `json:"digest,omitempty"`
@@ -615,6 +763,7 @@ type BuiltImage struct {
// PushTiming: Stores timing information for pushing the specified
// image.
+ // @OutputOnly
PushTiming *TimeSpan `json:"pushTiming,omitempty"`
// ForceSendFields is a list of field names (e.g. "Digest") to
@@ -734,9 +883,9 @@ func (s *Hash) MarshalJSON() ([]byte, error) {
}
// ListBuildTriggersResponse: Response containing existing
-// BuildTriggers.
+// `BuildTriggers`.
type ListBuildTriggersResponse struct {
- // Triggers: BuildTriggers for the project, sorted by create_time
+ // Triggers: `BuildTriggers` for the project, sorted by `create_time`
// descending.
Triggers []*BuildTrigger `json:"triggers,omitempty"`
@@ -769,7 +918,7 @@ func (s *ListBuildTriggersResponse) MarshalJSON() ([]byte, error) {
// ListBuildsResponse: Response including listed builds.
type ListBuildsResponse struct {
- // Builds: Builds will be sorted by create_time, descending.
+ // Builds: Builds will be sorted by `create_time`, descending.
Builds []*Build `json:"builds,omitempty"`
// NextPageToken: Token to receive the next page of results.
@@ -914,8 +1063,7 @@ func (s *Operation) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// RepoSource: RepoSource describes the location of the source in a
-// Google Cloud Source
+// RepoSource: Location of the source in a Google Cloud Source
// Repository.
type RepoSource struct {
// BranchName: Name of the branch to build.
@@ -926,14 +1074,19 @@ type RepoSource struct {
// Dir: Directory, relative to the source root, in which to run the
// build.
+ //
+ // This must be a relative path. If a step's `dir` is specified and is
+ // an
+ // absolute path, this value is ignored for that step's execution.
Dir string `json:"dir,omitempty"`
- // ProjectId: ID of the project that owns the repo. If omitted, the
- // project ID requesting
- // the build is assumed.
+ // ProjectId: ID of the project that owns the Cloud Source Repository.
+ // If omitted, the
+ // project ID requesting the build is assumed.
ProjectId string `json:"projectId,omitempty"`
- // RepoName: Name of the repo. If omitted, the name "default" is
+ // RepoName: Name of the Cloud Source Repository. If omitted, the name
+ // "default" is
// assumed.
RepoName string `json:"repoName,omitempty"`
@@ -963,17 +1116,25 @@ func (s *RepoSource) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Results: Results describes the artifacts created by the build
-// pipeline.
+// Results: Artifacts created by the build pipeline.
type Results struct {
- // BuildStepImages: List of build step digests, in order corresponding
- // to build step indices.
+ // ArtifactManifest: Path to the artifact manifest. Only populated when
+ // artifacts are uploaded.
+ ArtifactManifest string `json:"artifactManifest,omitempty"`
+
+ // BuildStepImages: List of build step digests, in the order
+ // corresponding to build step
+ // indices.
BuildStepImages []string `json:"buildStepImages,omitempty"`
- // Images: Images that were built as a part of the build.
+ // Images: Container images that were built as a part of the build.
Images []*BuiltImage `json:"images,omitempty"`
- // ForceSendFields is a list of field names (e.g. "BuildStepImages") to
+ // NumArtifacts: Number of artifacts uploaded. Only populated when
+ // artifacts are uploaded.
+ NumArtifacts int64 `json:"numArtifacts,omitempty,string"`
+
+ // ForceSendFields is a list of field names (e.g. "ArtifactManifest") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -981,7 +1142,7 @@ type Results struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "BuildStepImages") to
+ // NullFields is a list of field names (e.g. "ArtifactManifest") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
@@ -997,11 +1158,11 @@ func (s *Results) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// RetryBuildRequest: RetryBuildRequest specifies a build to retry.
+// RetryBuildRequest: Specifies a build to retry.
type RetryBuildRequest struct {
}
-// Secret: Secret pairs a set of secret environment variables containing
+// Secret: Pairs a set of secret environment variables containing
// encrypted
// values with the Cloud KMS key to use to decrypt the value.
type Secret struct {
@@ -1043,12 +1204,11 @@ func (s *Secret) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Source: Source describes the location of the source in a supported
-// storage
-// service.
+// Source: Location of the source in a supported storage service.
type Source struct {
- // RepoSource: If provided, get source from this location in a Cloud
- // Repo.
+ // RepoSource: If provided, get the source from this location in a Cloud
+ // Source
+ // Repository.
RepoSource *RepoSource `json:"repoSource,omitempty"`
// StorageSource: If provided, get the source from this location in
@@ -1084,10 +1244,10 @@ func (s *Source) MarshalJSON() ([]byte, error) {
type SourceProvenance struct {
// FileHashes: Hash(es) of the build source, which can be used to verify
// that the original
- // source integrity was maintained in the build. Note that FileHashes
+ // source integrity was maintained in the build. Note that `FileHashes`
// will
- // only be populated if BuildOptions has requested a
- // SourceProvenanceHash.
+ // only be populated if `BuildOptions` has requested a
+ // `SourceProvenanceHash`.
//
// The keys to this map are file paths used as build source and the
// values
@@ -1095,17 +1255,17 @@ type SourceProvenance struct {
//
// If the build source came in a single package such as a gzipped
// tarfile
- // (.tar.gz), the FileHash will be for the single path to that
+ // (`.tar.gz`), the `FileHash` will be for the single path to that
// file.
// @OutputOnly
FileHashes map[string]FileHashes `json:"fileHashes,omitempty"`
- // ResolvedRepoSource: A copy of the build's source.repo_source, if
+ // ResolvedRepoSource: A copy of the build's `source.repo_source`, if
// exists, with any
// revisions resolved.
ResolvedRepoSource *RepoSource `json:"resolvedRepoSource,omitempty"`
- // ResolvedStorageSource: A copy of the build's source.storage_source,
+ // ResolvedStorageSource: A copy of the build's `source.storage_source`,
// if exists, with any
// generations resolved.
ResolvedStorageSource *StorageSource `json:"resolvedStorageSource,omitempty"`
@@ -1252,11 +1412,11 @@ func (s *Status) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// StorageSource: StorageSource describes the location of the source in
-// an archive file in
-// Google Cloud Storage.
+// StorageSource: Location of the source in an archive file in Google
+// Cloud Storage.
type StorageSource struct {
- // Bucket: Google Cloud Storage bucket containing source (see
+ // Bucket: Google Cloud Storage bucket containing the source
+ // (see
// [Bucket
// Name
// Requirements](https://cloud.google.com/storage/docs/bucket-naming
@@ -1268,9 +1428,9 @@ type StorageSource struct {
// omitted, the latest generation will be used.
Generation int64 `json:"generation,omitempty,string"`
- // Object: Google Cloud Storage object containing source.
+ // Object: Google Cloud Storage object containing the source.
//
- // This object must be a gzipped archive file (.tar.gz) containing
+ // This object must be a gzipped archive file (`.tar.gz`) containing
// source to
// build.
Object string `json:"object,omitempty"`
@@ -1298,7 +1458,7 @@ func (s *StorageSource) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// TimeSpan: Stores start and end times for a build execution phase.
+// TimeSpan: Start and end times for a build execution phase.
type TimeSpan struct {
// EndTime: End of time span.
EndTime string `json:"endTime,omitempty"`
@@ -1891,7 +2051,7 @@ type ProjectsBuildsCancelCall struct {
header_ http.Header
}
-// Cancel: Cancels a requested build in progress.
+// Cancel: Cancels a build in progress.
func (r *ProjectsBuildsService) Cancel(projectId string, id string, cancelbuildrequest *CancelBuildRequest) *ProjectsBuildsCancelCall {
c := &ProjectsBuildsCancelCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.projectId = projectId
@@ -1987,7 +2147,7 @@ func (c *ProjectsBuildsCancelCall) Do(opts ...googleapi.CallOption) (*Build, err
}
return ret, nil
// {
- // "description": "Cancels a requested build in progress.",
+ // "description": "Cancels a build in progress.",
// "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
// "httpMethod": "POST",
// "id": "cloudbuild.projects.builds.cancel",
@@ -2036,11 +2196,11 @@ type ProjectsBuildsCreateCall struct {
// Create: Starts a build with the specified configuration.
//
-// The long-running Operation returned by this method will include the
-// ID of
-// the build, which can be passed to GetBuild to determine its status
-// (e.g.,
-// success or failure).
+// This method returns a long-running `Operation`, which includes the
+// build
+// ID. Pass the build ID to `GetBuild` to determine the build status
+// (such as
+// `SUCCESS` or `FAILURE`).
func (r *ProjectsBuildsService) Create(projectId string, build *Build) *ProjectsBuildsCreateCall {
c := &ProjectsBuildsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.projectId = projectId
@@ -2134,7 +2294,7 @@ func (c *ProjectsBuildsCreateCall) Do(opts ...googleapi.CallOption) (*Operation,
}
return ret, nil
// {
- // "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).",
+ // "description": "Starts a build with the specified configuration.\n\nThis method returns a long-running `Operation`, which includes the build\nID. Pass the build ID to `GetBuild` to determine the build status (such as\n`SUCCESS` or `FAILURE`).",
// "flatPath": "v1/projects/{projectId}/builds",
// "httpMethod": "POST",
// "id": "cloudbuild.projects.builds.create",
@@ -2177,9 +2337,9 @@ type ProjectsBuildsGetCall struct {
// Get: Returns information about a previously requested build.
//
-// The Build that is returned includes its status (e.g., success or
-// failure,
-// or in-progress), and timing information.
+// The `Build` that is returned includes its status (such as
+// `SUCCESS`,
+// `FAILURE`, or `WORKING`), and timing information.
func (r *ProjectsBuildsService) Get(projectId string, id string) *ProjectsBuildsGetCall {
c := &ProjectsBuildsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.projectId = projectId
@@ -2282,7 +2442,7 @@ func (c *ProjectsBuildsGetCall) Do(opts ...googleapi.CallOption) (*Build, error)
}
return ret, nil
// {
- // "description": "Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information.",
+ // "description": "Returns information about a previously requested build.\n\nThe `Build` that is returned includes its status (such as `SUCCESS`,\n`FAILURE`, or `WORKING`), and timing information.",
// "flatPath": "v1/projects/{projectId}/builds/{id}",
// "httpMethod": "GET",
// "id": "cloudbuild.projects.builds.get",
@@ -2527,19 +2687,20 @@ type ProjectsBuildsRetryCall struct {
header_ http.Header
}
-// Retry: Creates a new build based on the given build.
+// Retry: Creates a new build based on the specified build.
//
-// This API creates a new build using the original build request, which
-// may
+// This method creates a new build using the original build request,
+// which may
// or may not result in an identical build.
//
// For triggered builds:
//
-// * Triggered builds resolve to a precise revision, so a retry of a
-// triggered
-// build will result in a build that uses the same revision.
+// * Triggered builds resolve to a precise revision; therefore a retry
+// of a
+// triggered build will result in a build that uses the same
+// revision.
//
-// For non-triggered builds that specify RepoSource:
+// For non-triggered builds that specify `RepoSource`:
//
// * If the original build built from the tip of a branch, the retried
// build
@@ -2550,13 +2711,13 @@ type ProjectsBuildsRetryCall struct {
// retried
// build will use the identical source.
//
-// For builds that specify StorageSource:
+// For builds that specify `StorageSource`:
//
-// * If the original build pulled source from Cloud Storage without
-// specifying
-// the generation of the object, the new build will use the current
-// object,
-// which may be different from the original build source.
+// * If the original build pulled source from Google Cloud Storage
+// without
+// specifying the generation of the object, the new build will use the
+// current
+// object, which may be different from the original build source.
// * If the original build pulled source from Cloud Storage and
// specified the
// generation of the object, the new build will attempt to use the
@@ -2659,7 +2820,7 @@ func (c *ProjectsBuildsRetryCall) Do(opts ...googleapi.CallOption) (*Operation,
}
return ret, nil
// {
- // "description": "Creates a new build based on the given build.\n\nThis API creates a new build using the original build request, which may\nor may not result in an identical build.\n\nFor triggered builds:\n\n* Triggered builds resolve to a precise revision, so a retry of a triggered\nbuild will result in a build that uses the same revision.\n\nFor non-triggered builds that specify RepoSource:\n\n* If the original build built from the tip of a branch, the retried build\nwill build from the tip of that branch, which may not be the same revision\nas the original build.\n* If the original build specified a commit sha or revision ID, the retried\nbuild will use the identical source.\n\nFor builds that specify StorageSource:\n\n* If the original build pulled source from Cloud Storage without specifying\nthe generation of the object, the new build will use the current object,\nwhich may be different from the original build source.\n* If the original build pulled source from Cloud Storage and specified the\ngeneration of the object, the new build will attempt to use the same\nobject, which may or may not be available depending on the bucket's\nlifecycle management settings.",
+ // "description": "Creates a new build based on the specified build.\n\nThis method creates a new build using the original build request, which may\nor may not result in an identical build.\n\nFor triggered builds:\n\n* Triggered builds resolve to a precise revision; therefore a retry of a\ntriggered build will result in a build that uses the same revision.\n\nFor non-triggered builds that specify `RepoSource`:\n\n* If the original build built from the tip of a branch, the retried build\nwill build from the tip of that branch, which may not be the same revision\nas the original build.\n* If the original build specified a commit sha or revision ID, the retried\nbuild will use the identical source.\n\nFor builds that specify `StorageSource`:\n\n* If the original build pulled source from Google Cloud Storage without\nspecifying the generation of the object, the new build will use the current\nobject, which may be different from the original build source.\n* If the original build pulled source from Cloud Storage and specified the\ngeneration of the object, the new build will attempt to use the same\nobject, which may or may not be available depending on the bucket's\nlifecycle management settings.",
// "flatPath": "v1/projects/{projectId}/builds/{id}:retry",
// "httpMethod": "POST",
// "id": "cloudbuild.projects.builds.retry",
@@ -2706,7 +2867,7 @@ type ProjectsTriggersCreateCall struct {
header_ http.Header
}
-// Create: Creates a new BuildTrigger.
+// Create: Creates a new `BuildTrigger`.
//
// This API is experimental.
func (r *ProjectsTriggersService) Create(projectId string, buildtrigger *BuildTrigger) *ProjectsTriggersCreateCall {
@@ -2802,7 +2963,7 @@ func (c *ProjectsTriggersCreateCall) Do(opts ...googleapi.CallOption) (*BuildTri
}
return ret, nil
// {
- // "description": "Creates a new BuildTrigger.\n\nThis API is experimental.",
+ // "description": "Creates a new `BuildTrigger`.\n\nThis API is experimental.",
// "flatPath": "v1/projects/{projectId}/triggers",
// "httpMethod": "POST",
// "id": "cloudbuild.projects.triggers.create",
@@ -2842,7 +3003,7 @@ type ProjectsTriggersDeleteCall struct {
header_ http.Header
}
-// Delete: Deletes an BuildTrigger by its project ID and trigger
+// Delete: Deletes a `BuildTrigger` by its project ID and trigger
// ID.
//
// This API is experimental.
@@ -2935,7 +3096,7 @@ func (c *ProjectsTriggersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, e
}
return ret, nil
// {
- // "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
+ // "description": "Deletes a `BuildTrigger` by its project ID and trigger ID.\n\nThis API is experimental.",
// "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
// "httpMethod": "DELETE",
// "id": "cloudbuild.projects.triggers.delete",
@@ -2951,7 +3112,7 @@ func (c *ProjectsTriggersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, e
// "type": "string"
// },
// "triggerId": {
- // "description": "ID of the BuildTrigger to delete.",
+ // "description": "ID of the `BuildTrigger` to delete.",
// "location": "path",
// "required": true,
// "type": "string"
@@ -2980,7 +3141,7 @@ type ProjectsTriggersGetCall struct {
header_ http.Header
}
-// Get: Gets information about a BuildTrigger.
+// Get: Returns information about a `BuildTrigger`.
//
// This API is experimental.
func (r *ProjectsTriggersService) Get(projectId string, triggerId string) *ProjectsTriggersGetCall {
@@ -3085,7 +3246,7 @@ func (c *ProjectsTriggersGetCall) Do(opts ...googleapi.CallOption) (*BuildTrigge
}
return ret, nil
// {
- // "description": "Gets information about a BuildTrigger.\n\nThis API is experimental.",
+ // "description": "Returns information about a `BuildTrigger`.\n\nThis API is experimental.",
// "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
// "httpMethod": "GET",
// "id": "cloudbuild.projects.triggers.get",
@@ -3101,7 +3262,7 @@ func (c *ProjectsTriggersGetCall) Do(opts ...googleapi.CallOption) (*BuildTrigge
// "type": "string"
// },
// "triggerId": {
- // "description": "ID of the BuildTrigger to get.",
+ // "description": "ID of the `BuildTrigger` to get.",
// "location": "path",
// "required": true,
// "type": "string"
@@ -3129,7 +3290,7 @@ type ProjectsTriggersListCall struct {
header_ http.Header
}
-// List: Lists existing BuildTrigger.
+// List: Lists existing `BuildTrigger`s.
//
// This API is experimental.
func (r *ProjectsTriggersService) List(projectId string) *ProjectsTriggersListCall {
@@ -3232,7 +3393,7 @@ func (c *ProjectsTriggersListCall) Do(opts ...googleapi.CallOption) (*ListBuildT
}
return ret, nil
// {
- // "description": "Lists existing BuildTrigger.\n\nThis API is experimental.",
+ // "description": "Lists existing `BuildTrigger`s.\n\nThis API is experimental.",
// "flatPath": "v1/projects/{projectId}/triggers",
// "httpMethod": "GET",
// "id": "cloudbuild.projects.triggers.list",
@@ -3270,7 +3431,7 @@ type ProjectsTriggersPatchCall struct {
header_ http.Header
}
-// Patch: Updates an BuildTrigger by its project ID and trigger
+// Patch: Updates a `BuildTrigger` by its project ID and trigger
// ID.
//
// This API is experimental.
@@ -3369,7 +3530,7 @@ func (c *ProjectsTriggersPatchCall) Do(opts ...googleapi.CallOption) (*BuildTrig
}
return ret, nil
// {
- // "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
+ // "description": "Updates a `BuildTrigger` by its project ID and trigger ID.\n\nThis API is experimental.",
// "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
// "httpMethod": "PATCH",
// "id": "cloudbuild.projects.triggers.patch",
@@ -3385,7 +3546,7 @@ func (c *ProjectsTriggersPatchCall) Do(opts ...googleapi.CallOption) (*BuildTrig
// "type": "string"
// },
// "triggerId": {
- // "description": "ID of the BuildTrigger to update.",
+ // "description": "ID of the `BuildTrigger` to update.",
// "location": "path",
// "required": true,
// "type": "string"
@@ -3417,7 +3578,7 @@ type ProjectsTriggersRunCall struct {
header_ http.Header
}
-// Run: Runs a BuildTrigger at a particular source revision.
+// Run: Runs a `BuildTrigger` at a particular source revision.
func (r *ProjectsTriggersService) Run(projectId string, triggerId string, reposource *RepoSource) *ProjectsTriggersRunCall {
c := &ProjectsTriggersRunCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.projectId = projectId
@@ -3513,7 +3674,7 @@ func (c *ProjectsTriggersRunCall) Do(opts ...googleapi.CallOption) (*Operation,
}
return ret, nil
// {
- // "description": "Runs a BuildTrigger at a particular source revision.",
+ // "description": "Runs a `BuildTrigger` at a particular source revision.",
// "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run",
// "httpMethod": "POST",
// "id": "cloudbuild.projects.triggers.run",
diff --git a/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-api.json b/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-api.json
index 8cf6d915c..ce194ca57 100644
--- a/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-api.json
+++ b/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-api.json
@@ -1,573 +1,696 @@
{
- "resources": {
- "debugger": {
- "resources": {
- "debuggees": {
- "methods": {
- "list": {
- "description": "Lists all the debuggees that the user has access to.",
- "response": {
- "$ref": "ListDebuggeesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "includeInactive": {
- "location": "query",
- "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
- "type": "boolean"
- },
- "project": {
- "location": "query",
- "description": "Project number of a Google Cloud project whose debuggees to list.",
- "type": "string"
- },
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/debugger/debuggees",
- "path": "v2/debugger/debuggees",
- "id": "clouddebugger.debugger.debuggees.list"
- }
- },
- "resources": {
- "breakpoints": {
- "methods": {
- "set": {
- "httpMethod": "POST",
- "parameterOrder": [
- "debuggeeId"
- ],
- "response": {
- "$ref": "SetBreakpointResponse"
- },
- "parameters": {
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- },
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee where the breakpoint is to be set.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- "id": "clouddebugger.debugger.debuggees.breakpoints.set",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- "request": {
- "$ref": "Breakpoint"
- },
- "description": "Sets the breakpoint to the debuggee."
- },
- "delete": {
- "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "description": "Deletes the breakpoint from the debuggee.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- },
- "breakpointId": {
- "description": "ID of the breakpoint to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee whose breakpoint to delete.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}"
- },
- "get": {
- "description": "Gets breakpoint information.",
- "response": {
- "$ref": "GetBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "clientVersion": {
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
- },
- "breakpointId": {
- "location": "path",
- "description": "ID of the breakpoint to get.",
- "required": true,
- "type": "string"
- },
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoint to get.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "id": "clouddebugger.debugger.debuggees.breakpoints.get"
- },
- "list": {
- "description": "Lists all breakpoints for the debuggee.",
- "response": {
- "$ref": "ListBreakpointsResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "waitToken": {
- "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.",
- "type": "string",
- "location": "query"
- },
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- },
- "action.value": {
- "enum": [
- "CAPTURE",
- "LOG"
- ],
- "description": "Only breakpoints with the specified action will pass the filter.",
- "type": "string",
- "location": "query"
- },
- "includeAllUsers": {
- "location": "query",
- "description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller.",
- "type": "boolean"
- },
- "includeInactive": {
- "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
- "type": "boolean",
- "location": "query"
- },
- "stripResults": {
- "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
- "type": "boolean",
- "location": "query"
- },
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoints to list.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "id": "clouddebugger.debugger.debuggees.breakpoints.list"
- }
- }
- }
- }
- }
- }
- },
- "controller": {
- "resources": {
- "debuggees": {
- "methods": {
- "register": {
- "response": {
- "$ref": "RegisterDebuggeeResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/controller/debuggees/register",
- "path": "v2/controller/debuggees/register",
- "id": "clouddebugger.controller.debuggees.register",
- "request": {
- "$ref": "RegisterDebuggeeRequest"
- },
- "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application must call this method with\nexactly the same request content to get back the same stable `debuggee_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND`\nis returned from any controller method.\n\nThis protocol allows the controller service to disable debuggees, recover\nfrom data loss, or change the `debuggee_id` format. Agents must handle\n`debuggee_id` value changing upon re-registration."
- }
- },
- "resources": {
- "breakpoints": {
- "methods": {
- "list": {
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "id": "clouddebugger.controller.debuggees.breakpoints.list",
- "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `condition`, and `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again.",
- "response": {
- "$ref": "ListActiveBreakpointsResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "waitToken": {
- "location": "query",
- "description": "A token that, if specified, blocks the method call until the list\nof active breakpoints has changed, or a server-selected timeout has\nexpired. The value should be set from the `next_wait_token` field in\nthe last response. The initial value should be set to `\"init\"`.",
- "type": "string"
- },
- "debuggeeId": {
- "description": "Identifies the debuggee.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "successOnTimeout": {
- "description": "If set to `true` (recommended), returns `google.rpc.Code.OK` status and\nsets the `wait_expired` response field to `true` when the server-selected\ntimeout has expired.\n\nIf set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status\nwhen the server-selected timeout has expired.",
- "type": "boolean",
- "location": "query"
- }
- },
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints"
- },
- "update": {
- "response": {
- "$ref": "UpdateActiveBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId",
- "id"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "required": true,
- "type": "string"
- },
- "debuggeeId": {
- "description": "Identifies the debuggee being debugged.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "id": "clouddebugger.controller.debuggees.breakpoints.update",
- "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller service.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expressions` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code.",
- "request": {
- "$ref": "UpdateActiveBreakpointRequest"
- }
- }
- }
- }
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud_debugger": {
+ "description": "Use Stackdriver Debugger"
}
}
}
},
+ "basePath": "",
+ "baseUrl": "https://clouddebugger.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Debugger",
+ "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
+ "discoveryVersion": "v1",
+ "documentationLink": "http://cloud.google.com/debugger",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "clouddebugger:v2",
+ "kind": "discovery#restDescription",
+ "name": "clouddebugger",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
"parameters": {
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
"type": "string"
},
"alt": {
+ "default": "json",
+ "description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "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.",
"type": "string"
},
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
"bearer_token": {
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
"location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
+ "type": "string"
}
},
- "version": "v2",
- "baseUrl": "https://clouddebugger.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
- "servicePath": "",
- "basePath": "",
- "id": "clouddebugger:v2",
- "documentationLink": "http://cloud.google.com/debugger",
- "revision": "20180112",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "StatusMessage": {
- "properties": {
- "isError": {
- "description": "Distinguishes errors from informational messages.",
- "type": "boolean"
- },
- "description": {
- "$ref": "FormatMessage",
- "description": "Status message text."
- },
- "refersTo": {
- "enumDescriptions": [
- "Status doesn't refer to any particular input.",
- "Status applies to the breakpoint and is related to its location.",
- "Status applies to the breakpoint and is related to its condition.",
- "Status applies to the breakpoint and is related to its expressions.",
- "Status applies to the breakpoint and is related to its age.",
- "Status applies to the entire variable.",
- "Status applies to variable value (variable name is valid)."
- ],
- "enum": [
- "UNSPECIFIED",
- "BREAKPOINT_SOURCE_LOCATION",
- "BREAKPOINT_CONDITION",
- "BREAKPOINT_EXPRESSION",
- "BREAKPOINT_AGE",
- "VARIABLE_NAME",
- "VARIABLE_VALUE"
- ],
- "description": "Reference to which the message applies.",
- "type": "string"
- }
- },
- "id": "StatusMessage",
- "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.",
- "type": "object"
- },
- "GitSourceContext": {
- "description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).",
- "type": "object",
- "properties": {
- "revisionId": {
- "description": "Git commit hash.\nrequired.",
- "type": "string"
- },
- "url": {
- "description": "Git repository URL.",
- "type": "string"
- }
- },
- "id": "GitSourceContext"
- },
- "Variable": {
- "properties": {
- "varTableIndex": {
- "description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint.",
- "format": "int32",
- "type": "integer"
- },
- "value": {
- "description": "Simple value of the variable.",
- "type": "string"
- },
- "members": {
- "description": "Members contained or pointed to by the variable.",
- "type": "array",
- "items": {
- "$ref": "Variable"
+ "protocol": "rest",
+ "resources": {
+ "controller": {
+ "resources": {
+ "debuggees": {
+ "methods": {
+ "register": {
+ "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application must call this method with\nexactly the same request content to get back the same stable `debuggee_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND`\nis returned from any controller method.\n\nThis protocol allows the controller service to disable debuggees, recover\nfrom data loss, or change the `debuggee_id` format. Agents must handle\n`debuggee_id` value changing upon re-registration.",
+ "flatPath": "v2/controller/debuggees/register",
+ "httpMethod": "POST",
+ "id": "clouddebugger.controller.debuggees.register",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v2/controller/debuggees/register",
+ "request": {
+ "$ref": "RegisterDebuggeeRequest"
+ },
+ "response": {
+ "$ref": "RegisterDebuggeeResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ }
+ },
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "list": {
+ "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `condition`, and `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again.",
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints",
+ "httpMethod": "GET",
+ "id": "clouddebugger.controller.debuggees.breakpoints.list",
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "parameters": {
+ "debuggeeId": {
+ "description": "Identifies the debuggee.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "successOnTimeout": {
+ "description": "If set to `true` (recommended), returns `google.rpc.Code.OK` status and\nsets the `wait_expired` response field to `true` when the server-selected\ntimeout has expired.\n\nIf set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status\nwhen the server-selected timeout has expired.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "waitToken": {
+ "description": "A token that, if specified, blocks the method call until the list\nof active breakpoints has changed, or a server-selected timeout has\nexpired. The value should be set from the `next_wait_token` field in\nthe last response. The initial value should be set to `\"init\"`.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
+ "response": {
+ "$ref": "ListActiveBreakpointsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ },
+ "update": {
+ "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller service.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expressions` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code.",
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "httpMethod": "PUT",
+ "id": "clouddebugger.controller.debuggees.breakpoints.update",
+ "parameterOrder": [
+ "debuggeeId",
+ "id"
+ ],
+ "parameters": {
+ "debuggeeId": {
+ "description": "Identifies the debuggee being debugged.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "request": {
+ "$ref": "UpdateActiveBreakpointRequest"
+ },
+ "response": {
+ "$ref": "UpdateActiveBreakpointResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ }
+ }
+ }
}
- },
- "status": {
- "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`",
- "$ref": "StatusMessage"
+ }
+ }
+ },
+ "debugger": {
+ "resources": {
+ "debuggees": {
+ "methods": {
+ "list": {
+ "description": "Lists all the debuggees that the user has access to.",
+ "flatPath": "v2/debugger/debuggees",
+ "httpMethod": "GET",
+ "id": "clouddebugger.debugger.debuggees.list",
+ "parameterOrder": [],
+ "parameters": {
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query",
+ "type": "string"
+ },
+ "includeInactive": {
+ "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "project": {
+ "description": "Project number of a Google Cloud project whose debuggees to list.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2/debugger/debuggees",
+ "response": {
+ "$ref": "ListDebuggeesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ }
+ },
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the breakpoint from the debuggee.",
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "httpMethod": "DELETE",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "parameters": {
+ "breakpointId": {
+ "description": "ID of the breakpoint to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query",
+ "type": "string"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoint to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ },
+ "get": {
+ "description": "Gets breakpoint information.",
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "httpMethod": "GET",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.get",
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "parameters": {
+ "breakpointId": {
+ "description": "ID of the breakpoint to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query",
+ "type": "string"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoint to get.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "response": {
+ "$ref": "GetBreakpointResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ },
+ "list": {
+ "description": "Lists all breakpoints for the debuggee.",
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "httpMethod": "GET",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.list",
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "parameters": {
+ "action.value": {
+ "description": "Only breakpoints with the specified action will pass the filter.",
+ "enum": [
+ "CAPTURE",
+ "LOG"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query",
+ "type": "string"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoints to list.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "includeAllUsers": {
+ "description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "includeInactive": {
+ "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "stripResults": {
+ "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "waitToken": {
+ "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "response": {
+ "$ref": "ListBreakpointsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ },
+ "set": {
+ "description": "Sets the breakpoint to the debuggee.",
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
+ "httpMethod": "POST",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.set",
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "parameters": {
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query",
+ "type": "string"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee where the breakpoint is to be set.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
+ "request": {
+ "$ref": "Breakpoint"
+ },
+ "response": {
+ "$ref": "SetBreakpointResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20180131",
+ "rootUrl": "https://clouddebugger.googleapis.com/",
+ "schemas": {
+ "AliasContext": {
+ "description": "An alias to a repo revision.",
+ "id": "AliasContext",
+ "properties": {
+ "kind": {
+ "description": "The alias kind.",
+ "enum": [
+ "ANY",
+ "FIXED",
+ "MOVABLE",
+ "OTHER"
+ ],
+ "enumDescriptions": [
+ "Do not use.",
+ "Git tag",
+ "Git branch",
+ "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
+ ],
+ "type": "string"
},
"name": {
- "description": "Name of the variable, if any.",
- "type": "string"
- },
- "type": {
- "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.",
+ "description": "The alias name.",
"type": "string"
}
},
- "id": "Variable",
- "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.",
"type": "object"
},
- "StackFrame": {
+ "Breakpoint": {
+ "description": "Represents the breakpoint specification, status and results.",
+ "id": "Breakpoint",
"properties": {
- "function": {
- "description": "Demangled function name at the call site.",
+ "action": {
+ "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.",
+ "enum": [
+ "CAPTURE",
+ "LOG"
+ ],
+ "enumDescriptions": [
+ "Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.",
+ "Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired."
+ ],
"type": "string"
},
- "arguments": {
- "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
+ "condition": {
+ "description": "Condition that triggers the breakpoint.\nThe condition is a compound boolean expression composed using expressions\nin a programming language at the source location.",
+ "type": "string"
},
- "locals": {
- "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
- "type": "array",
+ "createTime": {
+ "description": "Time this breakpoint was created by the server in seconds resolution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "evaluatedExpressions": {
+ "description": "Values of evaluated expressions at breakpoint time.\nThe evaluated expressions appear in exactly the same order they\nare listed in the `expressions` field.\nThe `name` field holds the original expression text, the `value` or\n`members` field holds the result of the evaluated expression.\nIf the expression cannot be evaluated, the `status` inside the `Variable`\nwill indicate an error and contain the error text.",
"items": {
"$ref": "Variable"
- }
+ },
+ "type": "array"
+ },
+ "expressions": {
+ "description": "List of read-only expressions to evaluate at the breakpoint location.\nThe expressions are composed using expressions in the programming language\nat the source location. If the breakpoint action is `LOG`, the evaluated\nexpressions are included in log statements.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "finalTime": {
+ "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "type": "string"
+ },
+ "isFinalState": {
+ "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on.",
+ "type": "boolean"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
},
"location": {
"$ref": "SourceLocation",
- "description": "Source location of the call site."
+ "description": "Breakpoint source location."
+ },
+ "logLevel": {
+ "description": "Indicates the severity of the log. Only relevant when action is `LOG`.",
+ "enum": [
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "enumDescriptions": [
+ "Information log message.",
+ "Warning log message.",
+ "Error log message."
+ ],
+ "type": "string"
+ },
+ "logMessageFormat": {
+ "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.",
+ "type": "string"
+ },
+ "stackFrames": {
+ "description": "The stack at breakpoint time.",
+ "items": {
+ "$ref": "StackFrame"
+ },
+ "type": "array"
+ },
+ "status": {
+ "$ref": "StatusMessage",
+ "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition"
+ },
+ "userEmail": {
+ "description": "E-mail address of the user that created this breakpoint",
+ "type": "string"
+ },
+ "variableTable": {
+ "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.",
+ "items": {
+ "$ref": "Variable"
+ },
+ "type": "array"
}
},
- "id": "StackFrame",
- "description": "Represents a stack frame context.",
"type": "object"
},
- "RepoId": {
- "description": "A unique identifier for a cloud repo.",
- "type": "object",
+ "CloudRepoSourceContext": {
+ "description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
+ "id": "CloudRepoSourceContext",
"properties": {
- "projectRepoId": {
- "$ref": "ProjectRepoId",
- "description": "A combination of a project ID and a repo name."
+ "aliasContext": {
+ "$ref": "AliasContext",
+ "description": "An alias, which may be a branch or tag."
},
- "uid": {
- "description": "A server-assigned, globally unique identifier.",
+ "aliasName": {
+ "description": "The name of an alias (branch, tag, etc.).",
+ "type": "string"
+ },
+ "repoId": {
+ "$ref": "RepoId",
+ "description": "The ID of the repo."
+ },
+ "revisionId": {
+ "description": "A revision ID.",
"type": "string"
}
},
- "id": "RepoId"
+ "type": "object"
},
- "FormatMessage": {
- "description": "Represents a message with parameters.",
- "type": "object",
+ "CloudWorkspaceId": {
+ "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.",
+ "id": "CloudWorkspaceId",
"properties": {
- "parameters": {
- "description": "Optional parameters to be embedded into the message.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "name": {
+ "description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.",
+ "type": "string"
},
- "format": {
- "description": "Format template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n* `Please pay $$10 to use $0 instead of $1.`",
+ "repoId": {
+ "$ref": "RepoId",
+ "description": "The ID of the repo containing the workspace."
+ }
+ },
+ "type": "object"
+ },
+ "CloudWorkspaceSourceContext": {
+ "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
+ "id": "CloudWorkspaceSourceContext",
+ "properties": {
+ "snapshotId": {
+ "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
+ "type": "string"
+ },
+ "workspaceId": {
+ "$ref": "CloudWorkspaceId",
+ "description": "The ID of the workspace."
+ }
+ },
+ "type": "object"
+ },
+ "Debuggee": {
+ "description": "Represents the debugged application. The application may include one or more\nreplicated processes executing the same code. Each of these processes is\nattached with a debugger agent, carrying out the debugging commands.\nAgents attached to the same debuggee identify themselves as such by using\nexactly the same Debuggee message value when registering.",
+ "id": "Debuggee",
+ "properties": {
+ "agentVersion": {
+ "description": "Version ID of the agent.\nSchema: `domain/language-platform/vmajor.minor` (for example\n`google.com/java-gcp/v1.1`).",
+ "type": "string"
+ },
+ "description": {
+ "description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.",
+ "type": "string"
+ },
+ "extSourceContexts": {
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.",
+ "items": {
+ "$ref": "ExtendedSourceContext"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for the debuggee generated by the controller service.",
+ "type": "string"
+ },
+ "isDisabled": {
+ "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
+ "type": "boolean"
+ },
+ "isInactive": {
+ "description": "If set to `true`, indicates that Controller service does not detect any\nactivity from the debuggee agents and the application is possibly stopped.",
+ "type": "boolean"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
+ },
+ "project": {
+ "description": "Project the debuggee is associated with.\nUse project number or id when registering a Google Cloud Platform project.",
+ "type": "string"
+ },
+ "sourceContexts": {
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.",
+ "items": {
+ "$ref": "SourceContext"
+ },
+ "type": "array"
+ },
+ "status": {
+ "$ref": "StatusMessage",
+ "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status."
+ },
+ "uniquifier": {
+ "description": "Uniquifier to further distiguish the application.\nIt is possible that different applications might have identical values in\nthe debuggee message, thus, incorrectly identified as a single application\nby the Controller service. This field adds salt to further distiguish the\napplication. Agents should consider seeding this field with value that\nidentifies the code, binary, configuration and environment.",
"type": "string"
}
},
- "id": "FormatMessage"
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
},
"ExtendedSourceContext": {
"description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
- "type": "object",
+ "id": "ExtendedSourceContext",
"properties": {
"context": {
"$ref": "SourceContext",
@@ -581,56 +704,222 @@
"type": "object"
}
},
- "id": "ExtendedSourceContext"
+ "type": "object"
},
- "AliasContext": {
+ "FormatMessage": {
+ "description": "Represents a message with parameters.",
+ "id": "FormatMessage",
"properties": {
- "name": {
- "description": "The alias name.",
+ "format": {
+ "description": "Format template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n* `Please pay $$10 to use $0 instead of $1.`",
"type": "string"
},
- "kind": {
- "enumDescriptions": [
- "Do not use.",
- "Git tag",
- "Git branch",
- "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
- ],
- "enum": [
- "ANY",
- "FIXED",
- "MOVABLE",
- "OTHER"
- ],
- "description": "The alias kind.",
+ "parameters": {
+ "description": "Optional parameters to be embedded into the message.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GerritSourceContext": {
+ "description": "A SourceContext referring to a Gerrit project.",
+ "id": "GerritSourceContext",
+ "properties": {
+ "aliasContext": {
+ "$ref": "AliasContext",
+ "description": "An alias, which may be a branch or tag."
+ },
+ "aliasName": {
+ "description": "The name of an alias (branch, tag, etc.).",
+ "type": "string"
+ },
+ "gerritProject": {
+ "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
+ "type": "string"
+ },
+ "hostUri": {
+ "description": "The URI of a running Gerrit instance.",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "A revision (commit) ID.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GetBreakpointResponse": {
+ "description": "Response for getting breakpoint information.",
+ "id": "GetBreakpointResponse",
+ "properties": {
+ "breakpoint": {
+ "$ref": "Breakpoint",
+ "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set."
+ }
+ },
+ "type": "object"
+ },
+ "GitSourceContext": {
+ "description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).",
+ "id": "GitSourceContext",
+ "properties": {
+ "revisionId": {
+ "description": "Git commit hash.\nrequired.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Git repository URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListActiveBreakpointsResponse": {
+ "description": "Response for listing active breakpoints.",
+ "id": "ListActiveBreakpointsResponse",
+ "properties": {
+ "breakpoints": {
+ "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.",
+ "items": {
+ "$ref": "Breakpoint"
+ },
+ "type": "array"
+ },
+ "nextWaitToken": {
+ "description": "A token that can be used in the next method call to block until\nthe list of breakpoints changes.",
+ "type": "string"
+ },
+ "waitExpired": {
+ "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ListBreakpointsResponse": {
+ "description": "Response for listing breakpoints.",
+ "id": "ListBreakpointsResponse",
+ "properties": {
+ "breakpoints": {
+ "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of its status.",
+ "items": {
+ "$ref": "Breakpoint"
+ },
+ "type": "array"
+ },
+ "nextWaitToken": {
+ "description": "A wait token that can be used in the next call to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of breakpoints has changes.",
"type": "string"
}
},
- "id": "AliasContext",
- "description": "An alias to a repo revision.",
"type": "object"
},
"ListDebuggeesResponse": {
+ "description": "Response for listing debuggees.",
+ "id": "ListDebuggeesResponse",
"properties": {
"debuggees": {
"description": "List of debuggees accessible to the calling user.\nThe fields `debuggee.id` and `description` are guaranteed to be set.\nThe `description` field is a human readable field provided by agents and\ncan be displayed to users.",
- "type": "array",
"items": {
"$ref": "Debuggee"
- }
+ },
+ "type": "array"
}
},
- "id": "ListDebuggeesResponse",
- "description": "Response for listing debuggees.",
"type": "object"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "ProjectRepoId": {
+ "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.",
+ "id": "ProjectRepoId",
+ "properties": {
+ "projectId": {
+ "description": "The ID of the project.",
+ "type": "string"
+ },
+ "repoName": {
+ "description": "The name of the repo. Leave empty for the default repo.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegisterDebuggeeRequest": {
+ "description": "Request to register a debuggee.",
+ "id": "RegisterDebuggeeRequest",
+ "properties": {
+ "debuggee": {
+ "$ref": "Debuggee",
+ "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
+ }
+ },
+ "type": "object"
+ },
+ "RegisterDebuggeeResponse": {
+ "description": "Response for registering a debuggee.",
+ "id": "RegisterDebuggeeResponse",
+ "properties": {
+ "debuggee": {
+ "$ref": "Debuggee",
+ "description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields).\nIf the field `is_disabled` is set to `true`, the agent should disable\nitself by removing all breakpoints and detaching from the application.\nIt should however continue to poll `RegisterDebuggee` until reenabled."
+ }
+ },
+ "type": "object"
+ },
+ "RepoId": {
+ "description": "A unique identifier for a cloud repo.",
+ "id": "RepoId",
+ "properties": {
+ "projectRepoId": {
+ "$ref": "ProjectRepoId",
+ "description": "A combination of a project ID and a repo name."
+ },
+ "uid": {
+ "description": "A server-assigned, globally unique identifier.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SetBreakpointResponse": {
+ "description": "Response for setting a breakpoint.",
+ "id": "SetBreakpointResponse",
+ "properties": {
+ "breakpoint": {
+ "$ref": "Breakpoint",
+ "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
+ }
+ },
+ "type": "object"
+ },
+ "SourceContext": {
+ "description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.",
+ "id": "SourceContext",
+ "properties": {
+ "cloudRepo": {
+ "$ref": "CloudRepoSourceContext",
+ "description": "A SourceContext referring to a revision in a cloud repo."
+ },
+ "cloudWorkspace": {
+ "$ref": "CloudWorkspaceSourceContext",
+ "description": "A SourceContext referring to a snapshot in a cloud workspace."
+ },
+ "gerrit": {
+ "$ref": "GerritSourceContext",
+ "description": "A SourceContext referring to a Gerrit project."
+ },
+ "git": {
+ "$ref": "GitSourceContext",
+ "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
+ }
+ },
+ "type": "object"
},
"SourceLocation": {
+ "description": "Represents a location in the source code.",
+ "id": "SourceLocation",
"properties": {
"line": {
"description": "Line inside the file. The first line in the file has the value `1`.",
@@ -642,418 +931,129 @@
"type": "string"
}
},
- "id": "SourceLocation",
- "description": "Represents a location in the source code.",
"type": "object"
},
- "Debuggee": {
- "description": "Represents the debugged application. The application may include one or more\nreplicated processes executing the same code. Each of these processes is\nattached with a debugger agent, carrying out the debugging commands.\nAgents attached to the same debuggee identify themselves as such by using\nexactly the same Debuggee message value when registering.",
- "type": "object",
+ "StackFrame": {
+ "description": "Represents a stack frame context.",
+ "id": "StackFrame",
"properties": {
- "id": {
- "description": "Unique identifier for the debuggee generated by the controller service.",
- "type": "string"
- },
- "agentVersion": {
- "description": "Version ID of the agent.\nSchema: `domain/language-platform/vmajor.minor` (for example\n`google.com/java-gcp/v1.1`).",
- "type": "string"
- },
- "isDisabled": {
- "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
- "type": "boolean"
- },
- "description": {
- "description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.",
- "type": "string"
- },
- "uniquifier": {
- "description": "Uniquifier to further distiguish the application.\nIt is possible that different applications might have identical values in\nthe debuggee message, thus, incorrectly identified as a single application\nby the Controller service. This field adds salt to further distiguish the\napplication. Agents should consider seeding this field with value that\nidentifies the code, binary, configuration and environment.",
- "type": "string"
- },
- "sourceContexts": {
- "description": "References to the locations and revisions of the source code used in the\ndeployed application.",
- "type": "array",
+ "arguments": {
+ "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
"items": {
- "$ref": "SourceContext"
- }
- },
- "extSourceContexts": {
- "description": "References to the locations and revisions of the source code used in the\ndeployed application.",
- "type": "array",
- "items": {
- "$ref": "ExtendedSourceContext"
- }
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
+ "$ref": "Variable"
},
- "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object"
+ "type": "array"
},
- "status": {
- "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status.",
- "$ref": "StatusMessage"
- },
- "isInactive": {
- "description": "If set to `true`, indicates that Controller service does not detect any\nactivity from the debuggee agents and the application is possibly stopped.",
- "type": "boolean"
- },
- "project": {
- "description": "Project the debuggee is associated with.\nUse project number or id when registering a Google Cloud Platform project.",
- "type": "string"
- }
- },
- "id": "Debuggee"
- },
- "ProjectRepoId": {
- "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "The ID of the project.",
+ "function": {
+ "description": "Demangled function name at the call site.",
"type": "string"
},
- "repoName": {
- "description": "The name of the repo. Leave empty for the default repo.",
- "type": "string"
- }
- },
- "id": "ProjectRepoId"
- },
- "ListActiveBreakpointsResponse": {
- "properties": {
- "nextWaitToken": {
- "description": "A token that can be used in the next method call to block until\nthe list of breakpoints changes.",
- "type": "string"
- },
- "breakpoints": {
- "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.",
- "type": "array",
+ "locals": {
+ "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
"items": {
- "$ref": "Breakpoint"
- }
- },
- "waitExpired": {
- "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored.",
- "type": "boolean"
- }
- },
- "id": "ListActiveBreakpointsResponse",
- "description": "Response for listing active breakpoints.",
- "type": "object"
- },
- "CloudWorkspaceSourceContext": {
- "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
- "type": "object",
- "properties": {
- "snapshotId": {
- "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
- "type": "string"
- },
- "workspaceId": {
- "$ref": "CloudWorkspaceId",
- "description": "The ID of the workspace."
- }
- },
- "id": "CloudWorkspaceSourceContext"
- },
- "UpdateActiveBreakpointResponse": {
- "properties": {},
- "id": "UpdateActiveBreakpointResponse",
- "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
- "type": "object"
- },
- "GerritSourceContext": {
- "description": "A SourceContext referring to a Gerrit project.",
- "type": "object",
- "properties": {
- "hostUri": {
- "description": "The URI of a running Gerrit instance.",
- "type": "string"
- },
- "revisionId": {
- "description": "A revision (commit) ID.",
- "type": "string"
- },
- "aliasName": {
- "description": "The name of an alias (branch, tag, etc.).",
- "type": "string"
- },
- "gerritProject": {
- "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
- "type": "string"
- },
- "aliasContext": {
- "description": "An alias, which may be a branch or tag.",
- "$ref": "AliasContext"
- }
- },
- "id": "GerritSourceContext"
- },
- "CloudWorkspaceId": {
- "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.",
- "type": "string"
- },
- "repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo containing the workspace."
- }
- },
- "id": "CloudWorkspaceId"
- },
- "ListBreakpointsResponse": {
- "properties": {
- "breakpoints": {
- "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of its status.",
- "type": "array",
- "items": {
- "$ref": "Breakpoint"
- }
- },
- "nextWaitToken": {
- "description": "A wait token that can be used in the next call to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of breakpoints has changes.",
- "type": "string"
- }
- },
- "id": "ListBreakpointsResponse",
- "description": "Response for listing breakpoints.",
- "type": "object"
- },
- "Breakpoint": {
- "description": "Represents the breakpoint specification, status and results.",
- "type": "object",
- "properties": {
- "isFinalState": {
- "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on.",
- "type": "boolean"
- },
- "stackFrames": {
- "description": "The stack at breakpoint time.",
- "type": "array",
- "items": {
- "$ref": "StackFrame"
- }
- },
- "condition": {
- "description": "Condition that triggers the breakpoint.\nThe condition is a compound boolean expression composed using expressions\nin a programming language at the source location.",
- "type": "string"
- },
- "status": {
- "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition",
- "$ref": "StatusMessage"
- },
- "userEmail": {
- "description": "E-mail address of the user that created this breakpoint",
- "type": "string"
- },
- "action": {
- "enumDescriptions": [
- "Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.",
- "Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired."
- ],
- "enum": [
- "CAPTURE",
- "LOG"
- ],
- "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.",
- "type": "string"
- },
- "logLevel": {
- "enumDescriptions": [
- "Information log message.",
- "Warning log message.",
- "Error log message."
- ],
- "enum": [
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Indicates the severity of the log. Only relevant when action is `LOG`.",
- "type": "string"
- },
- "id": {
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "type": "string"
+ "$ref": "Variable"
+ },
+ "type": "array"
},
"location": {
"$ref": "SourceLocation",
- "description": "Breakpoint source location."
- },
- "finalTime": {
- "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
- "format": "google-datetime",
- "type": "string"
- },
- "variableTable": {
- "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
- },
- "createTime": {
- "description": "Time this breakpoint was created by the server in seconds resolution.",
- "format": "google-datetime",
- "type": "string"
- },
- "logMessageFormat": {
- "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object"
- },
- "expressions": {
- "description": "List of read-only expressions to evaluate at the breakpoint location.\nThe expressions are composed using expressions in the programming language\nat the source location. If the breakpoint action is `LOG`, the evaluated\nexpressions are included in log statements.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "evaluatedExpressions": {
- "description": "Values of evaluated expressions at breakpoint time.\nThe evaluated expressions appear in exactly the same order they\nare listed in the `expressions` field.\nThe `name` field holds the original expression text, the `value` or\n`members` field holds the result of the evaluated expression.\nIf the expression cannot be evaluated, the `status` inside the `Variable`\nwill indicate an error and contain the error text.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
+ "description": "Source location of the call site."
}
},
- "id": "Breakpoint"
+ "type": "object"
+ },
+ "StatusMessage": {
+ "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.",
+ "id": "StatusMessage",
+ "properties": {
+ "description": {
+ "$ref": "FormatMessage",
+ "description": "Status message text."
+ },
+ "isError": {
+ "description": "Distinguishes errors from informational messages.",
+ "type": "boolean"
+ },
+ "refersTo": {
+ "description": "Reference to which the message applies.",
+ "enum": [
+ "UNSPECIFIED",
+ "BREAKPOINT_SOURCE_LOCATION",
+ "BREAKPOINT_CONDITION",
+ "BREAKPOINT_EXPRESSION",
+ "BREAKPOINT_AGE",
+ "VARIABLE_NAME",
+ "VARIABLE_VALUE"
+ ],
+ "enumDescriptions": [
+ "Status doesn't refer to any particular input.",
+ "Status applies to the breakpoint and is related to its location.",
+ "Status applies to the breakpoint and is related to its condition.",
+ "Status applies to the breakpoint and is related to its expressions.",
+ "Status applies to the breakpoint and is related to its age.",
+ "Status applies to the entire variable.",
+ "Status applies to variable value (variable name is valid)."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"UpdateActiveBreakpointRequest": {
+ "description": "Request to update an active breakpoint.",
+ "id": "UpdateActiveBreakpointRequest",
"properties": {
"breakpoint": {
"$ref": "Breakpoint",
"description": "Updated breakpoint information.\nThe field `id` must be set.\nThe agent must echo all Breakpoint specification fields in the update."
}
},
- "id": "UpdateActiveBreakpointRequest",
- "description": "Request to update an active breakpoint.",
"type": "object"
},
- "SetBreakpointResponse": {
- "properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
- }
- },
- "id": "SetBreakpointResponse",
- "description": "Response for setting a breakpoint.",
+ "UpdateActiveBreakpointResponse": {
+ "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
+ "id": "UpdateActiveBreakpointResponse",
+ "properties": {},
"type": "object"
},
- "SourceContext": {
- "description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.",
- "type": "object",
+ "Variable": {
+ "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = \u0026x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = \u0026p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = \u0026x;\n T\u0026 r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T\u0026\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.",
+ "id": "Variable",
"properties": {
- "gerrit": {
- "$ref": "GerritSourceContext",
- "description": "A SourceContext referring to a Gerrit project."
+ "members": {
+ "description": "Members contained or pointed to by the variable.",
+ "items": {
+ "$ref": "Variable"
+ },
+ "type": "array"
},
- "cloudRepo": {
- "description": "A SourceContext referring to a revision in a cloud repo.",
- "$ref": "CloudRepoSourceContext"
- },
- "cloudWorkspace": {
- "$ref": "CloudWorkspaceSourceContext",
- "description": "A SourceContext referring to a snapshot in a cloud workspace."
- },
- "git": {
- "$ref": "GitSourceContext",
- "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
- }
- },
- "id": "SourceContext"
- },
- "CloudRepoSourceContext": {
- "properties": {
- "aliasContext": {
- "$ref": "AliasContext",
- "description": "An alias, which may be a branch or tag."
- },
- "revisionId": {
- "description": "A revision ID.",
+ "name": {
+ "description": "Name of the variable, if any.",
"type": "string"
},
- "aliasName": {
- "description": "The name of an alias (branch, tag, etc.).",
+ "status": {
+ "$ref": "StatusMessage",
+ "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`"
+ },
+ "type": {
+ "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.",
"type": "string"
},
- "repoId": {
- "description": "The ID of the repo.",
- "$ref": "RepoId"
+ "value": {
+ "description": "Simple value of the variable.",
+ "type": "string"
+ },
+ "varTableIndex": {
+ "description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "CloudRepoSourceContext",
- "description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
- "type": "object"
- },
- "RegisterDebuggeeRequest": {
- "description": "Request to register a debuggee.",
- "type": "object",
- "properties": {
- "debuggee": {
- "$ref": "Debuggee",
- "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
- }
- },
- "id": "RegisterDebuggeeRequest"
- },
- "RegisterDebuggeeResponse": {
- "properties": {
- "debuggee": {
- "description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields).\nIf the field `is_disabled` is set to `true`, the agent should disable\nitself by removing all breakpoints and detaching from the application.\nIt should however continue to poll `RegisterDebuggee` until reenabled.",
- "$ref": "Debuggee"
- }
- },
- "id": "RegisterDebuggeeResponse",
- "description": "Response for registering a debuggee.",
- "type": "object"
- },
- "GetBreakpointResponse": {
- "properties": {
- "breakpoint": {
- "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set.",
- "$ref": "Breakpoint"
- }
- },
- "id": "GetBreakpointResponse",
- "description": "Response for getting breakpoint information.",
"type": "object"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud Debugger",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud_debugger": {
- "description": "Use Stackdriver Debugger"
- }
- }
- }
- },
- "rootUrl": "https://clouddebugger.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "clouddebugger",
- "batchPath": "batch",
+ "servicePath": "",
"title": "Stackdriver Debugger API",
- "ownerName": "Google"
-}
+ "version": "v2",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/vendor/google.golang.org/api/clouderrorreporting/v1beta1/clouderrorreporting-api.json
index d34ed55e7..75e537b88 100644
--- a/vendor/google.golang.org/api/clouderrorreporting/v1beta1/clouderrorreporting-api.json
+++ b/vendor/google.golang.org/api/clouderrorreporting/v1beta1/clouderrorreporting-api.json
@@ -1,249 +1,512 @@
{
- "revision": "20180112",
- "documentationLink": "https://cloud.google.com/error-reporting/",
- "id": "clouderrorreporting:v1beta1",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://clouderrorreporting.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Clouderrorreporting",
+ "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
"discoveryVersion": "v1",
- "version_module": true,
+ "documentationLink": "https://cloud.google.com/error-reporting/",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "clouderrorreporting:v1beta1",
+ "kind": "discovery#restDescription",
+ "name": "clouderrorreporting",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "projects": {
+ "methods": {
+ "deleteEvents": {
+ "description": "Deletes all error events of a given project.",
+ "flatPath": "v1beta1/projects/{projectsId}/events",
+ "httpMethod": "DELETE",
+ "id": "clouderrorreporting.projects.deleteEvents",
+ "parameterOrder": [
+ "projectName"
+ ],
+ "parameters": {
+ "projectName": {
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+projectName}/events",
+ "response": {
+ "$ref": "DeleteEventsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "events": {
+ "methods": {
+ "list": {
+ "description": "Lists the specified events.",
+ "flatPath": "v1beta1/projects/{projectsId}/events",
+ "httpMethod": "GET",
+ "id": "clouderrorreporting.projects.events.list",
+ "parameterOrder": [
+ "projectName"
+ ],
+ "parameters": {
+ "groupId": {
+ "description": "[Required] The group for which events shall be returned.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "[Optional] The maximum number of results to return per response.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "[Optional] A `next_page_token` provided by a previous response.",
+ "location": "query",
+ "type": "string"
+ },
+ "projectName": {
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "serviceFilter.resourceType": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
+ "location": "query",
+ "type": "string"
+ },
+ "serviceFilter.service": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
+ "location": "query",
+ "type": "string"
+ },
+ "serviceFilter.version": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
+ "location": "query",
+ "type": "string"
+ },
+ "timeRange.period": {
+ "description": "Restricts the query to the specified time range.",
+ "enum": [
+ "PERIOD_UNSPECIFIED",
+ "PERIOD_1_HOUR",
+ "PERIOD_6_HOURS",
+ "PERIOD_1_DAY",
+ "PERIOD_1_WEEK",
+ "PERIOD_30_DAYS"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+projectName}/events",
+ "response": {
+ "$ref": "ListEventsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "report": {
+ "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e",
+ "flatPath": "v1beta1/projects/{projectsId}/events:report",
+ "httpMethod": "POST",
+ "id": "clouderrorreporting.projects.events.report",
+ "parameterOrder": [
+ "projectName"
+ ],
+ "parameters": {
+ "projectName": {
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+projectName}/events:report",
+ "request": {
+ "$ref": "ReportedErrorEvent"
+ },
+ "response": {
+ "$ref": "ReportErrorEventResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "groupStats": {
+ "methods": {
+ "list": {
+ "description": "Lists the specified groups.",
+ "flatPath": "v1beta1/projects/{projectsId}/groupStats",
+ "httpMethod": "GET",
+ "id": "clouderrorreporting.projects.groupStats.list",
+ "parameterOrder": [
+ "projectName"
+ ],
+ "parameters": {
+ "alignment": {
+ "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
+ "enum": [
+ "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
+ "ALIGNMENT_EQUAL_ROUNDED",
+ "ALIGNMENT_EQUAL_AT_END"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "alignmentTime": {
+ "description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",
+ "format": "google-datetime",
+ "location": "query",
+ "type": "string"
+ },
+ "groupId": {
+ "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "order": {
+ "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
+ "enum": [
+ "GROUP_ORDER_UNSPECIFIED",
+ "COUNT_DESC",
+ "LAST_SEEN_DESC",
+ "CREATED_DESC",
+ "AFFECTED_USERS_DESC"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
+ "location": "query",
+ "type": "string"
+ },
+ "projectName": {
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "serviceFilter.resourceType": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
+ "location": "query",
+ "type": "string"
+ },
+ "serviceFilter.service": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
+ "location": "query",
+ "type": "string"
+ },
+ "serviceFilter.version": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
+ "location": "query",
+ "type": "string"
+ },
+ "timeRange.period": {
+ "description": "Restricts the query to the specified time range.",
+ "enum": [
+ "PERIOD_UNSPECIFIED",
+ "PERIOD_1_HOUR",
+ "PERIOD_6_HOURS",
+ "PERIOD_1_DAY",
+ "PERIOD_1_WEEK",
+ "PERIOD_30_DAYS"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "timedCountDuration": {
+ "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
+ "format": "google-duration",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+projectName}/groupStats",
+ "response": {
+ "$ref": "ListGroupStatsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "get": {
+ "description": "Get the specified group.",
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "httpMethod": "GET",
+ "id": "clouderrorreporting.projects.groups.get",
+ "parameterOrder": [
+ "groupName"
+ ],
+ "parameters": {
+ "groupName": {
+ "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",
+ "location": "path",
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+groupName}",
+ "response": {
+ "$ref": "ErrorGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "update": {
+ "description": "Replace the data for the specified group.\nFails if the group does not exist.",
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "httpMethod": "PUT",
+ "id": "clouderrorreporting.projects.groups.update",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
+ "location": "path",
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+name}",
+ "request": {
+ "$ref": "ErrorGroup"
+ },
+ "response": {
+ "$ref": "ErrorGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20180126",
+ "rootUrl": "https://clouderrorreporting.googleapis.com/",
"schemas": {
- "ErrorGroup": {
- "description": "Description of a group of similar error events.",
- "type": "object",
- "properties": {
- "groupId": {
- "description": "Group IDs are unique for a given project. If the same kind of error\noccurs in different service contexts, it will receive the same group ID.",
- "type": "string"
- },
- "trackingIssues": {
- "description": "Associated tracking issues.",
- "type": "array",
- "items": {
- "$ref": "TrackingIssue"
- }
- },
- "name": {
- "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
- "type": "string"
- }
- },
- "id": "ErrorGroup"
- },
- "ServiceContext": {
- "description": "Describes a running service that sends errors.\nIts version changes over time and multiple versions can run in parallel.",
- "type": "object",
- "properties": {
- "service": {
- "description": "An identifier of the service, such as the name of the\nexecutable, job, or Google App Engine service name. This field is expected\nto have a low number of values that are relatively stable over time, as\nopposed to `version`, which can be changed whenever new code is deployed.\n\nContains the service name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default service is used.",
- "type": "string"
- },
- "resourceType": {
- "description": "Type of the MonitoredResource. List of possible values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set automatically for incoming errors and must not be set when\nreporting errors.",
- "type": "string"
- },
- "version": {
- "description": "Represents the source code version that the developer provided,\nwhich could represent a version label or a Git SHA-1 hash, for example.\nFor App Engine standard environment, the version is set to the version of\nthe app.",
- "type": "string"
- }
- },
- "id": "ServiceContext"
- },
- "SourceLocation": {
- "description": "Indicates a location in the source code of the service for which errors are\nreported. `functionName` must be provided by the application when reporting\nan error, unless the error report contains a `message` with a supported\nexception stack trace. All fields are optional for the later case.",
- "type": "object",
- "properties": {
- "functionName": {
- "description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java.",
- "type": "string"
- },
- "filePath": {
- "description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.",
- "type": "string"
- },
- "lineNumber": {
- "description": "1-based. 0 indicates that the line number is unknown.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SourceLocation"
- },
- "ReportErrorEventResponse": {
- "description": "Response for reporting an individual error event.\nData may be added to this message in the future.",
- "type": "object",
- "properties": {},
- "id": "ReportErrorEventResponse"
- },
- "HttpRequestContext": {
- "description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
- "type": "object",
- "properties": {
- "responseStatusCode": {
- "description": "The HTTP response status code for the request.",
- "format": "int32",
- "type": "integer"
- },
- "method": {
- "description": "The type of HTTP request, such as `GET`, `POST`, etc.",
- "type": "string"
- },
- "remoteIp": {
- "description": "The IP address from which the request originated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address, depending on the data that has been provided\nin the error report.",
- "type": "string"
- },
- "referrer": {
- "description": "The referrer information that is provided with the request.",
- "type": "string"
- },
- "userAgent": {
- "description": "The user agent information that is provided with the request.",
- "type": "string"
- },
- "url": {
- "description": "The URL of the request.",
- "type": "string"
- }
- },
- "id": "HttpRequestContext"
- },
- "ListGroupStatsResponse": {
- "description": "Contains a set of requested error group stats.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
- "type": "string"
- },
- "timeRangeBegin": {
- "description": "The timestamp specifies the start time to which the request was restricted.\nThe start time is set based on the requested time range. It may be adjusted\nto a later time if a project has exceeded the storage quota and older data\nhas been deleted.",
- "format": "google-datetime",
- "type": "string"
- },
- "errorGroupStats": {
- "description": "The error group stats which match the given request.",
- "type": "array",
- "items": {
- "$ref": "ErrorGroupStats"
- }
- }
- },
- "id": "ListGroupStatsResponse"
- },
- "SourceReference": {
- "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
- "type": "object",
- "properties": {
- "revisionId": {
- "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
- "type": "string"
- },
- "repository": {
- "description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
- "type": "string"
- }
- },
- "id": "SourceReference"
- },
"DeleteEventsResponse": {
"description": "Response message for deleting error events.",
- "type": "object",
+ "id": "DeleteEventsResponse",
"properties": {},
- "id": "DeleteEventsResponse"
- },
- "ErrorEvent": {
- "description": "An error event which is returned by the Error Reporting system.",
- "type": "object",
- "properties": {
- "serviceContext": {
- "description": "The `ServiceContext` for which this error was reported.",
- "$ref": "ServiceContext"
- },
- "eventTime": {
- "description": "Time when the event occurred as provided in the error report.\nIf the report did not contain a timestamp, the time the error was received\nby the Error Reporting system is used.",
- "format": "google-datetime",
- "type": "string"
- },
- "context": {
- "$ref": "ErrorContext",
- "description": "Data about the context in which the error occurred."
- },
- "message": {
- "description": "The stack trace that was reported or logged by the service.",
- "type": "string"
- }
- },
- "id": "ErrorEvent"
- },
- "ReportedErrorEvent": {
- "description": "An error event which is reported to the Error Reporting system.",
- "type": "object",
- "properties": {
- "serviceContext": {
- "description": "[Required] The service context in which this error has occurred.",
- "$ref": "ServiceContext"
- },
- "eventTime": {
- "description": "[Optional] Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",
- "format": "google-datetime",
- "type": "string"
- },
- "context": {
- "$ref": "ErrorContext",
- "description": "[Optional] A description of the context in which the error occurred."
- },
- "message": {
- "description": "[Required] The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).",
- "type": "string"
- }
- },
- "id": "ReportedErrorEvent"
+ "type": "object"
},
"ErrorContext": {
"description": "A description of the context in which an error occurred.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
- "type": "object",
+ "id": "ErrorContext",
"properties": {
+ "httpRequest": {
+ "$ref": "HttpRequestContext",
+ "description": "The HTTP request which was processed when the error was\ntriggered."
+ },
"reportLocation": {
"$ref": "SourceLocation",
"description": "The location in the source code where the decision was made to\nreport the error, usually the place where it was logged.\nFor a logged exception this would be the source line where the\nexception is logged, usually close to the place where it was\ncaught."
},
"sourceReferences": {
"description": "Source code that was used to build the executable which has\ncaused the given error message.",
- "type": "array",
"items": {
"$ref": "SourceReference"
- }
- },
- "httpRequest": {
- "$ref": "HttpRequestContext",
- "description": "The HTTP request which was processed when the error was\ntriggered."
+ },
+ "type": "array"
},
"user": {
"description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
"type": "string"
}
},
- "id": "ErrorContext"
+ "type": "object"
},
- "TrackingIssue": {
- "description": "Information related to tracking the progress on resolving the error.",
- "type": "object",
+ "ErrorEvent": {
+ "description": "An error event which is returned by the Error Reporting system.",
+ "id": "ErrorEvent",
"properties": {
- "url": {
- "description": "A URL pointing to a related entry in an issue tracking system.\nExample: https://github.com/user/project/issues/4",
+ "context": {
+ "$ref": "ErrorContext",
+ "description": "Data about the context in which the error occurred."
+ },
+ "eventTime": {
+ "description": "Time when the event occurred as provided in the error report.\nIf the report did not contain a timestamp, the time the error was received\nby the Error Reporting system is used.",
+ "format": "google-datetime",
"type": "string"
+ },
+ "message": {
+ "description": "The stack trace that was reported or logged by the service.",
+ "type": "string"
+ },
+ "serviceContext": {
+ "$ref": "ServiceContext",
+ "description": "The `ServiceContext` for which this error was reported."
}
},
- "id": "TrackingIssue"
+ "type": "object"
+ },
+ "ErrorGroup": {
+ "description": "Description of a group of similar error events.",
+ "id": "ErrorGroup",
+ "properties": {
+ "groupId": {
+ "description": "Group IDs are unique for a given project. If the same kind of error\noccurs in different service contexts, it will receive the same group ID.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
+ "type": "string"
+ },
+ "trackingIssues": {
+ "description": "Associated tracking issues.",
+ "items": {
+ "$ref": "TrackingIssue"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"ErrorGroupStats": {
"description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter.",
- "type": "object",
+ "id": "ErrorGroupStats",
"properties": {
- "group": {
- "description": "Group data that is independent of the filter criteria.",
- "$ref": "ErrorGroup"
+ "affectedServices": {
+ "description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count.",
+ "items": {
+ "$ref": "ServiceContext"
+ },
+ "type": "array"
},
- "firstSeenTime": {
- "description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",
- "format": "google-datetime",
+ "affectedUsersCount": {
+ "description": "Approximate number of affected users in the given group that\nmatch the filter criteria.\nUsers are distinguished by data in the `ErrorContext` of the\nindividual error events, such as their login name or their remote\nIP address in case of HTTP requests.\nThe number of affected users can be zero even if the number of\nerrors is non-zero if no data was provided from which the\naffected user could be deduced.\nUsers are counted based on data in the request\ncontext that was provided in the error report. If more users are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",
+ "format": "int64",
"type": "string"
},
"count": {
@@ -251,23 +514,20 @@
"format": "int64",
"type": "string"
},
- "affectedUsersCount": {
- "description": "Approximate number of affected users in the given group that\nmatch the filter criteria.\nUsers are distinguished by data in the `ErrorContext` of the\nindividual error events, such as their login name or their remote\nIP address in case of HTTP requests.\nThe number of affected users can be zero even if the number of\nerrors is non-zero if no data was provided from which the\naffected user could be deduced.\nUsers are counted based on data in the request\ncontext that was provided in the error report. If more users are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",
- "format": "int64",
+ "firstSeenTime": {
+ "description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",
+ "format": "google-datetime",
"type": "string"
},
+ "group": {
+ "$ref": "ErrorGroup",
+ "description": "Group data that is independent of the filter criteria."
+ },
"lastSeenTime": {
"description": "Approximate last occurrence that was ever seen for this group and\nwhich matches the given filter criteria, ignoring the time_range\nthat was specified in the request.",
"format": "google-datetime",
"type": "string"
},
- "affectedServices": {
- "description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count.",
- "type": "array",
- "items": {
- "$ref": "ServiceContext"
- }
- },
"numAffectedServices": {
"description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
"format": "int32",
@@ -279,472 +539,212 @@
},
"timedCounts": {
"description": "Approximate number of occurrences over time.\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requested time interval\n- Non-overlapping, and\n- Ordered by ascending time.",
- "type": "array",
"items": {
"$ref": "TimedCount"
- }
+ },
+ "type": "array"
}
},
- "id": "ErrorGroupStats"
+ "type": "object"
+ },
+ "HttpRequestContext": {
+ "description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
+ "id": "HttpRequestContext",
+ "properties": {
+ "method": {
+ "description": "The type of HTTP request, such as `GET`, `POST`, etc.",
+ "type": "string"
+ },
+ "referrer": {
+ "description": "The referrer information that is provided with the request.",
+ "type": "string"
+ },
+ "remoteIp": {
+ "description": "The IP address from which the request originated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address, depending on the data that has been provided\nin the error report.",
+ "type": "string"
+ },
+ "responseStatusCode": {
+ "description": "The HTTP response status code for the request.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "description": "The URL of the request.",
+ "type": "string"
+ },
+ "userAgent": {
+ "description": "The user agent information that is provided with the request.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"ListEventsResponse": {
"description": "Contains a set of requested error events.",
- "type": "object",
+ "id": "ListEventsResponse",
"properties": {
- "timeRangeBegin": {
- "description": "The timestamp specifies the start time to which the request was restricted.",
- "format": "google-datetime",
- "type": "string"
- },
"errorEvents": {
"description": "The error events which match the given request.",
- "type": "array",
"items": {
"$ref": "ErrorEvent"
- }
+ },
+ "type": "array"
},
"nextPageToken": {
"description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
"type": "string"
+ },
+ "timeRangeBegin": {
+ "description": "The timestamp specifies the start time to which the request was restricted.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "ListEventsResponse"
+ "type": "object"
},
- "TimedCount": {
- "description": "The number of errors in a given time period.\nAll numbers are approximate since the error events are sampled\nbefore counting them.",
- "type": "object",
+ "ListGroupStatsResponse": {
+ "description": "Contains a set of requested error group stats.",
+ "id": "ListGroupStatsResponse",
"properties": {
- "endTime": {
- "description": "End of the time period to which `count` refers (excluded).",
+ "errorGroupStats": {
+ "description": "The error group stats which match the given request.",
+ "items": {
+ "$ref": "ErrorGroupStats"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
+ "type": "string"
+ },
+ "timeRangeBegin": {
+ "description": "The timestamp specifies the start time to which the request was restricted.\nThe start time is set based on the requested time range. It may be adjusted\nto a later time if a project has exceeded the storage quota and older data\nhas been deleted.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportErrorEventResponse": {
+ "description": "Response for reporting an individual error event.\nData may be added to this message in the future.",
+ "id": "ReportErrorEventResponse",
+ "properties": {},
+ "type": "object"
+ },
+ "ReportedErrorEvent": {
+ "description": "An error event which is reported to the Error Reporting system.",
+ "id": "ReportedErrorEvent",
+ "properties": {
+ "context": {
+ "$ref": "ErrorContext",
+ "description": "[Optional] A description of the context in which the error occurred."
+ },
+ "eventTime": {
+ "description": "[Optional] Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",
"format": "google-datetime",
"type": "string"
},
+ "message": {
+ "description": "[Required] The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).",
+ "type": "string"
+ },
+ "serviceContext": {
+ "$ref": "ServiceContext",
+ "description": "[Required] The service context in which this error has occurred."
+ }
+ },
+ "type": "object"
+ },
+ "ServiceContext": {
+ "description": "Describes a running service that sends errors.\nIts version changes over time and multiple versions can run in parallel.",
+ "id": "ServiceContext",
+ "properties": {
+ "resourceType": {
+ "description": "Type of the MonitoredResource. List of possible values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set automatically for incoming errors and must not be set when\nreporting errors.",
+ "type": "string"
+ },
+ "service": {
+ "description": "An identifier of the service, such as the name of the\nexecutable, job, or Google App Engine service name. This field is expected\nto have a low number of values that are relatively stable over time, as\nopposed to `version`, which can be changed whenever new code is deployed.\n\nContains the service name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default service is used.",
+ "type": "string"
+ },
+ "version": {
+ "description": "Represents the source code version that the developer provided,\nwhich could represent a version label or a Git SHA-1 hash, for example.\nFor App Engine standard environment, the version is set to the version of\nthe app.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SourceLocation": {
+ "description": "Indicates a location in the source code of the service for which errors are\nreported. `functionName` must be provided by the application when reporting\nan error, unless the error report contains a `message` with a supported\nexception stack trace. All fields are optional for the later case.",
+ "id": "SourceLocation",
+ "properties": {
+ "filePath": {
+ "description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.",
+ "type": "string"
+ },
+ "functionName": {
+ "description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java.",
+ "type": "string"
+ },
+ "lineNumber": {
+ "description": "1-based. 0 indicates that the line number is unknown.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "SourceReference": {
+ "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
+ "id": "SourceReference",
+ "properties": {
+ "repository": {
+ "description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TimedCount": {
+ "description": "The number of errors in a given time period.\nAll numbers are approximate since the error events are sampled\nbefore counting them.",
+ "id": "TimedCount",
+ "properties": {
"count": {
"description": "Approximate number of occurrences in the given time period.",
"format": "int64",
"type": "string"
},
+ "endTime": {
+ "description": "End of the time period to which `count` refers (excluded).",
+ "format": "google-datetime",
+ "type": "string"
+ },
"startTime": {
"description": "Start of the time period to which `count` refers (included).",
"format": "google-datetime",
"type": "string"
}
},
- "id": "TimedCount"
- }
- },
- "protocol": "rest",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "canonicalName": "Clouderrorreporting",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://clouderrorreporting.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "clouderrorreporting",
- "batchPath": "batch",
- "title": "Stackdriver Error Reporting API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "deleteEvents": {
- "flatPath": "v1beta1/projects/{projectsId}/events",
- "path": "v1beta1/{+projectName}/events",
- "id": "clouderrorreporting.projects.deleteEvents",
- "description": "Deletes all error events of a given project.",
- "response": {
- "$ref": "DeleteEventsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "projectName": {
- "location": "path",
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "type": "object"
+ },
+ "TrackingIssue": {
+ "description": "Information related to tracking the progress on resolving the error.",
+ "id": "TrackingIssue",
+ "properties": {
+ "url": {
+ "description": "A URL pointing to a related entry in an issue tracking system.\nExample: https://github.com/user/project/issues/4",
+ "type": "string"
}
},
- "resources": {
- "groups": {
- "methods": {
- "get": {
- "response": {
- "$ref": "ErrorGroup"
- },
- "parameterOrder": [
- "groupName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "groupName": {
- "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
- "path": "v1beta1/{+groupName}",
- "id": "clouderrorreporting.projects.groups.get",
- "description": "Get the specified group."
- },
- "update": {
- "request": {
- "$ref": "ErrorGroup"
- },
- "description": "Replace the data for the specified group.\nFails if the group does not exist.",
- "response": {
- "$ref": "ErrorGroup"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
- "path": "v1beta1/{+name}",
- "id": "clouderrorreporting.projects.groups.update"
- }
- }
- },
- "groupStats": {
- "methods": {
- "list": {
- "description": "Lists the specified groups.",
- "response": {
- "$ref": "ListGroupStatsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "serviceFilter.service": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
- "format": "int32",
- "type": "integer"
- },
- "order": {
- "location": "query",
- "enum": [
- "GROUP_ORDER_UNSPECIFIED",
- "COUNT_DESC",
- "LAST_SEEN_DESC",
- "CREATED_DESC",
- "AFFECTED_USERS_DESC"
- ],
- "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
- "type": "string"
- },
- "serviceFilter.version": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
- "type": "string"
- },
- "serviceFilter.resourceType": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
- "type": "string",
- "location": "query"
- },
- "alignmentTime": {
- "description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "timedCountDuration": {
- "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
- "format": "google-duration",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
- "type": "string",
- "location": "query"
- },
- "timeRange.period": {
- "location": "query",
- "enum": [
- "PERIOD_UNSPECIFIED",
- "PERIOD_1_HOUR",
- "PERIOD_6_HOURS",
- "PERIOD_1_DAY",
- "PERIOD_1_WEEK",
- "PERIOD_30_DAYS"
- ],
- "description": "Restricts the query to the specified time range.",
- "type": "string"
- },
- "alignment": {
- "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
- "type": "string",
- "location": "query",
- "enum": [
- "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
- "ALIGNMENT_EQUAL_ROUNDED",
- "ALIGNMENT_EQUAL_AT_END"
- ]
- },
- "groupId": {
- "location": "query",
- "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
- "type": "string",
- "repeated": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/groupStats",
- "path": "v1beta1/{+projectName}/groupStats",
- "id": "clouderrorreporting.projects.groupStats.list"
- }
- }
- },
- "events": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListEventsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "[Optional] The maximum number of results to return per response.",
- "format": "int32",
- "type": "integer"
- },
- "serviceFilter.version": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
- "type": "string",
- "location": "query"
- },
- "serviceFilter.resourceType": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
- "type": "string"
- },
- "timeRange.period": {
- "location": "query",
- "enum": [
- "PERIOD_UNSPECIFIED",
- "PERIOD_1_HOUR",
- "PERIOD_6_HOURS",
- "PERIOD_1_DAY",
- "PERIOD_1_WEEK",
- "PERIOD_30_DAYS"
- ],
- "description": "Restricts the query to the specified time range.",
- "type": "string"
- },
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "groupId": {
- "location": "query",
- "description": "[Required] The group for which events shall be returned.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "[Optional] A `next_page_token` provided by a previous response.",
- "type": "string"
- },
- "serviceFilter.service": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/events",
- "id": "clouderrorreporting.projects.events.list",
- "path": "v1beta1/{+projectName}/events",
- "description": "Lists the specified events."
- },
- "report": {
- "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e",
- "request": {
- "$ref": "ReportedErrorEvent"
- },
- "response": {
- "$ref": "ReportErrorEventResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/events:report",
- "path": "v1beta1/{+projectName}/events:report",
- "id": "clouderrorreporting.projects.events.report"
- }
- }
- }
- }
+ "type": "object"
}
},
- "parameters": {
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://clouderrorreporting.googleapis.com/",
"servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
- "basePath": ""
-}
+ "title": "Stackdriver Error Reporting API",
+ "version": "v1beta1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-api.json b/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-api.json
index f08f4102a..c3316eaf3 100644
--- a/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-api.json
+++ b/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-api.json
@@ -1,40 +1,496 @@
{
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "GenerateUploadUrlResponse": {
- "description": "Response of `GenerateSourceUploadUrl` method.",
- "type": "object",
- "properties": {
- "uploadUrl": {
- "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function.",
- "type": "string"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
- },
- "id": "GenerateUploadUrlResponse"
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://cloudfunctions.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Functions",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/functions",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudfunctions:v1",
+ "kind": "discovery#restDescription",
+ "name": "cloudfunctions",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "ListFunctionsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1.ListFunctionsRequest\nto get more functions.",
- "type": "string"
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "flatPath": "v1/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.operations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "location": "path",
+ "pattern": "^operations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
- "functions": {
- "description": "The functions that match the request.",
- "type": "array",
- "items": {
- "$ref": "CloudFunction"
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "flatPath": "v1/operations",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.operations.list",
+ "parameterOrder": [],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/operations",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.projects.locations.list",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}/locations",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "functions": {
+ "methods": {
+ "call": {
+ "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
+ "httpMethod": "POST",
+ "id": "cloudfunctions.projects.locations.functions.call",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function to be called.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:call",
+ "request": {
+ "$ref": "CallFunctionRequest"
+ },
+ "response": {
+ "$ref": "CallFunctionResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
+ "httpMethod": "POST",
+ "id": "cloudfunctions.projects.locations.functions.create",
+ "parameterOrder": [
+ "location"
+ ],
+ "parameters": {
+ "location": {
+ "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+location}/functions",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "httpMethod": "DELETE",
+ "id": "cloudfunctions.projects.locations.functions.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function which should be deleted.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "generateDownloadUrl": {
+ "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
+ "httpMethod": "POST",
+ "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:generateDownloadUrl",
+ "request": {
+ "$ref": "GenerateDownloadUrlRequest"
+ },
+ "response": {
+ "$ref": "GenerateDownloadUrlResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "generateUploadUrl": {
+ "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls.\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
+ "httpMethod": "POST",
+ "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/functions:generateUploadUrl",
+ "request": {
+ "$ref": "GenerateUploadUrlRequest"
+ },
+ "response": {
+ "$ref": "GenerateUploadUrlResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Returns a function with the given name from the requested project.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.projects.locations.functions.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function which details should be obtained.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Returns a list of functions that belong to the requested project.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.projects.locations.functions.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/functions",
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates existing function.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "httpMethod": "PATCH",
+ "id": "cloudfunctions.projects.locations.functions.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
}
}
+ }
+ }
+ },
+ "revision": "20180120",
+ "rootUrl": "https://cloudfunctions.googleapis.com/",
+ "schemas": {
+ "CallFunctionRequest": {
+ "description": "Request for the `CallFunction` method.",
+ "id": "CallFunctionRequest",
+ "properties": {
+ "data": {
+ "description": "Input to be passed to the function.",
+ "type": "string"
+ }
},
- "id": "ListFunctionsResponse",
- "description": "Response for the `ListFunctions` method.",
"type": "object"
},
"CallFunctionResponse": {
"description": "Response of `CallFunction` method.",
- "type": "object",
+ "id": "CallFunctionResponse",
"properties": {
+ "error": {
+ "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
+ "type": "string"
+ },
"executionId": {
"description": "Execution id of function invocation.",
"type": "string"
@@ -42,69 +498,137 @@
"result": {
"description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
"type": "string"
- },
- "error": {
- "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
- "type": "string"
}
},
- "id": "CallFunctionResponse"
+ "type": "object"
},
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
+ "CloudFunction": {
+ "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
+ "id": "CloudFunction",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ "availableMemoryMb": {
+ "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": {
+ "description": "User-provided description of a function.",
"type": "string"
},
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
+ "entryPoint": {
+ "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
+ "type": "string"
+ },
+ "eventTrigger": {
+ "$ref": "EventTrigger",
+ "description": "A source that fires events in response to a condition in another service."
+ },
+ "httpsTrigger": {
+ "$ref": "HttpsTrigger",
+ "description": "An HTTPS endpoint type of source that can be triggered via URL."
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels associated with this Cloud Function.",
+ "type": "object"
+ },
+ "name": {
+ "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
+ "type": "string"
+ },
+ "serviceAccountEmail": {
+ "description": "Output only. The email of the function's service account.",
+ "type": "string"
+ },
+ "sourceArchiveUrl": {
+ "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.",
+ "type": "string"
+ },
+ "sourceRepository": {
+ "$ref": "SourceRepository",
+ "description": "**Beta Feature**\n\nThe source repository where a function is hosted."
+ },
+ "sourceUploadUrl": {
+ "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl",
+ "type": "string"
+ },
+ "status": {
+ "description": "Output only. Status of the function deployment.",
+ "enum": [
+ "CLOUD_FUNCTION_STATUS_UNSPECIFIED",
+ "ACTIVE",
+ "OFFLINE",
+ "DEPLOY_IN_PROGRESS",
+ "DELETE_IN_PROGRESS",
+ "UNKNOWN"
+ ],
+ "enumDescriptions": [
+ "Not specified. Invalid state.",
+ "Function has been succesfully deployed and is serving.",
+ "Function deployment failed and the function isn’t serving.",
+ "Function is being created or updated.",
+ "Function is being deleted.",
+ "Function deployment failed and the function serving state is undefined.\nThe function should be updated or deleted to move it out of this state."
+ ],
+ "type": "string"
+ },
+ "timeout": {
+ "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. The last update timestamp of a Cloud Function.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "versionId": {
+ "description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "ListLocationsResponse"
+ "type": "object"
},
"EventTrigger": {
"description": "Describes EventTrigger, used to request events be sent from another\nservice.",
- "type": "object",
+ "id": "EventTrigger",
"properties": {
- "service": {
- "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.",
- "type": "string"
- },
- "failurePolicy": {
- "description": "Specifies policy for failed executions.",
- "$ref": "FailurePolicy"
- },
"eventType": {
"description": "Required. The type of event to observe. For example:\n`providers/cloud.storage/eventTypes/object.change` and\n`providers/cloud.pubsub/eventTypes/topic.publish`.\n\nEvent types match pattern `providers/*/eventTypes/*.*`.\nThe pattern contains:\n\n1. namespace: For example, `cloud.storage` and\n `google.firebase.analytics`.\n2. resource type: The type of resource on which event occurs. For\n example, the Google Cloud Storage API includes the type `object`.\n3. action: The action that generates the event. For example, action for\n a Google Cloud Storage Object is 'change'.\nThese parts are lower case.",
"type": "string"
},
+ "failurePolicy": {
+ "$ref": "FailurePolicy",
+ "description": "Specifies policy for failed executions."
+ },
"resource": {
"description": "Required. The resource(s) from which to observe events, for example,\n`projects/_/buckets/myBucket`.\n\nNot all syntactically correct values are accepted by all services. For\nexample:\n\n1. The authorization model must support it. Google Cloud Functions\n only allows EventTriggers to be deployed that observe resources in the\n same project as the `CloudFunction`.\n2. The resource type must match the pattern expected for an\n `event_type`. For example, an `EventTrigger` that has an\n `event_type` of \"google.pubsub.topic.publish\" should have a resource\n that matches Google Cloud Pub/Sub topics.\n\nAdditionally, some services may support short names when creating an\n`EventTrigger`. These will always be returned in the normalized \"long\"\nformat.\n\nSee each *service's* documentation for supported formats.",
"type": "string"
+ },
+ "service": {
+ "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.",
+ "type": "string"
}
},
- "id": "EventTrigger"
+ "type": "object"
},
"FailurePolicy": {
"description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
- "type": "object",
+ "id": "FailurePolicy",
"properties": {
"retry": {
"$ref": "Retry",
"description": "If specified, then the function will be retried in case of a failure."
}
},
- "id": "FailurePolicy"
+ "type": "object"
},
"GenerateDownloadUrlRequest": {
"description": "Request of `GenerateDownloadUrl` method.",
- "type": "object",
+ "id": "GenerateDownloadUrlRequest",
"properties": {
"versionId": {
"description": "The optional version of function. If not set, default, current version\nis used.",
@@ -112,70 +636,138 @@
"type": "string"
}
},
- "id": "GenerateDownloadUrlRequest"
+ "type": "object"
},
- "OperationMetadataV1": {
- "description": "Metadata describing an Operation",
- "type": "object",
+ "GenerateDownloadUrlResponse": {
+ "description": "Response of `GenerateDownloadUrl` method.",
+ "id": "GenerateDownloadUrlResponse",
"properties": {
- "updateTime": {
- "description": "The last update timestamp of the operation.",
- "format": "google-datetime",
+ "downloadUrl": {
+ "description": "The generated Google Cloud Storage signed URL that should be used for\nfunction source code download.",
"type": "string"
- },
- "target": {
- "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
- "type": "string"
- },
- "request": {
- "description": "The original request that started the operation.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "versionId": {
- "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "enum": [
- "OPERATION_UNSPECIFIED",
- "CREATE_FUNCTION",
- "UPDATE_FUNCTION",
- "DELETE_FUNCTION"
- ],
- "description": "Type of operation.",
- "type": "string",
- "enumDescriptions": [
- "Unknown operation type.",
- "Triggered by CreateFunction call",
- "Triggered by UpdateFunction call",
- "Triggered by DeleteFunction call."
- ]
}
},
- "id": "OperationMetadataV1"
+ "type": "object"
},
- "Operation": {
+ "GenerateUploadUrlRequest": {
+ "description": "Request of `GenerateSourceUploadUrl` method.",
+ "id": "GenerateUploadUrlRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "GenerateUploadUrlResponse": {
+ "description": "Response of `GenerateSourceUploadUrl` method.",
+ "id": "GenerateUploadUrlResponse",
"properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
+ "uploadUrl": {
+ "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HttpsTrigger": {
+ "description": "Describes HttpsTrigger, could be used to connect web hooks to function.",
+ "id": "HttpsTrigger",
+ "properties": {
+ "url": {
+ "description": "Output only. The deployed url for the function.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListFunctionsResponse": {
+ "description": "Response for the `ListFunctions` method.",
+ "id": "ListFunctionsResponse",
+ "properties": {
+ "functions": {
+ "description": "The functions that match the request.",
+ "items": {
+ "$ref": "CloudFunction"
+ },
+ "type": "array"
},
- "response": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1.ListFunctionsRequest\nto get more functions.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
},
"name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "id": "Operation",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
},
"error": {
"$ref": "Status",
@@ -188,25 +780,26 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object"
},
- "OperationMetadataV1Beta2": {
+ "OperationMetadataV1": {
"description": "Metadata describing an Operation",
- "type": "object",
+ "id": "OperationMetadataV1",
"properties": {
- "updateTime": {
- "description": "The last update timestamp of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
- "type": "string"
- },
"request": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -215,728 +808,135 @@
"description": "The original request that started the operation.",
"type": "object"
},
- "versionId": {
- "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
- "format": "int64",
+ "target": {
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
"type": "string"
},
"type": {
+ "description": "Type of operation.",
"enum": [
"OPERATION_UNSPECIFIED",
"CREATE_FUNCTION",
"UPDATE_FUNCTION",
"DELETE_FUNCTION"
],
- "description": "Type of operation.",
- "type": "string",
"enumDescriptions": [
"Unknown operation type.",
"Triggered by CreateFunction call",
"Triggered by UpdateFunction call",
"Triggered by DeleteFunction call."
- ]
+ ],
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "The last update timestamp of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "versionId": {
+ "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "OperationMetadataV1Beta2"
+ "type": "object"
+ },
+ "OperationMetadataV1Beta2": {
+ "description": "Metadata describing an Operation",
+ "id": "OperationMetadataV1Beta2",
+ "properties": {
+ "request": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The original request that started the operation.",
+ "type": "object"
+ },
+ "target": {
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of operation.",
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "CREATE_FUNCTION",
+ "UPDATE_FUNCTION",
+ "DELETE_FUNCTION"
+ ],
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ],
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "The last update timestamp of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "versionId": {
+ "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Retry": {
+ "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.",
+ "id": "Retry",
+ "properties": {},
+ "type": "object"
+ },
+ "SourceRepository": {
+ "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted.",
+ "id": "SourceRepository",
+ "properties": {
+ "deployedUrl": {
+ "description": "Output only. The URL pointing to the hosted repository where the function\nwere defined at the time of deployment. It always points to a specific\ncommit in the format described above.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
+ "id": "Status",
"properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
- "id": "Status"
- },
- "SourceRepository": {
- "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.",
- "type": "string"
- },
- "deployedUrl": {
- "description": "Output only. The URL pointing to the hosted repository where the function\nwere defined at the time of deployment. It always points to a specific\ncommit in the format described above.",
- "type": "string"
- }
- },
- "id": "SourceRepository"
- },
- "CallFunctionRequest": {
- "description": "Request for the `CallFunction` method.",
- "type": "object",
- "properties": {
- "data": {
- "description": "Input to be passed to the function.",
- "type": "string"
- }
- },
- "id": "CallFunctionRequest"
- },
- "CloudFunction": {
- "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
- "type": "object",
- "properties": {
- "versionId": {
- "description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.",
- "format": "int64",
- "type": "string"
- },
- "sourceArchiveUrl": {
- "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.",
- "type": "string"
- },
- "sourceRepository": {
- "$ref": "SourceRepository",
- "description": "**Beta Feature**\n\nThe source repository where a function is hosted."
- },
- "entryPoint": {
- "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
- "type": "string"
- },
- "labels": {
- "description": "Labels associated with this Cloud Function.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "updateTime": {
- "description": "Output only. The last update timestamp of a Cloud Function.",
- "format": "google-datetime",
- "type": "string"
- },
- "httpsTrigger": {
- "description": "An HTTPS endpoint type of source that can be triggered via URL.",
- "$ref": "HttpsTrigger"
- },
- "serviceAccountEmail": {
- "description": "Output only. The email of the function's service account.",
- "type": "string"
- },
- "description": {
- "description": "User-provided description of a function.",
- "type": "string"
- },
- "eventTrigger": {
- "description": "A source that fires events in response to a condition in another service.",
- "$ref": "EventTrigger"
- },
- "sourceUploadUrl": {
- "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "Not specified. Invalid state.",
- "Function has been succesfully deployed and is serving.",
- "Function deployment failed and the function isn’t serving.",
- "Function is being created or updated.",
- "Function is being deleted.",
- "Function deployment failed and the function serving state is undefined.\nThe function should be updated or deleted to move it out of this state."
- ],
- "enum": [
- "CLOUD_FUNCTION_STATUS_UNSPECIFIED",
- "ACTIVE",
- "OFFLINE",
- "DEPLOY_IN_PROGRESS",
- "DELETE_IN_PROGRESS",
- "UNKNOWN"
- ],
- "description": "Output only. Status of the function deployment.",
- "type": "string"
- },
- "timeout": {
- "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
- "format": "google-duration",
- "type": "string"
- },
- "availableMemoryMb": {
- "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
- "type": "string"
- }
- },
- "id": "CloudFunction"
- },
- "HttpsTrigger": {
- "description": "Describes HttpsTrigger, could be used to connect web hooks to function.",
- "type": "object",
- "properties": {
- "url": {
- "description": "Output only. The deployed url for the function.",
- "type": "string"
- }
- },
- "id": "HttpsTrigger"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: `\"us-east1\"`.",
- "type": "string"
- },
- "metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Location"
- },
- "GenerateDownloadUrlResponse": {
- "properties": {
- "downloadUrl": {
- "description": "The generated Google Cloud Storage signed URL that should be used for\nfunction source code download.",
- "type": "string"
- }
- },
- "id": "GenerateDownloadUrlResponse",
- "description": "Response of `GenerateDownloadUrl` method.",
"type": "object"
- },
- "Retry": {
- "properties": {},
- "id": "Retry",
- "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.",
- "type": "object"
- },
- "GenerateUploadUrlRequest": {
- "properties": {},
- "id": "GenerateUploadUrlRequest",
- "description": "Request of `GenerateSourceUploadUrl` method.",
- "type": "object"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListOperationsResponse"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud Functions",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudfunctions.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudfunctions",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Functions API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations",
- "path": "v1/{+name}/locations",
- "id": "cloudfunctions.projects.locations.list",
- "description": "Lists information about the supported locations for this service."
- }
- },
- "resources": {
- "functions": {
- "methods": {
- "list": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
- "id": "cloudfunctions.projects.locations.functions.list",
- "path": "v1/{+parent}/functions",
- "description": "Returns a list of functions that belong to the requested project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListFunctionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of functions to return per call.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "call": {
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function to be called.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
- "path": "v1/{+name}:call",
- "id": "cloudfunctions.projects.locations.functions.call",
- "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
- "request": {
- "$ref": "CallFunctionRequest"
- }
- },
- "create": {
- "request": {
- "$ref": "CloudFunction"
- },
- "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "POST",
- "parameters": {
- "location": {
- "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
- "path": "v1/{+location}/functions",
- "id": "cloudfunctions.projects.locations.functions.create"
- },
- "generateUploadUrl": {
- "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls.\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`",
- "request": {
- "$ref": "GenerateUploadUrlRequest"
- },
- "response": {
- "$ref": "GenerateUploadUrlResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
- "path": "v1/{+parent}/functions:generateUploadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateUploadUrl"
- },
- "generateDownloadUrl": {
- "request": {
- "$ref": "GenerateDownloadUrlRequest"
- },
- "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
- "response": {
- "$ref": "GenerateDownloadUrlResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
- "path": "v1/{+name}:generateDownloadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl"
- },
- "patch": {
- "request": {
- "$ref": "CloudFunction"
- },
- "description": "Updates existing function.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "location": "path",
- "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "id": "cloudfunctions.projects.locations.functions.patch",
- "path": "v1/{+name}"
- },
- "get": {
- "response": {
- "$ref": "CloudFunction"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the function which details should be obtained.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "path": "v1/{+name}",
- "id": "cloudfunctions.projects.locations.functions.get",
- "description": "Returns a function with the given name from the requested project."
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function which should be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "id": "cloudfunctions.projects.locations.functions.delete",
- "path": "v1/{+name}",
- "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function."
- }
- }
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "name": {
- "location": "query",
- "description": "The name of the operation's parent resource.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations",
- "id": "cloudfunctions.operations.list",
- "path": "v1/operations",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- },
- "get": {
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudfunctions.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- },
- "parameters": {
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudfunctions.googleapis.com/",
"servicePath": "",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "id": "cloudfunctions:v1",
- "documentationLink": "https://cloud.google.com/functions",
- "revision": "20180102"
-}
+ "title": "Google Cloud Functions API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudfunctions/v1beta2/cloudfunctions-api.json b/vendor/google.golang.org/api/cloudfunctions/v1beta2/cloudfunctions-api.json
index 3d842f704..f961fcfe8 100644
--- a/vendor/google.golang.org/api/cloudfunctions/v1beta2/cloudfunctions-api.json
+++ b/vendor/google.golang.org/api/cloudfunctions/v1beta2/cloudfunctions-api.json
@@ -1,78 +1,535 @@
{
- "kind": "discovery#restDescription",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
- "servicePath": "",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
"basePath": "",
- "id": "cloudfunctions:v1beta2",
- "documentationLink": "https://cloud.google.com/functions",
- "revision": "20180102",
+ "baseUrl": "https://cloudfunctions.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Functions",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
"discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "CloudFunction": {
- "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
- "type": "object",
- "properties": {
- "sourceRepositoryUrl": {
- "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.",
- "type": "string"
- },
- "updateTime": {
- "description": "Output only. The last update timestamp of a Cloud Function.",
- "format": "google-datetime",
- "type": "string"
- },
- "latestOperation": {
- "description": "Output only. Name of the most recent operation modifying the function. If\nthe function status is `DEPLOYING` or `DELETING`, then it points to the\nactive operation.",
- "type": "string"
- },
- "httpsTrigger": {
- "$ref": "HTTPSTrigger",
- "description": "An HTTPS endpoint type of source that can be triggered via URL."
- },
- "sourceUploadUrl": {
- "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1beta2.GenerateUploadUrl",
- "type": "string"
- },
- "eventTrigger": {
- "description": "A source that fires events in response to a condition in another service.",
- "$ref": "EventTrigger"
- },
- "status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "READY",
- "FAILED",
- "DEPLOYING",
- "DELETING"
+ "documentationLink": "https://cloud.google.com/functions",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudfunctions:v1beta2",
+ "kind": "discovery#restDescription",
+ "name": "cloudfunctions",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "flatPath": "v1beta2/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.operations.get",
+ "parameterOrder": [
+ "name"
],
- "description": "Output only. Status of the function deployment.",
- "type": "string",
- "enumDescriptions": [
- "Status not specified.",
- "Successfully deployed.",
- "Not deployed correctly - behavior is undefined. The item should be updated\nor deleted to move it out of this state.",
- "Creation or update in progress.",
- "Deletion in progress."
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "location": "path",
+ "pattern": "^operations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
]
},
- "timeout": {
- "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
- "format": "google-duration",
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "flatPath": "v1beta2/operations",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.operations.list",
+ "parameterOrder": [],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/operations",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v1beta2/projects/{projectsId}/locations",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.projects.locations.list",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+name}/locations",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "functions": {
+ "methods": {
+ "call": {
+ "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
+ "httpMethod": "POST",
+ "id": "cloudfunctions.projects.locations.functions.call",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function to be called.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+name}:call",
+ "request": {
+ "$ref": "CallFunctionRequest"
+ },
+ "response": {
+ "$ref": "CallFunctionResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "httpMethod": "POST",
+ "id": "cloudfunctions.projects.locations.functions.create",
+ "parameterOrder": [
+ "location"
+ ],
+ "parameters": {
+ "location": {
+ "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+location}/functions",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "httpMethod": "DELETE",
+ "id": "cloudfunctions.projects.locations.functions.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function which should be deleted.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "generateDownloadUrl": {
+ "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
+ "httpMethod": "POST",
+ "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+name}:generateDownloadUrl",
+ "request": {
+ "$ref": "GenerateDownloadUrlRequest"
+ },
+ "response": {
+ "$ref": "GenerateDownloadUrlResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "generateUploadUrl": {
+ "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
+ "httpMethod": "POST",
+ "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+parent}/functions:generateUploadUrl",
+ "request": {
+ "$ref": "GenerateUploadUrlRequest"
+ },
+ "response": {
+ "$ref": "GenerateUploadUrlResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Returns a function with the given name from the requested project.",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.projects.locations.functions.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function which details should be obtained.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+name}",
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Returns a list of functions that belong to the requested project.",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "httpMethod": "GET",
+ "id": "cloudfunctions.projects.locations.functions.list",
+ "parameterOrder": [
+ "location"
+ ],
+ "parameters": {
+ "location": {
+ "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+location}/functions",
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "update": {
+ "description": "Updates existing function.",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "httpMethod": "PUT",
+ "id": "cloudfunctions.projects.locations.functions.update",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function to be updated.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta2/{+name}",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20180120",
+ "rootUrl": "https://cloudfunctions.googleapis.com/",
+ "schemas": {
+ "CallFunctionRequest": {
+ "description": "Request for the `CallFunction` method.",
+ "id": "CallFunctionRequest",
+ "properties": {
+ "data": {
+ "description": "Input to be passed to the function.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CallFunctionResponse": {
+ "description": "Response of `CallFunction` method.",
+ "id": "CallFunctionResponse",
+ "properties": {
+ "error": {
+ "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
"type": "string"
},
+ "executionId": {
+ "description": "Execution id of function invocation.",
+ "type": "string"
+ },
+ "result": {
+ "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CloudFunction": {
+ "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
+ "id": "CloudFunction",
+ "properties": {
"availableMemoryMb": {
"description": "The amount of memory in MB available for a function.\nDefaults to 256MB.",
"format": "int32",
"type": "integer"
},
- "name": {
- "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
+ "entryPoint": {
+ "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
"type": "string"
},
- "versionId": {
- "description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.",
- "format": "int64",
+ "eventTrigger": {
+ "$ref": "EventTrigger",
+ "description": "A source that fires events in response to a condition in another service."
+ },
+ "httpsTrigger": {
+ "$ref": "HTTPSTrigger",
+ "description": "An HTTPS endpoint type of source that can be triggered via URL."
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels associated with this Cloud Function.",
+ "type": "object"
+ },
+ "latestOperation": {
+ "description": "Output only. Name of the most recent operation modifying the function. If\nthe function status is `DEPLOYING` or `DELETING`, then it points to the\nactive operation.",
+ "type": "string"
+ },
+ "name": {
+ "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
"type": "string"
},
"serviceAccount": {
@@ -84,35 +541,202 @@
"type": "string"
},
"sourceRepository": {
- "description": "The hosted repository where the function is defined.",
- "$ref": "SourceRepository"
+ "$ref": "SourceRepository",
+ "description": "The hosted repository where the function is defined."
},
- "entryPoint": {
- "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
+ "sourceRepositoryUrl": {
+ "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.",
"type": "string"
},
+ "sourceUploadUrl": {
+ "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1beta2.GenerateUploadUrl",
+ "type": "string"
+ },
+ "status": {
+ "description": "Output only. Status of the function deployment.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "READY",
+ "FAILED",
+ "DEPLOYING",
+ "DELETING"
+ ],
+ "enumDescriptions": [
+ "Status not specified.",
+ "Successfully deployed.",
+ "Not deployed correctly - behavior is undefined. The item should be updated\nor deleted to move it out of this state.",
+ "Creation or update in progress.",
+ "Deletion in progress."
+ ],
+ "type": "string"
+ },
+ "timeout": {
+ "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. The last update timestamp of a Cloud Function.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "versionId": {
+ "description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EventTrigger": {
+ "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
+ "id": "EventTrigger",
+ "properties": {
+ "eventType": {
+ "description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.\n\nHandle an object changing in Google Cloud Storage:\n`providers/cloud.storage/eventTypes/object.change`\n\nHandle a write to the Firebase Realtime Database:\n`providers/google.firebase.database/eventTypes/ref.write`",
+ "type": "string"
+ },
+ "failurePolicy": {
+ "$ref": "FailurePolicy",
+ "description": "Specifies policy for failed executions."
+ },
+ "resource": {
+ "description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)",
+ "type": "string"
+ },
+ "service": {
+ "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FailurePolicy": {
+ "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
+ "id": "FailurePolicy",
+ "properties": {
+ "retry": {
+ "$ref": "Retry",
+ "description": "If specified, then the function will be retried in case of a failure."
+ }
+ },
+ "type": "object"
+ },
+ "GenerateDownloadUrlRequest": {
+ "description": "Request of `GenerateDownloadUrl` method.",
+ "id": "GenerateDownloadUrlRequest",
+ "properties": {
+ "versionId": {
+ "description": "The optional version of function.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GenerateDownloadUrlResponse": {
+ "description": "Response of `GenerateDownloadUrl` method.",
+ "id": "GenerateDownloadUrlResponse",
+ "properties": {
+ "downloadUrl": {
+ "description": "The generated Google Cloud Storage signed URL that should be used for\nfunction source code download.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GenerateUploadUrlRequest": {
+ "description": "Request of `GenerateUploadUrl` method.",
+ "id": "GenerateUploadUrlRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "GenerateUploadUrlResponse": {
+ "description": "Response of `GenerateUploadUrl` method.",
+ "id": "GenerateUploadUrlResponse",
+ "properties": {
+ "uploadUrl": {
+ "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HTTPSTrigger": {
+ "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
+ "id": "HTTPSTrigger",
+ "properties": {
+ "url": {
+ "description": "Output only. The deployed url for the function.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListFunctionsResponse": {
+ "description": "Response for the `ListFunctions` method.",
+ "id": "ListFunctionsResponse",
+ "properties": {
+ "functions": {
+ "description": "The functions that match the request.",
+ "items": {
+ "$ref": "CloudFunction"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
+ "properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
- "description": "Labels associated with this Cloud Function.",
- "type": "object"
- }
- },
- "id": "CloudFunction"
- },
- "Location": {
- "properties": {
- "labels": {
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
+ "type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
@@ -125,229 +749,38 @@
},
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
- }
- },
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
- },
- "GenerateDownloadUrlResponse": {
- "description": "Response of `GenerateDownloadUrl` method.",
- "type": "object",
- "properties": {
- "downloadUrl": {
- "description": "The generated Google Cloud Storage signed URL that should be used for\nfunction source code download.",
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
- "id": "GenerateDownloadUrlResponse"
- },
- "Retry": {
- "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.",
- "type": "object",
- "properties": {},
- "id": "Retry"
- },
- "GenerateUploadUrlRequest": {
- "properties": {},
- "id": "GenerateUploadUrlRequest",
- "description": "Request of `GenerateUploadUrl` method.",
- "type": "object"
- },
- "ListOperationsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
- },
- "GenerateUploadUrlResponse": {
- "description": "Response of `GenerateUploadUrl` method.",
- "type": "object",
- "properties": {
- "uploadUrl": {
- "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function.",
- "type": "string"
- }
- },
- "id": "GenerateUploadUrlResponse"
- },
- "ListFunctionsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.",
- "type": "string"
- },
- "functions": {
- "description": "The functions that match the request.",
- "type": "array",
- "items": {
- "$ref": "CloudFunction"
- }
- }
- },
- "id": "ListFunctionsResponse",
- "description": "Response for the `ListFunctions` method.",
- "type": "object"
- },
- "CallFunctionResponse": {
- "description": "Response of `CallFunction` method.",
- "type": "object",
- "properties": {
- "executionId": {
- "description": "Execution id of function invocation.",
- "type": "string"
- },
- "result": {
- "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
- "type": "string"
- },
- "error": {
- "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
- "type": "string"
- }
- },
- "id": "CallFunctionResponse"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListLocationsResponse"
- },
- "EventTrigger": {
- "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
- "type": "object",
- "properties": {
- "failurePolicy": {
- "description": "Specifies policy for failed executions.",
- "$ref": "FailurePolicy"
- },
- "eventType": {
- "description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.\n\nHandle an object changing in Google Cloud Storage:\n`providers/cloud.storage/eventTypes/object.change`\n\nHandle a write to the Firebase Realtime Database:\n`providers/google.firebase.database/eventTypes/ref.write`",
- "type": "string"
- },
- "resource": {
- "description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)",
- "type": "string"
- },
- "service": {
- "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.",
- "type": "string"
- }
- },
- "id": "EventTrigger"
- },
- "HTTPSTrigger": {
- "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
- "type": "object",
- "properties": {
- "url": {
- "description": "Output only. The deployed url for the function.",
- "type": "string"
- }
- },
- "id": "HTTPSTrigger"
- },
- "FailurePolicy": {
- "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
- "type": "object",
- "properties": {
- "retry": {
- "$ref": "Retry",
- "description": "If specified, then the function will be retried in case of a failure."
- }
- },
- "id": "FailurePolicy"
- },
- "GenerateDownloadUrlRequest": {
- "description": "Request of `GenerateDownloadUrl` method.",
- "type": "object",
- "properties": {
- "versionId": {
- "description": "The optional version of function.",
- "format": "uint64",
- "type": "string"
- }
- },
- "id": "GenerateDownloadUrlRequest"
- },
- "OperationMetadataV1": {
- "properties": {
- "updateTime": {
- "description": "The last update timestamp of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
- "type": "string"
- },
- "request": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The original request that started the operation.",
- "type": "object"
- },
- "versionId": {
- "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "enum": [
- "OPERATION_UNSPECIFIED",
- "CREATE_FUNCTION",
- "UPDATE_FUNCTION",
- "DELETE_FUNCTION"
- ],
- "description": "Type of operation.",
- "type": "string",
- "enumDescriptions": [
- "Unknown operation type.",
- "Triggered by CreateFunction call",
- "Triggered by UpdateFunction call",
- "Triggered by DeleteFunction call."
- ]
- }
- },
- "id": "OperationMetadataV1",
- "description": "Metadata describing an Operation",
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
+ "id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -355,39 +788,14 @@
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
}
},
- "id": "Operation"
+ "type": "object"
},
- "OperationMetadataV1Beta2": {
+ "OperationMetadataV1": {
"description": "Metadata describing an Operation",
- "type": "object",
+ "id": "OperationMetadataV1",
"properties": {
- "updateTime": {
- "description": "The last update timestamp of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
- "type": "string"
- },
"request": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -396,73 +804,94 @@
"description": "The original request that started the operation.",
"type": "object"
},
- "versionId": {
- "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
- "format": "int64",
+ "target": {
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
"type": "string"
},
"type": {
- "enumDescriptions": [
- "Unknown operation type.",
- "Triggered by CreateFunction call",
- "Triggered by UpdateFunction call",
- "Triggered by DeleteFunction call."
- ],
+ "description": "Type of operation.",
"enum": [
"OPERATION_UNSPECIFIED",
"CREATE_FUNCTION",
"UPDATE_FUNCTION",
"DELETE_FUNCTION"
],
- "description": "Type of operation.",
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ],
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "The last update timestamp of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "versionId": {
+ "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
+ "format": "int64",
"type": "string"
}
},
- "id": "OperationMetadataV1Beta2"
+ "type": "object"
},
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
+ "OperationMetadataV1Beta2": {
+ "description": "Metadata describing an Operation",
+ "id": "OperationMetadataV1Beta2",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "request": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The original request that started the operation.",
+ "type": "object"
+ },
+ "target": {
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
"type": "string"
},
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
+ "type": {
+ "description": "Type of operation.",
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "CREATE_FUNCTION",
+ "UPDATE_FUNCTION",
+ "DELETE_FUNCTION"
+ ],
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ],
+ "type": "string"
},
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ "updateTime": {
+ "description": "The last update timestamp of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "versionId": {
+ "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "Status"
+ "type": "object"
+ },
+ "Retry": {
+ "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.",
+ "id": "Retry",
+ "properties": {},
+ "type": "object"
},
"SourceRepository": {
"description": "Describes the location of the function source in a remote repository.",
- "type": "object",
+ "id": "SourceRepository",
"properties": {
- "revision": {
- "description": "The id of the revision that captures the state of the repository from\nwhich the function should be fetched.",
- "type": "string"
- },
- "repositoryUrl": {
- "description": "URL to the hosted repository where the function is defined. Only paths in\nhttps://source.developers.google.com domain are supported. The path should\ncontain the name of the repository.",
- "type": "string"
- },
- "tag": {
- "description": "The name of the tag that captures the state of the repository from\nwhich the function should be fetched.",
- "type": "string"
- },
"branch": {
"description": "The name of the branch from which the function should be fetched.",
"type": "string"
@@ -471,484 +900,55 @@
"description": "Output only. The id of the revision that was resolved at the moment of\nfunction creation or update. For example when a user deployed from a\nbranch, it will be the revision id of the latest change on this branch at\nthat time. If user deployed from revision then this value will be always\nequal to the revision specified by the user.",
"type": "string"
},
+ "repositoryUrl": {
+ "description": "URL to the hosted repository where the function is defined. Only paths in\nhttps://source.developers.google.com domain are supported. The path should\ncontain the name of the repository.",
+ "type": "string"
+ },
+ "revision": {
+ "description": "The id of the revision that captures the state of the repository from\nwhich the function should be fetched.",
+ "type": "string"
+ },
"sourcePath": {
"description": "The path within the repository where the function is defined. The path\nshould point to the directory where Cloud Functions files are located. Use\n\"/\" if the function is defined directly in the root directory of a\nrepository.",
"type": "string"
- }
- },
- "id": "SourceRepository"
- },
- "CallFunctionRequest": {
- "description": "Request for the `CallFunction` method.",
- "type": "object",
- "properties": {
- "data": {
- "description": "Input to be passed to the function.",
+ },
+ "tag": {
+ "description": "The name of the tag that captures the state of the repository from\nwhich the function should be fetched.",
"type": "string"
}
},
- "id": "CallFunctionRequest"
- }
- },
- "protocol": "rest",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "canonicalName": "Cloud Functions",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudfunctions.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudfunctions",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Functions API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "resources": {
- "functions": {
- "methods": {
- "generateUploadUrl": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GenerateUploadUrlResponse"
- },
- "parameters": {
- "parent": {
- "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
- "path": "v1beta2/{+parent}/functions:generateUploadUrl",
- "request": {
- "$ref": "GenerateUploadUrlRequest"
- },
- "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`"
- },
- "generateDownloadUrl": {
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
- "path": "v1beta2/{+name}:generateDownloadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
- "request": {
- "$ref": "GenerateDownloadUrlRequest"
- },
- "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
- "response": {
- "$ref": "GenerateDownloadUrlResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "response": {
- "$ref": "CloudFunction"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function which details should be obtained.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "path": "v1beta2/{+name}",
- "id": "cloudfunctions.projects.locations.functions.get",
- "description": "Returns a function with the given name from the requested project."
- },
- "update": {
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "id": "cloudfunctions.projects.locations.functions.update",
- "path": "v1beta2/{+name}",
- "request": {
- "$ref": "CloudFunction"
- },
- "description": "Updates existing function.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the function to be updated.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "id": "cloudfunctions.projects.locations.functions.delete",
- "path": "v1beta2/{+name}",
- "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function which should be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "response": {
- "$ref": "ListFunctionsResponse"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Maximum number of functions to return per call.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "location": {
- "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "path": "v1beta2/{+location}/functions",
- "id": "cloudfunctions.projects.locations.functions.list",
- "description": "Returns a list of functions that belong to the requested project."
- },
- "call": {
- "path": "v1beta2/{+name}:call",
- "id": "cloudfunctions.projects.locations.functions.call",
- "request": {
- "$ref": "CallFunctionRequest"
- },
- "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the function to be called.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call"
- },
- "create": {
- "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
- "request": {
- "$ref": "CloudFunction"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "location": {
- "location": "path",
- "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "path": "v1beta2/{+location}/functions",
- "id": "cloudfunctions.projects.locations.functions.create"
- }
- }
- }
- },
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations",
- "id": "cloudfunctions.projects.locations.list",
- "path": "v1beta2/{+name}/locations",
- "description": "Lists information about the supported locations for this service."
- }
- }
- }
- }
+ "type": "object"
},
- "operations": {
- "methods": {
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "name": {
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/operations",
- "id": "cloudfunctions.operations.list",
- "path": "v1beta2/operations"
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
},
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
},
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/operations/{operationsId}",
- "id": "cloudfunctions.operations.get",
- "path": "v1beta2/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
- }
- }
- },
- "parameters": {
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
+ },
+ "type": "object"
}
},
+ "servicePath": "",
+ "title": "Google Cloud Functions API",
"version": "v1beta2",
- "baseUrl": "https://cloudfunctions.googleapis.com/"
-}
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudiot/v1/cloudiot-api.json b/vendor/google.golang.org/api/cloudiot/v1/cloudiot-api.json
index f4e856c5d..97c1757f5 100644
--- a/vendor/google.golang.org/api/cloudiot/v1/cloudiot-api.json
+++ b/vendor/google.golang.org/api/cloudiot/v1/cloudiot-api.json
@@ -1,20 +1,709 @@
{
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloudiot": {
+ "description": "Register and manage devices in the Google Cloud IoT service"
+ }
+ }
+ }
+ },
"basePath": "",
- "revision": "20180111",
- "documentationLink": "https://cloud.google.com/iot",
- "id": "cloudiot:v1",
+ "baseUrl": "https://cloudiot.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Iot",
+ "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
"discoveryVersion": "v1",
- "version_module": true,
+ "documentationLink": "https://cloud.google.com/iot",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudiot:v1",
+ "kind": "discovery#restDescription",
+ "name": "cloudiot",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "resources": {
+ "registries": {
+ "methods": {
+ "create": {
+ "description": "Creates a device registry that contains devices.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
+ "httpMethod": "POST",
+ "id": "cloudiot.projects.locations.registries.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/registries",
+ "request": {
+ "$ref": "DeviceRegistry"
+ },
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a device registry configuration.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "httpMethod": "DELETE",
+ "id": "cloudiot.projects.locations.registries.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "get": {
+ "description": "Gets a device registry configuration.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "httpMethod": "GET",
+ "id": "cloudiot.projects.locations.registries.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudiot.projects.locations.registries.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "list": {
+ "description": "Lists device registries.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
+ "httpMethod": "GET",
+ "id": "cloudiot.projects.locations.registries.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call, and\nthat the system should return the next page of data.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/registries",
+ "response": {
+ "$ref": "ListDeviceRegistriesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "patch": {
+ "description": "Updates a device registry configuration.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "httpMethod": "PATCH",
+ "id": "cloudiot.projects.locations.registries.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config`, `http_config`,\n`mqtt_config`, and `state_notification_config`.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "DeviceRegistry"
+ },
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudiot.projects.locations.registries.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudiot.projects.locations.registries.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ }
+ },
+ "resources": {
+ "devices": {
+ "methods": {
+ "create": {
+ "description": "Creates a device in a device registry.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "httpMethod": "POST",
+ "id": "cloudiot.projects.locations.registries.devices.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/devices",
+ "request": {
+ "$ref": "Device"
+ },
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a device.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "httpMethod": "DELETE",
+ "id": "cloudiot.projects.locations.registries.devices.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "get": {
+ "description": "Gets details about a device.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "httpMethod": "GET",
+ "id": "cloudiot.projects.locations.registries.devices.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "fieldMask": {
+ "description": "The fields of the `Device` resource to be returned in the response. If the\nfield mask is unset or empty, all fields are returned.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "list": {
+ "description": "List devices in a device registry.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "httpMethod": "GET",
+ "id": "cloudiot.projects.locations.registries.devices.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "deviceIds": {
+ "description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "deviceNumIds": {
+ "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.",
+ "format": "uint64",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "fieldMask": {
+ "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/devices",
+ "response": {
+ "$ref": "ListDevicesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "modifyCloudToDeviceConfig": {
+ "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
+ "httpMethod": "POST",
+ "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:modifyCloudToDeviceConfig",
+ "request": {
+ "$ref": "ModifyCloudToDeviceConfigRequest"
+ },
+ "response": {
+ "$ref": "DeviceConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "patch": {
+ "description": "Updates a device.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "httpMethod": "PATCH",
+ "id": "cloudiot.projects.locations.registries.devices.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `blocked`, and `metadata`",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Device"
+ },
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ }
+ },
+ "resources": {
+ "configVersions": {
+ "methods": {
+ "list": {
+ "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
+ "httpMethod": "GET",
+ "id": "cloudiot.projects.locations.registries.devices.configVersions.list",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "numVersions": {
+ "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ }
+ },
+ "path": "v1/{+name}/configVersions",
+ "response": {
+ "$ref": "ListDeviceConfigVersionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ }
+ }
+ },
+ "states": {
+ "methods": {
+ "list": {
+ "description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states",
+ "httpMethod": "GET",
+ "id": "cloudiot.projects.locations.registries.devices.states.list",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "numStates": {
+ "description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ }
+ },
+ "path": "v1/{+name}/states",
+ "response": {
+ "$ref": "ListDeviceStatesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20180314",
+ "rootUrl": "https://cloudiot.googleapis.com/",
"schemas": {
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"Device": {
"description": "The device resource.",
- "type": "object",
+ "id": "Device",
"properties": {
- "lastEventTime": {
- "description": "[Output only] The last time a telemetry event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
+ "blocked": {
+ "description": "If a device is blocked, connections or requests from this device will fail.\nCan be used to temporarily prevent the device from connecting if, for\nexample, the sensor is generating bad data and needs maintenance.",
+ "type": "boolean"
+ },
+ "config": {
+ "$ref": "DeviceConfig",
+ "description": "The most recent device configuration, which is eventually sent from\nCloud IoT Core to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method."
+ },
+ "credentials": {
+ "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time. When new credentials are added to a device, they are verified\nagainst the registry credentials. For details, see the description of the\n`DeviceRegistry.credentials` field.",
+ "items": {
+ "$ref": "DeviceCredential"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.",
+ "type": "string"
+ },
+ "lastConfigAckTime": {
+ "description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device. This field is only for configurations\nsent through MQTT.",
"format": "google-datetime",
"type": "string"
},
@@ -27,32 +716,23 @@
"$ref": "Status",
"description": "[Output only] The error message of the most recent error, such as a failure\nto publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this\nfield. If no errors have occurred, this field has an empty message\nand the status code 0 == OK. Otherwise, this field is expected to have a\nstatus code other than OK."
},
- "lastStateTime": {
- "description": "[Output only] The last time a state event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
+ "lastErrorTime": {
+ "description": "[Output only] The time the most recent error occurred, such as a failure to\npublish to Cloud Pub/Sub. This field is the timestamp of\n'last_error_status'.",
"format": "google-datetime",
"type": "string"
},
- "state": {
- "$ref": "DeviceState",
- "description": "[Output only] The state most recently received from the device. If no state\nhas been reported, this field is not present."
- },
- "config": {
- "$ref": "DeviceConfig",
- "description": "The most recent device configuration, which is eventually sent from\nCloud IoT Core to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method."
- },
- "credentials": {
- "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time. When new credentials are added to a device, they are verified\nagainst the registry credentials. For details, see the description of the\n`DeviceRegistry.credentials` field.",
- "type": "array",
- "items": {
- "$ref": "DeviceCredential"
- }
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
+ "lastEventTime": {
+ "description": "[Output only] The last time a telemetry event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
+ "format": "google-datetime",
"type": "string"
},
- "lastErrorTime": {
- "description": "[Output only] The time the most recent error occurred, such as a failure to\npublish to Cloud Pub/Sub. This field is the timestamp of\n'last_error_status'.",
+ "lastHeartbeatTime": {
+ "description": "[Output only] The last time an MQTT `PINGREQ` was received. This field\napplies only to devices connecting through MQTT. MQTT clients usually only\nsend `PINGREQ` messages if the connection is idle, and no other messages\nhave been sent. Timestamps are periodically collected and written to\nstorage; they may be stale by a few minutes.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "lastStateTime": {
+ "description": "[Output only] The last time a state event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
"format": "google-datetime",
"type": "string"
},
@@ -60,16 +740,11 @@
"additionalProperties": {
"type": "string"
},
- "description": "The metadata key-value pairs assigned to the device. This metadata is not\ninterpreted or indexed by Cloud IoT Core. It can be used to add contextual\ninformation for the device.\n\nKeys must conform to the regular expression [a-zA-Z0-9-_]+ and be less than\n128 bytes in length.\n\nValues are free-form strings. Each value must be less than or equal to 32\nKB in size.\n\nThe total size of all keys and values must be less than 256 KB, and the\nmaximum number of key-value pairs is 500.",
+ "description": "The metadata key-value pairs assigned to the device. This metadata is not\ninterpreted or indexed by Cloud IoT Core. It can be used to add contextual\ninformation for the device.\n\nKeys must conform to the regular expression a-zA-Z+ and\nbe less than 128 bytes in length.\n\nValues are free-form strings. Each value must be less than or equal to 32\nKB in size.\n\nThe total size of all keys and values must be less than 256 KB, and the\nmaximum number of key-value pairs is 500.",
"type": "object"
},
- "id": {
- "type": "string",
- "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry."
- },
- "lastConfigAckTime": {
- "description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device. This field is only for configurations\nsent through MQTT.",
- "format": "google-datetime",
+ "name": {
+ "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
"type": "string"
},
"numId": {
@@ -77,415 +752,20 @@
"format": "uint64",
"type": "string"
},
- "blocked": {
- "description": "If a device is blocked, connections or requests from this device will fail.\nCan be used to temporarily prevent the device from connecting if, for\nexample, the sensor is generating bad data and needs maintenance.",
- "type": "boolean"
- },
- "lastHeartbeatTime": {
- "description": "[Output only] The last time a heartbeat was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes. This field is only for devices connecting through MQTT.",
- "format": "google-datetime",
- "type": "string"
+ "state": {
+ "$ref": "DeviceState",
+ "description": "[Output only] The state most recently received from the device. If no state\nhas been reported, this field is not present."
}
},
- "id": "Device"
- },
- "ListDeviceConfigVersionsResponse": {
- "description": "Response for `ListDeviceConfigVersions`.",
- "type": "object",
- "properties": {
- "deviceConfigs": {
- "description": "The device configuration for the last few versions. Versions are listed\nin decreasing order, starting from the most recent one.",
- "type": "array",
- "items": {
- "$ref": "DeviceConfig"
- }
- }
- },
- "id": "ListDeviceConfigVersionsResponse"
- },
- "X509CertificateDetails": {
- "type": "object",
- "properties": {
- "publicKeyType": {
- "description": "The type of public key in the certificate.",
- "type": "string"
- },
- "signatureAlgorithm": {
- "type": "string",
- "description": "The algorithm used to sign the certificate."
- },
- "startTime": {
- "description": "The time the certificate becomes valid.",
- "format": "google-datetime",
- "type": "string"
- },
- "expiryTime": {
- "type": "string",
- "description": "The time the certificate becomes invalid.",
- "format": "google-datetime"
- },
- "subject": {
- "description": "The entity the certificate and public key belong to.",
- "type": "string"
- },
- "issuer": {
- "description": "The entity that signed the certificate.",
- "type": "string"
- }
- },
- "id": "X509CertificateDetails",
- "description": "Details of an X.509 certificate. For informational purposes only."
- },
- "EventNotificationConfig": {
- "description": "The configuration to forward telemetry events.",
- "type": "object",
- "properties": {
- "pubsubTopicName": {
- "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
- "type": "string"
- }
- },
- "id": "EventNotificationConfig"
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- },
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "SetIamPolicyRequest"
- },
- "Empty": {
- "type": "object",
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
- },
- "PublicKeyCredential": {
- "description": "A public key format and data.",
- "type": "object",
- "properties": {
- "key": {
- "description": "The key data.",
- "type": "string"
- },
- "format": {
- "enumDescriptions": [
- "The format has not been specified. This is an invalid default value and\nmust not be used.",
- "An RSA public key encoded in base64, and wrapped by\n`-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be\nused to verify `RS256` signatures in JWT tokens ([RFC7518](\nhttps://www.ietf.org/rfc/rfc7518.txt)).",
- "As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.",
- "Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in\nbase64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END\nPUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256`\nalgorithm ([RFC7518](https://www.ietf.org/rfc/rfc7518.txt)). This curve is\ndefined in [OpenSSL](https://www.openssl.org/) as the `prime256v1` curve.",
- "As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`."
- ],
- "enum": [
- "UNSPECIFIED_PUBLIC_KEY_FORMAT",
- "RSA_PEM",
- "RSA_X509_PEM",
- "ES256_PEM",
- "ES256_X509_PEM"
- ],
- "description": "The format of the key.",
- "type": "string"
- }
- },
- "id": "PublicKeyCredential"
- },
- "PublicKeyCertificate": {
- "type": "object",
- "properties": {
- "x509Details": {
- "$ref": "X509CertificateDetails",
- "description": "[Output only] The certificate details. Used only for X.509 certificates."
- },
- "format": {
- "description": "The certificate format.",
- "type": "string",
- "enumDescriptions": [
- "The format has not been specified. This is an invalid default value and\nmust not be used.",
- "An X.509v3 certificate ([RFC5280](https://www.ietf.org/rfc/rfc5280.txt)),\nencoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and\n`-----END CERTIFICATE-----`."
- ],
- "enum": [
- "UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT",
- "X509_CERTIFICATE_PEM"
- ]
- },
- "certificate": {
- "description": "The certificate data.",
- "type": "string"
- }
- },
- "id": "PublicKeyCertificate",
- "description": "A public key certificate format and data."
- },
- "DeviceState": {
- "description": "The device state, as reported by the device.",
- "type": "object",
- "properties": {
- "binaryData": {
- "description": "The device state data.",
- "format": "byte",
- "type": "string"
- },
- "updateTime": {
- "description": "[Output only] The time at which this state version was updated in Cloud\nIoT Core.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "DeviceState"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string"
- }
- },
- "id": "AuditLogConfig"
- },
- "StateNotificationConfig": {
- "type": "object",
- "properties": {
- "pubsubTopicName": {
- "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
- "type": "string"
- }
- },
- "id": "StateNotificationConfig",
- "description": "The configuration for notification of new states received from the device."
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "Policy": {
- "properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- },
- "iamOwned": {
- "type": "boolean"
- }
- },
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
"type": "object"
},
- "RegistryCredential": {
- "description": "A server-stored registry credential used to validate device credentials.",
- "type": "object",
- "properties": {
- "publicKeyCertificate": {
- "$ref": "PublicKeyCertificate",
- "description": "A public key certificate used to verify the device credentials."
- }
- },
- "id": "RegistryCredential"
- },
- "ListDeviceRegistriesResponse": {
- "description": "Response for `ListDeviceRegistries`.",
- "type": "object",
- "properties": {
- "deviceRegistries": {
- "description": "The registries that matched the query.",
- "type": "array",
- "items": {
- "$ref": "DeviceRegistry"
- }
- },
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.",
- "type": "string"
- }
- },
- "id": "ListDeviceRegistriesResponse"
- },
- "DeviceRegistry": {
- "properties": {
- "mqttConfig": {
- "$ref": "MqttConfig",
- "description": "The MQTT configuration for this device registry."
- },
- "stateNotificationConfig": {
- "$ref": "StateNotificationConfig",
- "description": "The configuration for notification of new states received from the device.\nState updates are guaranteed to be stored in the state history, but\nnotifications to Cloud Pub/Sub are not guaranteed. For example, if\npermissions are misconfigured or the specified topic doesn't exist, no\nnotification will be published but the state will still be stored in Cloud\nIoT Core."
- },
- "credentials": {
- "description": "The credentials used to verify the device credentials. No more than 10\ncredentials can be bound to a single registry at a time. The verification\nprocess occurs at the time of device creation or update. If this field is\nempty, no verification is performed. Otherwise, the credentials of a newly\ncreated device or added credentials of an updated device should be signed\nwith one of these registry credentials.\n\nNote, however, that existing devices will never be affected by\nmodifications to this list of credentials: after a device has been\nsuccessfully created in a registry, it should be able to connect even if\nits registry credentials are revoked, deleted, or modified.",
- "type": "array",
- "items": {
- "$ref": "RegistryCredential"
- }
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "type": "string"
- },
- "eventNotificationConfigs": {
- "description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. Only the first configuration is used. If you\ntry to publish a device telemetry event using MQTT without specifying a\nCloud Pub/Sub topic for the device's registry, the connection closes\nautomatically. If you try to do so using an HTTP connection, an error\nis returned.",
- "type": "array",
- "items": {
- "$ref": "EventNotificationConfig"
- }
- },
- "httpConfig": {
- "$ref": "HttpConfig",
- "description": "The DeviceService (HTTP) configuration for this device registry."
- },
- "id": {
- "type": "string",
- "description": "The identifier of this device registry. For example, `myRegistry`."
- }
- },
- "id": "DeviceRegistry",
- "description": "A container for a group of devices.",
- "type": "object"
- },
- "ListDevicesResponse": {
- "properties": {
- "devices": {
- "type": "array",
- "items": {
- "$ref": "Device"
- },
- "description": "The devices that match the request."
- },
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`.",
- "type": "string"
- }
- },
- "id": "ListDevicesResponse",
- "description": "Response for `ListDevices`.",
- "type": "object"
- },
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
- "exemptedMembers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- }
- },
- "id": "AuditConfig"
- },
- "HttpConfig": {
- "description": "The configuration of the HTTP bridge for a device registry.",
- "type": "object",
- "properties": {
- "httpEnabledState": {
- "enum": [
- "HTTP_STATE_UNSPECIFIED",
- "HTTP_ENABLED",
- "HTTP_DISABLED"
- ],
- "description": "If enabled, allows devices to use DeviceService via the HTTP protocol.\nOtherwise, any requests to DeviceService will fail for this registry.",
- "type": "string",
- "enumDescriptions": [
- "No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
- "Enables DeviceService (HTTP) service for the registry.",
- "Disables DeviceService (HTTP) service for the registry."
- ]
- }
- },
- "id": "HttpConfig"
- },
- "DeviceCredential": {
- "description": "A server-stored device credential used for authentication.",
- "type": "object",
- "properties": {
- "expirationTime": {
- "description": "[Optional] The time at which this credential becomes invalid. This\ncredential will be ignored for new client authentication requests after\nthis timestamp; however, it will not be automatically deleted.",
- "format": "google-datetime",
- "type": "string"
- },
- "publicKey": {
- "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).\nWhen adding a new device credential, either via device creation or via\nmodifications, this public key credential may be required to be signed by\none of the registry level certificates. More specifically, if the\nregistry contains at least one certificate, any new device credential\nmust be signed by one of the registry certificates. As a result,\nwhen the registry contains certificates, only X.509 certificates are\naccepted as device credentials. However, if the registry does\nnot contain a certificate, self-signed certificates and public keys will\nbe accepted. New device credentials must be different from every\nregistry-level certificate.",
- "$ref": "PublicKeyCredential"
- }
- },
- "id": "DeviceCredential"
- },
"DeviceConfig": {
- "type": "object",
+ "description": "The device configuration. Eventually delivered to devices.",
+ "id": "DeviceConfig",
"properties": {
- "version": {
- "description": "[Output only] The version of this update. The version number is assigned by\nthe server, and is always greater than 0 after device creation. The\nversion must be 0 on the `CreateDevice` request if a `config` is\nspecified; the response of `CreateDevice` will always have a value of 1.",
- "format": "int64",
+ "binaryData": {
+ "description": "The device configuration data.",
+ "format": "byte",
"type": "string"
},
"cloudUpdateTime": {
@@ -498,814 +778,442 @@
"format": "google-datetime",
"type": "string"
},
- "binaryData": {
- "description": "The device configuration data.",
- "format": "byte",
+ "version": {
+ "description": "[Output only] The version of this update. The version number is assigned by\nthe server, and is always greater than 0 after device creation. The\nversion must be 0 on the `CreateDevice` request if a `config` is\nspecified; the response of `CreateDevice` will always have a value of 1.",
+ "format": "int64",
"type": "string"
}
},
- "id": "DeviceConfig",
- "description": "The device configuration. Eventually delivered to devices."
+ "type": "object"
+ },
+ "DeviceCredential": {
+ "description": "A server-stored device credential used for authentication.",
+ "id": "DeviceCredential",
+ "properties": {
+ "expirationTime": {
+ "description": "[Optional] The time at which this credential becomes invalid. This\ncredential will be ignored for new client authentication requests after\nthis timestamp; however, it will not be automatically deleted.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "publicKey": {
+ "$ref": "PublicKeyCredential",
+ "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).\nWhen adding a new device credential, either via device creation or via\nmodifications, this public key credential may be required to be signed by\none of the registry level certificates. More specifically, if the\nregistry contains at least one certificate, any new device credential\nmust be signed by one of the registry certificates. As a result,\nwhen the registry contains certificates, only X.509 certificates are\naccepted as device credentials. However, if the registry does\nnot contain a certificate, self-signed certificates and public keys will\nbe accepted. New device credentials must be different from every\nregistry-level certificate."
+ }
+ },
+ "type": "object"
+ },
+ "DeviceRegistry": {
+ "description": "A container for a group of devices.",
+ "id": "DeviceRegistry",
+ "properties": {
+ "credentials": {
+ "description": "The credentials used to verify the device credentials. No more than 10\ncredentials can be bound to a single registry at a time. The verification\nprocess occurs at the time of device creation or update. If this field is\nempty, no verification is performed. Otherwise, the credentials of a newly\ncreated device or added credentials of an updated device should be signed\nwith one of these registry credentials.\n\nNote, however, that existing devices will never be affected by\nmodifications to this list of credentials: after a device has been\nsuccessfully created in a registry, it should be able to connect even if\nits registry credentials are revoked, deleted, or modified.",
+ "items": {
+ "$ref": "RegistryCredential"
+ },
+ "type": "array"
+ },
+ "eventNotificationConfigs": {
+ "description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. If multiple configurations match a message,\nonly the first matching configuration is used. If you try to publish a\ndevice telemetry event using MQTT without specifying a Cloud Pub/Sub topic\nfor the device's registry, the connection closes automatically. If you try\nto do so using an HTTP connection, an error is returned. Up to 10\nconfigurations may be provided.",
+ "items": {
+ "$ref": "EventNotificationConfig"
+ },
+ "type": "array"
+ },
+ "httpConfig": {
+ "$ref": "HttpConfig",
+ "description": "The DeviceService (HTTP) configuration for this device registry."
+ },
+ "id": {
+ "description": "The identifier of this device registry. For example, `myRegistry`.",
+ "type": "string"
+ },
+ "mqttConfig": {
+ "$ref": "MqttConfig",
+ "description": "The MQTT configuration for this device registry."
+ },
+ "name": {
+ "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "type": "string"
+ },
+ "stateNotificationConfig": {
+ "$ref": "StateNotificationConfig",
+ "description": "The configuration for notification of new states received from the device.\nState updates are guaranteed to be stored in the state history, but\nnotifications to Cloud Pub/Sub are not guaranteed. For example, if\npermissions are misconfigured or the specified topic doesn't exist, no\nnotification will be published but the state will still be stored in Cloud\nIoT Core."
+ }
+ },
+ "type": "object"
+ },
+ "DeviceState": {
+ "description": "The device state, as reported by the device.",
+ "id": "DeviceState",
+ "properties": {
+ "binaryData": {
+ "description": "The device state data.",
+ "format": "byte",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "[Output only] The time at which this state version was updated in Cloud\nIoT Core.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "EventNotificationConfig": {
+ "description": "The configuration for forwarding telemetry events.",
+ "id": "EventNotificationConfig",
+ "properties": {
+ "pubsubTopicName": {
+ "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
+ "type": "string"
+ },
+ "subfolderMatches": {
+ "description": "If the subfolder name matches this string exactly, this configuration will\nbe used. The string must not include the leading '/' character. If empty,\nall strings are matched. This field is used only for telemetry events;\nsubfolders are not supported for state changes.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "id": "GetIamPolicyRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "HttpConfig": {
+ "description": "The configuration of the HTTP bridge for a device registry.",
+ "id": "HttpConfig",
+ "properties": {
+ "httpEnabledState": {
+ "description": "If enabled, allows devices to use DeviceService via the HTTP protocol.\nOtherwise, any requests to DeviceService will fail for this registry.",
+ "enum": [
+ "HTTP_STATE_UNSPECIFIED",
+ "HTTP_ENABLED",
+ "HTTP_DISABLED"
+ ],
+ "enumDescriptions": [
+ "No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
+ "Enables DeviceService (HTTP) service for the registry.",
+ "Disables DeviceService (HTTP) service for the registry."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListDeviceConfigVersionsResponse": {
+ "description": "Response for `ListDeviceConfigVersions`.",
+ "id": "ListDeviceConfigVersionsResponse",
+ "properties": {
+ "deviceConfigs": {
+ "description": "The device configuration for the last few versions. Versions are listed\nin decreasing order, starting from the most recent one.",
+ "items": {
+ "$ref": "DeviceConfig"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListDeviceRegistriesResponse": {
+ "description": "Response for `ListDeviceRegistries`.",
+ "id": "ListDeviceRegistriesResponse",
+ "properties": {
+ "deviceRegistries": {
+ "description": "The registries that matched the query.",
+ "items": {
+ "$ref": "DeviceRegistry"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListDeviceStatesResponse": {
+ "description": "Response for `ListDeviceStates`.",
+ "id": "ListDeviceStatesResponse",
+ "properties": {
+ "deviceStates": {
+ "description": "The last few device states. States are listed in descending order of server\nupdate time, starting from the most recent one.",
+ "items": {
+ "$ref": "DeviceState"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListDevicesResponse": {
+ "description": "Response for `ListDevices`.",
+ "id": "ListDevicesResponse",
+ "properties": {
+ "devices": {
+ "description": "The devices that match the request.",
+ "items": {
+ "$ref": "Device"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ModifyCloudToDeviceConfigRequest": {
+ "description": "Request for `ModifyCloudToDeviceConfig`.",
+ "id": "ModifyCloudToDeviceConfigRequest",
+ "properties": {
+ "binaryData": {
+ "description": "The configuration data for the device.",
+ "format": "byte",
+ "type": "string"
+ },
+ "versionToUpdate": {
+ "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"MqttConfig": {
"description": "The configuration of MQTT for a device registry.",
- "type": "object",
+ "id": "MqttConfig",
"properties": {
"mqttEnabledState": {
- "enumDescriptions": [
- "No MQTT state specified. If not specified, MQTT will be enabled by default.",
- "Enables a MQTT connection.",
- "Disables a MQTT connection."
- ],
+ "description": "If enabled, allows connections using the MQTT protocol. Otherwise, MQTT\nconnections to this registry will fail.",
"enum": [
"MQTT_STATE_UNSPECIFIED",
"MQTT_ENABLED",
"MQTT_DISABLED"
],
- "description": "If enabled, allows connections using the MQTT protocol. Otherwise, MQTT\nconnections to this registry will fail.",
+ "enumDescriptions": [
+ "No MQTT state specified. If not specified, MQTT will be enabled by default.",
+ "Enables a MQTT connection.",
+ "Disables a MQTT connection."
+ ],
"type": "string"
}
},
- "id": "MqttConfig"
+ "type": "object"
},
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "id": "Policy",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
"type": "string"
},
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "version": {
+ "description": "Deprecated.",
"format": "int32",
"type": "integer"
}
},
- "id": "Status"
+ "type": "object"
},
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
+ "PublicKeyCertificate": {
+ "description": "A public key certificate format and data.",
+ "id": "PublicKeyCertificate",
"properties": {
- "condition": {
- "$ref": "Expr",
- "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
+ "certificate": {
+ "description": "The certificate data.",
+ "type": "string"
},
- "members": {
- "type": "array",
+ "format": {
+ "description": "The certificate format.",
+ "enum": [
+ "UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT",
+ "X509_CERTIFICATE_PEM"
+ ],
+ "enumDescriptions": [
+ "The format has not been specified. This is an invalid default value and\nmust not be used.",
+ "An X.509v3 certificate ([RFC5280](https://www.ietf.org/rfc/rfc5280.txt)),\nencoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and\n`-----END CERTIFICATE-----`."
+ ],
+ "type": "string"
+ },
+ "x509Details": {
+ "$ref": "X509CertificateDetails",
+ "description": "[Output only] The certificate details. Used only for X.509 certificates."
+ }
+ },
+ "type": "object"
+ },
+ "PublicKeyCredential": {
+ "description": "A public key format and data.",
+ "id": "PublicKeyCredential",
+ "properties": {
+ "format": {
+ "description": "The format of the key.",
+ "enum": [
+ "UNSPECIFIED_PUBLIC_KEY_FORMAT",
+ "RSA_PEM",
+ "RSA_X509_PEM",
+ "ES256_PEM",
+ "ES256_X509_PEM"
+ ],
+ "enumDescriptions": [
+ "The format has not been specified. This is an invalid default value and\nmust not be used.",
+ "An RSA public key encoded in base64, and wrapped by\n`-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be\nused to verify `RS256` signatures in JWT tokens ([RFC7518](\nhttps://www.ietf.org/rfc/rfc7518.txt)).",
+ "As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.",
+ "Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in\nbase64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END\nPUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256`\nalgorithm ([RFC7518](https://www.ietf.org/rfc/rfc7518.txt)). This curve is\ndefined in [OpenSSL](https://www.openssl.org/) as the `prime256v1` curve.",
+ "As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`."
+ ],
+ "type": "string"
+ },
+ "key": {
+ "description": "The key data.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegistryCredential": {
+ "description": "A server-stored registry credential used to validate device credentials.",
+ "id": "RegistryCredential",
+ "properties": {
+ "publicKeyCertificate": {
+ "$ref": "PublicKeyCertificate",
+ "description": "A public key certificate used to verify the device credentials."
+ }
+ },
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "id": "SetIamPolicyRequest",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "type": "object"
+ },
+ "StateNotificationConfig": {
+ "description": "The configuration for notification of new states received from the device.",
+ "id": "StateNotificationConfig",
+ "properties": {
+ "pubsubTopicName": {
+ "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
+ "type": "array"
}
},
- "id": "Binding"
- },
- "Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
- "properties": {
- "description": {
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "expression": {
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
- "type": "string"
- },
- "title": {
- "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
- "type": "string"
- },
- "location": {
- "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
- "type": "string"
- }
- },
- "id": "Expr"
- },
- "ModifyCloudToDeviceConfigRequest": {
- "properties": {
- "versionToUpdate": {
- "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.",
- "format": "int64",
- "type": "string"
- },
- "binaryData": {
- "description": "The configuration data for the device.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ModifyCloudToDeviceConfigRequest",
- "description": "Request for `ModifyCloudToDeviceConfig`.",
"type": "object"
},
- "ListDeviceStatesResponse": {
- "id": "ListDeviceStatesResponse",
- "description": "Response for `ListDeviceStates`.",
- "type": "object",
- "properties": {
- "deviceStates": {
- "description": "The last few device states. States are listed in descending order of server\nupdate time, starting from the most recent one.",
- "type": "array",
- "items": {
- "$ref": "DeviceState"
- }
- }
- }
- },
"TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
}
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
"type": "object"
},
- "GetIamPolicyRequest": {
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {}
- }
- },
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "Cloud Iot",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloudiot": {
- "description": "Register and manage devices in the Google Cloud IoT service"
+ "X509CertificateDetails": {
+ "description": "Details of an X.509 certificate. For informational purposes only.",
+ "id": "X509CertificateDetails",
+ "properties": {
+ "expiryTime": {
+ "description": "The time the certificate becomes invalid.",
+ "format": "google-datetime",
+ "type": "string"
},
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ "issuer": {
+ "description": "The entity that signed the certificate.",
+ "type": "string"
+ },
+ "publicKeyType": {
+ "description": "The type of public key in the certificate.",
+ "type": "string"
+ },
+ "signatureAlgorithm": {
+ "description": "The algorithm used to sign the certificate.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The time the certificate becomes valid.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "subject": {
+ "description": "The entity the certificate and public key belong to.",
+ "type": "string"
}
- }
- }
- },
- "rootUrl": "https://cloudiot.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudiot",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud IoT API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "resources": {
- "registries": {
- "methods": {
- "list": {
- "description": "Lists device registries.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListDeviceRegistriesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "parent": {
- "description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call, and\nthat the system should return the next page of data."
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
- "id": "cloudiot.projects.locations.registries.list",
- "path": "v1/{+parent}/registries"
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "cloudiot.projects.locations.registries.setIamPolicy"
- },
- "create": {
- "id": "cloudiot.projects.locations.registries.create",
- "path": "v1/{+parent}/registries",
- "request": {
- "$ref": "DeviceRegistry"
- },
- "description": "Creates a device registry that contains devices.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries"
- },
- "getIamPolicy": {
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
- "id": "cloudiot.projects.locations.registries.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config`, `http_config`,\n`mqtt_config`, and `state_notification_config`.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "id": "cloudiot.projects.locations.registries.patch",
- "path": "v1/{+name}",
- "request": {
- "$ref": "DeviceRegistry"
- },
- "description": "Updates a device registry configuration."
- },
- "get": {
- "description": "Gets a device registry configuration.",
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.get"
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudiot.projects.locations.registries.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
- },
- "delete": {
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.delete",
- "description": "Deletes a device registry configuration.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}"
- }
- },
- "resources": {
- "devices": {
- "resources": {
- "configVersions": {
- "methods": {
- "list": {
- "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).",
- "response": {
- "$ref": "ListDeviceConfigVersionsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "numVersions": {
- "location": "query",
- "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
- "path": "v1/{+name}/configVersions",
- "id": "cloudiot.projects.locations.registries.devices.configVersions.list"
- }
- }
- },
- "states": {
- "methods": {
- "list": {
- "path": "v1/{+name}/states",
- "id": "cloudiot.projects.locations.registries.devices.states.list",
- "description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).",
- "response": {
- "$ref": "ListDeviceStatesResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- },
- "numStates": {
- "type": "integer",
- "location": "query",
- "description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
- "format": "int32"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states"
- }
- }
- }
- },
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "id": "cloudiot.projects.locations.registries.devices.delete",
- "path": "v1/{+name}",
- "description": "Deletes a device."
- },
- "list": {
- "id": "cloudiot.projects.locations.registries.devices.list",
- "path": "v1/{+parent}/devices",
- "description": "List devices in a device registry.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListDevicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data.",
- "type": "string",
- "location": "query"
- },
- "fieldMask": {
- "type": "string",
- "location": "query",
- "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.",
- "format": "google-fieldmask"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
- "format": "int32",
- "type": "integer"
- },
- "deviceIds": {
- "repeated": true,
- "location": "query",
- "description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries.",
- "type": "string"
- },
- "parent": {
- "location": "path",
- "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- },
- "deviceNumIds": {
- "location": "query",
- "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.",
- "format": "uint64",
- "type": "string",
- "repeated": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices"
- },
- "create": {
- "request": {
- "$ref": "Device"
- },
- "description": "Creates a device in a device registry.",
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
- "path": "v1/{+parent}/devices",
- "id": "cloudiot.projects.locations.registries.devices.create"
- },
- "modifyCloudToDeviceConfig": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`."
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
- "path": "v1/{+name}:modifyCloudToDeviceConfig",
- "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
- "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
- "request": {
- "$ref": "ModifyCloudToDeviceConfigRequest"
- },
- "response": {
- "$ref": "DeviceConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST"
- },
- "patch": {
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `enabled_state`, and `metadata`",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.patch",
- "description": "Updates a device.",
- "request": {
- "$ref": "Device"
- }
- },
- "get": {
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`."
- },
- "fieldMask": {
- "description": "The fields of the `Device` resource to be returned in the response. If the\nfield mask is unset or empty, all fields are returned.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.get",
- "description": "Gets details about a device."
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
+ },
+ "type": "object"
}
},
+ "servicePath": "",
+ "title": "Cloud IoT API",
"version": "v1",
- "baseUrl": "https://cloudiot.googleapis.com/"
-}
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudiot/v1/cloudiot-gen.go b/vendor/google.golang.org/api/cloudiot/v1/cloudiot-gen.go
index fc1d8462b..51dcf6d06 100644
--- a/vendor/google.golang.org/api/cloudiot/v1/cloudiot-gen.go
+++ b/vendor/google.golang.org/api/cloudiot/v1/cloudiot-gen.go
@@ -1,4 +1,4 @@
-// Package cloudiot provides access to the Google Cloud IoT API.
+// Package cloudiot provides access to the Cloud IoT API.
//
// See https://cloud.google.com/iot
//
@@ -147,174 +147,8 @@ type ProjectsLocationsRegistriesDevicesStatesService struct {
s *Service
}
-// AuditConfig: 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
-// AuditConfig 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.
-type AuditConfig struct {
- // AuditLogConfigs: The configuration for logging of each type of
- // permission.
- // Next ID: 4
- AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
-
- ExemptedMembers []string `json:"exemptedMembers,omitempty"`
-
- // Service: 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 `json:"service,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-
- // NullFields is a list of field names (e.g. "AuditLogConfigs") to
- // include in API requests with the JSON null value. By default, fields
- // with empty values are omitted from API requests. However, any field
- // with an empty value appearing in NullFields will be sent to the
- // server as null. It is an error if a field in this list has a
- // non-empty value. This may be used to include null fields in Patch
- // requests.
- NullFields []string `json:"-"`
-}
-
-func (s *AuditConfig) MarshalJSON() ([]byte, error) {
- type NoMethod AuditConfig
- raw := NoMethod(*s)
- return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
-}
-
-// AuditLogConfig: 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.
-type AuditLogConfig struct {
- // ExemptedMembers: Specifies the identities that do not cause logging
- // for this type of
- // permission.
- // Follows the same format of Binding.members.
- ExemptedMembers []string `json:"exemptedMembers,omitempty"`
-
- // LogType: The log type that this config enables.
- //
- // Possible values:
- // "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
- // "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
- // "DATA_WRITE" - Data writes. Example: CloudSQL Users create
- // "DATA_READ" - Data reads. Example: CloudSQL Users list
- LogType string `json:"logType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-
- // NullFields is a list of field names (e.g. "ExemptedMembers") to
- // include in API requests with the JSON null value. By default, fields
- // with empty values are omitted from API requests. However, any field
- // with an empty value appearing in NullFields will be sent to the
- // server as null. It is an error if a field in this list has a
- // non-empty value. This may be used to include null fields in Patch
- // requests.
- NullFields []string `json:"-"`
-}
-
-func (s *AuditLogConfig) MarshalJSON() ([]byte, error) {
- type NoMethod AuditLogConfig
- raw := NoMethod(*s)
- return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
-}
-
// Binding: Associates `members` with a `role`.
type Binding struct {
- // Condition: 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.
- // This field is GOOGLE_INTERNAL.
- Condition *Expr `json:"condition,omitempty"`
-
// Members: Specifies the identities requesting access for a Cloud
// Platform resource.
// `members` can have the following values:
@@ -356,7 +190,7 @@ type Binding struct {
// Required
Role string `json:"role,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Condition") to
+ // ForceSendFields is a list of field names (e.g. "Members") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -364,7 +198,7 @@ type Binding struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Condition") to include in
+ // NullFields is a list of field names (e.g. "Members") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
@@ -454,11 +288,15 @@ type Device struct {
// minutes.
LastEventTime string `json:"lastEventTime,omitempty"`
- // LastHeartbeatTime: [Output only] The last time a heartbeat was
- // received. Timestamps are
- // periodically collected and written to storage; they may be stale by a
- // few
- // minutes. This field is only for devices connecting through MQTT.
+ // LastHeartbeatTime: [Output only] The last time an MQTT `PINGREQ` was
+ // received. This field
+ // applies only to devices connecting through MQTT. MQTT clients usually
+ // only
+ // send `PINGREQ` messages if the connection is idle, and no other
+ // messages
+ // have been sent. Timestamps are periodically collected and written
+ // to
+ // storage; they may be stale by a few minutes.
LastHeartbeatTime string `json:"lastHeartbeatTime,omitempty"`
// LastStateTime: [Output only] The last time a state event was
@@ -474,9 +312,8 @@ type Device struct {
// contextual
// information for the device.
//
- // Keys must conform to the regular expression [a-zA-Z0-9-_]+ and be
- // less than
- // 128 bytes in length.
+ // Keys must conform to the regular expression a-zA-Z+ and
+ // be less than 128 bytes in length.
//
// Values are free-form strings. Each value must be less than or equal
// to 32
@@ -687,15 +524,17 @@ type DeviceRegistry struct {
// the
// device and acknowledged by Cloud IoT Core are guaranteed to
// be
- // delivered to Cloud Pub/Sub. Only the first configuration is used. If
- // you
- // try to publish a device telemetry event using MQTT without specifying
+ // delivered to Cloud Pub/Sub. If multiple configurations match a
+ // message,
+ // only the first matching configuration is used. If you try to publish
// a
- // Cloud Pub/Sub topic for the device's registry, the connection
- // closes
- // automatically. If you try to do so using an HTTP connection, an
- // error
- // is returned.
+ // device telemetry event using MQTT without specifying a Cloud Pub/Sub
+ // topic
+ // for the device's registry, the connection closes automatically. If
+ // you try
+ // to do so using an HTTP connection, an error is returned. Up to
+ // 10
+ // configurations may be provided.
EventNotificationConfigs []*EventNotificationConfig `json:"eventNotificationConfigs,omitempty"`
// HttpConfig: The DeviceService (HTTP) configuration for this device
@@ -806,7 +645,7 @@ type Empty struct {
googleapi.ServerResponse `json:"-"`
}
-// EventNotificationConfig: The configuration to forward telemetry
+// EventNotificationConfig: The configuration for forwarding telemetry
// events.
type EventNotificationConfig struct {
// PubsubTopicName: A Cloud Pub/Sub topic name. For
@@ -814,6 +653,15 @@ type EventNotificationConfig struct {
// `projects/myProject/topics/deviceEvents`.
PubsubTopicName string `json:"pubsubTopicName,omitempty"`
+ // SubfolderMatches: If the subfolder name matches this string exactly,
+ // this configuration will
+ // be used. The string must not include the leading '/' character. If
+ // empty,
+ // all strings are matched. This field is used only for telemetry
+ // events;
+ // subfolders are not supported for state changes.
+ SubfolderMatches string `json:"subfolderMatches,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "PubsubTopicName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -838,60 +686,6 @@ func (s *EventNotificationConfig) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Expr: Represents an expression text. Example:
-//
-// title: "User account presence"
-// description: "Determines whether the request has a user account"
-// expression: "size(request.user) > 0"
-type Expr struct {
- // Description: 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 `json:"description,omitempty"`
-
- // Expression: 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 `json:"expression,omitempty"`
-
- // Location: 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 `json:"location,omitempty"`
-
- // Title: 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 `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-
- // NullFields is a list of field names (e.g. "Description") to include
- // in API requests with the JSON null value. By default, fields with
- // empty values are omitted from API requests. However, any field with
- // an empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
- NullFields []string `json:"-"`
-}
-
-func (s *Expr) MarshalJSON() ([]byte, error) {
- type NoMethod Expr
- raw := NoMethod(*s)
- return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
-}
-
// GetIamPolicyRequest: Request message for `GetIamPolicy` method.
type GetIamPolicyRequest struct {
}
@@ -1197,10 +991,6 @@ func (s *MqttConfig) MarshalJSON() ([]byte, error) {
// For a description of IAM and its features, see the
// [IAM developer's guide](https://cloud.google.com/iam/docs).
type Policy struct {
- // AuditConfigs: Specifies cloud audit logging configuration for this
- // policy.
- AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
-
// Bindings: Associates a list of `members` to a `role`.
// `bindings` with no members will result in an error.
Bindings []*Binding `json:"bindings,omitempty"`
@@ -1225,8 +1015,6 @@ type Policy struct {
// policy is overwritten blindly.
Etag string `json:"etag,omitempty"`
- IamOwned bool `json:"iamOwned,omitempty"`
-
// Version: Deprecated.
Version int64 `json:"version,omitempty"`
@@ -1234,7 +1022,7 @@ type Policy struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "AuditConfigs") to
+ // ForceSendFields is a list of field names (e.g. "Bindings") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -1242,10 +1030,10 @@ type Policy struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "AuditConfigs") to include
- // in API requests with the JSON null value. By default, fields with
- // empty values are omitted from API requests. However, any field with
- // an empty value appearing in NullFields will be sent to the server as
+ // NullFields is a list of field names (e.g. "Bindings") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
@@ -1407,15 +1195,6 @@ type SetIamPolicyRequest struct {
// might reject them.
Policy *Policy `json:"policy,omitempty"`
- // UpdateMask: 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 `json:"updateMask,omitempty"`
-
// ForceSendFields is a list of field names (e.g. "Policy") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -3696,8 +3475,7 @@ func (r *ProjectsLocationsRegistriesDevicesService) Patch(name string, device *D
// The field mask must not be empty, and it must not contain fields
// that
// are immutable or only set by the server.
-// Mutable top-level fields: `credentials`, `enabled_state`, and
-// `metadata`
+// Mutable top-level fields: `credentials`, `blocked`, and `metadata`
func (c *ProjectsLocationsRegistriesDevicesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsRegistriesDevicesPatchCall {
c.urlParams_.Set("updateMask", updateMask)
return c
@@ -3805,7 +3583,7 @@ func (c *ProjectsLocationsRegistriesDevicesPatchCall) Do(opts ...googleapi.CallO
// "type": "string"
// },
// "updateMask": {
- // "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `enabled_state`, and `metadata`",
+ // "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `blocked`, and `metadata`",
// "format": "google-fieldmask",
// "location": "query",
// "type": "string"
diff --git a/vendor/google.golang.org/api/cloudkms/v1/cloudkms-api.json b/vendor/google.golang.org/api/cloudkms/v1/cloudkms-api.json
index ee3dc126f..93885058e 100644
--- a/vendor/google.golang.org/api/cloudkms/v1/cloudkms-api.json
+++ b/vendor/google.golang.org/api/cloudkms/v1/cloudkms-api.json
@@ -1,473 +1,4 @@
{
- "kind": "discovery#restDescription",
- "description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
- "servicePath": "",
- "basePath": "",
- "revision": "20180117",
- "documentationLink": "https://cloud.google.com/kms/",
- "id": "cloudkms:v1",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- },
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "SetIamPolicyRequest"
- },
- "DecryptRequest": {
- "description": "Request message for KeyManagementService.Decrypt.",
- "type": "object",
- "properties": {
- "ciphertext": {
- "description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
- "format": "byte",
- "type": "string"
- },
- "additionalAuthenticatedData": {
- "description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "DecryptRequest"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "EncryptRequest": {
- "description": "Request message for KeyManagementService.Encrypt.",
- "type": "object",
- "properties": {
- "plaintext": {
- "description": "Required. The data to encrypt. Must be no larger than 64KiB.",
- "format": "byte",
- "type": "string"
- },
- "additionalAuthenticatedData": {
- "description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "EncryptRequest"
- },
- "ListCryptoKeyVersionsResponse": {
- "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
- "type": "object",
- "properties": {
- "cryptoKeyVersions": {
- "description": "The list of CryptoKeyVersions.",
- "type": "array",
- "items": {
- "$ref": "CryptoKeyVersion"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.",
- "type": "string"
- },
- "totalSize": {
- "description": "The total number of CryptoKeyVersions that matched the\nquery.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListCryptoKeyVersionsResponse"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "labels": {
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: `\"us-east1\"`.",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "ListCryptoKeysResponse": {
- "description": "Response message for KeyManagementService.ListCryptoKeys.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeysRequest.page_token to retrieve the next page of results.",
- "type": "string"
- },
- "cryptoKeys": {
- "description": "The list of CryptoKeys.",
- "type": "array",
- "items": {
- "$ref": "CryptoKey"
- }
- },
- "totalSize": {
- "description": "The total number of CryptoKeys that matched the query.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListCryptoKeysResponse"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "DestroyCryptoKeyVersionRequest": {
- "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
- "type": "object",
- "properties": {},
- "id": "DestroyCryptoKeyVersionRequest"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string"
- },
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AuditLogConfig"
- },
- "CryptoKey": {
- "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
- "type": "object",
- "properties": {
- "purpose": {
- "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
- ],
- "enum": [
- "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
- "ENCRYPT_DECRYPT"
- ]
- },
- "nextRotationTime": {
- "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels with user-defined metadata. For more information, see\n[Labeling Keys](/kms/docs/labeling-keys).",
- "type": "object"
- },
- "createTime": {
- "description": "Output only. The time at which this CryptoKey was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "rotationPeriod": {
- "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
- "format": "google-duration",
- "type": "string"
- },
- "primary": {
- "$ref": "CryptoKeyVersion",
- "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion."
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "type": "string"
- }
- },
- "id": "CryptoKey"
- },
- "DecryptResponse": {
- "description": "Response message for KeyManagementService.Decrypt.",
- "type": "object",
- "properties": {
- "plaintext": {
- "description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "DecryptResponse"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "EncryptResponse": {
- "description": "Response message for KeyManagementService.Encrypt.",
- "type": "object",
- "properties": {
- "ciphertext": {
- "description": "The encrypted data.",
- "format": "byte",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the CryptoKeyVersion used in encryption.",
- "type": "string"
- }
- },
- "id": "EncryptResponse"
- },
- "KeyRing": {
- "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
- "type": "object",
- "properties": {
- "createTime": {
- "description": "Output only. The time at which this KeyRing was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
- "type": "string"
- }
- },
- "id": "KeyRing"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- }
- },
- "id": "ListLocationsResponse"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
- "type": "object",
- "properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- }
- },
- "id": "Policy"
- },
- "UpdateCryptoKeyPrimaryVersionRequest": {
- "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
- "type": "object",
- "properties": {
- "cryptoKeyVersionId": {
- "description": "The id of the child CryptoKeyVersion to use as primary.",
- "type": "string"
- }
- },
- "id": "UpdateCryptoKeyPrimaryVersionRequest"
- },
- "RestoreCryptoKeyVersionRequest": {
- "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
- "type": "object",
- "properties": {},
- "id": "RestoreCryptoKeyVersionRequest"
- },
- "ListKeyRingsResponse": {
- "description": "Response message for KeyManagementService.ListKeyRings.",
- "type": "object",
- "properties": {
- "keyRings": {
- "description": "The list of KeyRings.",
- "type": "array",
- "items": {
- "$ref": "KeyRing"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.",
- "type": "string"
- },
- "totalSize": {
- "description": "The total number of KeyRings that matched the query.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListKeyRingsResponse"
- },
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- }
- },
- "id": "AuditConfig"
- },
- "CryptoKeyVersion": {
- "description": "A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.\n\nFor security reasons, the raw cryptographic key material represented by a\nCryptoKeyVersion can never be viewed or exported. It can only be used to\nencrypt or decrypt data when an authorized user or application invokes Cloud\nKMS.",
- "type": "object",
- "properties": {
- "createTime": {
- "description": "Output only. The time at which this CryptoKeyVersion was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "Not specified.",
- "This version may be used in Encrypt and\nDecrypt requests.",
- "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
- "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
- "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
- ],
- "enum": [
- "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DESTROYED",
- "DESTROY_SCHEDULED"
- ],
- "description": "The current state of the CryptoKeyVersion.",
- "type": "string"
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
- "type": "string"
- },
- "destroyEventTime": {
- "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
- "format": "google-datetime",
- "type": "string"
- },
- "destroyTime": {
- "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "CryptoKeyVersion"
- }
- },
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud KMS",
"auth": {
"oauth2": {
"scopes": {
@@ -477,78 +8,178 @@
}
}
},
- "rootUrl": "https://cloudkms.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudkms",
+ "basePath": "",
+ "baseUrl": "https://cloudkms.googleapis.com/",
"batchPath": "batch",
- "title": "Google Cloud Key Management Service (KMS) API",
+ "canonicalName": "Cloud KMS",
+ "description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/kms/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudkms:v1",
+ "kind": "discovery#restDescription",
+ "name": "cloudkms",
+ "ownerDomain": "google.com",
"ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
- "list": {
+ "get": {
+ "description": "Gets information about a location.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
- "response": {
- "$ref": "ListLocationsResponse"
+ "id": "cloudkms.projects.locations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the location.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
- "location": "query",
"description": "The standard list filter.",
+ "location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
+ "required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations",
- "id": "cloudkms.projects.locations.list",
"path": "v1/{+name}/locations",
- "description": "Lists information about the supported locations for this service."
- },
- "get": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.get",
- "description": "Get information about a location.",
"response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name for the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
+ "$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
@@ -558,657 +189,657 @@
"resources": {
"keyRings": {
"methods": {
- "list": {
- "response": {
- "$ref": "ListKeyRingsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
- "path": "v1/{+parent}/keyRings",
- "id": "cloudkms.projects.locations.keyRings.list",
- "description": "Lists KeyRings."
- },
"create": {
- "response": {
- "$ref": "KeyRing"
- },
+ "description": "Create a new KeyRing in a given Project and Location.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.create",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
"parameters": {
+ "keyRingId": {
+ "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "location": "query",
+ "type": "string"
+ },
"parent": {
"description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "keyRingId": {
- "location": "query",
- "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
"path": "v1/{+parent}/keyRings",
- "id": "cloudkms.projects.locations.keyRings.create",
"request": {
"$ref": "KeyRing"
},
- "description": "Create a new KeyRing in a given Project and Location."
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Returns metadata for a given KeyRing.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.keyRings.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the KeyRing to get.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.keyRings.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists KeyRings.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.keyRings.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/keyRings",
+ "response": {
+ "$ref": "ListKeyRingsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.setIamPolicy"
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.getIamPolicy"
- },
- "get": {
- "response": {
- "$ref": "KeyRing"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the KeyRing to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.get",
- "description": "Returns metadata for a given KeyRing."
+ ]
},
"testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.testIamPermissions",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
+ "required": true,
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
- }
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
},
"resources": {
"cryptoKeys": {
"methods": {
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "create": {
+ "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
"httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
"parameterOrder": [
- "resource"
+ "parent"
],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
"parameters": {
- "resource": {
+ "cryptoKeyId": {
+ "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
"location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ "type": "string"
}
},
+ "path": "v1/{+parent}/cryptoKeys",
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "response": {
+ "$ref": "CryptoKey"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
+ ]
},
"decrypt": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
- "path": "v1/{+name}:decrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
- "request": {
- "$ref": "DecryptRequest"
- },
"description": "Decrypts data that was protected by Encrypt.",
- "response": {
- "$ref": "DecryptResponse"
- },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
"parameters": {
"name": {
"description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
+ "required": true,
+ "type": "string"
}
},
+ "path": "v1/{+name}:decrypt",
+ "request": {
+ "$ref": "DecryptRequest"
+ },
+ "response": {
+ "$ref": "DecryptResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "list": {
- "description": "Lists CryptoKeys.",
- "response": {
- "$ref": "ListCryptoKeysResponse"
- },
+ "encrypt": {
+ "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
"parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "name"
],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
+ "name": {
+ "description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "path": "v1/{+parent}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list"
- },
- "encrypt": {
+ "path": "v1/{+name}:encrypt",
"request": {
"$ref": "EncryptRequest"
},
- "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
"response": {
"$ref": "EncryptResponse"
},
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
- "path": "v1/{+name}:encrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt"
- },
- "setIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "create": {
- "request": {
- "$ref": "CryptoKey"
- },
- "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "CryptoKey"
- },
- "parameters": {
- "parent": {
- "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- },
- "cryptoKeyId": {
- "location": "query",
- "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
- "path": "v1/{+parent}/cryptoKeys"
- },
- "updatePrimaryVersion": {
- "request": {
- "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
- },
- "description": "Update the version of a CryptoKey that will be used in Encrypt",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKey"
- },
- "parameters": {
- "name": {
- "description": "The resource name of the CryptoKey to update.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
- "path": "v1/{+name}:updatePrimaryVersion"
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy"
- },
- "patch": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
- "path": "v1/{+name}",
- "request": {
- "$ref": "CryptoKey"
- },
- "description": "Update a CryptoKey.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKey"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
- "response": {
- "$ref": "CryptoKey"
- },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
- "location": "path",
"description": "The name of the CryptoKey to get.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ "type": "string"
}
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "CryptoKey"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
+ "parameterOrder": [
+ "resource"
],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists CryptoKeys.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/cryptoKeys",
+ "response": {
+ "$ref": "ListCryptoKeysResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Update a CryptoKey.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "httpMethod": "PATCH",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
"path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get"
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "updatePrimaryVersion": {
+ "description": "Update the version of a CryptoKey that will be used in Encrypt",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the CryptoKey to update.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:updatePrimaryVersion",
+ "request": {
+ "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
+ },
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
},
"resources": {
"cryptoKeyVersions": {
"methods": {
- "restore": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
- "path": "v1/{+name}:restore",
- "request": {
- "$ref": "RestoreCryptoKeyVersionRequest"
- },
- "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
+ "create": {
+ "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
"httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
"parameterOrder": [
- "name"
+ "parent"
],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
"response": {
"$ref": "CryptoKeyVersion"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "destroy": {
+ "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ "parameterOrder": [
+ "name"
+ ],
"parameters": {
"name": {
- "description": "The resource name of the CryptoKeyVersion to restore.",
- "required": true,
- "type": "string",
+ "description": "The resource name of the CryptoKeyVersion to destroy.",
+ "location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
+ "required": true,
+ "type": "string"
}
},
+ "path": "v1/{+name}:destroy",
+ "request": {
+ "$ref": "DestroyCryptoKeyVersionRequest"
+ },
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Returns metadata for a given CryptoKeyVersion.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the CryptoKeyVersion to get.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists CryptoKeyVersions.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "response": {
+ "$ref": "ListCryptoKeyVersionsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
- "request": {
- "$ref": "CryptoKeyVersion"
- },
"description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
"httpMethod": "PATCH",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
"parameters": {
+ "name": {
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
"updateMask": {
"description": "Required list of fields to be updated in this request.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
+ "location": "query",
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
- "path": "v1/{+name}"
- },
- "get": {
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the CryptoKeyVersion to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
"path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
- "description": "Returns metadata for a given CryptoKeyVersion."
- },
- "list": {
- "description": "Lists CryptoKeyVersions.",
- "response": {
- "$ref": "ListCryptoKeyVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list"
- },
- "create": {
- "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
"request": {
"$ref": "CryptoKeyVersion"
},
"response": {
"$ref": "CryptoKeyVersion"
},
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create"
+ ]
},
- "destroy": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
- "path": "v1/{+name}:destroy",
- "request": {
- "$ref": "DestroyCryptoKeyVersionRequest"
- },
- "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
+ "restore": {
+ "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
"httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
"parameters": {
"name": {
+ "description": "The resource name of the CryptoKeyVersion to restore.",
"location": "path",
- "description": "The resource name of the CryptoKeyVersion to destroy.",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
+ "type": "string"
}
},
+ "path": "v1/{+name}:restore",
+ "request": {
+ "$ref": "RestoreCryptoKeyVersionRequest"
+ },
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
@@ -1224,94 +855,468 @@
}
}
},
- "parameters": {
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
+ "revision": "20180316",
+ "rootUrl": "https://cloudkms.googleapis.com/",
+ "schemas": {
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "id": "AuditConfig",
+ "properties": {
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "id": "AuditLogConfig",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logType": {
+ "description": "The log type that this config enables.",
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "CryptoKey": {
+ "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
+ "id": "CryptoKey",
+ "properties": {
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKey was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels with user-defined metadata. For more information, see\n[Labeling Keys](/kms/docs/labeling-keys).",
+ "type": "object"
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "type": "string"
+ },
+ "nextRotationTime": {
+ "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "primary": {
+ "$ref": "CryptoKeyVersion",
+ "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion."
+ },
+ "purpose": {
+ "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
+ "enum": [
+ "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
+ "ENCRYPT_DECRYPT"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
+ ],
+ "type": "string"
+ },
+ "rotationPeriod": {
+ "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "CryptoKeyVersion": {
+ "description": "A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.\n\nFor security reasons, the raw cryptographic key material represented by a\nCryptoKeyVersion can never be viewed or exported. It can only be used to\nencrypt or decrypt data when an authorized user or application invokes Cloud\nKMS.",
+ "id": "CryptoKeyVersion",
+ "properties": {
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKeyVersion was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "destroyEventTime": {
+ "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "destroyTime": {
+ "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The current state of the CryptoKeyVersion.",
+ "enum": [
+ "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
+ "ENABLED",
+ "DISABLED",
+ "DESTROYED",
+ "DESTROY_SCHEDULED"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "This version may be used in Encrypt and\nDecrypt requests.",
+ "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
+ "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
+ "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
+ "DecryptRequest": {
+ "description": "Request message for KeyManagementService.Decrypt.",
+ "id": "DecryptRequest",
+ "properties": {
+ "additionalAuthenticatedData": {
+ "description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
+ "format": "byte",
+ "type": "string"
+ },
+ "ciphertext": {
+ "description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "DecryptResponse": {
+ "description": "Response message for KeyManagementService.Decrypt.",
+ "id": "DecryptResponse",
+ "properties": {
+ "plaintext": {
+ "description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "DestroyCryptoKeyVersionRequest": {
+ "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
+ "id": "DestroyCryptoKeyVersionRequest",
+ "properties": {},
+ "type": "object"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "EncryptRequest": {
+ "description": "Request message for KeyManagementService.Encrypt.",
+ "id": "EncryptRequest",
+ "properties": {
+ "additionalAuthenticatedData": {
+ "description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.",
+ "format": "byte",
+ "type": "string"
+ },
+ "plaintext": {
+ "description": "Required. The data to encrypt. Must be no larger than 64KiB.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
+ "EncryptResponse": {
+ "description": "Response message for KeyManagementService.Encrypt.",
+ "id": "EncryptResponse",
+ "properties": {
+ "ciphertext": {
+ "description": "The encrypted data.",
+ "format": "byte",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
+ "KeyRing": {
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "id": "KeyRing",
+ "properties": {
+ "createTime": {
+ "description": "Output only. The time at which this KeyRing was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
+ "ListCryptoKeyVersionsResponse": {
+ "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
+ "id": "ListCryptoKeyVersionsResponse",
+ "properties": {
+ "cryptoKeyVersions": {
+ "description": "The list of CryptoKeyVersions.",
+ "items": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.",
+ "type": "string"
+ },
+ "totalSize": {
+ "description": "The total number of CryptoKeyVersions that matched the\nquery.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
},
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "ListCryptoKeysResponse": {
+ "description": "Response message for KeyManagementService.ListCryptoKeys.",
+ "id": "ListCryptoKeysResponse",
+ "properties": {
+ "cryptoKeys": {
+ "description": "The list of CryptoKeys.",
+ "items": {
+ "$ref": "CryptoKey"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeysRequest.page_token to retrieve the next page of results.",
+ "type": "string"
+ },
+ "totalSize": {
+ "description": "The total number of CryptoKeys that matched the query.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ListKeyRingsResponse": {
+ "description": "Response message for KeyManagementService.ListKeyRings.",
+ "id": "ListKeyRingsResponse",
+ "properties": {
+ "keyRings": {
+ "description": "The list of KeyRings.",
+ "items": {
+ "$ref": "KeyRing"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.",
+ "type": "string"
+ },
+ "totalSize": {
+ "description": "The total number of KeyRings that matched the query.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
+ "properties": {
+ "displayName": {
+ "description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "id": "Policy",
+ "properties": {
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "AuditConfig"
+ },
+ "type": "array"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "RestoreCryptoKeyVersionRequest": {
+ "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
+ "id": "RestoreCryptoKeyVersionRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "id": "SetIamPolicyRequest",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UpdateCryptoKeyPrimaryVersionRequest": {
+ "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
+ "id": "UpdateCryptoKeyPrimaryVersionRequest",
+ "properties": {
+ "cryptoKeyVersionId": {
+ "description": "The id of the child CryptoKeyVersion to use as primary.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
},
+ "servicePath": "",
+ "title": "Google Cloud Key Management Service (KMS) API",
"version": "v1",
- "baseUrl": "https://cloudkms.googleapis.com/"
-}
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudkms/v1/cloudkms-gen.go b/vendor/google.golang.org/api/cloudkms/v1/cloudkms-gen.go
index 9c015ae42..7b7d769ed 100644
--- a/vendor/google.golang.org/api/cloudkms/v1/cloudkms-gen.go
+++ b/vendor/google.golang.org/api/cloudkms/v1/cloudkms-gen.go
@@ -144,7 +144,7 @@ type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService struct {
// log_types
// specified in each AuditConfig are enabled, and the exempted_members
// in each
-// AuditConfig are exempted.
+// AuditLogConfig are exempted.
//
// Example Policy with multiple AuditConfigs:
//
@@ -881,6 +881,11 @@ func (s *ListLocationsResponse) MarshalJSON() ([]byte, error) {
// Location: A resource that represents Google Cloud Platform location.
type Location struct {
+ // DisplayName: The friendly name for this location, typically a nearby
+ // city name.
+ // For example, "Tokyo".
+ DisplayName string `json:"displayName,omitempty"`
+
// Labels: Cross-service attributes for the location. For example
//
// {"cloud.googleapis.com/region": "us-east1"}
@@ -904,7 +909,7 @@ type Location struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Labels") to
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -912,10 +917,10 @@ type Location struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Labels") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
@@ -1181,7 +1186,7 @@ type ProjectsLocationsGetCall struct {
header_ http.Header
}
-// Get: Get information about a location.
+// Get: Gets information about a location.
func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall {
c := &ProjectsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -1282,7 +1287,7 @@ func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location,
}
return ret, nil
// {
- // "description": "Get information about a location.",
+ // "description": "Gets information about a location.",
// "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
// "httpMethod": "GET",
// "id": "cloudkms.projects.locations.get",
diff --git a/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-gen.go b/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-gen.go
index 57208fccd..0f599614a 100644
--- a/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-gen.go
+++ b/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-gen.go
@@ -141,8 +141,8 @@ type DeleteMetricDescriptorResponse struct {
}
func (s *DeleteMetricDescriptorResponse) MarshalJSON() ([]byte, error) {
- type noMethod DeleteMetricDescriptorResponse
- raw := noMethod(*s)
+ type NoMethod DeleteMetricDescriptorResponse
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -171,8 +171,8 @@ type ListMetricDescriptorsRequest struct {
}
func (s *ListMetricDescriptorsRequest) MarshalJSON() ([]byte, error) {
- type noMethod ListMetricDescriptorsRequest
- raw := noMethod(*s)
+ type NoMethod ListMetricDescriptorsRequest
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -214,8 +214,8 @@ type ListMetricDescriptorsResponse struct {
}
func (s *ListMetricDescriptorsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListMetricDescriptorsResponse
- raw := noMethod(*s)
+ type NoMethod ListMetricDescriptorsResponse
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -244,8 +244,8 @@ type ListTimeseriesDescriptorsRequest struct {
}
func (s *ListTimeseriesDescriptorsRequest) MarshalJSON() ([]byte, error) {
- type noMethod ListTimeseriesDescriptorsRequest
- raw := noMethod(*s)
+ type NoMethod ListTimeseriesDescriptorsRequest
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -295,8 +295,8 @@ type ListTimeseriesDescriptorsResponse struct {
}
func (s *ListTimeseriesDescriptorsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListTimeseriesDescriptorsResponse
- raw := noMethod(*s)
+ type NoMethod ListTimeseriesDescriptorsResponse
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -324,8 +324,8 @@ type ListTimeseriesRequest struct {
}
func (s *ListTimeseriesRequest) MarshalJSON() ([]byte, error) {
- type noMethod ListTimeseriesRequest
- raw := noMethod(*s)
+ type NoMethod ListTimeseriesRequest
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -376,8 +376,8 @@ type ListTimeseriesResponse struct {
}
func (s *ListTimeseriesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListTimeseriesResponse
- raw := noMethod(*s)
+ type NoMethod ListTimeseriesResponse
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -421,8 +421,8 @@ type MetricDescriptor struct {
}
func (s *MetricDescriptor) MarshalJSON() ([]byte, error) {
- type noMethod MetricDescriptor
- raw := noMethod(*s)
+ type NoMethod MetricDescriptor
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -454,8 +454,8 @@ type MetricDescriptorLabelDescriptor struct {
}
func (s *MetricDescriptorLabelDescriptor) MarshalJSON() ([]byte, error) {
- type noMethod MetricDescriptorLabelDescriptor
- raw := noMethod(*s)
+ type NoMethod MetricDescriptorLabelDescriptor
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -489,8 +489,8 @@ type MetricDescriptorTypeDescriptor struct {
}
func (s *MetricDescriptorTypeDescriptor) MarshalJSON() ([]byte, error) {
- type noMethod MetricDescriptorTypeDescriptor
- raw := noMethod(*s)
+ type NoMethod MetricDescriptorTypeDescriptor
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -550,18 +550,18 @@ type Point struct {
}
func (s *Point) MarshalJSON() ([]byte, error) {
- type noMethod Point
- raw := noMethod(*s)
+ type NoMethod Point
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *Point) UnmarshalJSON(data []byte) error {
- type noMethod Point
+ type NoMethod Point
var s1 struct {
DoubleValue *gensupport.JSONFloat64 `json:"doubleValue"`
- *noMethod
+ *NoMethod
}
- s1.noMethod = (*noMethod)(s)
+ s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
@@ -603,8 +603,8 @@ type PointDistribution struct {
}
func (s *PointDistribution) MarshalJSON() ([]byte, error) {
- type noMethod PointDistribution
- raw := noMethod(*s)
+ type NoMethod PointDistribution
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -643,19 +643,19 @@ type PointDistributionBucket struct {
}
func (s *PointDistributionBucket) MarshalJSON() ([]byte, error) {
- type noMethod PointDistributionBucket
- raw := noMethod(*s)
+ type NoMethod PointDistributionBucket
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *PointDistributionBucket) UnmarshalJSON(data []byte) error {
- type noMethod PointDistributionBucket
+ type NoMethod PointDistributionBucket
var s1 struct {
LowerBound gensupport.JSONFloat64 `json:"lowerBound"`
UpperBound gensupport.JSONFloat64 `json:"upperBound"`
- *noMethod
+ *NoMethod
}
- s1.noMethod = (*noMethod)(s)
+ s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
@@ -694,18 +694,18 @@ type PointDistributionOverflowBucket struct {
}
func (s *PointDistributionOverflowBucket) MarshalJSON() ([]byte, error) {
- type noMethod PointDistributionOverflowBucket
- raw := noMethod(*s)
+ type NoMethod PointDistributionOverflowBucket
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *PointDistributionOverflowBucket) UnmarshalJSON(data []byte) error {
- type noMethod PointDistributionOverflowBucket
+ type NoMethod PointDistributionOverflowBucket
var s1 struct {
LowerBound gensupport.JSONFloat64 `json:"lowerBound"`
- *noMethod
+ *NoMethod
}
- s1.noMethod = (*noMethod)(s)
+ s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
@@ -743,18 +743,18 @@ type PointDistributionUnderflowBucket struct {
}
func (s *PointDistributionUnderflowBucket) MarshalJSON() ([]byte, error) {
- type noMethod PointDistributionUnderflowBucket
- raw := noMethod(*s)
+ type NoMethod PointDistributionUnderflowBucket
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *PointDistributionUnderflowBucket) UnmarshalJSON(data []byte) error {
- type noMethod PointDistributionUnderflowBucket
+ type NoMethod PointDistributionUnderflowBucket
var s1 struct {
UpperBound gensupport.JSONFloat64 `json:"upperBound"`
- *noMethod
+ *NoMethod
}
- s1.noMethod = (*noMethod)(s)
+ s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
@@ -792,8 +792,8 @@ type Timeseries struct {
}
func (s *Timeseries) MarshalJSON() ([]byte, error) {
- type noMethod Timeseries
- raw := noMethod(*s)
+ type NoMethod Timeseries
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -828,8 +828,8 @@ type TimeseriesDescriptor struct {
}
func (s *TimeseriesDescriptor) MarshalJSON() ([]byte, error) {
- type noMethod TimeseriesDescriptor
- raw := noMethod(*s)
+ type NoMethod TimeseriesDescriptor
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -858,8 +858,8 @@ type TimeseriesDescriptorLabel struct {
}
func (s *TimeseriesDescriptorLabel) MarshalJSON() ([]byte, error) {
- type noMethod TimeseriesDescriptorLabel
- raw := noMethod(*s)
+ type NoMethod TimeseriesDescriptorLabel
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -891,8 +891,8 @@ type TimeseriesPoint struct {
}
func (s *TimeseriesPoint) MarshalJSON() ([]byte, error) {
- type noMethod TimeseriesPoint
- raw := noMethod(*s)
+ type NoMethod TimeseriesPoint
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -925,8 +925,8 @@ type WriteTimeseriesRequest struct {
}
func (s *WriteTimeseriesRequest) MarshalJSON() ([]byte, error) {
- type noMethod WriteTimeseriesRequest
- raw := noMethod(*s)
+ type NoMethod WriteTimeseriesRequest
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -959,8 +959,8 @@ type WriteTimeseriesResponse struct {
}
func (s *WriteTimeseriesResponse) MarshalJSON() ([]byte, error) {
- type noMethod WriteTimeseriesResponse
- raw := noMethod(*s)
+ type NoMethod WriteTimeseriesResponse
+ raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1064,7 +1064,7 @@ func (c *MetricDescriptorsCreateCall) Do(opts ...googleapi.CallOption) (*MetricD
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -1194,7 +1194,7 @@ func (c *MetricDescriptorsDeleteCall) Do(opts ...googleapi.CallOption) (*DeleteM
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -1373,7 +1373,7 @@ func (c *MetricDescriptorsListCall) Do(opts ...googleapi.CallOption) (*ListMetri
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -1651,7 +1651,7 @@ func (c *TimeseriesListCall) Do(opts ...googleapi.CallOption) (*ListTimeseriesRe
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -1882,7 +1882,7 @@ func (c *TimeseriesWriteCall) Do(opts ...googleapi.CallOption) (*WriteTimeseries
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
@@ -2122,7 +2122,7 @@ func (c *TimeseriesDescriptorsListCall) Do(opts ...googleapi.CallOption) (*ListT
},
}
target := &ret
- if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v1/cloudresourcemanager-api.json b/vendor/google.golang.org/api/cloudresourcemanager/v1/cloudresourcemanager-api.json
index ba77c58db..0187a314b 100644
--- a/vendor/google.golang.org/api/cloudresourcemanager/v1/cloudresourcemanager-api.json
+++ b/vendor/google.golang.org/api/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -1,90 +1,378 @@
{
- "ownerDomain": "google.com",
- "name": "cloudresourcemanager",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/",
"batchPath": "batch",
+ "canonicalName": "Cloud Resource Manager",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/resource-manager",
"fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Resource Manager API",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudresourcemanager:v1",
+ "kind": "discovery#restDescription",
+ "name": "cloudresourcemanager",
+ "ownerDomain": "google.com",
"ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
"resources": {
- "liens": {
+ "folders": {
"methods": {
- "delete": {
- "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.",
- "httpMethod": "DELETE",
+ "clearOrgPolicy": {
+ "description": "Clears a `Policy` from a resource.",
+ "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.clearOrgPolicy",
"parameterOrder": [
- "name"
+ "resource"
],
- "response": {
- "$ref": "Empty"
- },
"parameters": {
- "name": {
- "pattern": "^liens/.+$",
+ "resource": {
+ "description": "Name of the resource for the `Policy` to clear.",
"location": "path",
- "description": "The name/identifier of the Lien to delete.",
+ "pattern": "^folders/[^/]+$",
"required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/liens/{liensId}",
- "id": "cloudresourcemanager.liens.delete",
- "path": "v1/{+name}"
- },
- "list": {
- "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.",
- "response": {
- "$ref": "ListLiensResponse"
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "response": {
+ "$ref": "Empty"
},
- "parameterOrder": [],
- "httpMethod": "GET",
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "getEffectiveOrgPolicy": {
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
+ "parameterOrder": [
+ "resource"
],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "resource": {
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
"type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of items to return. This is a suggestion for the server.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
- "type": "string",
- "location": "query"
}
},
- "flatPath": "v1/liens",
- "path": "v1/liens",
- "id": "cloudresourcemanager.liens.list"
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ },
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
+ "getOrgPolicy": {
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
+ "flatPath": "v1/folders/{foldersId}:getOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.getOrgPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource the `Policy` is set on.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getOrgPolicy",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
+ },
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "listAvailableOrgPolicyConstraints": {
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list `Constraints` for.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "listOrgPolicies": {
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "flatPath": "v1/folders/{foldersId}:listOrgPolicies",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.listOrgPolicies",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list Policies for.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:listOrgPolicies",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "setOrgPolicy": {
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
+ "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.setOrgPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:setOrgPolicy",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ },
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "liens": {
+ "methods": {
"create": {
+ "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied.",
+ "flatPath": "v1/liens",
+ "httpMethod": "POST",
"id": "cloudresourcemanager.liens.create",
+ "parameterOrder": [],
+ "parameters": {},
"path": "v1/liens",
"request": {
"$ref": "Lien"
},
- "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "Lien"
},
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "delete": {
+ "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.",
+ "flatPath": "v1/liens/{liensId}",
+ "httpMethod": "DELETE",
+ "id": "cloudresourcemanager.liens.delete",
+ "parameterOrder": [
+ "name"
],
- "flatPath": "v1/liens"
+ "parameters": {
+ "name": {
+ "description": "The name/identifier of the Lien to delete.",
+ "location": "path",
+ "pattern": "^liens/.+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.",
+ "flatPath": "v1/liens",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.liens.list",
+ "parameterOrder": [],
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of items to return. This is a suggestion for the server.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/liens",
+ "response": {
+ "$ref": "ListLiensResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
}
}
},
@@ -92,1374 +380,997 @@
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
+ "flatPath": "v1/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.operations.get",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
+ "description": "The name of the operation resource.",
"location": "path",
- "description": "The name of the operation resource."
+ "pattern": "^operations/.+$",
+ "required": true,
+ "type": "string"
}
},
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.operations.get"
+ ]
}
}
},
- "folders": {
+ "organizations": {
"methods": {
"clearOrgPolicy": {
"description": "Clears a `Policy` from a resource.",
+ "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.clearOrgPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource for the `Policy` to clear.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:clearOrgPolicy",
"request": {
"$ref": "ClearOrgPolicyRequest"
},
"response": {
"$ref": "Empty"
},
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "flatPath": "v1/organizations/{organizationsId}",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.organizations.get",
+ "parameterOrder": [
+ "name"
],
"parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
+ "name": {
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
"location": "path",
- "description": "Name of the resource for the `Policy` to clear.",
+ "pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
- "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.folders.clearOrgPolicy"
- },
- "setOrgPolicy": {
+ "path": "v1/{+name}",
"response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$"
- }
- },
- "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.folders.setOrgPolicy",
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- }
- },
- "listAvailableOrgPolicyConstraints": {
- "description": "Lists `Constraints` that could be applied on the specified resource.",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "Name of the resource to list `Constraints` for.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints"
- },
- "listOrgPolicies": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "parameters": {
- "resource": {
- "description": "Name of the resource to list Policies for.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
+ "$ref": "Organization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/folders/{foldersId}:listOrgPolicies",
- "id": "cloudresourcemanager.folders.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "description": "Lists all the `Policies` set for a particular resource."
- },
- "getOrgPolicy": {
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.folders.getOrgPolicy",
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "request": {
- "$ref": "GetOrgPolicyRequest"
- },
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Name of the resource the `Policy` is set on."
- }
- },
- "flatPath": "v1/folders/{foldersId}:getOrgPolicy"
+ ]
},
"getEffectiveOrgPolicy": {
"description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
"request": {
"$ref": "GetEffectiveOrgPolicyRequest"
},
"response": {
"$ref": "OrgPolicy"
},
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization",
+ "flatPath": "v1/organizations/{organizationsId}:getIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "parameterOrder": [
+ "resource"
],
"parameters": {
"resource": {
- "pattern": "^folders/[^/]+$",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
- "description": "The name of the resource to start computing the effective `Policy`.",
+ "pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
- "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy"
- }
- }
- },
- "projects": {
- "methods": {
- "list": {
- "parameters": {
- "filter": {
- "location": "query",
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
- "format": "int32",
- "type": "integer"
- }
+ "path": "v1/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects",
- "path": "v1/projects",
- "id": "cloudresourcemanager.projects.list",
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method.",
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
+ ]
},
- "setOrgPolicy": {
- "request": {
- "$ref": "SetOrgPolicyRequest"
+ "getOrgPolicy": {
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
+ "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.getOrgPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource the `Policy` is set on.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getOrgPolicy",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
},
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
"response": {
"$ref": "OrgPolicy"
},
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.projects.setOrgPolicy"
- },
- "create": {
- "request": {
- "$ref": "Project"
- },
- "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects",
- "id": "cloudresourcemanager.projects.create",
- "path": "v1/projects"
- },
- "listOrgPolicies": {
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list Policies for."
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}:listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "id": "cloudresourcemanager.projects.listOrgPolicies",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "description": "Lists all the `Policies` set for a particular resource."
+ ]
},
- "get": {
- "httpMethod": "GET",
+ "listAvailableOrgPolicyConstraints": {
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
"parameterOrder": [
- "projectId"
+ "resource"
],
- "response": {
- "$ref": "Project"
- },
"parameters": {
- "projectId": {
+ "resource": {
+ "description": "Name of the resource to list `Constraints` for.",
"location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get",
- "path": "v1/projects/{projectId}",
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project."
- },
- "getAncestry": {
- "response": {
- "$ref": "GetAncestryResponse"
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
},
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "listOrgPolicies": {
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.listOrgPolicies",
+ "parameterOrder": [
+ "resource"
],
"parameters": {
- "projectId": {
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "resource": {
+ "description": "Name of the resource to list Policies for.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectId}:getAncestry",
- "path": "v1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "path": "v1/{+resource}:listOrgPolicies",
"request": {
- "$ref": "GetAncestryRequest"
- }
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "search": {
+ "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
+ "flatPath": "v1/organizations:search",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.search",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/organizations:search",
+ "request": {
+ "$ref": "SearchOrganizationsRequest"
+ },
+ "response": {
+ "$ref": "SearchOrganizationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization",
+ "flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setOrgPolicy": {
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
+ "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.setOrgPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:setOrgPolicy",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ },
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"testIamPermissions": {
- "path": "v1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call.",
+ "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".\n\nThere are no permissions required for making this API call.",
+ "flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{resource}:testIamPermissions"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}",
- "path": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.delete",
- "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project."
- },
+ ]
+ }
+ }
+ },
+ "projects": {
+ "methods": {
"clearOrgPolicy": {
+ "description": "Clears a `Policy` from a resource.",
+ "flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
"httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.clearOrgPolicy",
"parameterOrder": [
"resource"
],
- "response": {
- "$ref": "Empty"
- },
"parameters": {
"resource": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
"description": "Name of the resource for the `Policy` to clear.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
- "id": "cloudresourcemanager.projects.clearOrgPolicy",
"path": "v1/{+resource}:clearOrgPolicy",
"request": {
"$ref": "ClearOrgPolicyRequest"
},
- "description": "Clears a `Policy` from a resource."
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project",
"response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "location": "path"
- }
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject. The parent is identified by a specified ResourceId,\nwhich must include both an ID and a type, such as organization.",
+ "flatPath": "v1/projects",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.create",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v1/projects",
+ "request": {
+ "$ref": "Project"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if it has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
+ "flatPath": "v1/projects/{projectId}",
+ "httpMethod": "DELETE",
+ "id": "cloudresourcemanager.projects.delete",
+ "parameterOrder": [
+ "projectId"
],
- "flatPath": "v1/projects/{resource}:setIamPolicy",
- "path": "v1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy"
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "flatPath": "v1/projects/{projectId}",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.projects.get",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}",
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getAncestry": {
+ "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "flatPath": "v1/projects/{projectId}:getAncestry",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.getAncestry",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}:getAncestry",
+ "request": {
+ "$ref": "GetAncestryRequest"
+ },
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getEffectiveOrgPolicy": {
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ },
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names).",
+ "flatPath": "v1/projects/{resource}:getIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getOrgPolicy": {
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
+ "flatPath": "v1/projects/{projectsId}:getOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.getOrgPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource the `Policy` is set on.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getOrgPolicy",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
+ },
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method.",
+ "flatPath": "v1/projects",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.projects.list",
+ "parameterOrder": [],
+ "parameters": {
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red\u0026nbsp;labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/projects",
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
"listAvailableOrgPolicyConstraints": {
"description": "Lists `Constraints` that could be applied on the specified resource.",
+ "flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list `Constraints` for.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
"request": {
"$ref": "ListAvailableOrgPolicyConstraintsRequest"
},
"response": {
"$ref": "ListAvailableOrgPolicyConstraintsResponse"
},
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "listOrgPolicies": {
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "flatPath": "v1/projects/{projectsId}:listOrgPolicies",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.listOrgPolicies",
+ "parameterOrder": [
+ "resource"
],
"parameters": {
"resource": {
- "pattern": "^projects/[^/]+$",
+ "description": "Name of the resource to list Policies for.",
"location": "path",
- "description": "Name of the resource to list `Constraints` for.",
+ "pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints"
+ "path": "v1/{+resource}:listOrgPolicies",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
- "getIamPolicy": {
+ "setIamPolicy": {
+ "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project",
+ "flatPath": "v1/projects/{resource}:setIamPolicy",
"httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
"parameterOrder": [
"resource"
],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
"response": {
"$ref": "Policy"
},
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
- }
- },
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{resource}:getIamPolicy",
- "id": "cloudresourcemanager.projects.getIamPolicy",
- "path": "v1/projects/{resource}:getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names)."
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
- "getOrgPolicy": {
- "response": {
- "$ref": "OrgPolicy"
- },
+ "setOrgPolicy": {
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
+ "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.setOrgPolicy",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"resource": {
- "pattern": "^projects/[^/]+$",
+ "description": "Resource name of the resource to attach the `Policy`.",
"location": "path",
- "description": "Name of the resource the `Policy` is set on.",
+ "pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.projects.getOrgPolicy",
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
+ "path": "v1/{+resource}:setOrgPolicy",
"request": {
- "$ref": "GetOrgPolicyRequest"
- }
- },
- "getEffectiveOrgPolicy": {
- "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
+ "$ref": "SetOrgPolicyRequest"
},
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "OrgPolicy"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call.",
+ "flatPath": "v1/projects/{resource}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
"parameters": {
"resource": {
- "description": "The name of the resource to start computing the effective `Policy`.",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
+ "path": "v1/projects/{resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"undelete": {
+ "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
+ "flatPath": "v1/projects/{projectId}:undelete",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.undelete",
+ "parameterOrder": [
+ "projectId"
+ ],
"parameters": {
"projectId": {
- "required": true,
- "type": "string",
+ "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
"location": "path",
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired."
+ "required": true,
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete",
"path": "v1/projects/{projectId}:undelete",
"request": {
"$ref": "UndeleteProjectRequest"
},
- "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
"response": {
"$ref": "Empty"
- }
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "path": "v1/projects/{projectId}",
- "request": {
- "$ref": "Project"
- },
- "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project."
- }
- }
- },
- "organizations": {
- "methods": {
- "listOrgPolicies": {
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list Policies for."
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "id": "cloudresourcemanager.organizations.listOrgPolicies",
- "description": "Lists all the `Policies` set for a particular resource.",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- }
- },
- "listAvailableOrgPolicyConstraints": {
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "description": "Lists `Constraints` that could be applied on the specified resource.",
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "Name of the resource to list `Constraints` for.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints"
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization"
- },
- "getOrgPolicy": {
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource the `Policy` is set on.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.organizations.getOrgPolicy",
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "request": {
- "$ref": "GetOrgPolicyRequest"
- }
- },
- "search": {
- "response": {
- "$ref": "SearchOrganizationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {},
- "flatPath": "v1/organizations:search",
- "path": "v1/organizations:search",
- "id": "cloudresourcemanager.organizations.search",
- "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
- "request": {
- "$ref": "SearchOrganizationsRequest"
- }
- },
- "get": {
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.organizations.get",
- "description": "Fetches an Organization resource identified by the specified resource name."
- },
- "getEffectiveOrgPolicy": {
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The name of the resource to start computing the effective `Policy`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy"
- },
- "testIamPermissions": {
- "id": "cloudresourcemanager.organizations.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".\n\nThere are no permissions required for making this API call.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:testIamPermissions"
- },
- "clearOrgPolicy": {
- "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.organizations.clearOrgPolicy",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
- "description": "Clears a `Policy` from a resource.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "Name of the resource for the `Policy` to clear.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "setOrgPolicy": {
- "response": {
- "$ref": "OrgPolicy"
- },
+ "update": {
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
+ "flatPath": "v1/projects/{projectId}",
+ "httpMethod": "PUT",
+ "id": "cloudresourcemanager.projects.update",
"parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "projectId"
],
"parameters": {
- "resource": {
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.organizations.setOrgPolicy",
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- }
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
+ "projectId": {
+ "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
"location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
+ "type": "string"
}
},
+ "path": "v1/projects/{projectId}",
+ "request": {
+ "$ref": "Project"
+ },
+ "response": {
+ "$ref": "Project"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization"
+ ]
}
}
}
},
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudresourcemanager.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
- "basePath": "",
- "revision": "20180110",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "id": "cloudresourcemanager:v1",
- "discoveryVersion": "v1",
+ "revision": "20180315",
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
- "Constraint": {
- "id": "Constraint",
- "description": "A `Constraint` describes a way in which a resource's configuration can be\nrestricted. For example, it controls which cloud services can be activated\nacross an organization, or whether a Compute Engine instance can have\nserial port connections established. `Constraints` can be configured by the\norganization's policy adminstrator to fit the needs of the organzation by\nsetting Policies for `Constraints` at different locations in the\norganization's resource hierarchy. Policies are inherited down the resource\nhierarchy from higher levels, but can also be overridden. For details about\nthe inheritance rules please read about\nPolicies.\n\n`Constraints` have a default behavior determined by the `constraint_default`\nfield, which is the enforcement behavior that is used in the absence of a\n`Policy` being defined or inherited for the resource in question.",
- "type": "object",
+ "Ancestor": {
+ "description": "Identifying information for a single ancestor of a project.",
+ "id": "Ancestor",
"properties": {
+ "resourceId": {
+ "$ref": "ResourceId",
+ "description": "Resource id of the ancestor."
+ }
+ },
+ "type": "object"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "id": "AuditConfig",
+ "properties": {
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "id": "AuditLogConfig",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logType": {
+ "description": "The log type that this config enables.",
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BooleanConstraint": {
+ "description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.",
+ "id": "BooleanConstraint",
+ "properties": {},
+ "type": "object"
+ },
+ "BooleanPolicy": {
+ "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
+ "id": "BooleanPolicy",
+ "properties": {
+ "enforced": {
+ "description": "If `true`, then the `Policy` is enforced. If `false`, then any\nconfiguration is acceptable.\n\nSuppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`\nwith `constraint_default` set to `ALLOW`. A `Policy` for that\n`Constraint` exhibits the following behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial\n port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial\n port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port\n connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the\n resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the\n resource hierarchy, the behavior is as if the`Policy` were set at\n this resource.\n\nThe following examples demonstrate the different possible layerings:\n\nExample 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\nThe constraint at `projects/bar` and `organizations/foo` will not be\nenforced.\n\nExample 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\nThe constraint at `organizations/foo` is not enforced.\nThe constraint at `projects/bar` is enforced.\n\nExample 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: {}}\nThe constraint at `organizations/foo` is enforced.\nThe constraint at `projects/bar` is not enforced, because\n`constraint_default` for the `Constraint` is `ALLOW`.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ClearOrgPolicyRequest": {
+ "description": "The request sent to the ClearOrgPolicy method.",
+ "id": "ClearOrgPolicyRequest",
+ "properties": {
+ "constraint": {
+ "description": "Name of the `Constraint` of the `Policy` to clear.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Constraint": {
+ "description": "A `Constraint` describes a way in which a resource's configuration can be\nrestricted. For example, it controls which cloud services can be activated\nacross an organization, or whether a Compute Engine instance can have\nserial port connections established. `Constraints` can be configured by the\norganization's policy adminstrator to fit the needs of the organzation by\nsetting Policies for `Constraints` at different locations in the\norganization's resource hierarchy. Policies are inherited down the resource\nhierarchy from higher levels, but can also be overridden. For details about\nthe inheritance rules please read about\nPolicies.\n\n`Constraints` have a default behavior determined by the `constraint_default`\nfield, which is the enforcement behavior that is used in the absence of a\n`Policy` being defined or inherited for the resource in question.",
+ "id": "Constraint",
+ "properties": {
+ "booleanConstraint": {
+ "$ref": "BooleanConstraint",
+ "description": "Defines this constraint as being a BooleanConstraint."
+ },
"constraintDefault": {
"description": "The evaluation behavior of this constraint in the absense of 'Policy'.",
- "type": "string",
+ "enum": [
+ "CONSTRAINT_DEFAULT_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
"enumDescriptions": [
"This is only used for distinguishing unset values and should never be\nused.",
"Indicate that all values are allowed for list constraints.\nIndicate that enforcement is off for boolean constraints.",
"Indicate that all values are denied for list constraints.\nIndicate that enforcement is on for boolean constraints."
],
- "enum": [
- "CONSTRAINT_DEFAULT_UNSPECIFIED",
- "ALLOW",
- "DENY"
- ]
+ "type": "string"
},
- "name": {
- "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
+ "description": {
+ "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The human readable name.\n\nMutable.",
"type": "string"
},
"listConstraint": {
"$ref": "ListConstraint",
"description": "Defines this constraint as being a ListConstraint."
},
+ "name": {
+ "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
+ "type": "string"
+ },
"version": {
"description": "Version of the `Constraint`. Default version is 0;",
"format": "int32",
"type": "integer"
- },
- "displayName": {
- "type": "string",
- "description": "The human readable name.\n\nMutable."
- },
- "description": {
- "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.",
- "type": "string"
- },
- "booleanConstraint": {
- "$ref": "BooleanConstraint",
- "description": "Defines this constraint as being a BooleanConstraint."
- }
- }
- },
- "ListLiensResponse": {
- "description": "The response message for Liens.ListLiens.",
- "type": "object",
- "properties": {
- "liens": {
- "description": "A list of Liens.",
- "type": "array",
- "items": {
- "$ref": "Lien"
- }
- },
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
- "type": "string"
}
},
- "id": "ListLiensResponse"
- },
- "Status": {
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object"
},
- "Binding": {
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- }
- },
- "RestoreDefault": {
- "description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.",
- "type": "object",
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
"properties": {},
- "id": "RestoreDefault"
+ "type": "object"
},
- "GetOrgPolicyRequest": {
- "description": "The request sent to the GetOrgPolicy method.",
- "type": "object",
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "id": "FolderOperation",
"properties": {
- "constraint": {
- "description": "Name of the `Constraint` to get the `Policy`.",
- "type": "string"
- }
- },
- "id": "GetOrgPolicyRequest"
- },
- "ClearOrgPolicyRequest": {
- "type": "object",
- "properties": {
- "etag": {
- "description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.",
- "format": "byte",
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
"type": "string"
},
- "constraint": {
- "description": "Name of the `Constraint` of the `Policy` to clear.",
- "type": "string"
- }
- },
- "id": "ClearOrgPolicyRequest",
- "description": "The request sent to the ClearOrgPolicy method."
- },
- "UndeleteProjectRequest": {
- "description": "The request sent to the UndeleteProject\nmethod.",
- "type": "object",
- "properties": {},
- "id": "UndeleteProjectRequest"
- },
- "ProjectCreationStatus": {
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object",
- "properties": {
- "createTime": {
- "type": "string",
- "description": "Creation time of the project creation workflow.",
- "format": "google-datetime"
- },
- "gettable": {
- "type": "boolean",
- "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete."
- },
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
- }
- },
- "id": "ProjectCreationStatus"
- },
- "BooleanConstraint": {
- "description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.",
- "type": "object",
- "properties": {},
- "id": "BooleanConstraint"
- },
- "GetIamPolicyRequest": {
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {}
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "OrganizationOwner": {
- "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
- "type": "object",
- "properties": {
- "directoryCustomerId": {
- "description": "The Google for Work customer id used in the Directory API.",
- "type": "string"
- }
- },
- "id": "OrganizationOwner"
- },
- "ListProjectsResponse": {
- "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
- "type": "object",
- "properties": {
- "projects": {
- "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
- "type": "array",
- "items": {
- "$ref": "Project"
- }
- },
- "nextPageToken": {
- "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
- "type": "string"
- }
- },
- "id": "ListProjectsResponse"
- },
- "Project": {
- "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
- "type": "object",
- "properties": {
- "projectNumber": {
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "format": "int64",
+ "displayName": {
+ "description": "The display name of the folder.",
"type": "string"
},
- "parent": {
- "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write.",
- "$ref": "ResourceId"
- },
- "createTime": {
- "description": "Creation time.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
- "type": "object"
- },
- "name": {
- "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
- "type": "string"
- },
- "projectId": {
- "type": "string",
- "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation."
- },
- "lifecycleState": {
- "enumDescriptions": [
- "Unspecified state. This is only used/useful for distinguishing\nunset values.",
- "The normal and active state.",
- "The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
- "This lifecycle state is no longer used and not returned by the API."
- ],
+ "operationType": {
+ "description": "The type of this operation.",
"enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
+ ],
+ "enumDescriptions": [
+ "Operation type not specified.",
+ "A create folder operation.",
+ "A move folder operation."
],
- "description": "The Project lifecycle state.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "Project"
- },
- "SearchOrganizationsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results.",
"type": "string"
},
- "organizations": {
- "description": "The list of Organizations that matched the search query, possibly\npaginated.",
- "type": "array",
- "items": {
- "$ref": "Organization"
- }
- }
- },
- "id": "SearchOrganizationsResponse",
- "description": "The response returned from the `SearchOrganizations` method."
- },
- "ListOrgPoliciesResponse": {
- "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.",
- "type": "object",
- "properties": {
- "policies": {
- "description": "The `Policies` that are set on the resource. It will be empty if no\n`Policies` are set.",
- "type": "array",
- "items": {
- "$ref": "OrgPolicy"
- }
- },
- "nextPageToken": {
- "description": "Page token used to retrieve the next page. This is currently not used, but\nthe server may at any point start supplying a valid token.",
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
"type": "string"
}
},
- "id": "ListOrgPoliciesResponse"
+ "type": "object"
},
"FolderOperationError": {
"description": "A classification of the Folder Operation error.",
- "type": "object",
+ "id": "FolderOperationError",
"properties": {
"errorMessageId": {
"description": "The type of operation error experienced.",
- "type": "string",
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "ACTIVE_FOLDER_HEIGHT_VIOLATION",
+ "MAX_CHILD_FOLDERS_VIOLATION",
+ "FOLDER_NAME_UNIQUENESS_VIOLATION",
+ "RESOURCE_DELETED_VIOLATION",
+ "PARENT_DELETED_VIOLATION",
+ "CYCLE_INTRODUCED_VIOLATION",
+ "FOLDER_BEING_MOVED_VIOLATION",
+ "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
+ "DELETED_FOLDER_HEIGHT_VIOLATION"
+ ],
"enumDescriptions": [
"The error type was unrecognized or unspecified.",
"The attempted action would violate the max folder depth constraint.",
@@ -1472,78 +1383,63 @@
"The folder the caller is trying to delete contains active resources.",
"The attempted action would violate the max deleted folder depth\nconstraint."
],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "ACTIVE_FOLDER_HEIGHT_VIOLATION",
- "MAX_CHILD_FOLDERS_VIOLATION",
- "FOLDER_NAME_UNIQUENESS_VIOLATION",
- "RESOURCE_DELETED_VIOLATION",
- "PARENT_DELETED_VIOLATION",
- "CYCLE_INTRODUCED_VIOLATION",
- "FOLDER_BEING_MOVED_VIOLATION",
- "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
- "DELETED_FOLDER_HEIGHT_VIOLATION"
- ]
+ "type": "string"
}
},
- "id": "FolderOperationError"
+ "type": "object"
},
- "BooleanPolicy": {
- "id": "BooleanPolicy",
- "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
- "type": "object",
+ "GetAncestryRequest": {
+ "description": "The request sent to the\nGetAncestry\nmethod.",
+ "id": "GetAncestryRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "GetAncestryResponse": {
+ "description": "Response from the GetAncestry method.",
+ "id": "GetAncestryResponse",
"properties": {
- "enforced": {
- "description": "If `true`, then the `Policy` is enforced. If `false`, then any\nconfiguration is acceptable.\n\nSuppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`\nwith `constraint_default` set to `ALLOW`. A `Policy` for that\n`Constraint` exhibits the following behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial\n port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial\n port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port\n connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the\n resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the\n resource hierarchy, the behavior is as if the`Policy` were set at\n this resource.\n\nThe following examples demonstrate the different possible layerings:\n\nExample 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\nThe constraint at `projects/bar` and `organizations/foo` will not be\nenforced.\n\nExample 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\nThe constraint at `organizations/foo` is not enforced.\nThe constraint at `projects/bar` is enforced.\n\nExample 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: {}}\nThe constraint at `organizations/foo` is enforced.\nThe constraint at `projects/bar` is not enforced, because\n`constraint_default` for the `Constraint` is `ALLOW`.",
- "type": "boolean"
+ "ancestor": {
+ "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
+ "items": {
+ "$ref": "Ancestor"
+ },
+ "type": "array"
}
- }
+ },
+ "type": "object"
},
- "OrgPolicy": {
- "id": "OrgPolicy",
- "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
- "type": "object",
+ "GetEffectiveOrgPolicyRequest": {
+ "description": "The request sent to the GetEffectiveOrgPolicy method.",
+ "id": "GetEffectiveOrgPolicyRequest",
"properties": {
- "updateTime": {
- "description": "The time stamp the `Policy` was previously updated. This is set by the\nserver, not specified by the caller, and represents the last time a call to\n`SetOrgPolicy` was made for that `Policy`. Any value set by the client will\nbe ignored.",
- "format": "google-datetime",
- "type": "string"
- },
- "version": {
- "description": "Version of the `Policy`. Default version is 0;",
- "format": "int32",
- "type": "integer"
- },
- "restoreDefault": {
- "$ref": "RestoreDefault",
- "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
- },
- "listPolicy": {
- "$ref": "ListPolicy",
- "description": "List of values either allowed or disallowed."
- },
- "etag": {
- "description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
- "format": "byte",
- "type": "string"
- },
"constraint": {
- "description": "The name of the `Constraint` the `Policy` is configuring, for example,\n`constraints/serviceuser.services`.\n\nImmutable after creation.",
+ "description": "The name of the `Constraint` to compute the effective `Policy`.",
"type": "string"
- },
- "booleanPolicy": {
- "$ref": "BooleanPolicy",
- "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not."
}
- }
+ },
+ "type": "object"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "id": "GetIamPolicyRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "GetOrgPolicyRequest": {
+ "description": "The request sent to the GetOrgPolicy method.",
+ "id": "GetOrgPolicyRequest",
+ "properties": {
+ "constraint": {
+ "description": "Name of the `Constraint` to get the `Policy`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"Lien": {
- "type": "object",
+ "description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.",
+ "id": "Lien",
"properties": {
- "parent": {
- "description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`",
- "type": "string"
- },
"createTime": {
"description": "The creation time of this Lien.",
"format": "google-datetime",
@@ -1553,410 +1449,193 @@
"description": "A system-generated unique identifier for this Lien.\n\nExample: `liens/1234abcd`",
"type": "string"
},
- "reason": {
- "description": "Concise user-visible strings indicating why an action cannot be performed\non a resource. Maximum lenth of 200 characters.\n\nExample: 'Holds production API key'",
- "type": "string"
- },
"origin": {
"description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'",
"type": "string"
},
+ "parent": {
+ "description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Concise user-visible strings indicating why an action cannot be performed\non a resource. Maximum lenth of 200 characters.\n\nExample: 'Holds production API key'",
+ "type": "string"
+ },
"restrictions": {
"description": "The types of operations which should be blocked as a result of this Lien.\nEach value should correspond to an IAM permission. The server will\nvalidate the permissions against those for which Liens are supported.\n\nAn empty list is meaningless and will be rejected.\n\nExample: ['resourcemanager.projects.delete']",
- "type": "array",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
}
},
- "id": "Lien",
- "description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource."
- },
- "Ancestor": {
- "properties": {
- "resourceId": {
- "$ref": "ResourceId",
- "description": "Resource id of the ancestor."
- }
- },
- "id": "Ancestor",
- "description": "Identifying information for a single ancestor of a project.",
"type": "object"
},
- "ListConstraint": {
- "type": "object",
+ "ListAvailableOrgPolicyConstraintsRequest": {
+ "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
+ "id": "ListAvailableOrgPolicyConstraintsRequest",
"properties": {
- "suggestedValue": {
- "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Constraint`.",
+ "pageSize": {
+ "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
"type": "string"
}
},
- "id": "ListConstraint",
- "description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`."
- },
- "SetOrgPolicyRequest": {
- "description": "The request sent to the SetOrgPolicyRequest method.",
- "type": "object",
- "properties": {
- "policy": {
- "description": "`Policy` to set on the resource.",
- "$ref": "OrgPolicy"
- }
- },
- "id": "SetOrgPolicyRequest"
- },
- "SetIamPolicyRequest": {
- "properties": {
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- },
- "updateMask": {
- "type": "string",
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask"
- }
- },
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
"type": "object"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Organization": {
- "id": "Organization",
- "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
- "type": "object",
- "properties": {
- "creationTime": {
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "owner": {
- "$ref": "OrganizationOwner",
- "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
- },
- "lifecycleState": {
- "enumDescriptions": [
- "Unspecified state. This is only useful for distinguishing unset values.",
- "The normal and active state.",
- "The organization has been marked for deletion by the user."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
- ],
- "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
- "type": "string"
- },
- "displayName": {
- "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
- "type": "string"
- }
- }
- },
"ListAvailableOrgPolicyConstraintsResponse": {
"description": "The response returned from the ListAvailableOrgPolicyConstraints method.\nReturns all `Constraints` that could be set at this level of the hierarchy\n(contrast with the response from `ListPolicies`, which returns all policies\nwhich are set).",
- "type": "object",
+ "id": "ListAvailableOrgPolicyConstraintsResponse",
"properties": {
"constraints": {
"description": "The collection of constraints that are settable on the request resource.",
- "type": "array",
"items": {
"$ref": "Constraint"
- }
+ },
+ "type": "array"
},
"nextPageToken": {
"description": "Page token used to retrieve the next page. This is currently not used.",
"type": "string"
}
},
- "id": "ListAvailableOrgPolicyConstraintsResponse"
+ "type": "object"
+ },
+ "ListConstraint": {
+ "description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`.",
+ "id": "ListConstraint",
+ "properties": {
+ "suggestedValue": {
+ "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Constraint`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListLiensResponse": {
+ "description": "The response message for Liens.ListLiens.",
+ "id": "ListLiensResponse",
+ "properties": {
+ "liens": {
+ "description": "A list of Liens.",
+ "items": {
+ "$ref": "Lien"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOrgPoliciesRequest": {
+ "description": "The request sent to the ListOrgPolicies method.",
+ "id": "ListOrgPoliciesRequest",
+ "properties": {
+ "pageSize": {
+ "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListOrgPoliciesResponse": {
+ "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.",
+ "id": "ListOrgPoliciesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Page token used to retrieve the next page. This is currently not used, but\nthe server may at any point start supplying a valid token.",
+ "type": "string"
+ },
+ "policies": {
+ "description": "The `Policies` that are set on the resource. It will be empty if no\n`Policies` are set.",
+ "items": {
+ "$ref": "OrgPolicy"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"ListPolicy": {
"description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset.",
- "type": "object",
+ "id": "ListPolicy",
"properties": {
- "deniedValues": {
- "description": "List of values denied at this resource. Can only be set if no values are\nset for `allowed_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"allValues": {
+ "description": "The policy all_values state.",
"enum": [
"ALL_VALUES_UNSPECIFIED",
"ALLOW",
"DENY"
],
- "description": "The policy all_values state.",
- "type": "string",
"enumDescriptions": [
"Indicates that either allowed_values or denied_values must be set.",
"A policy with this set allows all values.",
"A policy with this set denies all values."
- ]
+ ],
+ "type": "string"
},
"allowedValues": {
"description": "List of values allowed at this resource. Can only be set if no values\nare set for `denied_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
- "type": "array",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
+ },
+ "deniedValues": {
+ "description": "List of values denied at this resource. Can only be set if no values are\nset for `allowed_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "inheritFromParent": {
+ "description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n ``projects/bar`` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {value: “E3” value: ”E4” inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.",
+ "type": "boolean"
},
"suggestedValue": {
"description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`.",
"type": "string"
- },
- "inheritFromParent": {
- "type": "boolean",
- "description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n ``projects/bar`` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {value: “E3” value: ”E4” inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`."
}
},
- "id": "ListPolicy"
- },
- "GetAncestryResponse": {
- "description": "Response from the GetAncestry method.",
- "type": "object",
- "properties": {
- "ancestor": {
- "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
- "type": "array",
- "items": {
- "$ref": "Ancestor"
- }
- }
- },
- "id": "GetAncestryResponse"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string"
- },
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AuditLogConfig"
- },
- "SearchOrganizationsRequest": {
- "description": "The request sent to the `SearchOrganizations` method.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to `SearchOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SearchOrganizationsRequest"
- },
- "GetAncestryRequest": {
- "properties": {},
- "id": "GetAncestryRequest",
- "description": "The request sent to the\nGetAncestry\nmethod.",
"type": "object"
},
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
+ "ListProjectsResponse": {
+ "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
+ "id": "ListProjectsResponse",
"properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
- "type": "object",
- "properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
+ "nextPageToken": {
+ "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
"type": "string"
},
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
+ "projects": {
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
"items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "type": "array",
- "items": {
- "$ref": "Binding"
+ "$ref": "Project"
},
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error."
+ "type": "array"
}
},
- "id": "Policy"
- },
- "FolderOperation": {
- "description": "Metadata describing a long running folder operation",
- "type": "object",
- "properties": {
- "operationType": {
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ],
- "description": "The type of this operation.",
- "type": "string",
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ]
- },
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
- }
- },
- "id": "FolderOperation"
- },
- "ListAvailableOrgPolicyConstraintsRequest": {
- "id": "ListAvailableOrgPolicyConstraintsRequest",
- "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
- "type": "string"
- },
- "pageSize": {
- "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "ResourceId": {
- "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
- "type": "string"
- },
- "id": {
- "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
- "type": "string"
- }
- },
- "id": "ResourceId"
- },
- "GetEffectiveOrgPolicyRequest": {
- "type": "object",
- "properties": {
- "constraint": {
- "description": "The name of the `Constraint` to compute the effective `Policy`.",
- "type": "string"
- }
- },
- "id": "GetEffectiveOrgPolicyRequest",
- "description": "The request sent to the GetEffectiveOrgPolicy method."
- },
- "ListOrgPoliciesRequest": {
- "description": "The request sent to the ListOrgPolicies method.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
- "type": "string"
- },
- "pageSize": {
- "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListOrgPoliciesRequest"
- },
- "AuditConfig": {
- "type": "object",
- "properties": {
- "service": {
- "type": "string",
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services."
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- }
- },
- "id": "AuditConfig",
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging."
+ "type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
+ "id": "Operation",
"properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
},
"error": {
"$ref": "Status",
@@ -1970,39 +1649,360 @@
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
},
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
},
"response": {
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
}
},
- "id": "Operation"
- }
- },
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "Cloud Resource Manager",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
+ "type": "object"
+ },
+ "OrgPolicy": {
+ "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
+ "id": "OrgPolicy",
+ "properties": {
+ "booleanPolicy": {
+ "$ref": "BooleanPolicy",
+ "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not."
},
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ "constraint": {
+ "description": "The name of the `Constraint` the `Policy` is configuring, for example,\n`constraints/serviceuser.services`.\n\nImmutable after creation.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
+ "format": "byte",
+ "type": "string"
+ },
+ "listPolicy": {
+ "$ref": "ListPolicy",
+ "description": "List of values either allowed or disallowed."
+ },
+ "restoreDefault": {
+ "$ref": "RestoreDefault",
+ "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
+ },
+ "updateTime": {
+ "description": "The time stamp the `Policy` was previously updated. This is set by the\nserver, not specified by the caller, and represents the last time a call to\n`SetOrgPolicy` was made for that `Policy`. Any value set by the client will\nbe ignored.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the `Policy`. Default version is 0;",
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "type": "object"
+ },
+ "Organization": {
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
+ "id": "Organization",
+ "properties": {
+ "creationTime": {
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "A human-readable string that refers to the Organization in the\nGCP Console UI. This string is set by the server and cannot be\nchanged. The string will be set to the primary domain (for example,\n\"google.com\") of the G Suite customer that owns the organization.\n@OutputOnly",
+ "type": "string"
+ },
+ "lifecycleState": {
+ "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED"
+ ],
+ "enumDescriptions": [
+ "Unspecified state. This is only useful for distinguishing unset values.",
+ "The normal and active state.",
+ "The organization has been marked for deletion by the user."
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "type": "string"
+ },
+ "owner": {
+ "$ref": "OrganizationOwner",
+ "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
+ }
+ },
+ "type": "object"
+ },
+ "OrganizationOwner": {
+ "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
+ "id": "OrganizationOwner",
+ "properties": {
+ "directoryCustomerId": {
+ "description": "The G Suite customer id used in the Directory API.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "id": "Policy",
+ "properties": {
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "AuditConfig"
+ },
+ "type": "array"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Project": {
+ "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
+ "id": "Project",
+ "properties": {
+ "createTime": {
+ "description": "Creation time.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
+ "type": "object"
+ },
+ "lifecycleState": {
+ "description": "The Project lifecycle state.\n\nRead-only.",
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED",
+ "DELETE_IN_PROGRESS"
+ ],
+ "enumDescriptions": [
+ "Unspecified state. This is only used/useful for distinguishing\nunset values.",
+ "The normal and active state.",
+ "The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
+ "This lifecycle state is no longer used and not returned by the API."
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
+ "type": "string"
+ },
+ "parent": {
+ "$ref": "ResourceId",
+ "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write."
+ },
+ "projectId": {
+ "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
+ "type": "string"
+ },
+ "projectNumber": {
+ "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProjectCreationStatus": {
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
+ "id": "ProjectCreationStatus",
+ "properties": {
+ "createTime": {
+ "description": "Creation time of the project creation workflow.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "gettable": {
+ "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
+ "type": "boolean"
+ },
+ "ready": {
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ResourceId": {
+ "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
+ "id": "ResourceId",
+ "properties": {
+ "id": {
+ "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RestoreDefault": {
+ "description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.",
+ "id": "RestoreDefault",
+ "properties": {},
+ "type": "object"
+ },
+ "SearchOrganizationsRequest": {
+ "description": "The request sent to the `SearchOrganizations` method.",
+ "id": "SearchOrganizationsRequest",
+ "properties": {
+ "filter": {
+ "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a G Suite domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `SearchOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SearchOrganizationsResponse": {
+ "description": "The response returned from the `SearchOrganizations` method.",
+ "id": "SearchOrganizationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results.",
+ "type": "string"
+ },
+ "organizations": {
+ "description": "The list of Organizations that matched the search query, possibly\npaginated.",
+ "items": {
+ "$ref": "Organization"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "id": "SetIamPolicyRequest",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SetOrgPolicyRequest": {
+ "description": "The request sent to the SetOrgPolicyRequest method.",
+ "id": "SetOrgPolicyRequest",
+ "properties": {
+ "policy": {
+ "$ref": "OrgPolicy",
+ "description": "`Policy` to set on the resource."
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UndeleteProjectRequest": {
+ "description": "The request sent to the UndeleteProject\nmethod.",
+ "id": "UndeleteProjectRequest",
+ "properties": {},
+ "type": "object"
}
},
- "rootUrl": "https://cloudresourcemanager.googleapis.com/"
-}
+ "servicePath": "",
+ "title": "Cloud Resource Manager API",
+ "version": "v1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v1/cloudresourcemanager-gen.go b/vendor/google.golang.org/api/cloudresourcemanager/v1/cloudresourcemanager-gen.go
index 4f9e5266a..f0c3b8d41 100644
--- a/vendor/google.golang.org/api/cloudresourcemanager/v1/cloudresourcemanager-gen.go
+++ b/vendor/google.golang.org/api/cloudresourcemanager/v1/cloudresourcemanager-gen.go
@@ -1,4 +1,4 @@
-// Package cloudresourcemanager provides access to the Google Cloud Resource Manager API.
+// Package cloudresourcemanager provides access to the Cloud Resource Manager API.
//
// See https://cloud.google.com/resource-manager
//
@@ -175,7 +175,7 @@ func (s *Ancestor) MarshalJSON() ([]byte, error) {
// log_types
// specified in each AuditConfig are enabled, and the exempted_members
// in each
-// AuditConfig are exempted.
+// AuditLogConfig are exempted.
//
// Example Policy with multiple AuditConfigs:
//
@@ -1542,11 +1542,14 @@ type Organization struct {
// @OutputOnly
CreationTime string `json:"creationTime,omitempty"`
- // DisplayName: A friendly string to be used to refer to the
- // Organization in the UI.
- // Assigned by the server, set to the primary domain of the G
- // Suite
- // customer that owns the organization.
+ // DisplayName: A human-readable string that refers to the Organization
+ // in the
+ // GCP Console UI. This string is set by the server and cannot
+ // be
+ // changed. The string will be set to the primary domain (for
+ // example,
+ // "google.com") of the G Suite customer that owns the
+ // organization.
// @OutputOnly
DisplayName string `json:"displayName,omitempty"`
@@ -1610,8 +1613,8 @@ func (s *Organization) MarshalJSON() ([]byte, error) {
// descendants will
// be deleted.
type OrganizationOwner struct {
- // DirectoryCustomerId: The Google for Work customer id used in the
- // Directory API.
+ // DirectoryCustomerId: The G Suite customer id used in the Directory
+ // API.
DirectoryCustomerId string `json:"directoryCustomerId,omitempty"`
// ForceSendFields is a list of field names (e.g. "DirectoryCustomerId")
@@ -1968,7 +1971,7 @@ type SearchOrganizationsRequest struct {
//
// Organizations may be filtered by `owner.directoryCustomerId` or
// by
- // `domain`, where the domain is a Google for Work domain, for
+ // `domain`, where the domain is a G Suite domain, for
// example:
//
// |Filter|Description|
@@ -5573,7 +5576,8 @@ type ProjectsCreateCall struct {
// permission
// `resourcemanager.projects.create` on the specified parent for the
// new
-// project.
+// project. The parent is identified by a specified ResourceId,
+// which must include both an ID and a type, such as organization.
func (r *ProjectsService) Create(project *Project) *ProjectsCreateCall {
c := &ProjectsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -5663,7 +5667,7 @@ func (c *ProjectsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error
}
return ret, nil
// {
- // "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject.",
+ // "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject. The parent is identified by a specified ResourceId,\nwhich must include both an ID and a type, such as organization.",
// "flatPath": "v1/projects",
// "httpMethod": "POST",
// "id": "cloudresourcemanager.projects.create",
@@ -5695,11 +5699,8 @@ type ProjectsDeleteCall struct {
// Delete: Marks the Project identified by the specified
// `project_id` (for example, `my-project-123`) for deletion.
-// This method will only affect the Project if the following criteria
-// are met:
-//
-// + The Project does not have a billing account associated with it.
-// + The Project has a lifecycle state of
+// This method will only affect the Project if it has a lifecycle state
+// of
// ACTIVE.
//
// This method changes the Project's lifecycle state from
@@ -5806,7 +5807,7 @@ func (c *ProjectsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error) {
}
return ret, nil
// {
- // "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
+ // "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if it has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
// "flatPath": "v1/projects/{projectId}",
// "httpMethod": "DELETE",
// "id": "cloudresourcemanager.projects.delete",
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
index 735ec341f..97ee2bb60 100644
--- a/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ b/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,819 +1,718 @@
{
- "resources": {
- "organizations": {
- "methods": {
- "list": {
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations",
- "path": "v1beta1/organizations",
- "id": "cloudresourcemanager.organizations.list",
- "description": "Lists Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the list.",
- "response": {
- "$ref": "ListOrganizationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
},
- "setIamPolicy": {
- "path": "v1beta1/{+resource}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy"
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\"."
- },
- "get": {
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "organizationId": {
- "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "path": "v1beta1/{+name}",
- "id": "cloudresourcemanager.organizations.get",
- "description": "Fetches an Organization resource identified by the specified resource name."
- },
- "update": {
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "path": "v1beta1/{+name}",
- "id": "cloudresourcemanager.organizations.update",
- "description": "Updates an Organization resource identified by the specified resource name.",
- "request": {
- "$ref": "Organization"
- }
- },
- "testIamPermissions": {
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST"
- }
- }
- },
- "projects": {
- "methods": {
- "testIamPermissions": {
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects/{resource}:testIamPermissions",
- "path": "v1beta1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Project.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST"
- },
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}",
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.delete",
- "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "DELETE"
- },
- "list": {
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the GetProjectmethod.",
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects",
- "path": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.list"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
- "path": "v1beta1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles."
- },
- "create": {
- "path": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.create",
- "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.",
- "request": {
- "$ref": "Project"
- },
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "useLegacyStack": {
- "location": "query",
- "description": "A safety hatch to opt out of the new reliable project creation process.",
- "type": "boolean"
- }
- },
- "flatPath": "v1beta1/projects"
- },
- "getIamPolicy": {
- "path": "v1beta1/projects/{resource}:getIamPolicy",
- "id": "cloudresourcemanager.projects.getIamPolicy",
- "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names).",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{resource}:getIamPolicy"
- },
- "get": {
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}",
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get"
- },
- "undelete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}:undelete",
- "path": "v1beta1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete",
- "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
- "request": {
- "$ref": "UndeleteProjectRequest"
- }
- },
- "update": {
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
- "request": {
- "$ref": "Project"
- },
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}"
- },
- "getAncestry": {
- "response": {
- "$ref": "GetAncestryResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects/{projectId}:getAncestry",
- "path": "v1beta1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "request": {
- "$ref": "GetAncestryRequest"
- },
- "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project."
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
}
}
}
},
+ "basePath": "",
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Resource Manager",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudresourcemanager:v1beta1",
+ "kind": "discovery#restDescription",
+ "name": "cloudresourcemanager",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
"parameters": {
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
"type": "string"
},
"alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
"type": "string"
},
"key": {
"description": "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.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
"location": "query",
- "description": "OAuth access token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
"type": "string"
}
},
- "version": "v1beta1",
- "baseUrl": "https://cloudresourcemanager.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
- "servicePath": "",
- "basePath": "",
- "id": "cloudresourcemanager:v1beta1",
- "revision": "20180110",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "discoveryVersion": "v1",
- "schemas": {
- "ProjectCreationStatus": {
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object",
- "properties": {
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
+ "protocol": "rest",
+ "resources": {
+ "organizations": {
+ "methods": {
+ "get": {
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.organizations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "organizationId": {
+ "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+name}",
+ "response": {
+ "$ref": "Organization"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
- "createTime": {
- "description": "Creation time of the project creation workflow.",
- "format": "google-datetime",
- "type": "string"
+ "getIamPolicy": {
+ "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".",
+ "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
- "gettable": {
- "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
- "type": "boolean"
- }
- },
- "id": "ProjectCreationStatus"
- },
- "TestIamPermissionsResponse": {
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "list": {
+ "description": "Lists Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the list.",
+ "flatPath": "v1beta1/organizations",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.organizations.list",
+ "parameterOrder": [],
+ "parameters": {
+ "filter": {
+ "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a G Suite domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/organizations",
+ "response": {
+ "$ref": "ListOrganizationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
+ "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
+ "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "update": {
+ "description": "Updates an Organization resource identified by the specified resource name.",
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "httpMethod": "PUT",
+ "id": "cloudresourcemanager.organizations.update",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "location": "path",
+ "pattern": "^organizations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+name}",
+ "request": {
+ "$ref": "Organization"
+ },
+ "response": {
+ "$ref": "Organization"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
},
- "GetIamPolicyRequest": {
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {}
- },
- "GetAncestryResponse": {
- "description": "Response from the GetAncestry method.",
- "type": "object",
- "properties": {
- "ancestor": {
- "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
- "type": "array",
- "items": {
- "$ref": "Ancestor"
- }
- }
- },
- "id": "GetAncestryResponse"
- },
- "OrganizationOwner": {
- "id": "OrganizationOwner",
- "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
- "type": "object",
- "properties": {
- "directoryCustomerId": {
- "description": "The Google for Work customer id used in the Directory API.",
- "type": "string"
- }
- }
- },
- "ListProjectsResponse": {
- "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
- "type": "object",
- "properties": {
- "projects": {
- "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
- "type": "array",
- "items": {
+ "projects": {
+ "methods": {
+ "create": {
+ "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage. The parent is identified by a specified\nResourceId, which must include both an ID and a type, such as\nproject, folder, or organization.",
+ "flatPath": "v1beta1/projects",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.create",
+ "parameterOrder": [],
+ "parameters": {
+ "useLegacyStack": {
+ "description": "A safety hatch to opt out of the new reliable project creation process.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "v1beta1/projects",
+ "request": {
"$ref": "Project"
- }
+ },
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
- "nextPageToken": {
- "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
+ "delete": {
+ "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if it has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
+ "flatPath": "v1beta1/projects/{projectId}",
+ "httpMethod": "DELETE",
+ "id": "cloudresourcemanager.projects.delete",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/projects/{projectId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "flatPath": "v1beta1/projects/{projectId}",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.projects.get",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/projects/{projectId}",
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getAncestry": {
+ "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "flatPath": "v1beta1/projects/{projectId}:getAncestry",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.getAncestry",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/projects/{projectId}:getAncestry",
+ "request": {
+ "$ref": "GetAncestryRequest"
+ },
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names).",
+ "flatPath": "v1beta1/projects/{resource}:getIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/projects/{resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the GetProjectmethod.",
+ "flatPath": "v1beta1/projects",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.projects.list",
+ "parameterOrder": [],
+ "parameters": {
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red\u0026nbsp;labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/projects",
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.",
+ "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/projects/{resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified Project.",
+ "flatPath": "v1beta1/projects/{resource}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/projects/{resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "undelete": {
+ "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
+ "flatPath": "v1beta1/projects/{projectId}:undelete",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.projects.undelete",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/projects/{projectId}:undelete",
+ "request": {
+ "$ref": "UndeleteProjectRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "update": {
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
+ "flatPath": "v1beta1/projects/{projectId}",
+ "httpMethod": "PUT",
+ "id": "cloudresourcemanager.projects.update",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/projects/{projectId}",
+ "request": {
+ "$ref": "Project"
+ },
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180315",
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
+ "schemas": {
+ "Ancestor": {
+ "description": "Identifying information for a single ancestor of a project.",
+ "id": "Ancestor",
+ "properties": {
+ "resourceId": {
+ "$ref": "ResourceId",
+ "description": "Resource id of the ancestor."
+ }
+ },
+ "type": "object"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "id": "AuditConfig",
+ "properties": {
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
}
},
- "id": "ListProjectsResponse"
+ "type": "object"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
+ "id": "AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
},
"logType": {
"description": "The log type that this config enables.",
- "type": "string",
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ]
+ "type": "string"
}
},
- "id": "AuditLogConfig"
+ "type": "object"
},
- "GetAncestryRequest": {
- "description": "The request sent to the\nGetAncestry\nmethod.",
- "type": "object",
- "properties": {},
- "id": "GetAncestryRequest"
- },
- "Project": {
- "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
- "type": "object",
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
"properties": {
- "name": {
- "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
- "type": "string"
- },
- "projectId": {
- "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
- "type": "string"
- },
- "lifecycleState": {
- "enumDescriptions": [
- "Unspecified state. This is only used/useful for distinguishing\nunset values.",
- "The normal and active state.",
- "The project has been marked for deletion by the user\n(by invoking DeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
- "This lifecycle state is no longer used and is not returned by the API."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
- ],
- "description": "The Project lifecycle state.\n\nRead-only.",
- "type": "string"
- },
- "projectNumber": {
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "format": "int64",
- "type": "string"
- },
- "parent": {
- "$ref": "ResourceId",
- "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write."
- },
- "labels": {
- "additionalProperties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
"type": "string"
},
- "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
- "type": "object"
+ "type": "array"
},
- "createTime": {
- "description": "Creation time.\n\nRead-only.",
- "format": "google-datetime",
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
},
- "id": "Project"
+ "type": "object"
},
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
- "type": "object",
- "properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- }
- },
- "id": "Policy"
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
},
"FolderOperation": {
- "id": "FolderOperation",
"description": "Metadata describing a long running folder operation",
- "type": "object",
+ "id": "FolderOperation",
"properties": {
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
"destinationParent": {
"description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
"type": "string"
},
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
"operationType": {
"description": "The type of this operation.",
- "type": "string",
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
+ ],
"enumDescriptions": [
"Operation type not specified.",
"A create folder operation.",
"A move folder operation."
],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ]
+ "type": "string"
+ },
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
}
- }
+ },
+ "type": "object"
},
"FolderOperationError": {
- "id": "FolderOperationError",
"description": "A classification of the Folder Operation error.",
- "type": "object",
+ "id": "FolderOperationError",
"properties": {
"errorMessageId": {
"description": "The type of operation error experienced.",
- "type": "string",
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "ACTIVE_FOLDER_HEIGHT_VIOLATION",
+ "MAX_CHILD_FOLDERS_VIOLATION",
+ "FOLDER_NAME_UNIQUENESS_VIOLATION",
+ "RESOURCE_DELETED_VIOLATION",
+ "PARENT_DELETED_VIOLATION",
+ "CYCLE_INTRODUCED_VIOLATION",
+ "FOLDER_BEING_MOVED_VIOLATION",
+ "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
+ "DELETED_FOLDER_HEIGHT_VIOLATION"
+ ],
"enumDescriptions": [
"The error type was unrecognized or unspecified.",
"The attempted action would violate the max folder depth constraint.",
@@ -826,25 +725,232 @@
"The folder the caller is trying to delete contains active resources.",
"The attempted action would violate the max deleted folder depth\nconstraint."
],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "ACTIVE_FOLDER_HEIGHT_VIOLATION",
- "MAX_CHILD_FOLDERS_VIOLATION",
- "FOLDER_NAME_UNIQUENESS_VIOLATION",
- "RESOURCE_DELETED_VIOLATION",
- "PARENT_DELETED_VIOLATION",
- "CYCLE_INTRODUCED_VIOLATION",
- "FOLDER_BEING_MOVED_VIOLATION",
- "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
- "DELETED_FOLDER_HEIGHT_VIOLATION"
- ]
+ "type": "string"
}
- }
+ },
+ "type": "object"
+ },
+ "GetAncestryRequest": {
+ "description": "The request sent to the\nGetAncestry\nmethod.",
+ "id": "GetAncestryRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "GetAncestryResponse": {
+ "description": "Response from the GetAncestry method.",
+ "id": "GetAncestryResponse",
+ "properties": {
+ "ancestor": {
+ "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
+ "items": {
+ "$ref": "Ancestor"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "id": "GetIamPolicyRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "ListOrganizationsResponse": {
+ "description": "The response returned from the `ListOrganizations` method.",
+ "id": "ListOrganizationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results.",
+ "type": "string"
+ },
+ "organizations": {
+ "description": "The list of Organizations that matched the list query, possibly paginated.",
+ "items": {
+ "$ref": "Organization"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListProjectsResponse": {
+ "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
+ "id": "ListProjectsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
+ "type": "string"
+ },
+ "projects": {
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
+ "items": {
+ "$ref": "Project"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Organization": {
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
+ "id": "Organization",
+ "properties": {
+ "creationTime": {
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "A human-readable string that refers to the Organization in the\nGCP Console UI. This string is set by the server and cannot be\nchanged. The string will be set to the primary domain (for example,\n\"google.com\") of the G Suite customer that owns the organization.\n@OutputOnly",
+ "type": "string"
+ },
+ "lifecycleState": {
+ "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED"
+ ],
+ "enumDescriptions": [
+ "Unspecified state. This is only useful for distinguishing unset values.",
+ "The normal and active state.",
+ "The organization has been marked for deletion by the user."
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "type": "string"
+ },
+ "organizationId": {
+ "description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.",
+ "type": "string"
+ },
+ "owner": {
+ "$ref": "OrganizationOwner",
+ "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
+ }
+ },
+ "type": "object"
+ },
+ "OrganizationOwner": {
+ "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
+ "id": "OrganizationOwner",
+ "properties": {
+ "directoryCustomerId": {
+ "description": "The G Suite customer id used in the Directory API.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "id": "Policy",
+ "properties": {
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "AuditConfig"
+ },
+ "type": "array"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Project": {
+ "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
+ "id": "Project",
+ "properties": {
+ "createTime": {
+ "description": "Creation time.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
+ "type": "object"
+ },
+ "lifecycleState": {
+ "description": "The Project lifecycle state.\n\nRead-only.",
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED",
+ "DELETE_IN_PROGRESS"
+ ],
+ "enumDescriptions": [
+ "Unspecified state. This is only used/useful for distinguishing\nunset values.",
+ "The normal and active state.",
+ "The project has been marked for deletion by the user\n(by invoking DeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
+ "This lifecycle state is no longer used and is not returned by the API."
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
+ "type": "string"
+ },
+ "parent": {
+ "$ref": "ResourceId",
+ "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write."
+ },
+ "projectId": {
+ "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
+ "type": "string"
+ },
+ "projectNumber": {
+ "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProjectCreationStatus": {
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
+ "id": "ProjectCreationStatus",
+ "properties": {
+ "createTime": {
+ "description": "Creation time of the project creation workflow.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "gettable": {
+ "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
+ "type": "boolean"
+ },
+ "ready": {
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
},
"ResourceId": {
- "id": "ResourceId",
"description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
- "type": "object",
+ "id": "ResourceId",
"properties": {
"id": {
"description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
@@ -854,167 +960,61 @@
"description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\", \"folder\", and \"organization\".",
"type": "string"
}
- }
- },
- "AuditConfig": {
- "id": "AuditConfig",
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- }
- }
- },
- "Ancestor": {
- "id": "Ancestor",
- "description": "Identifying information for a single ancestor of a project.",
- "type": "object",
- "properties": {
- "resourceId": {
- "$ref": "ResourceId",
- "description": "Resource id of the ancestor."
- }
- }
+ },
+ "type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
- "type": "object",
+ "id": "SetIamPolicyRequest",
"properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"format": "google-fieldmask",
"type": "string"
- },
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
- "id": "SetIamPolicyRequest"
+ "type": "object"
},
- "ListOrganizationsResponse": {
- "id": "ListOrganizationsResponse",
- "description": "The response returned from the `ListOrganizations` method.",
- "type": "object",
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
"properties": {
- "organizations": {
- "description": "The list of Organizations that matched the list query, possibly paginated.",
- "type": "array",
- "items": {
- "$ref": "Organization"
- }
- },
- "nextPageToken": {
- "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results.",
- "type": "string"
- }
- }
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
+ },
+ "type": "array"
}
},
- "id": "Binding"
+ "type": "object"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Organization": {
- "id": "Organization",
- "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
- "type": "object",
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
"properties": {
- "creationTime": {
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "owner": {
- "$ref": "OrganizationOwner",
- "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
- },
- "name": {
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
- "type": "string"
- },
- "organizationId": {
- "description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.\nThis field is deprecated and will be removed in v1. Use name instead.",
- "type": "string"
- },
- "lifecycleState": {
- "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "Unspecified state. This is only useful for distinguishing unset values.",
- "The normal and active state.",
- "The organization has been marked for deletion by the user."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
- ]
- },
- "displayName": {
- "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
- "type": "string"
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
- }
+ },
+ "type": "object"
},
"UndeleteProjectRequest": {
- "id": "UndeleteProjectRequest",
"description": "The request sent to the UndeleteProject\nmethod.",
- "type": "object",
- "properties": {}
+ "id": "UndeleteProjectRequest",
+ "properties": {},
+ "type": "object"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud Resource Manager",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudresourcemanager.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudresourcemanager",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Resource Manager API",
- "ownerName": "Google"
-}
+ "servicePath": "",
+ "title": "Cloud Resource Manager API",
+ "version": "v1beta1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go b/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
index 4ebf128d1..b7ce4a410 100644
--- a/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
+++ b/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
@@ -1,4 +1,4 @@
-// Package cloudresourcemanager provides access to the Google Cloud Resource Manager API.
+// Package cloudresourcemanager provides access to the Cloud Resource Manager API.
//
// See https://cloud.google.com/resource-manager
//
@@ -139,7 +139,7 @@ func (s *Ancestor) MarshalJSON() ([]byte, error) {
// log_types
// specified in each AuditConfig are enabled, and the exempted_members
// in each
-// AuditConfig are exempted.
+// AuditLogConfig are exempted.
//
// Example Policy with multiple AuditConfigs:
//
@@ -625,11 +625,14 @@ type Organization struct {
// @OutputOnly
CreationTime string `json:"creationTime,omitempty"`
- // DisplayName: A friendly string to be used to refer to the
- // Organization in the UI.
- // Assigned by the server, set to the primary domain of the G
- // Suite
- // customer that owns the organization.
+ // DisplayName: A human-readable string that refers to the Organization
+ // in the
+ // GCP Console UI. This string is set by the server and cannot
+ // be
+ // changed. The string will be set to the primary domain (for
+ // example,
+ // "google.com") of the G Suite customer that owns the
+ // organization.
// @OutputOnly
DisplayName string `json:"displayName,omitempty"`
@@ -656,7 +659,6 @@ type Organization struct {
// on creation. This
// should be omitted when creating a new Organization.
// This field is read-only.
- // This field is deprecated and will be removed in v1. Use name instead.
OrganizationId string `json:"organizationId,omitempty"`
// Owner: The owner of this Organization. The owner should be specified
@@ -700,8 +702,8 @@ func (s *Organization) MarshalJSON() ([]byte, error) {
// descendants will
// be deleted.
type OrganizationOwner struct {
- // DirectoryCustomerId: The Google for Work customer id used in the
- // Directory API.
+ // DirectoryCustomerId: The G Suite customer id used in the Directory
+ // API.
DirectoryCustomerId string `json:"directoryCustomerId,omitempty"`
// ForceSendFields is a list of field names (e.g. "DirectoryCustomerId")
@@ -1464,7 +1466,7 @@ func (r *OrganizationsService) List() *OrganizationsListCall {
//
// Organizations may be filtered by `owner.directoryCustomerId` or
// by
-// `domain`, where the domain is a Google for Work domain, for
+// `domain`, where the domain is a G Suite domain, for
// example:
//
// |Filter|Description|
@@ -1596,7 +1598,7 @@ func (c *OrganizationsListCall) Do(opts ...googleapi.CallOption) (*ListOrganizat
// "parameterOrder": [],
// "parameters": {
// "filter": {
- // "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ // "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a G Suite domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
// "location": "query",
// "type": "string"
// },
@@ -2079,7 +2081,11 @@ type ProjectsCreateCall struct {
//
// Several APIs are activated automatically for the Project,
// including
-// Google Cloud Storage.
+// Google Cloud Storage. The parent is identified by a
+// specified
+// ResourceId, which must include both an ID and a type, such
+// as
+// project, folder, or organization.
func (r *ProjectsService) Create(project *Project) *ProjectsCreateCall {
c := &ProjectsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -2176,7 +2182,7 @@ func (c *ProjectsCreateCall) Do(opts ...googleapi.CallOption) (*Project, error)
}
return ret, nil
// {
- // "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.",
+ // "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage. The parent is identified by a specified\nResourceId, which must include both an ID and a type, such as\nproject, folder, or organization.",
// "flatPath": "v1beta1/projects",
// "httpMethod": "POST",
// "id": "cloudresourcemanager.projects.create",
@@ -2214,11 +2220,8 @@ type ProjectsDeleteCall struct {
// Delete: Marks the Project identified by the specified
// `project_id` (for example, `my-project-123`) for deletion.
-// This method will only affect the Project if the following criteria
-// are met:
-//
-// + The Project does not have a billing account associated with it.
-// + The Project has a lifecycle state of
+// This method will only affect the Project if it has a lifecycle state
+// of
// ACTIVE.
//
// This method changes the Project's lifecycle state from
@@ -2326,7 +2329,7 @@ func (c *ProjectsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error) {
}
return ret, nil
// {
- // "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
+ // "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if it has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
// "flatPath": "v1beta1/projects/{projectId}",
// "httpMethod": "DELETE",
// "id": "cloudresourcemanager.projects.delete",
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v2/cloudresourcemanager-api.json b/vendor/google.golang.org/api/cloudresourcemanager/v2/cloudresourcemanager-api.json
new file mode 100644
index 000000000..1fe2d03a1
--- /dev/null
+++ b/vendor/google.golang.org/api/cloudresourcemanager/v2/cloudresourcemanager-api.json
@@ -0,0 +1,848 @@
+{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Resource Manager",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudresourcemanager:v2",
+ "kind": "discovery#restDescription",
+ "name": "cloudresourcemanager",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "folders": {
+ "methods": {
+ "create": {
+ "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
+ "flatPath": "v2/folders",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.create",
+ "parameterOrder": [],
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2/folders",
+ "request": {
+ "$ref": "Folder"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Requests deletion of a Folder. The Folder is moved into the\nDELETE_REQUESTED state\nimmediately, and is deleted approximately 30 days later. This method may\nonly be called on an empty Folder in the\nACTIVE state, where a Folder is empty if\nit doesn't contain any Folders or Projects in the\nACTIVE state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder.",
+ "flatPath": "v2/folders/{foldersId}",
+ "httpMethod": "DELETE",
+ "id": "cloudresourcemanager.folders.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/{+name}",
+ "response": {
+ "$ref": "Folder"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder.",
+ "flatPath": "v2/folders/{foldersId}",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.folders.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/{+name}",
+ "response": {
+ "$ref": "Folder"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
+ "flatPath": "v2/folders/{foldersId}:getIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the Folders that are direct descendants of supplied parent resource.\nList provides a strongly consistent view of the Folders underneath\nthe specified parent resource.\nList returns Folders sorted based upon the (ascending) lexical ordering\nof their display_name.\nThe caller must have `resourcemanager.folders.list` permission on the\nidentified parent.",
+ "flatPath": "v2/folders",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.folders.list",
+ "parameterOrder": [],
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of Folders to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false. This field is optional.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "v2/folders",
+ "response": {
+ "$ref": "ListFoldersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "move": {
+ "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent.",
+ "flatPath": "v2/folders/{foldersId}:move",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.move",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/{+name}:move",
+ "request": {
+ "$ref": "MoveFolderRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in\nthe CreateFolder documentation.\n\nThe Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field.",
+ "flatPath": "v2/folders/{foldersId}",
+ "httpMethod": "PATCH",
+ "id": "cloudresourcemanager.folders.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2/{+name}",
+ "request": {
+ "$ref": "Folder"
+ },
+ "response": {
+ "$ref": "Folder"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "search": {
+ "description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`.",
+ "flatPath": "v2/folders:search",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.search",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v2/folders:search",
+ "request": {
+ "$ref": "SearchFoldersRequest"
+ },
+ "response": {
+ "$ref": "SearchFoldersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder.",
+ "flatPath": "v2/folders/{foldersId}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.",
+ "flatPath": "v2/folders/{foldersId}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "undelete": {
+ "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the\nDELETE_REQUESTED state.\nIn order to succeed, the Folder's parent must be in the\nACTIVE state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder.",
+ "flatPath": "v2/folders/{foldersId}:undelete",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.undelete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/{+name}:undelete",
+ "request": {
+ "$ref": "UndeleteFolderRequest"
+ },
+ "response": {
+ "$ref": "Folder"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180315",
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
+ "schemas": {
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "id": "AuditConfig",
+ "properties": {
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "id": "AuditLogConfig",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logType": {
+ "description": "The log type that this config enables.",
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Folder": {
+ "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
+ "id": "Folder",
+ "properties": {
+ "createTime": {
+ "description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.",
+ "type": "string"
+ },
+ "lifecycleState": {
+ "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED"
+ ],
+ "enumDescriptions": [
+ "Unspecified state.",
+ "The normal and active state.",
+ "The folder has been marked for deletion by the user."
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "id": "FolderOperation",
+ "properties": {
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "The type of this operation.",
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
+ ],
+ "enumDescriptions": [
+ "Operation type not specified.",
+ "A create folder operation.",
+ "A move folder operation."
+ ],
+ "type": "string"
+ },
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FolderOperationError": {
+ "description": "A classification of the Folder Operation error.",
+ "id": "FolderOperationError",
+ "properties": {
+ "errorMessageId": {
+ "description": "The type of operation error experienced.",
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "ACTIVE_FOLDER_HEIGHT_VIOLATION",
+ "MAX_CHILD_FOLDERS_VIOLATION",
+ "FOLDER_NAME_UNIQUENESS_VIOLATION",
+ "RESOURCE_DELETED_VIOLATION",
+ "PARENT_DELETED_VIOLATION",
+ "CYCLE_INTRODUCED_VIOLATION",
+ "FOLDER_BEING_MOVED_VIOLATION",
+ "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
+ "DELETED_FOLDER_HEIGHT_VIOLATION"
+ ],
+ "enumDescriptions": [
+ "The error type was unrecognized or unspecified.",
+ "The attempted action would violate the max folder depth constraint.",
+ "The attempted action would violate the max child folders constraint.",
+ "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
+ "The resource being moved has been deleted.",
+ "The resource a folder was being added to has been deleted.",
+ "The attempted action would introduce cycle in resource path.",
+ "The attempted action would move a folder that is already being moved.",
+ "The folder the caller is trying to delete contains active resources.",
+ "The attempted action would violate the max deleted folder depth\nconstraint."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "id": "GetIamPolicyRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "ListFoldersResponse": {
+ "description": "The ListFolders response message.",
+ "id": "ListFoldersResponse",
+ "properties": {
+ "folders": {
+ "description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource.",
+ "items": {
+ "$ref": "Folder"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MoveFolderRequest": {
+ "description": "The MoveFolder request message.",
+ "id": "MoveFolderRequest",
+ "properties": {
+ "destinationParent": {
+ "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "id": "Operation",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "id": "Policy",
+ "properties": {
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "AuditConfig"
+ },
+ "type": "array"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ProjectCreationStatus": {
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
+ "id": "ProjectCreationStatus",
+ "properties": {
+ "createTime": {
+ "description": "Creation time of the project creation workflow.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "gettable": {
+ "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
+ "type": "boolean"
+ },
+ "ready": {
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SearchFoldersRequest": {
+ "description": "The request message for searching folders.",
+ "id": "SearchFoldersRequest",
+ "properties": {
+ "pageSize": {
+ "description": "The maximum number of folders to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.",
+ "type": "string"
+ },
+ "query": {
+ "description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example queries are:\n\n|Query | Description|\n|----- | -----------|\n|displayName=Test* | Folders whose display name starts with \"Test\".\n|lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.\n|parent=folders/123 | Folders whose parent is \"folders/123\".\n|parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose parent is \"folders/123\".|",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SearchFoldersResponse": {
+ "description": "The response message for searching folders.",
+ "id": "SearchFoldersResponse",
+ "properties": {
+ "folders": {
+ "description": "A possibly paginated folder search results.\nthe specified parent resource.",
+ "items": {
+ "$ref": "Folder"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "id": "SetIamPolicyRequest",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UndeleteFolderRequest": {
+ "description": "The UndeleteFolder request message.",
+ "id": "UndeleteFolderRequest",
+ "properties": {},
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Cloud Resource Manager API",
+ "version": "v2"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v2/cloudresourcemanager-gen.go b/vendor/google.golang.org/api/cloudresourcemanager/v2/cloudresourcemanager-gen.go
new file mode 100644
index 000000000..b1434544a
--- /dev/null
+++ b/vendor/google.golang.org/api/cloudresourcemanager/v2/cloudresourcemanager-gen.go
@@ -0,0 +1,2826 @@
+// Package cloudresourcemanager provides access to the Cloud Resource Manager API.
+//
+// See https://cloud.google.com/resource-manager
+//
+// Usage example:
+//
+// import "google.golang.org/api/cloudresourcemanager/v2"
+// ...
+// cloudresourcemanagerService, err := cloudresourcemanager.New(oauthHttpClient)
+package cloudresourcemanager // import "google.golang.org/api/cloudresourcemanager/v2"
+
+import (
+ "bytes"
+ "encoding/json"
+ "errors"
+ "fmt"
+ context "golang.org/x/net/context"
+ ctxhttp "golang.org/x/net/context/ctxhttp"
+ gensupport "google.golang.org/api/gensupport"
+ googleapi "google.golang.org/api/googleapi"
+ "io"
+ "net/http"
+ "net/url"
+ "strconv"
+ "strings"
+)
+
+// Always reference these packages, just in case the auto-generated code
+// below doesn't.
+var _ = bytes.NewBuffer
+var _ = strconv.Itoa
+var _ = fmt.Sprintf
+var _ = json.NewDecoder
+var _ = io.Copy
+var _ = url.Parse
+var _ = gensupport.MarshalJSON
+var _ = googleapi.Version
+var _ = errors.New
+var _ = strings.Replace
+var _ = context.Canceled
+var _ = ctxhttp.Do
+
+const apiId = "cloudresourcemanager:v2"
+const apiName = "cloudresourcemanager"
+const apiVersion = "v2"
+const basePath = "https://cloudresourcemanager.googleapis.com/"
+
+// OAuth2 scopes used by this API.
+const (
+ // View and manage your data across Google Cloud Platform services
+ CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
+
+ // View your data across Google Cloud Platform services
+ CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
+)
+
+func New(client *http.Client) (*Service, error) {
+ if client == nil {
+ return nil, errors.New("client is nil")
+ }
+ s := &Service{client: client, BasePath: basePath}
+ s.Folders = NewFoldersService(s)
+ return s, nil
+}
+
+type Service struct {
+ client *http.Client
+ BasePath string // API endpoint base URL
+ UserAgent string // optional additional User-Agent fragment
+
+ Folders *FoldersService
+}
+
+func (s *Service) userAgent() string {
+ if s.UserAgent == "" {
+ return googleapi.UserAgent
+ }
+ return googleapi.UserAgent + " " + s.UserAgent
+}
+
+func NewFoldersService(s *Service) *FoldersService {
+ rs := &FoldersService{s: s}
+ return rs
+}
+
+type FoldersService struct {
+ s *Service
+}
+
+// AuditConfig: 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.
+type AuditConfig struct {
+ // AuditLogConfigs: The configuration for logging of each type of
+ // permission.
+ // Next ID: 4
+ AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
+
+ // Service: 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 `json:"service,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "AuditLogConfigs") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *AuditConfig) MarshalJSON() ([]byte, error) {
+ type NoMethod AuditConfig
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AuditLogConfig: 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.
+type AuditLogConfig struct {
+ // ExemptedMembers: Specifies the identities that do not cause logging
+ // for this type of
+ // permission.
+ // Follows the same format of Binding.members.
+ ExemptedMembers []string `json:"exemptedMembers,omitempty"`
+
+ // LogType: The log type that this config enables.
+ //
+ // Possible values:
+ // "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
+ // "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
+ // "DATA_WRITE" - Data writes. Example: CloudSQL Users create
+ // "DATA_READ" - Data reads. Example: CloudSQL Users list
+ LogType string `json:"logType,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "ExemptedMembers") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *AuditLogConfig) MarshalJSON() ([]byte, error) {
+ type NoMethod AuditLogConfig
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Binding: Associates `members` with a `role`.
+type Binding struct {
+ // Members: 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` or `joe@example.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}`: A Google Apps domain name that represents all
+ // the
+ // users of that domain. For example, `google.com` or
+ // `example.com`.
+ //
+ //
+ Members []string `json:"members,omitempty"`
+
+ // Role: Role that is assigned to `members`.
+ // For example, `roles/viewer`, `roles/editor`, or
+ // `roles/owner`.
+ // Required
+ Role string `json:"role,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Members") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Members") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Binding) MarshalJSON() ([]byte, error) {
+ type NoMethod Binding
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Folder: A Folder in an Organization's resource hierarchy, used
+// to
+// organize that Organization's resources.
+type Folder struct {
+ // CreateTime: Output only. Timestamp when the Folder was created.
+ // Assigned by the server.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // DisplayName: The folder’s display name.
+ // A folder’s display name must be unique amongst its siblings,
+ // e.g.
+ // no two folders with the same parent can share the same display
+ // name.
+ // The display name must start and end with a letter or digit, may
+ // contain
+ // letters, digits, spaces, hyphens and underscores and can be no
+ // longer
+ // than 30 characters. This is captured by the regular
+ // expression:
+ // [\p{L}\p{N}]({\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
+ DisplayName string `json:"displayName,omitempty"`
+
+ // LifecycleState: Output only. The lifecycle state of the
+ // folder.
+ // Updates to the lifecycle_state must be performed via
+ // DeleteFolder and
+ // UndeleteFolder.
+ //
+ // Possible values:
+ // "LIFECYCLE_STATE_UNSPECIFIED" - Unspecified state.
+ // "ACTIVE" - The normal and active state.
+ // "DELETE_REQUESTED" - The folder has been marked for deletion by the
+ // user.
+ LifecycleState string `json:"lifecycleState,omitempty"`
+
+ // Name: Output only. The resource name of the Folder.
+ // Its format is `folders/{folder_id}`, for example: "folders/1234".
+ Name string `json:"name,omitempty"`
+
+ // Parent: The Folder’s parent's resource name.
+ // Updates to the folder's parent must be performed via
+ // MoveFolder.
+ Parent string `json:"parent,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "CreateTime") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Folder) MarshalJSON() ([]byte, error) {
+ type NoMethod Folder
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// FolderOperation: Metadata describing a long running folder operation
+type FolderOperation struct {
+ // DestinationParent: The resource name of the folder or organization we
+ // are either creating
+ // the folder under or moving the folder to.
+ DestinationParent string `json:"destinationParent,omitempty"`
+
+ // DisplayName: The display name of the folder.
+ DisplayName string `json:"displayName,omitempty"`
+
+ // OperationType: The type of this operation.
+ //
+ // Possible values:
+ // "OPERATION_TYPE_UNSPECIFIED" - Operation type not specified.
+ // "CREATE" - A create folder operation.
+ // "MOVE" - A move folder operation.
+ OperationType string `json:"operationType,omitempty"`
+
+ // SourceParent: The resource name of the folder's parent.
+ // Only applicable when the operation_type is MOVE.
+ SourceParent string `json:"sourceParent,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "DestinationParent")
+ // to unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "DestinationParent") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *FolderOperation) MarshalJSON() ([]byte, error) {
+ type NoMethod FolderOperation
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// FolderOperationError: A classification of the Folder Operation error.
+type FolderOperationError struct {
+ // ErrorMessageId: The type of operation error experienced.
+ //
+ // Possible values:
+ // "ERROR_TYPE_UNSPECIFIED" - The error type was unrecognized or
+ // unspecified.
+ // "ACTIVE_FOLDER_HEIGHT_VIOLATION" - The attempted action would
+ // violate the max folder depth constraint.
+ // "MAX_CHILD_FOLDERS_VIOLATION" - The attempted action would violate
+ // the max child folders constraint.
+ // "FOLDER_NAME_UNIQUENESS_VIOLATION" - The attempted action would
+ // violate the locally-unique folder
+ // display_name constraint.
+ // "RESOURCE_DELETED_VIOLATION" - The resource being moved has been
+ // deleted.
+ // "PARENT_DELETED_VIOLATION" - The resource a folder was being added
+ // to has been deleted.
+ // "CYCLE_INTRODUCED_VIOLATION" - The attempted action would introduce
+ // cycle in resource path.
+ // "FOLDER_BEING_MOVED_VIOLATION" - The attempted action would move a
+ // folder that is already being moved.
+ // "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION" - The folder the caller is
+ // trying to delete contains active resources.
+ // "DELETED_FOLDER_HEIGHT_VIOLATION" - The attempted action would
+ // violate the max deleted folder depth
+ // constraint.
+ ErrorMessageId string `json:"errorMessageId,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ErrorMessageId") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "ErrorMessageId") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *FolderOperationError) MarshalJSON() ([]byte, error) {
+ type NoMethod FolderOperationError
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GetIamPolicyRequest: Request message for `GetIamPolicy` method.
+type GetIamPolicyRequest struct {
+}
+
+// ListFoldersResponse: The ListFolders response message.
+type ListFoldersResponse struct {
+ // Folders: A possibly paginated list of Folders that are direct
+ // descendants of
+ // the specified parent resource.
+ Folders []*Folder `json:"folders,omitempty"`
+
+ // NextPageToken: A pagination token returned from a previous call to
+ // `ListFolders`
+ // that indicates from where listing should continue.
+ // This field is optional.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Folders") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Folders") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ListFoldersResponse) MarshalJSON() ([]byte, error) {
+ type NoMethod ListFoldersResponse
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// MoveFolderRequest: The MoveFolder request message.
+type MoveFolderRequest struct {
+ // DestinationParent: The resource name of the Folder or Organization to
+ // reparent
+ // the folder under.
+ // Must be of the form `folders/{folder_id}` or
+ // `organizations/{org_id}`.
+ DestinationParent string `json:"destinationParent,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "DestinationParent")
+ // to unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "DestinationParent") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *MoveFolderRequest) MarshalJSON() ([]byte, error) {
+ type NoMethod MoveFolderRequest
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Operation: This resource represents a long-running operation that is
+// the result of a
+// network API call.
+type Operation struct {
+ // Done: 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 bool `json:"done,omitempty"`
+
+ // Error: The error result of the operation in case of failure or
+ // cancellation.
+ Error *Status `json:"error,omitempty"`
+
+ // Metadata: 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 googleapi.RawMessage `json:"metadata,omitempty"`
+
+ // 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 `json:"name,omitempty"`
+
+ // Response: 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 googleapi.RawMessage `json:"response,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Done") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Done") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Operation) MarshalJSON() ([]byte, error) {
+ type NoMethod Operation
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Policy: 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.
+//
+// **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"]
+// }
+// ]
+// }
+//
+// For a description of IAM and its features, see the
+// [IAM developer's guide](https://cloud.google.com/iam/docs).
+type Policy struct {
+ // AuditConfigs: Specifies cloud audit logging configuration for this
+ // policy.
+ AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
+
+ // Bindings: Associates a list of `members` to a `role`.
+ // `bindings` with no members will result in an error.
+ Bindings []*Binding `json:"bindings,omitempty"`
+
+ // Etag: `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 `json:"etag,omitempty"`
+
+ // Version: Deprecated.
+ Version int64 `json:"version,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "AuditConfigs") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "AuditConfigs") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Policy) MarshalJSON() ([]byte, error) {
+ type NoMethod Policy
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ProjectCreationStatus: A status object which is used as the
+// `metadata` field for the Operation
+// returned by CreateProject. It provides insight for when significant
+// phases of
+// Project creation have completed.
+type ProjectCreationStatus struct {
+ // CreateTime: Creation time of the project creation workflow.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // Gettable: True if the project can be retrieved using GetProject. No
+ // other operations
+ // on the project are guaranteed to work until the project creation
+ // is
+ // complete.
+ Gettable bool `json:"gettable,omitempty"`
+
+ // Ready: True if the project creation process is complete.
+ Ready bool `json:"ready,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "CreateTime") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ProjectCreationStatus) MarshalJSON() ([]byte, error) {
+ type NoMethod ProjectCreationStatus
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SearchFoldersRequest: The request message for searching folders.
+type SearchFoldersRequest struct {
+ // PageSize: The maximum number of folders to return in the
+ // response.
+ // This field is optional.
+ PageSize int64 `json:"pageSize,omitempty"`
+
+ // PageToken: A pagination token returned from a previous call to
+ // `SearchFolders`
+ // that indicates from where search should continue.
+ // This field is optional.
+ PageToken string `json:"pageToken,omitempty"`
+
+ // Query: Search criteria used to select the Folders to return.
+ // If no search criteria is specified then all accessible folders will
+ // be
+ // returned.
+ //
+ // Query expressions can be used to restrict results based upon
+ // displayName,
+ // lifecycleState and parent, where the operators `=`, `NOT`, `AND` and
+ // `OR`
+ // can be used along with the suffix wildcard symbol `*`.
+ //
+ // Some example queries are:
+ //
+ // |Query | Description|
+ // |----- | -----------|
+ // |displayName=Test* | Folders whose display name starts with
+ // "Test".
+ // |lifecycleState=ACTIVE | Folders whose lifecycleState is
+ // ACTIVE.
+ // |parent=folders/123 | Folders whose parent is
+ // "folders/123".
+ // |parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose
+ // parent is "folders/123".|
+ Query string `json:"query,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "PageSize") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "PageSize") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *SearchFoldersRequest) MarshalJSON() ([]byte, error) {
+ type NoMethod SearchFoldersRequest
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SearchFoldersResponse: The response message for searching folders.
+type SearchFoldersResponse struct {
+ // Folders: A possibly paginated folder search results.
+ // the specified parent resource.
+ Folders []*Folder `json:"folders,omitempty"`
+
+ // NextPageToken: A pagination token returned from a previous call to
+ // `SearchFolders`
+ // that indicates from where searching should continue.
+ // This field is optional.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Folders") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Folders") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *SearchFoldersResponse) MarshalJSON() ([]byte, error) {
+ type NoMethod SearchFoldersResponse
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SetIamPolicyRequest: Request message for `SetIamPolicy` method.
+type SetIamPolicyRequest struct {
+ // Policy: 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 *Policy `json:"policy,omitempty"`
+
+ // UpdateMask: 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 `json:"updateMask,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Policy") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Policy") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error) {
+ type NoMethod SetIamPolicyRequest
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Status: 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.
+type Status struct {
+ // Code: The status code, which should be an enum value of
+ // google.rpc.Code.
+ Code int64 `json:"code,omitempty"`
+
+ // Details: A list of messages that carry the error details. There is a
+ // common set of
+ // message types for APIs to use.
+ Details []googleapi.RawMessage `json:"details,omitempty"`
+
+ // Message: 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 `json:"message,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Code") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Code") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Status) MarshalJSON() ([]byte, error) {
+ type NoMethod Status
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TestIamPermissionsRequest: Request message for `TestIamPermissions`
+// method.
+type TestIamPermissionsRequest struct {
+ // 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 `json:"permissions,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Permissions") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Permissions") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error) {
+ type NoMethod TestIamPermissionsRequest
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TestIamPermissionsResponse: Response message for `TestIamPermissions`
+// method.
+type TestIamPermissionsResponse struct {
+ // Permissions: A subset of `TestPermissionsRequest.permissions` that
+ // the caller is
+ // allowed.
+ Permissions []string `json:"permissions,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Permissions") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Permissions") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error) {
+ type NoMethod TestIamPermissionsResponse
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// UndeleteFolderRequest: The UndeleteFolder request message.
+type UndeleteFolderRequest struct {
+}
+
+// method id "cloudresourcemanager.folders.create":
+
+type FoldersCreateCall struct {
+ s *Service
+ folder *Folder
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a Folder in the resource hierarchy.
+// Returns an Operation which can be used to track the progress of
+// the
+// folder creation workflow.
+// Upon success the Operation.response field will be populated with
+// the
+// created Folder.
+//
+// In order to succeed, the addition of this new Folder must not
+// violate
+// the Folder naming, height or fanout constraints.
+//
+// + The Folder's display_name must be distinct from all other Folder's
+// that
+// share its parent.
+// + The addition of the Folder must not cause the active Folder
+// hierarchy
+// to exceed a height of 4. Note, the full active + deleted Folder
+// hierarchy
+// is allowed to reach a height of 8; this provides additional headroom
+// when
+// moving folders that contain deleted folders.
+// + The addition of the Folder must not cause the total number of
+// Folders
+// under its parent to exceed 100.
+//
+// If the operation fails due to a folder constraint violation,
+// a PreconditionFailure explaining the violation will be returned.
+// If the failure occurs synchronously then the PreconditionFailure
+// will be returned via the Status.details field and if it
+// occurs
+// asynchronously then the PreconditionFailure will be returned
+// via the the Operation.error field.
+//
+// The caller must have `resourcemanager.folders.create` permission on
+// the
+// identified parent.
+func (r *FoldersService) Create(folder *Folder) *FoldersCreateCall {
+ c := &FoldersCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.folder = folder
+ return c
+}
+
+// Parent sets the optional parameter "parent": The resource name of the
+// new Folder's parent.
+// Must be of the form `folders/{folder_id}` or
+// `organizations/{org_id}`.
+func (c *FoldersCreateCall) Parent(parent string) *FoldersCreateCall {
+ c.urlParams_.Set("parent", parent)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersCreateCall) Fields(s ...googleapi.Field) *FoldersCreateCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersCreateCall) Context(ctx context.Context) *FoldersCreateCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersCreateCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.folder)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/folders")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.create" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *FoldersCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Operation{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
+ // "flatPath": "v2/folders",
+ // "httpMethod": "POST",
+ // "id": "cloudresourcemanager.folders.create",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "parent": {
+ // "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/folders",
+ // "request": {
+ // "$ref": "Folder"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudresourcemanager.folders.delete":
+
+type FoldersDeleteCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Requests deletion of a Folder. The Folder is moved into
+// the
+// DELETE_REQUESTED state
+// immediately, and is deleted approximately 30 days later. This method
+// may
+// only be called on an empty Folder in the
+// ACTIVE state, where a Folder is empty if
+// it doesn't contain any Folders or Projects in the
+// ACTIVE state.
+// The caller must have `resourcemanager.folders.delete` permission on
+// the
+// identified folder.
+func (r *FoldersService) Delete(name string) *FoldersDeleteCall {
+ c := &FoldersDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersDeleteCall) Fields(s ...googleapi.Field) *FoldersDeleteCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersDeleteCall) Context(ctx context.Context) *FoldersDeleteCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersDeleteCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.delete" call.
+// Exactly one of *Folder or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Folder.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *FoldersDeleteCall) Do(opts ...googleapi.CallOption) (*Folder, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Folder{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Requests deletion of a Folder. The Folder is moved into the\nDELETE_REQUESTED state\nimmediately, and is deleted approximately 30 days later. This method may\nonly be called on an empty Folder in the\nACTIVE state, where a Folder is empty if\nit doesn't contain any Folders or Projects in the\nACTIVE state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder.",
+ // "flatPath": "v2/folders/{foldersId}",
+ // "httpMethod": "DELETE",
+ // "id": "cloudresourcemanager.folders.delete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
+ // "location": "path",
+ // "pattern": "^folders/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/{+name}",
+ // "response": {
+ // "$ref": "Folder"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudresourcemanager.folders.get":
+
+type FoldersGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Retrieves a Folder identified by the supplied resource
+// name.
+// Valid Folder resource names have the format
+// `folders/{folder_id}`
+// (for example, `folders/1234`).
+// The caller must have `resourcemanager.folders.get` permission on
+// the
+// identified folder.
+func (r *FoldersService) Get(name string) *FoldersGetCall {
+ c := &FoldersGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersGetCall) Fields(s ...googleapi.Field) *FoldersGetCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *FoldersGetCall) IfNoneMatch(entityTag string) *FoldersGetCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersGetCall) Context(ctx context.Context) *FoldersGetCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersGetCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.get" call.
+// Exactly one of *Folder or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Folder.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *FoldersGetCall) Do(opts ...googleapi.CallOption) (*Folder, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Folder{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder.",
+ // "flatPath": "v2/folders/{foldersId}",
+ // "httpMethod": "GET",
+ // "id": "cloudresourcemanager.folders.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
+ // "location": "path",
+ // "pattern": "^folders/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/{+name}",
+ // "response": {
+ // "$ref": "Folder"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/cloud-platform.read-only"
+ // ]
+ // }
+
+}
+
+// method id "cloudresourcemanager.folders.getIamPolicy":
+
+type FoldersGetIamPolicyCall struct {
+ s *Service
+ resource string
+ getiampolicyrequest *GetIamPolicyRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetIamPolicy: Gets the access control policy for a Folder. The
+// returned policy may be
+// empty if no such policy or resource exists. The `resource` field
+// should
+// be the Folder's resource name, e.g. "folders/1234".
+// The caller must have `resourcemanager.folders.getIamPolicy`
+// permission
+// on the identified folder.
+func (r *FoldersService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *FoldersGetIamPolicyCall {
+ c := &FoldersGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ c.getiampolicyrequest = getiampolicyrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersGetIamPolicyCall) Fields(s ...googleapi.Field) *FoldersGetIamPolicyCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersGetIamPolicyCall) Context(ctx context.Context) *FoldersGetIamPolicyCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersGetIamPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersGetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.getiampolicyrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+resource}:getIamPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.getIamPolicy" call.
+// Exactly one of *Policy or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Policy.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *FoldersGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Policy{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
+ // "flatPath": "v2/folders/{foldersId}:getIamPolicy",
+ // "httpMethod": "POST",
+ // "id": "cloudresourcemanager.folders.getIamPolicy",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "parameters": {
+ // "resource": {
+ // "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ // "location": "path",
+ // "pattern": "^folders/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/{+resource}:getIamPolicy",
+ // "request": {
+ // "$ref": "GetIamPolicyRequest"
+ // },
+ // "response": {
+ // "$ref": "Policy"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/cloud-platform.read-only"
+ // ]
+ // }
+
+}
+
+// method id "cloudresourcemanager.folders.list":
+
+type FoldersListCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists the Folders that are direct descendants of supplied
+// parent resource.
+// List provides a strongly consistent view of the Folders
+// underneath
+// the specified parent resource.
+// List returns Folders sorted based upon the (ascending) lexical
+// ordering
+// of their display_name.
+// The caller must have `resourcemanager.folders.list` permission on
+// the
+// identified parent.
+func (r *FoldersService) List() *FoldersListCall {
+ c := &FoldersListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The maximum number
+// of Folders to return in the response.
+// This field is optional.
+func (c *FoldersListCall) PageSize(pageSize int64) *FoldersListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": A pagination token
+// returned from a previous call to `ListFolders`
+// that indicates where this listing should continue from.
+// This field is optional.
+func (c *FoldersListCall) PageToken(pageToken string) *FoldersListCall {
+ c.urlParams_.Set("pageToken", pageToken)
+ return c
+}
+
+// Parent sets the optional parameter "parent": The resource name of the
+// Organization or Folder whose Folders are
+// being listed.
+// Must be of the form `folders/{folder_id}` or
+// `organizations/{org_id}`.
+// Access to this method is controlled by checking
+// the
+// `resourcemanager.folders.list` permission on the `parent`.
+func (c *FoldersListCall) Parent(parent string) *FoldersListCall {
+ c.urlParams_.Set("parent", parent)
+ return c
+}
+
+// ShowDeleted sets the optional parameter "showDeleted": Controls
+// whether Folders in the
+// DELETE_REQUESTED
+// state should be returned. Defaults to false. This field is optional.
+func (c *FoldersListCall) ShowDeleted(showDeleted bool) *FoldersListCall {
+ c.urlParams_.Set("showDeleted", fmt.Sprint(showDeleted))
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersListCall) Fields(s ...googleapi.Field) *FoldersListCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *FoldersListCall) IfNoneMatch(entityTag string) *FoldersListCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersListCall) Context(ctx context.Context) *FoldersListCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersListCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/folders")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.list" call.
+// Exactly one of *ListFoldersResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListFoldersResponse.ServerResponse.Header or (if a response was
+// returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *FoldersListCall) Do(opts ...googleapi.CallOption) (*ListFoldersResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &ListFoldersResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Lists the Folders that are direct descendants of supplied parent resource.\nList provides a strongly consistent view of the Folders underneath\nthe specified parent resource.\nList returns Folders sorted based upon the (ascending) lexical ordering\nof their display_name.\nThe caller must have `resourcemanager.folders.list` permission on the\nidentified parent.",
+ // "flatPath": "v2/folders",
+ // "httpMethod": "GET",
+ // "id": "cloudresourcemanager.folders.list",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "The maximum number of Folders to return in the response.\nThis field is optional.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "showDeleted": {
+ // "description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false. This field is optional.",
+ // "location": "query",
+ // "type": "boolean"
+ // }
+ // },
+ // "path": "v2/folders",
+ // "response": {
+ // "$ref": "ListFoldersResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/cloud-platform.read-only"
+ // ]
+ // }
+
+}
+
+// Pages invokes f for each page of results.
+// A non-nil error returned from f will halt the iteration.
+// The provided context supersedes any context provided to the Context method.
+func (c *FoldersListCall) Pages(ctx context.Context, f func(*ListFoldersResponse) error) error {
+ c.ctx_ = ctx
+ defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point
+ for {
+ x, err := c.Do()
+ if err != nil {
+ return err
+ }
+ if err := f(x); err != nil {
+ return err
+ }
+ if x.NextPageToken == "" {
+ return nil
+ }
+ c.PageToken(x.NextPageToken)
+ }
+}
+
+// method id "cloudresourcemanager.folders.move":
+
+type FoldersMoveCall struct {
+ s *Service
+ name string
+ movefolderrequest *MoveFolderRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Move: Moves a Folder under a new resource parent.
+// Returns an Operation which can be used to track the progress of
+// the
+// folder move workflow.
+// Upon success the Operation.response field will be populated with
+// the
+// moved Folder.
+// Upon failure, a FolderOperationError categorizing the failure cause
+// will
+// be returned - if the failure occurs synchronously then
+// the
+// FolderOperationError will be returned via the Status.details
+// field
+// and if it occurs asynchronously then the FolderOperation will be
+// returned
+// via the the Operation.error field.
+// In addition, the Operation.metadata field will be populated with
+// a
+// FolderOperation message as an aid to stateless clients.
+// Folder moves will be rejected if they violate either the naming,
+// height
+// or fanout constraints described in the
+// CreateFolder documentation.
+// The caller must have `resourcemanager.folders.move` permission on
+// the
+// folder's current and proposed new parent.
+func (r *FoldersService) Move(name string, movefolderrequest *MoveFolderRequest) *FoldersMoveCall {
+ c := &FoldersMoveCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.movefolderrequest = movefolderrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersMoveCall) Fields(s ...googleapi.Field) *FoldersMoveCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersMoveCall) Context(ctx context.Context) *FoldersMoveCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersMoveCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersMoveCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.movefolderrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}:move")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.move" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *FoldersMoveCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Operation{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent.",
+ // "flatPath": "v2/folders/{foldersId}:move",
+ // "httpMethod": "POST",
+ // "id": "cloudresourcemanager.folders.move",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
+ // "location": "path",
+ // "pattern": "^folders/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/{+name}:move",
+ // "request": {
+ // "$ref": "MoveFolderRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudresourcemanager.folders.patch":
+
+type FoldersPatchCall struct {
+ s *Service
+ name string
+ folder *Folder
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Patch: Updates a Folder, changing its display_name.
+// Changes to the folder display_name will be rejected if they violate
+// either
+// the display_name formatting rules or naming constraints described
+// in
+// the CreateFolder documentation.
+//
+// The Folder's display name must start and end with a letter or
+// digit,
+// may contain letters, digits, spaces, hyphens and underscores and can
+// be
+// no longer than 30 characters. This is captured by the regular
+// expression:
+// [\p{L}\p{N}]({\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
+// The caller must have `resourcemanager.folders.update` permission on
+// the
+// identified folder.
+//
+// If the update fails due to the unique name constraint then
+// a
+// PreconditionFailure explaining this violation will be returned
+// in the Status.details field.
+func (r *FoldersService) Patch(name string, folder *Folder) *FoldersPatchCall {
+ c := &FoldersPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.folder = folder
+ return c
+}
+
+// UpdateMask sets the optional parameter "updateMask": Fields to be
+// updated.
+// Only the `display_name` can be updated.
+func (c *FoldersPatchCall) UpdateMask(updateMask string) *FoldersPatchCall {
+ c.urlParams_.Set("updateMask", updateMask)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersPatchCall) Fields(s ...googleapi.Field) *FoldersPatchCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersPatchCall) Context(ctx context.Context) *FoldersPatchCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersPatchCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersPatchCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.folder)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PATCH", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.patch" call.
+// Exactly one of *Folder or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Folder.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *FoldersPatchCall) Do(opts ...googleapi.CallOption) (*Folder, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Folder{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in\nthe CreateFolder documentation.\n\nThe Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field.",
+ // "flatPath": "v2/folders/{foldersId}",
+ // "httpMethod": "PATCH",
+ // "id": "cloudresourcemanager.folders.patch",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ // "location": "path",
+ // "pattern": "^folders/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "updateMask": {
+ // "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
+ // "format": "google-fieldmask",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/{+name}",
+ // "request": {
+ // "$ref": "Folder"
+ // },
+ // "response": {
+ // "$ref": "Folder"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudresourcemanager.folders.search":
+
+type FoldersSearchCall struct {
+ s *Service
+ searchfoldersrequest *SearchFoldersRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Search: Search for folders that match specific filter
+// criteria.
+// Search provides an eventually consistent view of the folders a user
+// has
+// access to which meet the specified filter criteria.
+//
+// This will only return folders on which the caller has the
+// permission `resourcemanager.folders.get`.
+func (r *FoldersService) Search(searchfoldersrequest *SearchFoldersRequest) *FoldersSearchCall {
+ c := &FoldersSearchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.searchfoldersrequest = searchfoldersrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersSearchCall) Fields(s ...googleapi.Field) *FoldersSearchCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersSearchCall) Context(ctx context.Context) *FoldersSearchCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersSearchCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersSearchCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.searchfoldersrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/folders:search")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.search" call.
+// Exactly one of *SearchFoldersResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *SearchFoldersResponse.ServerResponse.Header or (if a response was
+// returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *FoldersSearchCall) Do(opts ...googleapi.CallOption) (*SearchFoldersResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &SearchFoldersResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`.",
+ // "flatPath": "v2/folders:search",
+ // "httpMethod": "POST",
+ // "id": "cloudresourcemanager.folders.search",
+ // "parameterOrder": [],
+ // "parameters": {},
+ // "path": "v2/folders:search",
+ // "request": {
+ // "$ref": "SearchFoldersRequest"
+ // },
+ // "response": {
+ // "$ref": "SearchFoldersResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/cloud-platform.read-only"
+ // ]
+ // }
+
+}
+
+// Pages invokes f for each page of results.
+// A non-nil error returned from f will halt the iteration.
+// The provided context supersedes any context provided to the Context method.
+func (c *FoldersSearchCall) Pages(ctx context.Context, f func(*SearchFoldersResponse) error) error {
+ c.ctx_ = ctx
+ defer func(pt string) { c.searchfoldersrequest.PageToken = pt }(c.searchfoldersrequest.PageToken) // reset paging to original point
+ for {
+ x, err := c.Do()
+ if err != nil {
+ return err
+ }
+ if err := f(x); err != nil {
+ return err
+ }
+ if x.NextPageToken == "" {
+ return nil
+ }
+ c.searchfoldersrequest.PageToken = x.NextPageToken
+ }
+}
+
+// method id "cloudresourcemanager.folders.setIamPolicy":
+
+type FoldersSetIamPolicyCall struct {
+ s *Service
+ resource string
+ setiampolicyrequest *SetIamPolicyRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetIamPolicy: Sets the access control policy on a Folder, replacing
+// any existing policy.
+// The `resource` field should be the Folder's resource name,
+// e.g.
+// "folders/1234".
+// The caller must have `resourcemanager.folders.setIamPolicy`
+// permission
+// on the identified folder.
+func (r *FoldersService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *FoldersSetIamPolicyCall {
+ c := &FoldersSetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ c.setiampolicyrequest = setiampolicyrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersSetIamPolicyCall) Fields(s ...googleapi.Field) *FoldersSetIamPolicyCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersSetIamPolicyCall) Context(ctx context.Context) *FoldersSetIamPolicyCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersSetIamPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersSetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.setiampolicyrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+resource}:setIamPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.setIamPolicy" call.
+// Exactly one of *Policy or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Policy.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *FoldersSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Policy{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder.",
+ // "flatPath": "v2/folders/{foldersId}:setIamPolicy",
+ // "httpMethod": "POST",
+ // "id": "cloudresourcemanager.folders.setIamPolicy",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "parameters": {
+ // "resource": {
+ // "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ // "location": "path",
+ // "pattern": "^folders/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/{+resource}:setIamPolicy",
+ // "request": {
+ // "$ref": "SetIamPolicyRequest"
+ // },
+ // "response": {
+ // "$ref": "Policy"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudresourcemanager.folders.testIamPermissions":
+
+type FoldersTestIamPermissionsCall struct {
+ s *Service
+ resource string
+ testiampermissionsrequest *TestIamPermissionsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// TestIamPermissions: Returns permissions that a caller has on the
+// specified Folder.
+// The `resource` field should be the Folder's resource name,
+// e.g. "folders/1234".
+//
+// There are no permissions required for making this API call.
+func (r *FoldersService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *FoldersTestIamPermissionsCall {
+ c := &FoldersTestIamPermissionsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ c.testiampermissionsrequest = testiampermissionsrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersTestIamPermissionsCall) Fields(s ...googleapi.Field) *FoldersTestIamPermissionsCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersTestIamPermissionsCall) Context(ctx context.Context) *FoldersTestIamPermissionsCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersTestIamPermissionsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.testiampermissionsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+resource}:testIamPermissions")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.testIamPermissions" call.
+// Exactly one of *TestIamPermissionsResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *TestIamPermissionsResponse.ServerResponse.Header or (if a response
+// was returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *FoldersTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &TestIamPermissionsResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.",
+ // "flatPath": "v2/folders/{foldersId}:testIamPermissions",
+ // "httpMethod": "POST",
+ // "id": "cloudresourcemanager.folders.testIamPermissions",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "parameters": {
+ // "resource": {
+ // "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ // "location": "path",
+ // "pattern": "^folders/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/{+resource}:testIamPermissions",
+ // "request": {
+ // "$ref": "TestIamPermissionsRequest"
+ // },
+ // "response": {
+ // "$ref": "TestIamPermissionsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudresourcemanager.folders.undelete":
+
+type FoldersUndeleteCall struct {
+ s *Service
+ name string
+ undeletefolderrequest *UndeleteFolderRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Undelete: Cancels the deletion request for a Folder. This method may
+// only be
+// called on a Folder in the
+// DELETE_REQUESTED state.
+// In order to succeed, the Folder's parent must be in the
+// ACTIVE state.
+// In addition, reintroducing the folder into the tree must not
+// violate
+// folder naming, height and fanout constraints described in
+// the
+// CreateFolder documentation.
+// The caller must have `resourcemanager.folders.undelete` permission on
+// the
+// identified folder.
+func (r *FoldersService) Undelete(name string, undeletefolderrequest *UndeleteFolderRequest) *FoldersUndeleteCall {
+ c := &FoldersUndeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.undeletefolderrequest = undeletefolderrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FoldersUndeleteCall) Fields(s ...googleapi.Field) *FoldersUndeleteCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FoldersUndeleteCall) Context(ctx context.Context) *FoldersUndeleteCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FoldersUndeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FoldersUndeleteCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.undeletefolderrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}:undelete")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudresourcemanager.folders.undelete" call.
+// Exactly one of *Folder or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Folder.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *FoldersUndeleteCall) Do(opts ...googleapi.CallOption) (*Folder, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Folder{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the\nDELETE_REQUESTED state.\nIn order to succeed, the Folder's parent must be in the\nACTIVE state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder.",
+ // "flatPath": "v2/folders/{foldersId}:undelete",
+ // "httpMethod": "POST",
+ // "id": "cloudresourcemanager.folders.undelete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
+ // "location": "path",
+ // "pattern": "^folders/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/{+name}:undelete",
+ // "request": {
+ // "$ref": "UndeleteFolderRequest"
+ // },
+ // "response": {
+ // "$ref": "Folder"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json b/vendor/google.golang.org/api/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
index 28ebd8ba8..3e305c8fb 100644
--- a/vendor/google.golang.org/api/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
+++ b/vendor/google.golang.org/api/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
@@ -1,101 +1,581 @@
{
- "schemas": {
- "TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
}
}
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Resource Manager",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudresourcemanager:v2beta1",
+ "kind": "discovery#restDescription",
+ "name": "cloudresourcemanager",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
- "type": "object",
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "folders": {
+ "methods": {
+ "create": {
+ "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
+ "flatPath": "v2beta1/folders",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.create",
+ "parameterOrder": [],
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/folders",
+ "request": {
+ "$ref": "Folder"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Requests deletion of a Folder. The Folder is moved into the\nDELETE_REQUESTED state\nimmediately, and is deleted approximately 30 days later. This method may\nonly be called on an empty Folder in the\nACTIVE state, where a Folder is empty if\nit doesn't contain any Folders or Projects in the\nACTIVE state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder.",
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "httpMethod": "DELETE",
+ "id": "cloudresourcemanager.folders.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+name}",
+ "response": {
+ "$ref": "Folder"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder.",
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.folders.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+name}",
+ "response": {
+ "$ref": "Folder"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
+ "flatPath": "v2beta1/folders/{foldersId}:getIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "description": "Lists the Folders that are direct descendants of supplied parent resource.\nList provides a strongly consistent view of the Folders underneath\nthe specified parent resource.\nList returns Folders sorted based upon the (ascending) lexical ordering\nof their display_name.\nThe caller must have `resourcemanager.folders.list` permission on the\nidentified parent.",
+ "flatPath": "v2beta1/folders",
+ "httpMethod": "GET",
+ "id": "cloudresourcemanager.folders.list",
+ "parameterOrder": [],
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of Folders to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
+ "location": "query",
+ "type": "string"
+ },
+ "showDeleted": {
+ "description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false. This field is optional.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "v2beta1/folders",
+ "response": {
+ "$ref": "ListFoldersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "move": {
+ "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent.",
+ "flatPath": "v2beta1/folders/{foldersId}:move",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.move",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+name}:move",
+ "request": {
+ "$ref": "MoveFolderRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in the\nCreateFolder documentation.\n\nThe Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field.",
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "httpMethod": "PATCH",
+ "id": "cloudresourcemanager.folders.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+name}",
+ "request": {
+ "$ref": "Folder"
+ },
+ "response": {
+ "$ref": "Folder"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "search": {
+ "description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`.",
+ "flatPath": "v2beta1/folders:search",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.search",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v2beta1/folders:search",
+ "request": {
+ "$ref": "SearchFoldersRequest"
+ },
+ "response": {
+ "$ref": "SearchFoldersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder.",
+ "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.",
+ "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "undelete": {
+ "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the\nDELETE_REQUESTED state.\nIn order to succeed, the Folder's parent must be in the\nACTIVE state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder.",
+ "flatPath": "v2beta1/folders/{foldersId}:undelete",
+ "httpMethod": "POST",
+ "id": "cloudresourcemanager.folders.undelete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
+ "location": "path",
+ "pattern": "^folders/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/{+name}:undelete",
+ "request": {
+ "$ref": "UndeleteFolderRequest"
+ },
+ "response": {
+ "$ref": "Folder"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180315",
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
+ "schemas": {
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "id": "AuditConfig",
"properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
- },
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
}
},
- "id": "Policy"
+ "type": "object"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "id": "AuditLogConfig",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logType": {
+ "description": "The log type that this config enables.",
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Folder": {
+ "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
+ "id": "Folder",
+ "properties": {
+ "createTime": {
+ "description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.",
+ "type": "string"
+ },
+ "lifecycleState": {
+ "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED"
+ ],
+ "enumDescriptions": [
+ "Unspecified state.",
+ "The normal and active state.",
+ "The folder has been marked for deletion by the user."
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"FolderOperation": {
"description": "Metadata describing a long running folder operation",
- "type": "object",
+ "id": "FolderOperation",
"properties": {
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
"destinationParent": {
"description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
"type": "string"
},
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
"operationType": {
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ],
+ "description": "The type of this operation.",
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"CREATE",
"MOVE"
],
- "description": "The type of this operation.",
+ "enumDescriptions": [
+ "Operation type not specified.",
+ "A create folder operation.",
+ "A move folder operation."
+ ],
+ "type": "string"
+ },
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
"type": "string"
}
},
- "id": "FolderOperation"
+ "type": "object"
},
"FolderOperationError": {
- "id": "FolderOperationError",
"description": "A classification of the Folder Operation error.",
- "type": "object",
+ "id": "FolderOperationError",
"properties": {
"errorMessageId": {
- "enumDescriptions": [
- "The error type was unrecognized or unspecified.",
- "The attempted action would violate the max folder depth constraint.",
- "The attempted action would violate the max child folders constraint.",
- "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
- "The resource being moved has been deleted.",
- "The resource a folder was being added to has been deleted.",
- "The attempted action would introduce cycle in resource path.",
- "The attempted action would move a folder that is already being moved.",
- "The folder the caller is trying to delete contains active resources.",
- "The attempted action would violate the max deleted folder depth\nconstraint."
- ],
+ "description": "The type of operation error experienced.",
"enum": [
"ERROR_TYPE_UNSPECIFIED",
"ACTIVE_FOLDER_HEIGHT_VIOLATION",
@@ -108,20 +588,82 @@
"FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
"DELETED_FOLDER_HEIGHT_VIOLATION"
],
- "description": "The type of operation error experienced.",
+ "enumDescriptions": [
+ "The error type was unrecognized or unspecified.",
+ "The attempted action would violate the max folder depth constraint.",
+ "The attempted action would violate the max child folders constraint.",
+ "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
+ "The resource being moved has been deleted.",
+ "The resource a folder was being added to has been deleted.",
+ "The attempted action would introduce cycle in resource path.",
+ "The attempted action would move a folder that is already being moved.",
+ "The folder the caller is trying to delete contains active resources.",
+ "The attempted action would violate the max deleted folder depth\nconstraint."
+ ],
"type": "string"
}
- }
+ },
+ "type": "object"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "id": "GetIamPolicyRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "ListFoldersResponse": {
+ "description": "The ListFolders response message.",
+ "id": "ListFoldersResponse",
+ "properties": {
+ "folders": {
+ "description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource.",
+ "items": {
+ "$ref": "Folder"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MoveFolderRequest": {
+ "description": "The MoveFolder request message.",
+ "id": "MoveFolderRequest",
+ "properties": {
+ "destinationParent": {
+ "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"Operation": {
- "id": "Operation",
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
+ "id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -129,174 +671,44 @@
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- }
- },
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
}
},
- "id": "AuditConfig"
+ "type": "object"
},
- "ListFoldersResponse": {
- "id": "ListFoldersResponse",
- "description": "The ListFolders response message.",
- "type": "object",
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "id": "Policy",
"properties": {
- "folders": {
- "description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource.",
- "type": "array",
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
"items": {
- "$ref": "Folder"
- }
+ "$ref": "AuditConfig"
+ },
+ "type": "array"
},
- "nextPageToken": {
- "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
- "type": "string"
- }
- }
- },
- "MoveFolderRequest": {
- "id": "MoveFolderRequest",
- "description": "The MoveFolder request message.",
- "type": "object",
- "properties": {
- "destinationParent": {
- "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
- "type": "string"
- }
- }
- },
- "SearchFoldersResponse": {
- "id": "SearchFoldersResponse",
- "description": "The response message for searching folders.",
- "type": "object",
- "properties": {
- "folders": {
- "description": "A possibly paginated folder search results.\nthe specified parent resource.",
- "type": "array",
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"items": {
- "$ref": "Folder"
- }
+ "$ref": "Binding"
+ },
+ "type": "array"
},
- "nextPageToken": {
- "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.",
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
"type": "string"
- }
- }
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
},
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "SetIamPolicyRequest"
- },
- "Status": {
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- }
- }
- },
- "Binding": {
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- }
- },
- "SearchFoldersRequest": {
- "id": "SearchFoldersRequest",
- "description": "The request message for searching folders.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of folders to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- },
- "query": {
- "description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example queries are:\n\n|Query | Description|\n|----- | -----------|\n|displayName=Test*|Folders whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.|\n|parent=folders/123|Folders whose parent is \"folders/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose parent is \"folders/123\".|",
- "type": "string"
- }
- }
+ "type": "object"
},
"ProjectCreationStatus": {
"description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object",
+ "id": "ProjectCreationStatus",
"properties": {
"createTime": {
"description": "Creation time of the project creation workflow.",
@@ -312,537 +724,125 @@
"type": "boolean"
}
},
- "id": "ProjectCreationStatus"
+ "type": "object"
},
- "Folder": {
- "id": "Folder",
- "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
- "type": "object",
+ "SearchFoldersRequest": {
+ "description": "The request message for searching folders.",
+ "id": "SearchFoldersRequest",
"properties": {
- "parent": {
- "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
+ "pageSize": {
+ "description": "The maximum number of folders to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.",
"type": "string"
},
- "createTime": {
- "description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
- "format": "google-datetime",
- "type": "string"
- },
- "lifecycleState": {
- "enumDescriptions": [
- "Unspecified state.",
- "The normal and active state.",
- "The folder has been marked for deletion by the user."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
- ],
- "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
- "type": "string"
- },
- "name": {
- "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
- "type": "string"
- },
- "displayName": {
- "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.",
+ "query": {
+ "description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example queries are:\n\n|Query | Description|\n|----- | -----------|\n|displayName=Test*|Folders whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.|\n|parent=folders/123|Folders whose parent is \"folders/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose parent is \"folders/123\".|",
"type": "string"
}
- }
+ },
+ "type": "object"
+ },
+ "SearchFoldersResponse": {
+ "description": "The response message for searching folders.",
+ "id": "SearchFoldersResponse",
+ "properties": {
+ "folders": {
+ "description": "A possibly paginated folder search results.\nthe specified parent resource.",
+ "items": {
+ "$ref": "Folder"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "id": "SetIamPolicyRequest",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
- "type": "object",
+ "id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
}
},
- "id": "TestIamPermissionsResponse"
- },
- "GetIamPolicyRequest": {
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {}
+ "type": "object"
},
"UndeleteFolderRequest": {
- "id": "UndeleteFolderRequest",
"description": "The UndeleteFolder request message.",
- "type": "object",
- "properties": {}
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "logType": {
- "description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ]
- }
- },
- "id": "AuditLogConfig"
+ "id": "UndeleteFolderRequest",
+ "properties": {},
+ "type": "object"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud Resource Manager",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudresourcemanager.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudresourcemanager",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Resource Manager API",
- "ownerName": "Google",
- "resources": {
- "folders": {
- "methods": {
- "move": {
- "id": "cloudresourcemanager.folders.move",
- "path": "v2beta1/{+name}:move",
- "request": {
- "$ref": "MoveFolderRequest"
- },
- "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}:move"
- },
- "testIamPermissions": {
- "path": "v2beta1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.folders.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions"
- },
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/folders/{foldersId}",
- "path": "v2beta1/{+name}",
- "id": "cloudresourcemanager.folders.delete",
- "description": "Requests deletion of a Folder. The Folder is moved into the\nDELETE_REQUESTED state\nimmediately, and is deleted approximately 30 days later. This method may\nonly be called on an empty Folder in the\nACTIVE state, where a Folder is empty if\nit doesn't contain any Folders or Projects in the\nACTIVE state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder.",
- "response": {
- "$ref": "Folder"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE"
- },
- "list": {
- "description": "Lists the Folders that are direct descendants of supplied parent resource.\nList provides a strongly consistent view of the Folders underneath\nthe specified parent resource.\nList returns Folders sorted based upon the (ascending) lexical ordering\nof their display_name.\nThe caller must have `resourcemanager.folders.list` permission on the\nidentified parent.",
- "response": {
- "$ref": "ListFoldersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of Folders to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
- "type": "string",
- "location": "query"
- },
- "showDeleted": {
- "description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false. This field is optional.",
- "type": "boolean",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v2beta1/folders",
- "path": "v2beta1/folders",
- "id": "cloudresourcemanager.folders.list"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy",
- "path": "v2beta1/{+resource}:setIamPolicy",
- "id": "cloudresourcemanager.folders.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder."
- },
- "create": {
- "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
- "request": {
- "$ref": "Folder"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/folders",
- "path": "v2beta1/folders",
- "id": "cloudresourcemanager.folders.create"
- },
- "getIamPolicy": {
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v2beta1/folders/{foldersId}:getIamPolicy",
- "path": "v2beta1/{+resource}:getIamPolicy",
- "id": "cloudresourcemanager.folders.getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST"
- },
- "search": {
- "path": "v2beta1/folders:search",
- "id": "cloudresourcemanager.folders.search",
- "description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`.",
- "request": {
- "$ref": "SearchFoldersRequest"
- },
- "response": {
- "$ref": "SearchFoldersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {},
- "flatPath": "v2beta1/folders:search"
- },
- "patch": {
- "request": {
- "$ref": "Folder"
- },
- "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in the\nCreateFolder documentation.\n\nThe Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field.",
- "response": {
- "$ref": "Folder"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}",
- "path": "v2beta1/{+name}",
- "id": "cloudresourcemanager.folders.patch"
- },
- "get": {
- "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Folder"
- },
- "parameters": {
- "name": {
- "description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v2beta1/folders/{foldersId}",
- "id": "cloudresourcemanager.folders.get",
- "path": "v2beta1/{+name}"
- },
- "undelete": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Folder"
- },
- "parameters": {
- "name": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}:undelete",
- "id": "cloudresourcemanager.folders.undelete",
- "path": "v2beta1/{+name}:undelete",
- "request": {
- "$ref": "UndeleteFolderRequest"
- },
- "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the\nDELETE_REQUESTED state.\nIn order to succeed, the Folder's parent must be in the\nACTIVE state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder."
- }
- }
- }
- },
- "parameters": {
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v2beta1",
- "baseUrl": "https://cloudresourcemanager.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"servicePath": "",
- "basePath": "",
- "id": "cloudresourcemanager:v2beta1",
- "revision": "20180110",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "discoveryVersion": "v1"
-}
+ "title": "Cloud Resource Manager API",
+ "version": "v2beta1"
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v2beta1/cloudresourcemanager-gen.go b/vendor/google.golang.org/api/cloudresourcemanager/v2beta1/cloudresourcemanager-gen.go
index 518396c2a..950faed52 100644
--- a/vendor/google.golang.org/api/cloudresourcemanager/v2beta1/cloudresourcemanager-gen.go
+++ b/vendor/google.golang.org/api/cloudresourcemanager/v2beta1/cloudresourcemanager-gen.go
@@ -1,4 +1,4 @@
-// Package cloudresourcemanager provides access to the Google Cloud Resource Manager API.
+// Package cloudresourcemanager provides access to the Cloud Resource Manager API.
//
// See https://cloud.google.com/resource-manager
//
@@ -99,7 +99,7 @@ type FoldersService struct {
// log_types
// specified in each AuditConfig are enabled, and the exempted_members
// in each
-// AuditConfig are exempted.
+// AuditLogConfig are exempted.
//
// Example Policy with multiple AuditConfigs:
//
diff --git a/vendor/google.golang.org/api/cloudshell/v1/cloudshell-api.json b/vendor/google.golang.org/api/cloudshell/v1/cloudshell-api.json
index 1395c9877..623b10e71 100644
--- a/vendor/google.golang.org/api/cloudshell/v1/cloudshell-api.json
+++ b/vendor/google.golang.org/api/cloudshell/v1/cloudshell-api.json
@@ -1,51 +1,339 @@
{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://cloudshell.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Shell",
+ "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
"discoveryVersion": "v1",
- "version_module": true,
+ "documentationLink": "https://cloud.google.com/shell/docs/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudshell:v1",
+ "kind": "discovery#restDescription",
+ "name": "cloudshell",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "httpMethod": "POST",
+ "id": "cloudshell.operations.cancel",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "location": "path",
+ "pattern": "^operations/.+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "flatPath": "v1/operations/{operationsId}",
+ "httpMethod": "DELETE",
+ "id": "cloudshell.operations.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "location": "path",
+ "pattern": "^operations/.+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "flatPath": "v1/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "cloudshell.operations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "location": "path",
+ "pattern": "^operations/.+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "flatPath": "v1/operations",
+ "httpMethod": "GET",
+ "id": "cloudshell.operations.list",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "location": "path",
+ "pattern": "^operations$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20180203",
+ "rootUrl": "https://cloudshell.googleapis.com/",
"schemas": {
"CancelOperationRequest": {
- "type": "object",
- "properties": {},
+ "description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation."
+ "properties": {},
+ "type": "object"
},
- "StartEnvironmentMetadata": {
- "description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
- "type": "object",
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "Environment": {
+ "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
+ "id": "Environment",
"properties": {
+ "dockerImage": {
+ "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
+ "type": "string"
+ },
+ "id": {
+ "description": "Output only. The environment's identifier, which is always \"default\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.",
+ "type": "string"
+ },
+ "publicKeys": {
+ "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
+ "items": {
+ "$ref": "PublicKey"
+ },
+ "type": "array"
+ },
+ "sshHost": {
+ "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
+ "type": "string"
+ },
+ "sshPort": {
+ "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sshUsername": {
+ "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
+ "type": "string"
+ },
"state": {
- "enumDescriptions": [
- "The environment's start state is unknown.",
- "The environment is in the process of being started, but no additional\ndetails are available.",
- "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
- "Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
- ],
+ "description": "Output only. Current execution state of this environment.",
"enum": [
"STATE_UNSPECIFIED",
+ "DISABLED",
"STARTING",
- "UNARCHIVING_DISK",
- "FINISHED"
+ "RUNNING"
+ ],
+ "enumDescriptions": [
+ "The environment's states is unknown.",
+ "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
+ "The environment is being started but is not yet ready to accept\nconnections.",
+ "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
],
- "description": "Current state of the environment being started.",
"type": "string"
}
},
- "id": "StartEnvironmentMetadata"
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
+ "id": "Operation",
"properties": {
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
},
"error": {
"$ref": "Status",
@@ -59,138 +347,27 @@
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
},
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- }
- },
- "id": "Operation"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "Environment": {
- "properties": {
- "publicKeys": {
- "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
- "type": "array",
- "items": {
- "$ref": "PublicKey"
- }
- },
- "dockerImage": {
- "type": "string",
- "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\"."
- },
- "state": {
- "description": "Output only. Current execution state of this environment.",
- "type": "string",
- "enumDescriptions": [
- "The environment's states is unknown.",
- "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
- "The environment is being started but is not yet ready to accept\nconnections.",
- "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "DISABLED",
- "STARTING",
- "RUNNING"
- ]
- },
"name": {
- "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.",
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
},
- "sshHost": {
- "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
- "type": "string"
- },
- "sshPort": {
- "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "Output only. The environment's identifier, which is always \"default\".",
- "type": "string"
- },
- "sshUsername": {
- "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
- "type": "string"
- }
- },
- "id": "Environment",
- "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
- "type": "object"
- },
- "StartEnvironmentResponse": {
- "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.",
- "type": "object",
- "properties": {
- "environment": {
- "description": "Environment that was started.",
- "$ref": "Environment"
- }
- },
- "id": "StartEnvironmentResponse"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
}
},
- "id": "Status"
+ "type": "object"
},
"PublicKey": {
"description": "A public SSH key, corresponding to a private SSH key held by the client.",
- "type": "object",
+ "id": "PublicKey",
"properties": {
- "name": {
- "type": "string",
- "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`."
- },
- "key": {
- "description": "Required. Content of this key.",
- "format": "byte",
- "type": "string"
- },
"format": {
+ "description": "Required. Format of this key's content.",
"enum": [
"FORMAT_UNSPECIFIED",
"SSH_DSS",
@@ -199,8 +376,6 @@
"ECDSA_SHA2_NISTP384",
"ECDSA_SHA2_NISTP521"
],
- "description": "Required. Format of this key's content.",
- "type": "string",
"enumDescriptions": [
"Unknown format. Do not use.",
"`ssh-dss` key format (see RFC4253).",
@@ -208,260 +383,85 @@
"`ecdsa-sha2-nistp256` key format (see RFC5656).",
"`ecdsa-sha2-nistp384` key format (see RFC5656).",
"`ecdsa-sha2-nistp521` key format (see RFC5656)."
- ]
+ ],
+ "type": "string"
+ },
+ "key": {
+ "description": "Required. Content of this key.",
+ "format": "byte",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.",
+ "type": "string"
}
},
- "id": "PublicKey"
+ "type": "object"
},
- "Empty": {
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {}
- }
- },
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud Shell",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ "StartEnvironmentMetadata": {
+ "description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
+ "id": "StartEnvironmentMetadata",
+ "properties": {
+ "state": {
+ "description": "Current state of the environment being started.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "STARTING",
+ "UNARCHIVING_DISK",
+ "FINISHED"
+ ],
+ "enumDescriptions": [
+ "The environment's start state is unknown.",
+ "The environment is in the process of being started, but no additional\ndetails are available.",
+ "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
+ "Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
+ ],
+ "type": "string"
}
- }
- }
- },
- "rootUrl": "https://cloudshell.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudshell",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Cloud Shell API",
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "id": "cloudshell.operations.cancel",
- "path": "v1/{+name}:cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}:cancel"
- },
- "delete": {
- "path": "v1/{+name}",
- "id": "cloudshell.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}"
- },
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations$"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "cloudshell.operations.list"
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudshell.operations.get"
+ },
+ "type": "object"
+ },
+ "StartEnvironmentResponse": {
+ "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.",
+ "id": "StartEnvironmentResponse",
+ "properties": {
+ "environment": {
+ "$ref": "Environment",
+ "description": "Environment that was started."
}
- }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
},
- "parameters": {
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudshell.googleapis.com/",
"servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
- "basePath": "",
- "id": "cloudshell:v1",
- "documentationLink": "https://cloud.google.com/shell/docs/",
- "revision": "20180118"
-}
+ "title": "Cloud Shell API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudshell/v1alpha1/cloudshell-api.json b/vendor/google.golang.org/api/cloudshell/v1alpha1/cloudshell-api.json
index 4e4a17795..415dccf63 100644
--- a/vendor/google.golang.org/api/cloudshell/v1alpha1/cloudshell-api.json
+++ b/vendor/google.golang.org/api/cloudshell/v1alpha1/cloudshell-api.json
@@ -1,159 +1,267 @@
{
- "rootUrl": "https://cloudshell.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudshell",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://cloudshell.googleapis.com/",
"batchPath": "batch",
+ "canonicalName": "Cloud Shell",
+ "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://cloud.google.com/shell/docs/",
"fullyEncodeReservedExpansion": true,
- "title": "Cloud Shell API",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudshell:v1alpha1",
+ "kind": "discovery#restDescription",
+ "name": "cloudshell",
+ "ownerDomain": "google.com",
"ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
"resources": {
"users": {
"resources": {
"environments": {
"methods": {
- "start": {
- "response": {
- "$ref": "Operation"
- },
+ "get": {
+ "description": "Gets an environment. Returns NOT_FOUND if the environment does not exist.",
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
+ "httpMethod": "GET",
+ "id": "cloudshell.users.environments.get",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "Name of the requested resource, for example `users/me/environments/default`\nor `users/someone@example.com/environments/default`.",
+ "location": "path",
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha1/{+name}",
+ "response": {
+ "$ref": "Environment"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing environment.",
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
+ "httpMethod": "PATCH",
+ "id": "cloudshell.users.environments.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Name of the resource to be updated, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.",
+ "location": "path",
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask specifying which fields in the environment should be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1alpha1/{+name}",
+ "request": {
+ "$ref": "Environment"
+ },
+ "response": {
+ "$ref": "Environment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "start": {
+ "description": "Starts an existing environment, allowing clients to connect to it. The\nreturned operation will contain an instance of StartEnvironmentMetadata in\nits metadata field. Users can wait for the environment to start by polling\nthis operation via GetOperation. Once the environment has finished starting\nand is ready to accept connections, the operation will contain a\nStartEnvironmentResponse in its response field.",
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start",
+ "httpMethod": "POST",
+ "id": "cloudshell.users.environments.start",
+ "parameterOrder": [
+ "name"
],
"parameters": {
"name": {
"description": "Name of the resource that should be started, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.",
- "required": true,
- "type": "string",
+ "location": "path",
"pattern": "^users/[^/]+/environments/[^/]+$",
- "location": "path"
+ "required": true,
+ "type": "string"
}
},
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start",
"path": "v1alpha1/{+name}:start",
- "id": "cloudshell.users.environments.start",
- "description": "Starts an existing environment, allowing clients to connect to it. The\nreturned operation will contain an instance of StartEnvironmentMetadata in\nits metadata field. Users can wait for the environment to start by polling\nthis operation via GetOperation. Once the environment has finished starting\nand is ready to accept connections, the operation will contain a\nStartEnvironmentResponse in its response field.",
"request": {
"$ref": "StartEnvironmentRequest"
- }
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
+ },
"response": {
- "$ref": "Environment"
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Name of the requested resource, for example `users/me/environments/default`\nor `users/someone@example.com/environments/default`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/environments/[^/]+$"
- }
- },
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
- "id": "cloudshell.users.environments.get",
- "path": "v1alpha1/{+name}",
- "description": "Gets an environment. Returns NOT_FOUND if the environment does not exist."
- },
- "patch": {
- "request": {
- "$ref": "Environment"
- },
- "description": "Updates an existing environment.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Environment"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Mask specifying which fields in the environment should be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "pattern": "^users/[^/]+/environments/[^/]+$",
- "location": "path",
- "description": "Name of the resource to be updated, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
- "id": "cloudshell.users.environments.patch",
- "path": "v1alpha1/{+name}"
+ ]
}
},
"resources": {
"publicKeys": {
"methods": {
"create": {
- "id": "cloudshell.users.environments.publicKeys.create",
- "path": "v1alpha1/{+parent}/publicKeys",
"description": "Adds a public SSH key to an environment, allowing clients with the\ncorresponding private key to connect to that environment via SSH. If a key\nwith the same format and content already exists, this will return the\nexisting key.",
- "request": {
- "$ref": "CreatePublicKeyRequest"
- },
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys",
"httpMethod": "POST",
+ "id": "cloudshell.users.environments.publicKeys.create",
"parameterOrder": [
"parent"
],
+ "parameters": {
+ "parent": {
+ "description": "Parent resource name, e.g. `users/me/environments/default`.",
+ "location": "path",
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1alpha1/{+parent}/publicKeys",
+ "request": {
+ "$ref": "CreatePublicKeyRequest"
+ },
"response": {
"$ref": "PublicKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Removes a public SSH key from an environment. Clients will no longer be\nable to connect to the environment using the corresponding private key.",
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}",
+ "httpMethod": "DELETE",
+ "id": "cloudshell.users.environments.publicKeys.delete",
+ "parameterOrder": [
+ "name"
],
"parameters": {
- "parent": {
- "pattern": "^users/[^/]+/environments/[^/]+$",
+ "name": {
+ "description": "Name of the resource to be deleted, e.g.\n`users/me/environments/default/publicKeys/my-key`.",
"location": "path",
- "description": "Parent resource name, e.g. `users/me/environments/default`.",
+ "pattern": "^users/[^/]+/environments/[^/]+/publicKeys/[^/]+$",
"required": true,
"type": "string"
}
},
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys"
- },
- "delete": {
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}",
- "id": "cloudshell.users.environments.publicKeys.delete",
"path": "v1alpha1/{+name}",
- "description": "Removes a public SSH key from an environment. Clients will no longer be\nable to connect to the environment using the corresponding private key.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Name of the resource to be deleted, e.g.\n`users/me/environments/default/publicKeys/my-key`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/environments/[^/]+/publicKeys/[^/]+$",
- "location": "path"
- }
- }
+ ]
}
}
}
@@ -162,136 +270,88 @@
}
}
},
- "parameters": {
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "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.",
- "type": "string"
- }
- },
- "version": "v1alpha1",
- "baseUrl": "https://cloudshell.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
- "servicePath": "",
- "basePath": "",
- "revision": "20180118",
- "documentationLink": "https://cloud.google.com/shell/docs/",
- "id": "cloudshell:v1alpha1",
- "discoveryVersion": "v1",
- "version_module": true,
+ "revision": "20180203",
+ "rootUrl": "https://cloudshell.googleapis.com/",
"schemas": {
- "StartEnvironmentMetadata": {
- "id": "StartEnvironmentMetadata",
- "description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
- "type": "object",
+ "CreatePublicKeyRequest": {
+ "description": "Request message for CreatePublicKey.",
+ "id": "CreatePublicKeyRequest",
"properties": {
+ "key": {
+ "$ref": "PublicKey",
+ "description": "Key that should be added to the environment."
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "Environment": {
+ "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
+ "id": "Environment",
+ "properties": {
+ "dockerImage": {
+ "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
+ "type": "string"
+ },
+ "id": {
+ "description": "Output only. The environment's identifier, which is always \"default\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.",
+ "type": "string"
+ },
+ "publicKeys": {
+ "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
+ "items": {
+ "$ref": "PublicKey"
+ },
+ "type": "array"
+ },
+ "sshHost": {
+ "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
+ "type": "string"
+ },
+ "sshPort": {
+ "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sshUsername": {
+ "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
+ "type": "string"
+ },
"state": {
- "enumDescriptions": [
- "The environment's start state is unknown.",
- "The environment is in the process of being started, but no additional\ndetails are available.",
- "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
- "Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
- ],
+ "description": "Output only. Current execution state of this environment.",
"enum": [
"STATE_UNSPECIFIED",
+ "DISABLED",
"STARTING",
- "UNARCHIVING_DISK",
- "FINISHED"
+ "RUNNING"
+ ],
+ "enumDescriptions": [
+ "The environment's states is unknown.",
+ "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
+ "The environment is being started but is not yet ready to accept\nconnections.",
+ "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
],
- "description": "Current state of the environment being started.",
"type": "string"
}
- }
+ },
+ "type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
+ "id": "Operation",
"properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
},
"error": {
"$ref": "Status",
@@ -305,9 +365,9 @@
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
},
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
},
"response": {
"additionalProperties": {
@@ -318,140 +378,22 @@
"type": "object"
}
},
- "id": "Operation"
- },
- "Environment": {
- "id": "Environment",
- "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
- "type": "object",
- "properties": {
- "publicKeys": {
- "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
- "type": "array",
- "items": {
- "$ref": "PublicKey"
- }
- },
- "dockerImage": {
- "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "The environment's states is unknown.",
- "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
- "The environment is being started but is not yet ready to accept\nconnections.",
- "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "DISABLED",
- "STARTING",
- "RUNNING"
- ],
- "description": "Output only. Current execution state of this environment.",
- "type": "string"
- },
- "name": {
- "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.",
- "type": "string"
- },
- "sshHost": {
- "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
- "type": "string"
- },
- "sshPort": {
- "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "Output only. The environment's identifier, which is always \"default\".",
- "type": "string"
- },
- "sshUsername": {
- "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
- "type": "string"
- }
- }
- },
- "CreatePublicKeyRequest": {
- "description": "Request message for CreatePublicKey.",
- "type": "object",
- "properties": {
- "key": {
- "$ref": "PublicKey",
- "description": "Key that should be added to the environment."
- }
- },
- "id": "CreatePublicKeyRequest"
- },
- "Status": {
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
- }
- }
- },
- "StartEnvironmentResponse": {
- "id": "StartEnvironmentResponse",
- "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.",
- "type": "object",
- "properties": {
- "environment": {
- "description": "Environment that was started.",
- "$ref": "Environment"
- }
- }
- },
- "StartEnvironmentRequest": {
- "description": "Request message for StartEnvironment.",
- "type": "object",
- "properties": {},
- "id": "StartEnvironmentRequest"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "type": "object"
},
"PublicKey": {
"description": "A public SSH key, corresponding to a private SSH key held by the client.",
- "type": "object",
+ "id": "PublicKey",
"properties": {
- "name": {
- "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.",
- "type": "string"
- },
- "key": {
- "description": "Required. Content of this key.",
- "format": "byte",
- "type": "string"
- },
"format": {
"description": "Required. Format of this key's content.",
- "type": "string",
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "SSH_DSS",
+ "SSH_RSA",
+ "ECDSA_SHA2_NISTP256",
+ "ECDSA_SHA2_NISTP384",
+ "ECDSA_SHA2_NISTP521"
+ ],
"enumDescriptions": [
"Unknown format. Do not use.",
"`ssh-dss` key format (see RFC4253).",
@@ -460,32 +402,90 @@
"`ecdsa-sha2-nistp384` key format (see RFC5656).",
"`ecdsa-sha2-nistp521` key format (see RFC5656)."
],
- "enum": [
- "FORMAT_UNSPECIFIED",
- "SSH_DSS",
- "SSH_RSA",
- "ECDSA_SHA2_NISTP256",
- "ECDSA_SHA2_NISTP384",
- "ECDSA_SHA2_NISTP521"
- ]
+ "type": "string"
+ },
+ "key": {
+ "description": "Required. Content of this key.",
+ "format": "byte",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.",
+ "type": "string"
}
},
- "id": "PublicKey"
- }
- },
- "protocol": "rest",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "canonicalName": "Cloud Shell",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ "type": "object"
+ },
+ "StartEnvironmentMetadata": {
+ "description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
+ "id": "StartEnvironmentMetadata",
+ "properties": {
+ "state": {
+ "description": "Current state of the environment being started.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "STARTING",
+ "UNARCHIVING_DISK",
+ "FINISHED"
+ ],
+ "enumDescriptions": [
+ "The environment's start state is unknown.",
+ "The environment is in the process of being started, but no additional\ndetails are available.",
+ "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
+ "Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
+ ],
+ "type": "string"
}
- }
+ },
+ "type": "object"
+ },
+ "StartEnvironmentRequest": {
+ "description": "Request message for StartEnvironment.",
+ "id": "StartEnvironmentRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "StartEnvironmentResponse": {
+ "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.",
+ "id": "StartEnvironmentResponse",
+ "properties": {
+ "environment": {
+ "$ref": "Environment",
+ "description": "Environment that was started."
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
- }
-}
+ },
+ "servicePath": "",
+ "title": "Cloud Shell API",
+ "version": "v1alpha1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudtasks/v2beta2/cloudtasks-api.json b/vendor/google.golang.org/api/cloudtasks/v2beta2/cloudtasks-api.json
index c799508bd..f80511253 100644
--- a/vendor/google.golang.org/api/cloudtasks/v2beta2/cloudtasks-api.json
+++ b/vendor/google.golang.org/api/cloudtasks/v2beta2/cloudtasks-api.json
@@ -1,615 +1,839 @@
{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://cloudtasks.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Tasks",
+ "description": "Manages the execution of large numbers of distributed requests. Cloud Tasks is in Alpha.",
"discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "ResumeQueueRequest": {
- "description": "Request message for CloudTasks.ResumeQueue.",
- "type": "object",
- "properties": {},
- "id": "ResumeQueueRequest"
+ "documentationLink": "https://cloud.google.com/cloud-tasks/",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudtasks:v2beta2",
+ "kind": "discovery#restDescription",
+ "name": "cloudtasks",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "LeaseTasksResponse": {
- "description": "Response message for leasing tasks using CloudTasks.LeaseTasks.",
- "type": "object",
- "properties": {
- "tasks": {
- "description": "The leased tasks.",
- "type": "array",
- "items": {
- "$ref": "Task"
- }
- }
- },
- "id": "LeaseTasksResponse"
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
},
- "CreateTaskRequest": {
- "description": "Request message for CloudTasks.CreateTask.",
- "type": "object",
- "properties": {
- "task": {
- "description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a name for the task in\nTask.name. If a name is not specified then the system will\ngenerate a random unique task id, which will be returned in the\nresponse's Task.name.\n\nIf Task.schedule_time is not set or is in the past then Cloud\nTasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or completed recently then the call will fail\nwith google.rpc.Code.ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or completed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or completed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CloudTasks.CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently.",
- "$ref": "Task"
- },
- "responseView": {
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.",
- "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string"
- }
- },
- "id": "CreateTaskRequest"
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
},
- "ListTasksResponse": {
- "properties": {
- "tasks": {
- "type": "array",
- "items": {
- "$ref": "Task"
- },
- "description": "The list of tasks."
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListTasks with this value as the\nListTasksRequest.page_token.\n\nIf the next_page_token is empty, there are no more results."
- }
- },
- "id": "ListTasksResponse",
- "description": "Response message for listing tasks using CloudTasks.ListTasks.",
- "type": "object"
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
},
- "Queue": {
- "id": "Queue",
- "description": "A queue is a container of related tasks. Queues are configured to manage\nhow those tasks are dispatched. Configurable properties include rate limits,\nretry options, target types, and others.",
- "type": "object",
- "properties": {
- "pullTarget": {
- "$ref": "PullTarget",
- "description": "Pull target.\n\nA pull queue is a queue that has a PullTarget."
- },
- "appEngineHttpTarget": {
- "description": "App Engine HTTP target.\n\nAn App Engine queue is a queue that has an AppEngineHttpTarget.",
- "$ref": "AppEngineHttpTarget"
- },
- "purgeTime": {
- "description": "Output only. The last time this queue was purged.\n\nAll tasks that were created before this time\nwere purged.\n\nA queue can be purged using CloudTasks.PurgeQueue, the\n[App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).\n\nPurge time will be truncated to the nearest microsecond. Purge\ntime will be unset if the queue has never been purged.",
- "format": "google-datetime",
- "type": "string"
- },
- "retryConfig": {
- "$ref": "RetryConfig",
- "description": "Settings that determine the retry behavior.\n\n* For tasks created using Cloud Tasks: the queue-level retry settings\n apply to all tasks in the queue that were created using Cloud Tasks.\n Retry settings cannot be set on individual tasks.\n* For tasks created using the App Engine SDK: the queue-level retry\n settings apply to all tasks in the queue which do not have retry settings\n explicitly set on the task and were created by the App Engine SDK. See\n [App Engine documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks)."
- },
- "state": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified state.",
- "The queue is running. Tasks can be dispatched.\n\nIf the queue was created using Cloud Tasks and the queue has had no\nactivity (method calls or task dispatches) for 30 days, the queue may\ntake a few minutes to re-activate. Some method calls may return\ngoogle.rpc.Code.NOT_FOUND and tasks may not be dispatched for a few\nminutes until the queue has been re-activated.",
- "Tasks are paused by the user. If the queue is paused then Cloud\nTasks will stop delivering tasks from it, but more tasks can\nstill be added to it by the user. When a pull queue is paused,\nall CloudTasks.LeaseTasks calls will return a\n`FAILED_PRECONDITION` error.",
- "The queue is disabled.\n\nA queue becomes `DISABLED` when\n[queue.yaml](/appengine/docs/python/config/queueref) or\n[queue.xml](appengine/docs/standard/java/config/queueref) is uploaded\nwhich does not contain the queue. You cannot directly disable a queue.\n\nWhen a queue is disabled, tasks can still be added to a queue\nbut the tasks are not dispatched and CloudTasks.LeaseTasks calls\nreturn a `FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nCloudTasks.DeleteQueue."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "RUNNING",
- "PAUSED",
- "DISABLED"
- ],
- "description": "Output only. The state of the queue.\n\n`state` can only be changed by called\nCloudTasks.PauseQueue, CloudTasks.ResumeQueue, or uploading\n[queue.yaml/xml](/appengine/docs/python/config/queueref).\nCloudTasks.UpdateQueue cannot be used to change `state`."
- },
- "name": {
- "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.",
- "type": "string"
- },
- "rateLimits": {
- "description": "Rate limits for task dispatches.\n\nQueue.rate_limits and Queue.retry_config are related because they\nboth control task attempts however they control how tasks are attempted in\ndifferent ways:\n\n* Queue.rate_limits controls the total rate of dispatches from a queue\n (i.e. all traffic dispatched from the queue, regardless of whether the\n dispatch is from a first attempt or a retry).\n* Queue.retry_config controls what happens to particular a task after\n its first attempt fails. That is, Queue.retry_config controls task\n retries (the second attempt, third attempt, etc).",
- "$ref": "RateLimits"
- }
- }
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
},
- "SetIamPolicyRequest": {
- "type": "object",
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method."
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
},
- "AppEngineRouting": {
- "description": "App Engine Routing.\n\nFor more information about services, versions, and instances see\n[An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App Engine](/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
- "type": "object",
- "properties": {
- "service": {
- "description": "App service.\n\nBy default, the task is sent to the service which is the default\nservice when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine Task Queue\nAPI, AppEngineRouting.host is not parsable into\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance. For example, some tasks which were created\nusing the App Engine SDK use a custom domain name; custom domains are not\nparsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance are the empty string.",
- "type": "string"
- },
- "instance": {
- "description": "App instance.\n\nBy default, the task is sent to an instance which is available when\nthe task is attempted.\n\nRequests can only be sent to a specific instance if\n[manual scaling is used in App Engine Standard](/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).\nApp Engine Flex does not support instances. For more information, see\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed)\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
- "type": "string"
- },
- "version": {
- "description": "App version.\n\nBy default, the task is sent to the version which is the default\nversion when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine Task Queue\nAPI, AppEngineRouting.host is not parsable into\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance. For example, some tasks which were created\nusing the App Engine SDK use a custom domain name; custom domains are not\nparsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance are the empty string.",
- "type": "string"
- },
- "host": {
- "description": "Output only. The host that the task is sent to.\n\nFor more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed).\n\nThe host is constructed as:\n\n\n* `host = [application_domain_name]`\u003c/br\u003e\n `| [service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version_dot_service]+ '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`\n\n* `application_domain_name` = The domain name of the app, for\n example \u003capp-id\u003e.appspot.com, which is associated with the\n queue's project ID. Some tasks which were created using the App Engine\n SDK use a custom domain name.\n\n* `service =` AppEngineRouting.service\n\n* `version =` AppEngineRouting.version\n\n* `version_dot_service =`\n AppEngineRouting.version `+ '.' +` AppEngineRouting.service\n\n* `instance =` AppEngineRouting.instance\n\n* `instance_dot_service =`\n AppEngineRouting.instance `+ '.' +` AppEngineRouting.service\n\n* `instance_dot_version =`\n AppEngineRouting.instance `+ '.' +` AppEngineRouting.version\n\n* `instance_dot_version_dot_service =`\n AppEngineRouting.instance `+ '.' +`\n AppEngineRouting.version `+ '.' +` AppEngineRouting.service\n\nIf AppEngineRouting.service is empty, then the task will be sent\nto the service which is the default service when the task is attempted.\n\nIf AppEngineRouting.version is empty, then the task will be sent\nto the version which is the default version when the task is attempted.\n\nIf AppEngineRouting.instance is empty, then the task will be sent\nto an instance which is available when the task is attempted.\n\nWhen AppEngineRouting.service is \"default\",\nAppEngineRouting.version is \"default\", and\nAppEngineRouting.instance is empty, AppEngineRouting.host is\nshortened to just the `application_domain_name`.\n\nIf AppEngineRouting.service, AppEngineRouting.version, or\nAppEngineRouting.instance is invalid, then the task will be sent\nto the default version of the default service when the task is attempted.",
- "type": "string"
- }
- },
- "id": "AppEngineRouting"
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
},
- "AppEngineHttpTarget": {
- "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`",
- "type": "object",
- "properties": {
- "appEngineRoutingOverride": {
- "$ref": "AppEngineRouting",
- "description": "Overrides for the\ntask-level app_engine_routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
- }
- },
- "id": "AppEngineHttpTarget"
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
},
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
- "locationId": {
- "type": "string",
- "description": "The canonical id for this location. For example: `\"us-east1\"`."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- }
- },
- "id": "Location"
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
},
- "LeaseTasksRequest": {
- "description": "Request message for leasing tasks using CloudTasks.LeaseTasks.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "`filter` can be used to specify a subset of tasks to lease.\n\nWhen `filter` is set to `tag=\u003cmy-tag\u003e` then the\nLeaseTasksResponse will contain only tasks whose\nPullMessage.tag is equal to `\u003cmy-tag\u003e`. `\u003cmy-tag\u003e` must be\nless than 500 characters.\n\nWhen `filter` is set to `tag_function=oldest_tag()`, only tasks which have\nthe same tag as the task with the oldest schedule_time will be returned.\n\nGrammar Syntax:\n\n* `filter = \"tag=\" tag | \"tag_function=\" function`\n\n* `tag = string`\n\n* `function = \"oldest_tag()\"`\n\nThe `oldest_tag()` function returns tasks which have the same tag as the\noldest task (ordered by schedule time).\n\nSDK compatibility: Although the SDK allows tags to be either\nstring or [bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),\nonly UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8\nencoded can't be used in LeaseTasksRequest.filter and won't display in\nPullMessage.tag.",
- "type": "string"
- },
- "maxTasks": {
- "type": "integer",
- "description": "The maximum number of tasks to lease. The maximum that can be\nrequested is 1000.",
- "format": "int32"
- },
- "leaseDuration": {
- "description": "The duration of the lease.\n\nEach task returned in the LeaseTasksResponse will have its\nTask.schedule_time set to the current time plus the\n`lease_duration`. A task that has been returned in a\nLeaseTasksResponse is leased -- that task will not be\nreturned in a different LeaseTasksResponse before the\nTask.schedule_time.\n\nAfter the worker has successfully finished the work\nassociated with the task, the worker must call\nCloudTasks.AcknowledgeTask. If the task is not acknowledged\nvia CloudTasks.AcknowledgeTask before the\nTask.schedule_time then it will be returned in a later\nLeaseTasksResponse so that another worker can process\nit.\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
- "format": "google-duration",
- "type": "string"
- },
- "responseView": {
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the Task.name resource.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.",
- "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ]
- }
- },
- "id": "LeaseTasksRequest"
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
},
- "AcknowledgeTaskRequest": {
- "properties": {
- "scheduleTime": {
- "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "AcknowledgeTaskRequest",
- "description": "Request message for acknowledging a task using\nCloudTasks.AcknowledgeTask.",
- "type": "object"
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
},
- "ListQueuesResponse": {
- "id": "ListQueuesResponse",
- "description": "Response message for CloudTasks.ListQueues.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListQueues with this value as the\nListQueuesRequest.page_token.\n\nIf the next_page_token is empty, there are no more results.\n\nThe page token is valid for only 2 hours.",
- "type": "string"
- },
- "queues": {
- "description": "The list of queues.",
- "type": "array",
- "items": {
- "$ref": "Queue"
- }
- }
- }
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
- "type": "object",
- "properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Deprecated.",
- "format": "int32",
- "type": "integer"
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- }
- },
- "id": "Policy"
- },
- "ListLocationsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "projects": {
+ "resources": {
"locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- }
- },
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
- },
- "CancelLeaseRequest": {
- "description": "Request message for canceling a lease using\nCloudTasks.CancelLease.",
- "type": "object",
- "properties": {
- "responseView": {
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.",
- "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string"
- },
- "scheduleTime": {
- "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "CancelLeaseRequest"
- },
- "AttemptStatus": {
- "id": "AttemptStatus",
- "description": "The status of a task attempt.",
- "type": "object",
- "properties": {
- "responseTime": {
- "description": "Output only. The time that this attempt response was received.\n\n`response_time` will be truncated to the nearest microsecond.",
- "format": "google-datetime",
- "type": "string"
- },
- "responseStatus": {
- "$ref": "Status",
- "description": "Output only. The response from the target for this attempt.\n\nIf the task has not been attempted or the task is currently running\nthen the response status is unset."
- },
- "scheduleTime": {
- "description": "Output only. The time that this attempt was scheduled.\n\n`schedule_time` will be truncated to the nearest microsecond.",
- "format": "google-datetime",
- "type": "string"
- },
- "dispatchTime": {
- "description": "Output only. The time that this attempt was dispatched.\n\n`dispatch_time` will be truncated to the nearest microsecond.",
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "RateLimits": {
- "description": "Rate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry.",
- "type": "object",
- "properties": {
- "maxTasksDispatchedPerSecond": {
- "description": "The maximum rate at which tasks are dispatched from this queue.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n* For App Engine queues, the maximum allowed value is 500.\n* This field is output only for [pull queues](google.cloud.tasks.v2beta2.PullTarget).\n In addition to the `max_tasks_dispatched_per_second` limit, a maximum of\n 10 QPS of CloudTasks.LeaseTasks requests are allowed per pull queue.\n\n\nThis field has the same meaning as\n[rate in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#rate).",
- "format": "double",
- "type": "number"
- },
- "maxBurstSize": {
- "description": "Output only. The max burst size.\n\nMax burst size limits how fast tasks in queue are processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\n\nThe [token bucket](https://wikipedia.org/wiki/Token_Bucket)\nalgorithm is used to control the rate of task dispatches. Each\nqueue has a token bucket that holds tokens, up to the maximum\nspecified by `max_burst_size`. Each time a task is dispatched, a\ntoken is removed from the bucket. Tasks will be dispatched until\nthe queue's bucket runs out of tokens. The bucket will be\ncontinuously refilled with new tokens based on\nRateLimits.max_tasks_dispatched_per_second.\n\nCloud Tasks will pick the value of `max_burst_size` based on the value of\nRateLimits.max_tasks_dispatched_per_second.\n\nFor App Engine queues that were created or updated using\n`queue.yaml/xml`, `max_burst_size` is equal to\n[bucket_size](/appengine/docs/standard/python/config/queueref#bucket_size).\nSince `max_burst_size` is output only, if CloudTasks.UpdateQueue is\ncalled on a queue created by `queue.yaml/xml`, `max_burst_size` will be\nreset based on the value of RateLimits.max_tasks_dispatched_per_second,\nregardless of whether RateLimits.max_tasks_dispatched_per_second is\nupdated.\n",
- "format": "int32",
- "type": "integer"
- },
- "maxConcurrentTasks": {
- "description": "The maximum number of concurrent tasks that Cloud Tasks allows\nto be dispatched for this queue. After this threshold has been\nreached, Cloud Tasks stops dispatching tasks until the number of\nconcurrent requests decreases.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n\nThe maximum allowed value is 5,000. -1 indicates no limit.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\nThis field has the same meaning as\n[max_concurrent_requests in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RateLimits"
- },
- "PurgeQueueRequest": {
- "description": "Request message for CloudTasks.PurgeQueue.",
- "type": "object",
- "properties": {},
- "id": "PurgeQueueRequest"
- },
- "PauseQueueRequest": {
- "description": "Request message for CloudTasks.PauseQueue.",
- "type": "object",
- "properties": {},
- "id": "PauseQueueRequest"
- },
- "RunTaskRequest": {
- "id": "RunTaskRequest",
- "description": "Request message for forcing a task to run now using\nCloudTasks.RunTask.",
- "type": "object",
- "properties": {
- "responseView": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.",
- "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource."
- }
- }
- },
- "Task": {
- "description": "A unit of scheduled work.",
- "type": "object",
- "properties": {
- "appEngineHttpRequest": {
- "$ref": "AppEngineHttpRequest",
- "description": "App Engine HTTP request that is sent to the task's target. Can be set\nonly if Queue.app_engine_http_target is set.\n\nAn App Engine task is a task that has AppEngineHttpRequest set."
- },
- "view": {
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.",
- "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "Output only. The view specifies which subset of the Task has\nbeen returned.",
- "type": "string"
- },
- "pullMessage": {
- "description": "Pull message contains data that should be used by the caller of\nCloudTasks.LeaseTasks to process the task. Can be set only if\nQueue.pull_target is set.\n\nA pull task is a task that has PullMessage set.",
- "$ref": "PullMessage"
- },
- "scheduleTime": {
- "description": "The time when the task is scheduled to be attempted.\n\nFor App Engine queues, this is when the task will be attempted or retried.\n\nFor pull queues, this is the time when the task is available to\nbe leased; if a task is currently leased, this is the time when\nthe current lease expires, that is, the time that the task was\nleased plus the LeaseTasksRequest.lease_duration.\n\n`schedule_time` will be truncated to the nearest microsecond.",
- "format": "google-datetime",
- "type": "string"
- },
- "createTime": {
- "description": "Output only. The time that the task was created.\n\n`create_time` will be truncated to the nearest second.",
- "format": "google-datetime",
- "type": "string"
- },
- "status": {
- "description": "Output only. The task status.",
- "$ref": "TaskStatus"
- },
- "name": {
- "description": "The task name.\n\nThe task name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the task's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n* `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.\n\nOptionally caller-specified in CreateTaskRequest.",
- "type": "string"
- }
- },
- "id": "Task"
- },
- "PullMessage": {
- "description": "The pull message contains data that can be used by the caller of\nCloudTasks.LeaseTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\nQueue.pull_target set.",
- "type": "object",
- "properties": {
- "payload": {
- "description": "A data payload consumed by the worker to execute the task.",
- "format": "byte",
- "type": "string"
- },
- "tag": {
- "type": "string",
- "description": "The task's tag.\n\nTags allow similar tasks to be processed in a batch. If you label\ntasks with a tag, your worker can lease tasks\nwith the same tag using LeaseTasksRequest.filter. For example,\nif you want to aggregate the events associated with a specific\nuser once a day, you could tag tasks with the user ID.\n\nThe task's tag can only be set when the\ntask is created.\n\nThe tag must be less than 500 characters.\n\nSDK compatibility: Although the SDK allows tags to be either\nstring or [bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),\nonly UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8\nencoded, the tag will be empty when the task is returned by Cloud Tasks."
- }
- },
- "id": "PullMessage"
- },
- "Status": {
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "methods": {
+ "get": {
+ "description": "Get information about a location.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}",
+ "httpMethod": "GET",
+ "id": "cloudtasks.projects.locations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the location.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}",
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations",
+ "httpMethod": "GET",
+ "id": "cloudtasks.projects.locations.list",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}/locations",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "queues": {
+ "methods": {
+ "create": {
+ "description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\nbefore using this method.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+parent}/queues",
+ "request": {
+ "$ref": "Queue"
+ },
+ "response": {
+ "$ref": "Queue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\nbefore using this method.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "httpMethod": "DELETE",
+ "id": "cloudtasks.projects.locations.queues.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets a queue.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "httpMethod": "GET",
+ "id": "cloudtasks.projects.locations.queues.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}",
+ "response": {
+ "$ref": "Queue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a Queue.\nReturns an empty policy if the resource exists and does not have a policy\nset.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.getIamPolicy`",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists queues.\n\nQueues are returned in lexicographical order.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
+ "httpMethod": "GET",
+ "id": "cloudtasks.projects.locations.queues.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `\u003c=, \u003c, \u003e=, \u003e, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use the\nnext_page_token in the\nresponse to determine if more queues exist.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nnext_page_token returned\nfrom the previous call to ListQueues\nmethod. It is an error to switch the value of the\nfilter while iterating through pages.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+parent}/queues",
+ "response": {
+ "$ref": "ListQueuesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\nbefore using this method.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "httpMethod": "PATCH",
+ "id": "cloudtasks.projects.locations.queues.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueue,\nafter which it becomes output only.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "A mask used to specify which fields of the queue are being updated.\n\nIf empty, then all fields will be updated.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}",
+ "request": {
+ "$ref": "Queue"
+ },
+ "response": {
+ "$ref": "Queue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "pause": {
+ "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop dispatching tasks\nuntil the queue is resumed via\nResumeQueue. Tasks can still be added\nwhen the queue is paused. A queue is paused if its\nstate is PAUSED.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.pause",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}:pause",
+ "request": {
+ "$ref": "PauseQueueRequest"
+ },
+ "response": {
+ "$ref": "Queue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "purge": {
+ "description": "Purges a queue by deleting all of its tasks.\n\nAll tasks created before this method is called are permanently deleted.\n\nPurge operations can take up to one minute to take effect. Tasks\nmight be dispatched before the purge takes effect. A purge is irreversible.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.purge",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}:purge",
+ "request": {
+ "$ref": "PurgeQueueRequest"
+ },
+ "response": {
+ "$ref": "Queue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "resume": {
+ "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.resume",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}:resume",
+ "request": {
+ "$ref": "ResumeQueueRequest"
+ },
+ "response": {
+ "$ref": "Queue"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy for a Queue. Replaces any existing\npolicy.\n\nNote: The Cloud Console does not check queue-level IAM permissions yet.\nProject-level permissions are required to use the Cloud Console.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.setIamPolicy`",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.setIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "tasks": {
+ "methods": {
+ "acknowledge": {
+ "description": "Acknowledges a pull task.\n\nThe worker, that is, the entity that\nleased this task must call this method\nto indicate that the work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nlease_duration or the lease\nwill expire and the task will become available to be leased\nagain. After the task is acknowledged, it will not be returned\nby a later LeaseTasks,\nGetTask, or\nListTasks.\n\nTo acknowledge multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:acknowledge",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.tasks.acknowledge",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}:acknowledge",
+ "request": {
+ "$ref": "AcknowledgeTaskRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "cancelLease": {
+ "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease by\nsetting its schedule_time to now. This will\nmake the task available to be leased to the next caller of\nLeaseTasks.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}:cancelLease",
+ "request": {
+ "$ref": "CancelLeaseRequest"
+ },
+ "response": {
+ "$ref": "Task"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "description": "Creates a task and adds it to a queue.\n\nTo add multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n the maximum task size is 100KB.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n the maximum task size is 1MB.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.tasks.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+parent}/tasks",
+ "request": {
+ "$ref": "CreateTaskRequest"
+ },
+ "response": {
+ "$ref": "Task"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a task.\n\nA task can be deleted if it is scheduled or dispatched. A task\ncannot be deleted if it has completed successfully or permanently\nfailed.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
+ "httpMethod": "DELETE",
+ "id": "cloudtasks.projects.locations.queues.tasks.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets a task.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
+ "httpMethod": "GET",
+ "id": "cloudtasks.projects.locations.queues.tasks.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}",
+ "response": {
+ "$ref": "Task"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "lease": {
+ "description": "Leases tasks from a pull queue for\nlease_duration.\n\nThis method is invoked by the worker to obtain a lease. The\nworker must acknowledge the task via\nAcknowledgeTask after they have\nperformed the work associated with the task.\n\nThe payload is intended to store data that\nthe worker needs to perform the work associated with the task. To\nreturn the payloads in the response, set\nresponse_view to\nFULL.\n\nA maximum of 10 qps of LeaseTasks\nrequests are allowed per\nqueue. RESOURCE_EXHAUSTED\nis returned when this limit is\nexceeded. RESOURCE_EXHAUSTED\nis also returned when\nmax_tasks_dispatched_per_second\nis exceeded.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:lease",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.tasks.lease",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+parent}/tasks:lease",
+ "request": {
+ "$ref": "LeaseTasksRequest"
+ },
+ "response": {
+ "$ref": "LeaseTasksResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists the tasks in a queue.\n\nBy default, only the BASIC view is retrieved\ndue to performance considerations;\nresponse_view controls the\nsubset of information which is returned.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
+ "httpMethod": "GET",
+ "id": "cloudtasks.projects.locations.queues.tasks.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "orderBy": {
+ "description": "Sort order used for the query. The only fields supported for sorting\nare `schedule_time` and `pull_message.tag`. All results will be\nreturned in approximately ascending order. The default ordering is by\n`schedule_time`.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nnext_page_token in the\nresponse to determine if more tasks exist.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nnext_page_token returned\nfrom the previous call to ListTasks\nmethod.\n\nThe page token is valid for only 2 hours.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+parent}/tasks",
+ "response": {
+ "$ref": "ListTasksResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "renewLease": {
+ "description": "Renew the current lease of a pull task.\n\nThe worker can use this method to extend the lease by a new\nduration, starting from now. The new task lease will be\nreturned in the task's schedule_time.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:renewLease",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.tasks.renewLease",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}:renewLease",
+ "request": {
+ "$ref": "RenewLeaseRequest"
+ },
+ "response": {
+ "$ref": "Task"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "run": {
+ "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, RunTask can be used to retry a failed\ntask after a fix has been made or to manually force a task to be\ndispatched now.\n\nWhen this method is called, Cloud Tasks will dispatch the task to its\ntarget, even if the queue is PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the status after the task is dispatched but\nbefore the task is received by its target.\n\nIf Cloud Tasks receives a successful response from the task's\nhandler, then the task will be deleted; otherwise the task's\nschedule_time will be reset to the time that\nRunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nRunTask returns\nNOT_FOUND when it is called on a\ntask that has already succeeded or permanently\nfailed. FAILED_PRECONDITION\nis returned when RunTask is called on task\nthat is dispatched or already running.\n\nRunTask cannot be called on\npull tasks.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run",
+ "httpMethod": "POST",
+ "id": "cloudtasks.projects.locations.queues.tasks.run",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta2/{+name}:run",
+ "request": {
+ "$ref": "RunTaskRequest"
+ },
+ "response": {
+ "$ref": "Task"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
}
}
}
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "Binding": {
- "properties": {
- "members": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
- },
- "RenewLeaseRequest": {
- "type": "object",
+ }
+ }
+ },
+ "revision": "20180302",
+ "rootUrl": "https://cloudtasks.googleapis.com/",
+ "schemas": {
+ "AcknowledgeTaskRequest": {
+ "description": "Request message for acknowledging a task using\nAcknowledgeTask.",
+ "id": "AcknowledgeTaskRequest",
"properties": {
"scheduleTime": {
- "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.",
+ "description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
"format": "google-datetime",
"type": "string"
- },
- "leaseDuration": {
- "description": "Required.\n\nThe desired new lease duration, starting from now.\n\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
- "format": "google-duration",
- "type": "string"
- },
- "responseView": {
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.",
- "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string"
}
},
- "id": "RenewLeaseRequest",
- "description": "Request message for renewing a lease using CloudTasks.RenewLease."
- },
- "TaskStatus": {
- "description": "Status of the task.",
- "type": "object",
- "properties": {
- "attemptResponseCount": {
- "type": "integer",
- "description": "Output only. The number of attempts which have received a response.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
- "format": "int32"
- },
- "lastAttemptStatus": {
- "$ref": "AttemptStatus",
- "description": "Output only. The status of the task's last attempt.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget)."
- },
- "attemptDispatchCount": {
- "description": "Output only. The number of attempts dispatched.\n\nThis count includes tasks which have been dispatched but haven't\nreceived a response.",
- "format": "int32",
- "type": "integer"
- },
- "firstAttemptStatus": {
- "description": "Output only. The status of the task's first attempt.\n\nOnly AttemptStatus.dispatch_time will be set.\nThe other AttemptStatus information is not retained by Cloud Tasks.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
- "$ref": "AttemptStatus"
- }
- },
- "id": "TaskStatus"
+ "type": "object"
},
"AppEngineHttpRequest": {
- "description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nThis proto can only be used for tasks in a queue which has\nQueue.app_engine_http_target set.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch files](/appengine/docs/python/config/dispatchref).\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If set, AppEngineHttpTarget.app_engine_routing_override is used for\n all tasks in the queue, no matter what the setting is for the\n task-level app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` AppEngineRouting.host `+` AppEngineHttpRequest.relative_url\n\nThe task attempt has succeeded if the app's request handler returns\nan HTTP response code in the range [`200` - `299`]. `503` is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error `503` will be retried regardless of\nretry configuration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.",
- "type": "object",
+ "description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nThis proto can only be used for tasks in a queue which has\napp_engine_http_target set.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch files](/appengine/docs/python/config/dispatchref).\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If set,\n app_engine_routing_override\n is used for all tasks in the queue, no matter what the setting\n is for the\n task-level app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` host `+`\n relative_url\n\nThe task attempt has succeeded if the app's request handler returns\nan HTTP response code in the range [`200` - `299`]. `503` is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error `503` will be retried regardless of\nretry configuration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.",
+ "id": "AppEngineHttpRequest",
"properties": {
+ "appEngineRouting": {
+ "$ref": "AppEngineRouting",
+ "description": "Task-level setting for App Engine routing.\n\nIf set,\napp_engine_routing_override\nis used for all tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
+ },
"headers": {
"additionalProperties": {
"type": "string"
},
- "description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\n[task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has an AppEngineHttpRequest.payload, Cloud Tasks sets the\nfollowing headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explictly\n setting `Content-Type` to a particular media type when the\n [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CloudTasks.CreateTask documentation.",
+ "description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\n[task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has a payload, Cloud\nTasks sets the following headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explicitly\n setting `Content-Type` to a particular media type when the\n [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CreateTask documentation.",
"type": "object"
},
- "appEngineRouting": {
- "$ref": "AppEngineRouting",
- "description": "Task-level setting for App Engine routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
- },
"httpMethod": {
- "enumDescriptions": [
- "HTTP method unspecified",
- "HTTP Post",
- "HTTP Get",
- "HTTP Head",
- "HTTP Put",
- "HTTP Delete"
- ],
+ "description": "The HTTP method to use for the request. The default is POST.\n\nThe app's request handler for the task's target URL must be able to handle\nHTTP requests with this http_method, otherwise the task attempt will fail\nwith error code 405 (Method Not Allowed). See\n[Writing a push task request handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)\nand the documentation for the request handlers in the language your app is\nwritten in e.g.\n[Python Request Handler](/appengine/docs/python/tools/webapp/requesthandlerclass).",
"enum": [
"HTTP_METHOD_UNSPECIFIED",
"POST",
@@ -618,7 +842,14 @@
"PUT",
"DELETE"
],
- "description": "The HTTP method to use for the request. The default is POST.\n\nThe app's request handler for the task's target URL must be able to handle\nHTTP requests with this http_method, otherwise the task attempt will fail\nwith error code 405 (Method Not Allowed). See\n[Writing a push task request handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)\nand the documentation for the request handlers in the language your app is\nwritten in e.g.\n[Python Request Handler](/appengine/docs/python/tools/webapp/requesthandlerclass).",
+ "enumDescriptions": [
+ "HTTP method unspecified",
+ "HTTP Post",
+ "HTTP Get",
+ "HTTP Head",
+ "HTTP Put",
+ "HTTP Delete"
+ ],
"type": "string"
},
"payload": {
@@ -631,876 +862,649 @@
"type": "string"
}
},
- "id": "AppEngineHttpRequest"
+ "type": "object"
+ },
+ "AppEngineHttpTarget": {
+ "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`",
+ "id": "AppEngineHttpTarget",
+ "properties": {
+ "appEngineRoutingOverride": {
+ "$ref": "AppEngineRouting",
+ "description": "Overrides for the\ntask-level app_engine_routing.\n\nIf set, `app_engine_routing_override` is used for all tasks in\nthe queue, no matter what the setting is for the\ntask-level app_engine_routing."
+ }
+ },
+ "type": "object"
+ },
+ "AppEngineRouting": {
+ "description": "App Engine Routing.\n\nFor more information about services, versions, and instances see\n[An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App Engine](/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
+ "id": "AppEngineRouting",
+ "properties": {
+ "host": {
+ "description": "Output only. The host that the task is sent to.\n\nFor more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed).\n\nThe host is constructed as:\n\n\n* `host = [application_domain_name]`\u003c/br\u003e\n `| [service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version_dot_service]+ '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`\n\n* `application_domain_name` = The domain name of the app, for\n example \u003capp-id\u003e.appspot.com, which is associated with the\n queue's project ID. Some tasks which were created using the App Engine\n SDK use a custom domain name.\n\n* `service =` service\n\n* `version =` version\n\n* `version_dot_service =`\n version `+ '.' +`\n service\n\n* `instance =` instance\n\n* `instance_dot_service =`\n instance `+ '.' +`\n service\n\n* `instance_dot_version =`\n instance `+ '.' +`\n version\n\n* `instance_dot_version_dot_service =`\n instance `+ '.' +`\n version `+ '.' +`\n service\n\nIf service is empty, then the task will be sent\nto the service which is the default service when the task is attempted.\n\nIf version is empty, then the task will be sent\nto the version which is the default version when the task is attempted.\n\nIf instance is empty, then the task\nwill be sent to an instance which is available when the task is\nattempted.\n\nWhen service is \"default\",\nversion is \"default\", and\ninstance is empty,\nhost is shortened to just the\n`application_domain_name`.\n\nIf service,\nversion, or\ninstance is invalid, then the task\nwill be sent to the default version of the default service when\nthe task is attempted.",
+ "type": "string"
+ },
+ "instance": {
+ "description": "App instance.\n\nBy default, the task is sent to an instance which is available when\nthe task is attempted.\n\nRequests can only be sent to a specific instance if\n[manual scaling is used in App Engine Standard](/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).\nApp Engine Flex does not support instances. For more information, see\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed)\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
+ "type": "string"
+ },
+ "service": {
+ "description": "App service.\n\nBy default, the task is sent to the service which is the default\nservice when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine\nTask Queue API, host is not parsable\ninto service,\nversion, and\ninstance. For example, some tasks\nwhich were created using the App Engine SDK use a custom domain\nname; custom domains are not parsed by Cloud Tasks. If\nhost is not parsable, then\nservice,\nversion, and\ninstance are the empty string.",
+ "type": "string"
+ },
+ "version": {
+ "description": "App version.\n\nBy default, the task is sent to the version which is the default\nversion when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine\nTask Queue API, host is not parsable\ninto service,\nversion, and\ninstance. For example, some tasks\nwhich were created using the App Engine SDK use a custom domain\nname; custom domains are not parsed by Cloud Tasks. If\nhost is not parsable, then\nservice,\nversion, and\ninstance are the empty string.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AttemptStatus": {
+ "description": "The status of a task attempt.",
+ "id": "AttemptStatus",
+ "properties": {
+ "dispatchTime": {
+ "description": "Output only. The time that this attempt was dispatched.\n\n`dispatch_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "responseStatus": {
+ "$ref": "Status",
+ "description": "Output only. The response from the target for this attempt.\n\nIf the task has not been attempted or the task is currently running\nthen the response status is unset."
+ },
+ "responseTime": {
+ "description": "Output only. The time that this attempt response was received.\n\n`response_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "scheduleTime": {
+ "description": "Output only. The time that this attempt was scheduled.\n\n`schedule_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CancelLeaseRequest": {
+ "description": "Request message for canceling a lease using\nCancelLease.",
+ "id": "CancelLeaseRequest",
+ "properties": {
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
+ ],
+ "type": "string"
+ },
+ "scheduleTime": {
+ "description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreateTaskRequest": {
+ "description": "Request message for CreateTask.",
+ "id": "CreateTaskRequest",
+ "properties": {
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
+ ],
+ "type": "string"
+ },
+ "task": {
+ "$ref": "Task",
+ "description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a task name. If a\nname is not specified then the system will generate a random\nunique task id, which will be set in the task returned in the\nresponse.\n\nIf schedule_time is not set or is in the\npast then Cloud Tasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or completed recently then the call will fail\nwith ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or completed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or completed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently."
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
- "type": "object",
+ "id": "GetIamPolicyRequest",
"properties": {},
- "id": "GetIamPolicyRequest"
+ "type": "object"
},
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
+ "LeaseTasksRequest": {
+ "description": "Request message for leasing tasks using LeaseTasks.",
+ "id": "LeaseTasksRequest",
"properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "filter": {
+ "description": "`filter` can be used to specify a subset of tasks to lease.\n\nWhen `filter` is set to `tag=\u003cmy-tag\u003e` then the\nresponse will contain only tasks whose\ntag is equal to `\u003cmy-tag\u003e`. `\u003cmy-tag\u003e` must be\nless than 500 characters.\n\nWhen `filter` is set to `tag_function=oldest_tag()`, only tasks which have\nthe same tag as the task with the oldest schedule_time will be returned.\n\nGrammar Syntax:\n\n* `filter = \"tag=\" tag | \"tag_function=\" function`\n\n* `tag = string`\n\n* `function = \"oldest_tag()\"`\n\nThe `oldest_tag()` function returns tasks which have the same tag as the\noldest task (ordered by schedule time).\n\nSDK compatibility: Although the SDK allows tags to be either\nstring or\n[bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),\nonly UTF-8 encoded tags can be used in Cloud Tasks. Tag which\naren't UTF-8 encoded can't be used in the\nfilter and the task's\ntag will be displayed as empty in Cloud Tasks.",
+ "type": "string"
+ },
+ "leaseDuration": {
+ "description": "\nAfter the worker has successfully finished the work associated\nwith the task, the worker must call via\nAcknowledgeTask before the\nschedule_time. Otherwise the task will be\nreturned to a later LeaseTasks call so\nthat another worker can retry it.\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxTasks": {
+ "description": "The maximum number of tasks to lease. The maximum that can be\nrequested is 1000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
+ ],
+ "type": "string"
}
},
- "id": "TestIamPermissionsResponse"
+ "type": "object"
+ },
+ "LeaseTasksResponse": {
+ "description": "Response message for leasing tasks using LeaseTasks.",
+ "id": "LeaseTasksResponse",
+ "properties": {
+ "tasks": {
+ "description": "The leased tasks.",
+ "items": {
+ "$ref": "Task"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListQueuesResponse": {
+ "description": "Response message for ListQueues.",
+ "id": "ListQueuesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nListQueues with this value as the\npage_token.\n\nIf the next_page_token is empty, there are no more results.\n\nThe page token is valid for only 2 hours.",
+ "type": "string"
+ },
+ "queues": {
+ "description": "The list of queues.",
+ "items": {
+ "$ref": "Queue"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListTasksResponse": {
+ "description": "Response message for listing tasks using ListTasks.",
+ "id": "ListTasksResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nListTasks with this value as the\npage_token.\n\nIf the next_page_token is empty, there are no more results.",
+ "type": "string"
+ },
+ "tasks": {
+ "description": "The list of tasks.",
+ "items": {
+ "$ref": "Task"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
+ "properties": {
+ "displayName": {
+ "description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PauseQueueRequest": {
+ "description": "Request message for PauseQueue.",
+ "id": "PauseQueueRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "id": "Policy",
+ "properties": {
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "PullMessage": {
+ "description": "The pull message contains data that can be used by the caller of\nLeaseTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\npull_target set.",
+ "id": "PullMessage",
+ "properties": {
+ "payload": {
+ "description": "A data payload consumed by the worker to execute the task.",
+ "format": "byte",
+ "type": "string"
+ },
+ "tag": {
+ "description": "The task's tag.\n\nTags allow similar tasks to be processed in a batch. If you label\ntasks with a tag, your worker can\nlease tasks with the same tag using\nfilter. For example, if you want to\naggregate the events associated with a specific user once a day,\nyou could tag tasks with the user ID.\n\nThe task's tag can only be set when the\ntask is created.\n\nThe tag must be less than 500 characters.\n\nSDK compatibility: Although the SDK allows tags to be either\nstring or [bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),\nonly UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8\nencoded, the tag will be empty when the task is returned by Cloud Tasks.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PullTarget": {
+ "description": "Pull target.",
+ "id": "PullTarget",
+ "properties": {},
+ "type": "object"
+ },
+ "PurgeQueueRequest": {
+ "description": "Request message for PurgeQueue.",
+ "id": "PurgeQueueRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "Queue": {
+ "description": "A queue is a container of related tasks. Queues are configured to manage\nhow those tasks are dispatched. Configurable properties include rate limits,\nretry options, target types, and others.",
+ "id": "Queue",
+ "properties": {
+ "appEngineHttpTarget": {
+ "$ref": "AppEngineHttpTarget",
+ "description": "App Engine HTTP target.\n\nAn App Engine queue is a queue that has an AppEngineHttpTarget."
+ },
+ "name": {
+ "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueue,\nafter which it becomes output only.",
+ "type": "string"
+ },
+ "pullTarget": {
+ "$ref": "PullTarget",
+ "description": "Pull target.\n\nA pull queue is a queue that has a PullTarget."
+ },
+ "purgeTime": {
+ "description": "Output only. The last time this queue was purged.\n\nAll tasks that were created before this time\nwere purged.\n\nA queue can be purged using PurgeQueue, the\n[App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).\n\nPurge time will be truncated to the nearest microsecond. Purge\ntime will be unset if the queue has never been purged.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "rateLimits": {
+ "$ref": "RateLimits",
+ "description": "Rate limits for task dispatches.\n\nrate_limits and\nretry_config are related because they both\ncontrol task attempts however they control how tasks are\nattempted in different ways:\n\n* rate_limits controls the total rate of\n dispatches from a queue (i.e. all traffic dispatched from the\n queue, regardless of whether the dispatch is from a first\n attempt or a retry).\n* retry_config controls what happens to\n particular a task after its first attempt fails. That is,\n retry_config controls task retries (the\n second attempt, third attempt, etc)."
+ },
+ "retryConfig": {
+ "$ref": "RetryConfig",
+ "description": "Settings that determine the retry behavior.\n\n* For tasks created using Cloud Tasks: the queue-level retry settings\n apply to all tasks in the queue that were created using Cloud Tasks.\n Retry settings cannot be set on individual tasks.\n* For tasks created using the App Engine SDK: the queue-level retry\n settings apply to all tasks in the queue which do not have retry settings\n explicitly set on the task and were created by the App Engine SDK. See\n [App Engine documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks)."
+ },
+ "state": {
+ "description": "Output only. The state of the queue.\n\n`state` can only be changed by called\nPauseQueue,\nResumeQueue, or uploading\n[queue.yaml/xml](/appengine/docs/python/config/queueref).\nUpdateQueue cannot be used to change `state`.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "RUNNING",
+ "PAUSED",
+ "DISABLED"
+ ],
+ "enumDescriptions": [
+ "Unspecified state.",
+ "The queue is running. Tasks can be dispatched.\n\nIf the queue was created using Cloud Tasks and the queue has\nhad no activity (method calls or task dispatches) for 30 days,\nthe queue may take a few minutes to re-activate. Some method\ncalls may return NOT_FOUND and\ntasks may not be dispatched for a few minutes until the queue\nhas been re-activated.",
+ "Tasks are paused by the user. If the queue is paused then Cloud\nTasks will stop delivering tasks from it, but more tasks can\nstill be added to it by the user. When a pull queue is paused,\nall LeaseTasks calls will return a\nFAILED_PRECONDITION.",
+ "The queue is disabled.\n\nA queue becomes `DISABLED` when\n[queue.yaml](/appengine/docs/python/config/queueref) or\n[queue.xml](appengine/docs/standard/java/config/queueref) is uploaded\nwhich does not contain the queue. You cannot directly disable a queue.\n\nWhen a queue is disabled, tasks can still be added to a queue\nbut the tasks are not dispatched and\nLeaseTasks calls return a\n`FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nDeleteQueue."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RateLimits": {
+ "description": "Rate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry.",
+ "id": "RateLimits",
+ "properties": {
+ "maxBurstSize": {
+ "description": "Output only. The max burst size.\n\nMax burst size limits how fast tasks in queue are processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\n\nThe [token bucket](https://wikipedia.org/wiki/Token_Bucket)\nalgorithm is used to control the rate of task dispatches. Each\nqueue has a token bucket that holds tokens, up to the maximum\nspecified by `max_burst_size`. Each time a task is dispatched, a\ntoken is removed from the bucket. Tasks will be dispatched until\nthe queue's bucket runs out of tokens. The bucket will be\ncontinuously refilled with new tokens based on\nmax_tasks_dispatched_per_second.\n\nCloud Tasks will pick the value of `max_burst_size` based on the\nvalue of\nmax_tasks_dispatched_per_second.\n\nFor App Engine queues that were created or updated using\n`queue.yaml/xml`, `max_burst_size` is equal to\n[bucket_size](/appengine/docs/standard/python/config/queueref#bucket_size).\nSince `max_burst_size` is output only, if\nUpdateQueue is called on a queue\ncreated by `queue.yaml/xml`, `max_burst_size` will be reset based\non the value of\nmax_tasks_dispatched_per_second,\nregardless of whether\nmax_tasks_dispatched_per_second\nis updated.\n",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxConcurrentTasks": {
+ "description": "The maximum number of concurrent tasks that Cloud Tasks allows\nto be dispatched for this queue. After this threshold has been\nreached, Cloud Tasks stops dispatching tasks until the number of\nconcurrent requests decreases.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n\nThe maximum allowed value is 5,000. -1 indicates no limit.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\nThis field has the same meaning as\n[max_concurrent_requests in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxTasksDispatchedPerSecond": {
+ "description": "The maximum rate at which tasks are dispatched from this queue.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n* For App Engine queues, the maximum allowed value is 500.\n* This field is output only for [pull queues](google.cloud.tasks.v2beta2.PullTarget). In\n addition to the `max_tasks_dispatched_per_second` limit, a\n maximum of 10 QPS of LeaseTasks\n requests are allowed per pull queue.\n\n\nThis field has the same meaning as\n[rate in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#rate).",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "RenewLeaseRequest": {
+ "description": "Request message for renewing a lease using\nRenewLease.",
+ "id": "RenewLeaseRequest",
+ "properties": {
+ "leaseDuration": {
+ "description": "Required.\n\nThe desired new lease duration, starting from now.\n\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
+ ],
+ "type": "string"
+ },
+ "scheduleTime": {
+ "description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ResumeQueueRequest": {
+ "description": "Request message for ResumeQueue.",
+ "id": "ResumeQueueRequest",
+ "properties": {},
+ "type": "object"
},
"RetryConfig": {
+ "description": "Retry config.\n\nThese settings determine how a failed task attempt is retried.",
+ "id": "RetryConfig",
"properties": {
- "minBackoff": {
- "description": "A task will be [scheduled](Task.schedule_time) for retry between\nRetryConfig.min_backoff and RetryConfig.max_backoff duration after\nit fails, if the queue's RetryConfig specifies that the task should be\nretried.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\n`min_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[min_backoff_seconds in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "format": "google-duration",
- "type": "string"
- },
- "maxBackoff": {
- "description": "A task will be [scheduled](Task.schedule_time) for retry between\nRetryConfig.min_backoff and RetryConfig.max_backoff duration after\nit fails, if the queue's RetryConfig specifies that the task should be\nretried.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\n`max_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[max_backoff_seconds in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "format": "google-duration",
- "type": "string"
- },
- "maxRetryDuration": {
- "description": "If positive, `max_retry_duration` specifies the time limit for retrying a\nfailed task, measured from when the task was first attempted. Once\n`max_retry_duration` time has passed *and* the task has been attempted\nRetryConfig.max_attempts times, no further attempts will be made and\nthe task will be deleted.\n\nIf zero, then the task age is unlimited.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\n`max_retry_duration` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[task_age_limit in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "format": "google-duration",
- "type": "string"
- },
"maxAttempts": {
"description": "The maximum number of attempts for a task.\n\nCloud Tasks will attempt the task `max_attempts` times (that\nis, if the first attempt fails, then there will be\n`max_attempts - 1` retries). Must be \u003e 0.",
"format": "int32",
"type": "integer"
},
+ "maxBackoff": {
+ "description": "A task will be [scheduled](Task.schedule_time) for retry between\nmin_backoff and\nmax_backoff duration after it fails,\nif the queue's RetryConfig specifies that the task should be\nretried.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\n`max_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[max_backoff_seconds in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "google-duration",
+ "type": "string"
+ },
"maxDoublings": {
- "description": "The time between retries will double `max_doublings` times.\n\nA task's retry interval starts at RetryConfig.min_backoff,\nthen doubles `max_doublings` times, then increases linearly, and\nfinally retries retries at intervals of\nRetryConfig.max_backoff up to max_attempts times.\n\nFor example, if RetryConfig.min_backoff is 10s,\nRetryConfig.max_backoff is 300s, and `max_doublings` is 3,\nthen the a task will first be retried in 10s. The retry interval\nwill double three times, and then increase linearly by 2^3 * 10s.\nFinally, the task will retry at intervals of\nRetryConfig.max_backoff until the task has been attempted\n`max_attempts` times. Thus, the requests will retry at 10s, 20s,\n40s, 80s, 160s, 240s, 300s, 300s, ....\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\nThis field has the same meaning as\n[max_doublings in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "description": "The time between retries will double `max_doublings` times.\n\nA task's retry interval starts at\nmin_backoff, then doubles\n`max_doublings` times, then increases linearly, and finally\nretries retries at intervals of\nmax_backoff up to\nmax_attempts times.\n\nFor example, if min_backoff is 10s,\nmax_backoff is 300s, and\n`max_doublings` is 3, then the a task will first be retried in\n10s. The retry interval will double three times, and then\nincrease linearly by 2^3 * 10s. Finally, the task will retry at\nintervals of max_backoff until the\ntask has been attempted max_attempts\ntimes. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,\n240s, 300s, 300s, ....\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\nThis field has the same meaning as\n[max_doublings in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
"format": "int32",
"type": "integer"
},
+ "maxRetryDuration": {
+ "description": "If positive, `max_retry_duration` specifies the time limit for\nretrying a failed task, measured from when the task was first\nattempted. Once `max_retry_duration` time has passed *and* the\ntask has been attempted max_attempts\ntimes, no further attempts will be made and the task will be\ndeleted.\n\nIf zero, then the task age is unlimited.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\n`max_retry_duration` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[task_age_limit in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "minBackoff": {
+ "description": "A task will be [scheduled](Task.schedule_time) for retry between\nmin_backoff and\nmax_backoff duration after it fails,\nif the queue's RetryConfig specifies that the task should be\nretried.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\nThis field is output only for\n[pull queues](google.cloud.tasks.v2beta2.PullTarget).\n\n\n`min_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[min_backoff_seconds in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "google-duration",
+ "type": "string"
+ },
"unlimitedAttempts": {
"description": "If true, then the number of attempts is unlimited.",
"type": "boolean"
}
},
- "id": "RetryConfig",
- "description": "Retry config.\n\nThese settings determine how a failed task attempt is retried.",
"type": "object"
},
- "PullTarget": {
- "properties": {},
- "id": "PullTarget",
- "description": "Pull target.",
- "type": "object"
- }
- },
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "Cloud Tasks",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ "RunTaskRequest": {
+ "description": "Request message for forcing a task to run now using\nRunTask.",
+ "id": "RunTaskRequest",
+ "properties": {
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
+ ],
+ "type": "string"
}
- }
- }
- },
- "rootUrl": "https://cloudtasks.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudtasks",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Cloud Tasks API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "flatPath": "v2beta2/projects/{projectsId}/locations",
- "path": "v2beta2/{+name}/locations",
- "id": "cloudtasks.projects.locations.list",
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- }
+ },
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "id": "SetIamPolicyRequest",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
- "get": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.get",
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Resource name for the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
+ "type": "object"
},
- "resources": {
- "queues": {
- "resources": {
- "tasks": {
- "methods": {
- "renewLease": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Task"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:renewLease",
- "id": "cloudtasks.projects.locations.queues.tasks.renewLease",
- "path": "v2beta2/{+name}:renewLease",
- "request": {
- "$ref": "RenewLeaseRequest"
- },
- "description": "Renew the current lease of a pull task.\n\nThe worker can use this method to extend the lease by a new\nduration, starting from now. The new task lease will be\nreturned in Task.schedule_time."
- },
- "get": {
- "description": "Gets a task.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Task"
- },
- "parameters": {
- "name": {
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path"
- },
- "responseView": {
- "type": "string",
- "location": "query",
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
- "id": "cloudtasks.projects.locations.queues.tasks.get",
- "path": "v2beta2/{+name}"
- },
- "lease": {
- "response": {
- "$ref": "LeaseTasksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:lease",
- "path": "v2beta2/{+parent}/tasks:lease",
- "id": "cloudtasks.projects.locations.queues.tasks.lease",
- "request": {
- "$ref": "LeaseTasksRequest"
- },
- "description": "Leases tasks from a pull queue for LeaseTasksRequest.lease_duration.\n\nThis method is invoked by the worker to obtain a\nlease. The worker must acknowledge the task via\nCloudTasks.AcknowledgeTask after they have performed the work\nassociated with the task.\n\nThe payload is intended to store data that the worker needs\nto perform the work associated with the task. To return the\npayloads in the LeaseTasksResponse, set\nLeaseTasksRequest.response_view to Task.View.FULL.\n\nA maximum of 10 qps of CloudTasks.LeaseTasks requests are allowed per\nqueue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit\nis exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when\nRateLimits.max_tasks_dispatched_per_second is exceeded."
- },
- "delete": {
- "description": "Deletes a task.\n\nA task can be deleted if it is scheduled or dispatched. A task\ncannot be deleted if it has completed successfully or permanently\nfailed.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.tasks.delete"
- },
- "list": {
- "description": "Lists the tasks in a queue.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default due to performance\nconsiderations; ListTasksRequest.response_view controls the\nsubset of information which is returned.",
- "response": {
- "$ref": "ListTasksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string"
- },
- "responseView": {
- "location": "query",
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string"
- },
- "orderBy": {
- "description": "Sort order used for the query. The only fields supported for sorting\nare `schedule_time` and `pull_message.tag`. All results will be\nreturned in approximately ascending order. The default ordering is by\n`schedule_time`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListTasksResponse.next_page_token returned from the previous\ncall to CloudTasks.ListTasks method.\n\nThe page token is valid for only 2 hours.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nListTasksResponse.next_page_token to determine if more tasks\nexist.",
- "format": "int32"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
- "path": "v2beta2/{+parent}/tasks",
- "id": "cloudtasks.projects.locations.queues.tasks.list"
- },
- "create": {
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
- "path": "v2beta2/{+parent}/tasks",
- "id": "cloudtasks.projects.locations.queues.tasks.create",
- "description": "Creates a task and adds it to a queue.\n\nTo add multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n the maximum task size is 100KB.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n the maximum task size is 1MB.",
- "request": {
- "$ref": "CreateTaskRequest"
- }
- },
- "run": {
- "request": {
- "$ref": "RunTaskRequest"
- },
- "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, CloudTasks.RunTask can be used to retry a failed\ntask after a fix has been made or to manually force a task to be\ndispatched now.\n\nWhen this method is called, Cloud Tasks will dispatch the task to its\ntarget, even if the queue is Queue.State.PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the Task.status after the task is dispatched but\nbefore the task is received by its target.\n\nIf Cloud Tasks receives a successful response from the task's\nhandler, then the task will be deleted; otherwise the task's\nTask.schedule_time will be reset to the time that\nCloudTasks.RunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nCloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when\nit is called on a task that has already succeeded or permanently\nfailed. google.rpc.Code.FAILED_PRECONDITION is returned when\nCloudTasks.RunTask is called on task that is dispatched or\nalready running.\n\nCloudTasks.RunTask cannot be called on pull tasks.",
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run",
- "path": "v2beta2/{+name}:run",
- "id": "cloudtasks.projects.locations.queues.tasks.run"
- },
- "cancelLease": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease",
- "path": "v2beta2/{+name}:cancelLease",
- "id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
- "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease\nby setting Task.schedule_time to now. This will make the task\navailable to be leased to the next caller of CloudTasks.LeaseTasks.",
- "request": {
- "$ref": "CancelLeaseRequest"
- },
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST"
- },
- "acknowledge": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:acknowledge",
- "path": "v2beta2/{+name}:acknowledge",
- "id": "cloudtasks.projects.locations.queues.tasks.acknowledge",
- "description": "Acknowledges a pull task.\n\nThe worker, that is, the entity that received this task in\na LeaseTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nLeaseTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nLeaseTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.LeaseTasks,\nCloudTasks.GetTask, or CloudTasks.ListTasks.\n\nTo acknowledge multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.",
- "request": {
- "$ref": "AcknowledgeTaskRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path"
- }
- }
- }
- }
- }
- },
- "methods": {
- "list": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
- "path": "v2beta2/{+parent}/queues",
- "id": "cloudtasks.projects.locations.queues.list",
- "description": "Lists queues.\n\nQueues are returned in lexicographical order.",
- "response": {
- "$ref": "ListQueuesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListQueuesResponse.next_page_token returned from the previous\ncall to CloudTasks.ListQueues method. It is an error to\nswitch the value of ListQueuesRequest.filter while iterating\nthrough pages.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use\nListQueuesResponse.next_page_token to determine if more\nqueues exist.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- },
- "filter": {
- "location": "query",
- "description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `\u003c=, \u003c, \u003e=, \u003e, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "create": {
- "request": {
- "$ref": "Queue"
- },
- "description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.",
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\ngoogle.cloud.location.Locations.ListLocations.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
- "path": "v2beta2/{+parent}/queues",
- "id": "cloudtasks.projects.locations.queues.create"
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy",
- "id": "cloudtasks.projects.locations.queues.setIamPolicy",
- "path": "v2beta2/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy for a Queue. Replaces any existing\npolicy.\n\nNote: The Cloud Console does not check queue-level IAM permissions yet.\nProject-level permissions are required to use the Cloud Console.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.setIamPolicy`"
- },
- "resume": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Queue"
- },
- "parameters": {
- "name": {
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
- "id": "cloudtasks.projects.locations.queues.resume",
- "path": "v2beta2/{+name}:resume",
- "request": {
- "$ref": "ResumeQueueRequest"
- },
- "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nQueue.State.PAUSED or Queue.State.DISABLED. The state of\na queue is stored in Queue.state; after calling this method it\nwill be set to Queue.State.RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf)."
- },
- "getIamPolicy": {
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy",
- "path": "v2beta2/{+resource}:getIamPolicy",
- "id": "cloudtasks.projects.locations.queues.getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for a Queue.\nReturns an empty policy if the resource exists and does not have a policy\nset.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.getIamPolicy`",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST"
- },
- "patch": {
- "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.",
- "request": {
- "$ref": "Queue"
- },
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- },
- "updateMask": {
- "location": "query",
- "description": "A mask used to specify which fields of the queue are being updated.\n\nIf empty, then all fields will be updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.patch"
- },
- "get": {
- "description": "Gets a queue.",
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.get"
- },
- "purge": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge",
- "id": "cloudtasks.projects.locations.queues.purge",
- "path": "v2beta2/{+name}:purge",
- "request": {
- "$ref": "PurgeQueueRequest"
- },
- "description": "Purges a queue by deleting all of its tasks.\n\nAll tasks created before this method is called are permanently deleted.\n\nPurge operations can take up to one minute to take effect. Tasks\nmight be dispatched before the purge takes effect. A purge is irreversible.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Queue"
- },
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions",
- "path": "v2beta2/{+resource}:testIamPermissions",
- "id": "cloudtasks.projects.locations.queues.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a google.rpc.Code.NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- },
- "pause": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause",
- "id": "cloudtasks.projects.locations.queues.pause",
- "path": "v2beta2/{+name}:pause",
- "request": {
- "$ref": "PauseQueueRequest"
- },
- "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop executing the\ntasks in the queue until it is resumed via\nCloudTasks.ResumeQueue. Tasks can still be added when the\nqueue is paused. The state of the queue is stored in\nQueue.state; if paused it will be set to\nQueue.State.PAUSED.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Queue"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "parameters": {
- "name": {
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.delete",
- "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE"
- }
- }
- }
- }
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
- }
+ },
+ "type": "object"
+ },
+ "Task": {
+ "description": "A unit of scheduled work.",
+ "id": "Task",
+ "properties": {
+ "appEngineHttpRequest": {
+ "$ref": "AppEngineHttpRequest",
+ "description": "App Engine HTTP request that is sent to the task's target. Can\nbe set only if\napp_engine_http_target is set\non the queue.\n\nAn App Engine task is a task that has AppEngineHttpRequest set."
+ },
+ "createTime": {
+ "description": "Output only. The time that the task was created.\n\n`create_time` will be truncated to the nearest second.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "The task name.\n\nThe task name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the task's location.\n The list of available locations can be obtained by calling\n ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n* `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.\n\nOptionally caller-specified in CreateTask.",
+ "type": "string"
+ },
+ "pullMessage": {
+ "$ref": "PullMessage",
+ "description": "LeaseTasks to process the task. Can be\nset only if pull_target is set on the queue.\n\nA pull task is a task that has PullMessage set."
+ },
+ "scheduleTime": {
+ "description": "The time when the task is scheduled to be attempted.\n\nFor App Engine queues, this is when the task will be attempted or retried.\n\nFor pull queues, this is the time when the task is available to\nbe leased; if a task is currently leased, this is the time when\nthe current lease expires, that is, the time that the task was\nleased plus the lease_duration.\n\n`schedule_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "status": {
+ "$ref": "TaskStatus",
+ "description": "Output only. The task status."
+ },
+ "view": {
+ "description": "Output only. The view specifies which subset of the Task has\nbeen returned.",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the\n(payload in AppEngineHttpRequest and\npayload in PullMessage). These payloads are\ndesirable to return only when needed, because they can be large\nand because of the sensitivity of the data that you choose to\nstore in it.",
+ "All information is returned.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue resource."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TaskStatus": {
+ "description": "Status of the task.",
+ "id": "TaskStatus",
+ "properties": {
+ "attemptDispatchCount": {
+ "description": "Output only. The number of attempts dispatched.\n\nThis count includes tasks which have been dispatched but haven't\nreceived a response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "attemptResponseCount": {
+ "description": "Output only. The number of attempts which have received a response.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "firstAttemptStatus": {
+ "$ref": "AttemptStatus",
+ "description": "Output only. The status of the task's first attempt.\n\nOnly dispatch_time will be set.\nThe other AttemptStatus information is not retained by Cloud Tasks.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget)."
+ },
+ "lastAttemptStatus": {
+ "$ref": "AttemptStatus",
+ "description": "Output only. The status of the task's last attempt.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget)."
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
}
},
- "parameters": {
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v2beta2",
- "baseUrl": "https://cloudtasks.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Manages the execution of large numbers of distributed requests. Cloud Tasks is in Alpha.",
"servicePath": "",
- "basePath": "",
- "id": "cloudtasks:v2beta2",
- "documentationLink": "https://cloud.google.com/cloud-tasks/",
- "revision": "20180120"
-}
+ "title": "Cloud Tasks API",
+ "version": "v2beta2",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudtasks/v2beta2/cloudtasks-gen.go b/vendor/google.golang.org/api/cloudtasks/v2beta2/cloudtasks-gen.go
index 0731c1abb..7a6cb0184 100644
--- a/vendor/google.golang.org/api/cloudtasks/v2beta2/cloudtasks-gen.go
+++ b/vendor/google.golang.org/api/cloudtasks/v2beta2/cloudtasks-gen.go
@@ -122,15 +122,15 @@ type ProjectsLocationsQueuesTasksService struct {
// AcknowledgeTaskRequest: Request message for acknowledging a task
// using
-// CloudTasks.AcknowledgeTask.
+// AcknowledgeTask.
type AcknowledgeTaskRequest struct {
// ScheduleTime: Required.
//
// The task's current schedule time, available in the
- // Task.schedule_time
- // returned in LeaseTasksResponse.tasks or
- // CloudTasks.RenewLease. This restriction is to ensure that your
- // worker currently holds the lease.
+ // schedule_time returned by
+ // LeaseTasks response or
+ // RenewLease response. This restriction is
+ // to ensure that your worker currently holds the lease.
ScheduleTime string `json:"scheduleTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "ScheduleTime") to
@@ -164,7 +164,7 @@ func (s *AcknowledgeTaskRequest) MarshalJSON() ([]byte, error) {
//
// This proto can only be used for tasks in a queue which
// has
-// Queue.app_engine_http_target set.
+// app_engine_http_target set.
//
// Using AppEngineHttpRequest
// requires
@@ -188,16 +188,17 @@ func (s *AcknowledgeTaskRequest) MarshalJSON() ([]byte, error) {
// is
// delivered to can be set at the queue-level or task-level:
//
-// * If set, AppEngineHttpTarget.app_engine_routing_override is used
-// for
-// all tasks in the queue, no matter what the setting is for the
+// * If set,
+// app_engine_routing_override
+// is used for all tasks in the queue, no matter what the setting
+// is for the
// task-level app_engine_routing.
//
//
// The `url` that the task will be sent to is:
//
-// * `url =` AppEngineRouting.host `+`
-// AppEngineHttpRequest.relative_url
+// * `url =` host `+`
+// relative_url
//
// The task attempt has succeeded if the app's request handler
// returns
@@ -214,9 +215,9 @@ func (s *AcknowledgeTaskRequest) MarshalJSON() ([]byte, error) {
type AppEngineHttpRequest struct {
// AppEngineRouting: Task-level setting for App Engine routing.
//
- // If set, AppEngineHttpTarget.app_engine_routing_override is used
- // for
- // all tasks in the queue, no matter what the setting is for
+ // If set,
+ // app_engine_routing_override
+ // is used for all tasks in the queue, no matter what the setting is for
// the
// task-level app_engine_routing.
AppEngineRouting *AppEngineRouting `json:"appEngineRouting,omitempty"`
@@ -238,19 +239,18 @@ type AppEngineHttpRequest struct {
// "AppEngine-Google; (+http://code.google.com/appengine)" to the
// modified `User-Agent`.
//
- // If the task has an AppEngineHttpRequest.payload, Cloud Tasks sets
- // the
- // following headers:
+ // If the task has a payload, Cloud
+ // Tasks sets the following headers:
//
// * `Content-Type`: By default, the `Content-Type` header is set to
// "application/octet-stream". The default can be overridden by
- // explictly
+ // explicitly
// setting `Content-Type` to a particular media type when the
// [task is
// created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).
// For example, `Content-Type` can be set to "application/json".
// * `Content-Length`: This is computed by Cloud Tasks. This value is
- // output only. It cannot be changed.
+ // output only. It cannot be changed.
//
// The headers below cannot be set or overridden:
//
@@ -273,7 +273,7 @@ type AppEngineHttpRequest struct {
// or
// the size, there is a limit on the maximum size of the Task. For
// more
- // information, see the CloudTasks.CreateTask documentation.
+ // information, see the CreateTask documentation.
Headers map[string]string `json:"headers,omitempty"`
// HttpMethod: The HTTP method to use for the request. The default is
@@ -365,10 +365,8 @@ type AppEngineHttpTarget struct {
// AppEngineRoutingOverride: Overrides for the
// task-level app_engine_routing.
//
- // If set, AppEngineHttpTarget.app_engine_routing_override is used
- // for
- // all tasks in the queue, no matter what the setting is for
- // the
+ // If set, `app_engine_routing_override` is used for all tasks in
+ // the queue, no matter what the setting is for the
// task-level app_engine_routing.
AppEngineRoutingOverride *AppEngineRouting `json:"appEngineRoutingOverride,omitempty"`
@@ -437,47 +435,53 @@ type AppEngineRouting struct {
// Engine
// SDK use a custom domain name.
//
- // * `service =` AppEngineRouting.service
+ // * `service =` service
//
- // * `version =` AppEngineRouting.version
+ // * `version =` version
//
// * `version_dot_service =`
- // AppEngineRouting.version `+ '.' +` AppEngineRouting.service
+ // version `+ '.' +`
+ // service
//
- // * `instance =` AppEngineRouting.instance
+ // * `instance =` instance
//
// * `instance_dot_service =`
- // AppEngineRouting.instance `+ '.' +` AppEngineRouting.service
+ // instance `+ '.' +`
+ // service
//
// * `instance_dot_version =`
- // AppEngineRouting.instance `+ '.' +` AppEngineRouting.version
+ // instance `+ '.' +`
+ // version
//
// * `instance_dot_version_dot_service =`
- // AppEngineRouting.instance `+ '.' +`
- // AppEngineRouting.version `+ '.' +` AppEngineRouting.service
+ // instance `+ '.' +`
+ // version `+ '.' +`
+ // service
//
- // If AppEngineRouting.service is empty, then the task will be sent
+ // If service is empty, then the task will be sent
// to the service which is the default service when the task is
// attempted.
//
- // If AppEngineRouting.version is empty, then the task will be sent
+ // If version is empty, then the task will be sent
// to the version which is the default version when the task is
// attempted.
//
- // If AppEngineRouting.instance is empty, then the task will be sent
- // to an instance which is available when the task is attempted.
- //
- // When AppEngineRouting.service is "default",
- // AppEngineRouting.version is "default", and
- // AppEngineRouting.instance is empty, AppEngineRouting.host
+ // If instance is empty, then the task
+ // will be sent to an instance which is available when the task
// is
- // shortened to just the `application_domain_name`.
- //
- // If AppEngineRouting.service, AppEngineRouting.version,
- // or
- // AppEngineRouting.instance is invalid, then the task will be sent
- // to the default version of the default service when the task is
// attempted.
+ //
+ // When service is "default",
+ // version is "default", and
+ // instance is empty,
+ // host is shortened to just the
+ // `application_domain_name`.
+ //
+ // If service,
+ // version, or
+ // instance is invalid, then the task
+ // will be sent to the default version of the default service when
+ // the task is attempted.
Host string `json:"host,omitempty"`
// Instance: App instance.
@@ -504,21 +508,17 @@ type AppEngineRouting struct {
// default
// service when the task is attempted ("default").
//
- // For some queues or tasks which were created using the App Engine Task
- // Queue
- // API, AppEngineRouting.host is not parsable
- // into
- // AppEngineRouting.service, AppEngineRouting.version,
- // and
- // AppEngineRouting.instance. For example, some tasks which were
- // created
- // using the App Engine SDK use a custom domain name; custom domains are
- // not
- // parsed by Cloud Tasks. If AppEngineRouting.host is not parsable,
- // then
- // AppEngineRouting.service, AppEngineRouting.version,
- // and
- // AppEngineRouting.instance are the empty string.
+ // For some queues or tasks which were created using the App Engine
+ // Task Queue API, host is not parsable
+ // into service,
+ // version, and
+ // instance. For example, some tasks
+ // which were created using the App Engine SDK use a custom domain
+ // name; custom domains are not parsed by Cloud Tasks. If
+ // host is not parsable, then
+ // service,
+ // version, and
+ // instance are the empty string.
Service string `json:"service,omitempty"`
// Version: App version.
@@ -527,21 +527,17 @@ type AppEngineRouting struct {
// default
// version when the task is attempted ("default").
//
- // For some queues or tasks which were created using the App Engine Task
- // Queue
- // API, AppEngineRouting.host is not parsable
- // into
- // AppEngineRouting.service, AppEngineRouting.version,
- // and
- // AppEngineRouting.instance. For example, some tasks which were
- // created
- // using the App Engine SDK use a custom domain name; custom domains are
- // not
- // parsed by Cloud Tasks. If AppEngineRouting.host is not parsable,
- // then
- // AppEngineRouting.service, AppEngineRouting.version,
- // and
- // AppEngineRouting.instance are the empty string.
+ // For some queues or tasks which were created using the App Engine
+ // Task Queue API, host is not parsable
+ // into service,
+ // version, and
+ // instance. For example, some tasks
+ // which were created using the App Engine SDK use a custom domain
+ // name; custom domains are not parsed by Cloud Tasks. If
+ // host is not parsable, then
+ // service,
+ // version, and
+ // instance are the empty string.
Version string `json:"version,omitempty"`
// ForceSendFields is a list of field names (e.g. "Host") to
@@ -686,13 +682,13 @@ func (s *Binding) MarshalJSON() ([]byte, error) {
// CancelLeaseRequest: Request message for canceling a lease
// using
-// CloudTasks.CancelLease.
+// CancelLease.
type CancelLeaseRequest struct {
// ResponseView: The response_view specifies which subset of the Task
// will be
// returned.
//
- // By default response_view is Task.View.BASIC; not all
+ // By default response_view is BASIC; not all
// information is retrieved by default because some data, such
// as
// payloads, might be desirable to return only when needed because
@@ -700,10 +696,10 @@ type CancelLeaseRequest struct {
// it
// contains.
//
- // Authorization for Task.View.FULL requires
- // `cloudtasks.tasks.fullView`
- // [Google IAM](/iam/) permission on the
- // Task.name resource.
+ // Authorization for FULL requires
+ // `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on
+ // the
+ // Task resource.
//
// Possible values:
// "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
@@ -711,25 +707,27 @@ type CancelLeaseRequest struct {
// contain
// sensitive data.
//
- // This view does not include (AppEngineHttpRequest.payload
- // and PullMessage.payload). These payloads are desirable to
- // return only when needed, because they can be large and because
- // of the sensitivity of the data that you choose to store in it.
+ // This view does not include the
+ // (payload in AppEngineHttpRequest and
+ // payload in PullMessage). These payloads are
+ // desirable to return only when needed, because they can be large
+ // and because of the sensitivity of the data that you choose to
+ // store in it.
// "FULL" - All information is returned.
//
- // Authorization for Task.View.FULL requires
+ // Authorization for FULL requires
// `cloudtasks.tasks.fullView` [Google
// IAM](https://cloud.google.com/iam/)
- // permission on the Queue.name resource.
+ // permission on the Queue resource.
ResponseView string `json:"responseView,omitempty"`
// ScheduleTime: Required.
//
// The task's current schedule time, available in the
- // Task.schedule_time
- // returned in LeaseTasksResponse.tasks or
- // CloudTasks.RenewLease. This restriction is to ensure that your
- // worker currently holds the lease.
+ // schedule_time returned by
+ // LeaseTasks response or
+ // RenewLease response. This restriction is
+ // to ensure that your worker currently holds the lease.
ScheduleTime string `json:"scheduleTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "ResponseView") to
@@ -755,13 +753,13 @@ func (s *CancelLeaseRequest) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// CreateTaskRequest: Request message for CloudTasks.CreateTask.
+// CreateTaskRequest: Request message for CreateTask.
type CreateTaskRequest struct {
// ResponseView: The response_view specifies which subset of the Task
// will be
// returned.
//
- // By default response_view is Task.View.BASIC; not all
+ // By default response_view is BASIC; not all
// information is retrieved by default because some data, such
// as
// payloads, might be desirable to return only when needed because
@@ -769,10 +767,10 @@ type CreateTaskRequest struct {
// it
// contains.
//
- // Authorization for Task.View.FULL requires
- // `cloudtasks.tasks.fullView`
- // [Google IAM](/iam/) permission on the
- // Task.name resource.
+ // Authorization for FULL requires
+ // `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on
+ // the
+ // Task resource.
//
// Possible values:
// "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
@@ -780,16 +778,18 @@ type CreateTaskRequest struct {
// contain
// sensitive data.
//
- // This view does not include (AppEngineHttpRequest.payload
- // and PullMessage.payload). These payloads are desirable to
- // return only when needed, because they can be large and because
- // of the sensitivity of the data that you choose to store in it.
+ // This view does not include the
+ // (payload in AppEngineHttpRequest and
+ // payload in PullMessage). These payloads are
+ // desirable to return only when needed, because they can be large
+ // and because of the sensitivity of the data that you choose to
+ // store in it.
// "FULL" - All information is returned.
//
- // Authorization for Task.View.FULL requires
+ // Authorization for FULL requires
// `cloudtasks.tasks.fullView` [Google
// IAM](https://cloud.google.com/iam/)
- // permission on the Queue.name resource.
+ // permission on the Queue resource.
ResponseView string `json:"responseView,omitempty"`
// Task: Required.
@@ -800,21 +800,21 @@ type CreateTaskRequest struct {
// format:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tas
// ks/TASK_ID`.
- // The user can optionally specify a name for the task in
- // Task.name. If a name is not specified then the system will
- // generate a random unique task id, which will be returned in
+ // The user can optionally specify a task name. If a
+ // name is not specified then the system will generate a random
+ // unique task id, which will be set in the task returned in
// the
- // response's Task.name.
+ // response.
//
- // If Task.schedule_time is not set or is in the past then Cloud
- // Tasks will set it to the current time.
+ // If schedule_time is not set or is in the
+ // past then Cloud Tasks will set it to the current time.
//
// Task De-duplication:
//
// Explicitly specifying a task ID enables task de-duplication. If
// a task's ID is identical to that of an existing task or a task
// that was deleted or completed recently then the call will fail
- // with google.rpc.Code.ALREADY_EXISTS.
+ // with ALREADY_EXISTS.
// If the task's queue was created using Cloud Tasks, then another task
// with
// the same name can't be created for ~1hour after the original task
@@ -826,7 +826,7 @@ type CreateTaskRequest struct {
//
// Because there is an extra lookup cost to identify duplicate
// task
- // names, these CloudTasks.CreateTask calls have significantly
+ // names, these CreateTask calls have significantly
// increased latency. Using hashed strings for the task id or for
// the prefix of the task id is recommended. Choosing task ids that
// are sequential or have sequential prefixes, for example using
@@ -884,14 +884,14 @@ type GetIamPolicyRequest struct {
}
// LeaseTasksRequest: Request message for leasing tasks using
-// CloudTasks.LeaseTasks.
+// LeaseTasks.
type LeaseTasksRequest struct {
// Filter: `filter` can be used to specify a subset of tasks to
// lease.
//
// When `filter` is set to `tag=` then the
- // LeaseTasksResponse will contain only tasks whose
- // PullMessage.tag is equal to ``. `` must be
+ // response will contain only tasks whose
+ // tag is equal to ``. `` must be
// less than 500 characters.
//
// When `filter` is set to `tag_function=oldest_tag()`, only tasks which
@@ -912,37 +912,23 @@ type LeaseTasksRequest struct {
// oldest task (ordered by schedule time).
//
// SDK compatibility: Although the SDK allows tags to be either
- // string or
- // [bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api
- // /taskqueue/TaskOptions.html#tag-byte:A-),
- // only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't
- // UTF-8
- // encoded can't be used in LeaseTasksRequest.filter and won't display
- // in
- // PullMessage.tag.
+ // string
+ // or
+ // [bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/
+ // api/taskqueue/TaskOptions.html#tag-byte:A-),
+ // only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
+ // aren't UTF-8 encoded can't be used in the
+ // filter and the task's
+ // tag will be displayed as empty in Cloud Tasks.
Filter string `json:"filter,omitempty"`
- // LeaseDuration: The duration of the lease.
- //
- // Each task returned in the LeaseTasksResponse will have
- // its
- // Task.schedule_time set to the current time plus the
- // `lease_duration`. A task that has been returned in
- // a
- // LeaseTasksResponse is leased -- that task will not be
- // returned in a different LeaseTasksResponse before
- // the
- // Task.schedule_time.
- //
- // After the worker has successfully finished the work
- // associated with the task, the worker must
- // call
- // CloudTasks.AcknowledgeTask. If the task is not acknowledged
- // via CloudTasks.AcknowledgeTask before the
- // Task.schedule_time then it will be returned in a
- // later
- // LeaseTasksResponse so that another worker can process
- // it.
+ // LeaseDuration:
+ // After the worker has successfully finished the work associated
+ // with the task, the worker must call via
+ // AcknowledgeTask before the
+ // schedule_time. Otherwise the task will be
+ // returned to a later LeaseTasks call so
+ // that another worker can retry it.
//
// The maximum lease duration is 1 week.
// `lease_duration` will be truncated to the nearest second.
@@ -957,7 +943,7 @@ type LeaseTasksRequest struct {
// will be
// returned.
//
- // By default response_view is Task.View.BASIC; not all
+ // By default response_view is BASIC; not all
// information is retrieved by default because some data, such
// as
// payloads, might be desirable to return only when needed because
@@ -965,9 +951,10 @@ type LeaseTasksRequest struct {
// it
// contains.
//
- // Authorization for Task.View.FULL requires
- // `cloudtasks.tasks.fullView`
- // [Google IAM](/iam/) permission on the Task.name resource.
+ // Authorization for FULL requires
+ // `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on
+ // the
+ // Task resource.
//
// Possible values:
// "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
@@ -975,16 +962,18 @@ type LeaseTasksRequest struct {
// contain
// sensitive data.
//
- // This view does not include (AppEngineHttpRequest.payload
- // and PullMessage.payload). These payloads are desirable to
- // return only when needed, because they can be large and because
- // of the sensitivity of the data that you choose to store in it.
+ // This view does not include the
+ // (payload in AppEngineHttpRequest and
+ // payload in PullMessage). These payloads are
+ // desirable to return only when needed, because they can be large
+ // and because of the sensitivity of the data that you choose to
+ // store in it.
// "FULL" - All information is returned.
//
- // Authorization for Task.View.FULL requires
+ // Authorization for FULL requires
// `cloudtasks.tasks.fullView` [Google
// IAM](https://cloud.google.com/iam/)
- // permission on the Queue.name resource.
+ // permission on the Queue resource.
ResponseView string `json:"responseView,omitempty"`
// ForceSendFields is a list of field names (e.g. "Filter") to
@@ -1011,7 +1000,7 @@ func (s *LeaseTasksRequest) MarshalJSON() ([]byte, error) {
}
// LeaseTasksResponse: Response message for leasing tasks using
-// CloudTasks.LeaseTasks.
+// LeaseTasks.
type LeaseTasksResponse struct {
// Tasks: The leased tasks.
Tasks []*Task `json:"tasks,omitempty"`
@@ -1080,14 +1069,13 @@ func (s *ListLocationsResponse) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// ListQueuesResponse: Response message for CloudTasks.ListQueues.
+// ListQueuesResponse: Response message for ListQueues.
type ListQueuesResponse struct {
// NextPageToken: A token to retrieve next page of results.
//
// To return the next page of results, call
- // CloudTasks.ListQueues with this value as
- // the
- // ListQueuesRequest.page_token.
+ // ListQueues with this value as the
+ // page_token.
//
// If the next_page_token is empty, there are no more results.
//
@@ -1125,14 +1113,13 @@ func (s *ListQueuesResponse) MarshalJSON() ([]byte, error) {
}
// ListTasksResponse: Response message for listing tasks using
-// CloudTasks.ListTasks.
+// ListTasks.
type ListTasksResponse struct {
// NextPageToken: A token to retrieve next page of results.
//
// To return the next page of results, call
- // CloudTasks.ListTasks with this value as
- // the
- // ListTasksRequest.page_token.
+ // ListTasks with this value as the
+ // page_token.
//
// If the next_page_token is empty, there are no more results.
NextPageToken string `json:"nextPageToken,omitempty"`
@@ -1169,6 +1156,11 @@ func (s *ListTasksResponse) MarshalJSON() ([]byte, error) {
// Location: A resource that represents Google Cloud Platform location.
type Location struct {
+ // DisplayName: The friendly name for this location, typically a nearby
+ // city name.
+ // For example, "Tokyo".
+ DisplayName string `json:"displayName,omitempty"`
+
// Labels: Cross-service attributes for the location. For example
//
// {"cloud.googleapis.com/region": "us-east1"}
@@ -1192,7 +1184,7 @@ type Location struct {
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Labels") to
+ // ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -1200,10 +1192,10 @@ type Location struct {
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Labels") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
+ // NullFields is a list of field names (e.g. "DisplayName") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
@@ -1215,7 +1207,7 @@ func (s *Location) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// PauseQueueRequest: Request message for CloudTasks.PauseQueue.
+// PauseQueueRequest: Request message for PauseQueue.
type PauseQueueRequest struct {
}
@@ -1312,11 +1304,11 @@ func (s *Policy) MarshalJSON() ([]byte, error) {
// PullMessage: The pull message contains data that can be used by the
// caller of
-// CloudTasks.LeaseTasks to process the task.
+// LeaseTasks to process the task.
//
// This proto can only be used for tasks in a queue which
// has
-// Queue.pull_target set.
+// pull_target set.
type PullMessage struct {
// Payload: A data payload consumed by the worker to execute the task.
Payload string `json:"payload,omitempty"`
@@ -1325,10 +1317,11 @@ type PullMessage struct {
//
// Tags allow similar tasks to be processed in a batch. If you
// label
- // tasks with a tag, your worker can lease tasks
- // with the same tag using LeaseTasksRequest.filter. For example,
- // if you want to aggregate the events associated with a specific
- // user once a day, you could tag tasks with the user ID.
+ // tasks with a tag, your worker can
+ // lease tasks with the same tag using
+ // filter. For example, if you want to
+ // aggregate the events associated with a specific user once a day,
+ // you could tag tasks with the user ID.
//
// The task's tag can only be set when the
// task is created.
@@ -1372,7 +1365,7 @@ func (s *PullMessage) MarshalJSON() ([]byte, error) {
type PullTarget struct {
}
-// PurgeQueueRequest: Request message for CloudTasks.PurgeQueue.
+// PurgeQueueRequest: Request message for PurgeQueue.
type PurgeQueueRequest struct {
}
@@ -1402,15 +1395,15 @@ type Queue struct {
// g_projects)
// * `LOCATION_ID` is the canonical ID for the queue's location.
// The list of available locations can be obtained by calling
- // google.cloud.location.Locations.ListLocations.
+ // ListLocations.
// For more information, see
// https://cloud.google.com/about/locations/.
// * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
// hyphens (-). The maximum length is 100
// characters.
//
- // Caller-specified and required in CreateQueueRequest, after which
- // it becomes output only.
+ // Caller-specified and required in CreateQueue,
+ // after which it becomes output only.
Name string `json:"name,omitempty"`
// PullTarget: Pull target.
@@ -1423,7 +1416,7 @@ type Queue struct {
// All tasks that were created before this time
// were purged.
//
- // A queue can be purged using CloudTasks.PurgeQueue, the
+ // A queue can be purged using PurgeQueue, the
// [App Engine Task Queue SDK, or the Cloud
// Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks
// -and-queues#purging_all_tasks_from_a_queue).
@@ -1434,21 +1427,19 @@ type Queue struct {
// RateLimits: Rate limits for task dispatches.
//
- // Queue.rate_limits and Queue.retry_config are related because
- // they
- // both control task attempts however they control how tasks are
- // attempted in
- // different ways:
+ // rate_limits and
+ // retry_config are related because they both
+ // control task attempts however they control how tasks are
+ // attempted in different ways:
//
- // * Queue.rate_limits controls the total rate of dispatches from a
- // queue
- // (i.e. all traffic dispatched from the queue, regardless of whether
- // the
- // dispatch is from a first attempt or a retry).
- // * Queue.retry_config controls what happens to particular a task
- // after
- // its first attempt fails. That is, Queue.retry_config controls task
- // retries (the second attempt, third attempt, etc).
+ // * rate_limits controls the total rate of
+ // dispatches from a queue (i.e. all traffic dispatched from the
+ // queue, regardless of whether the dispatch is from a first
+ // attempt or a retry).
+ // * retry_config controls what happens to
+ // particular a task after its first attempt fails. That is,
+ // retry_config controls task retries (the
+ // second attempt, third attempt, etc).
RateLimits *RateLimits `json:"rateLimits,omitempty"`
// RetryConfig: Settings that determine the retry behavior.
@@ -1471,31 +1462,29 @@ type Queue struct {
// State: Output only. The state of the queue.
//
// `state` can only be changed by called
- // CloudTasks.PauseQueue, CloudTasks.ResumeQueue, or
+ // PauseQueue,
+ // ResumeQueue, or
// uploading
// [queue.yaml/xml](/appengine/docs/python/config/queueref).
- // Cl
- // oudTasks.UpdateQueue cannot be used to change `state`.
+ // Up
+ // dateQueue cannot be used to change `state`.
//
// Possible values:
// "STATE_UNSPECIFIED" - Unspecified state.
// "RUNNING" - The queue is running. Tasks can be dispatched.
//
- // If the queue was created using Cloud Tasks and the queue has had
- // no
- // activity (method calls or task dispatches) for 30 days, the queue
- // may
- // take a few minutes to re-activate. Some method calls may
- // return
- // google.rpc.Code.NOT_FOUND and tasks may not be dispatched for a
- // few
- // minutes until the queue has been re-activated.
+ // If the queue was created using Cloud Tasks and the queue has
+ // had no activity (method calls or task dispatches) for 30 days,
+ // the queue may take a few minutes to re-activate. Some method
+ // calls may return NOT_FOUND and
+ // tasks may not be dispatched for a few minutes until the queue
+ // has been re-activated.
// "PAUSED" - Tasks are paused by the user. If the queue is paused
// then Cloud
// Tasks will stop delivering tasks from it, but more tasks can
// still be added to it by the user. When a pull queue is paused,
- // all CloudTasks.LeaseTasks calls will return a
- // `FAILED_PRECONDITION` error.
+ // all LeaseTasks calls will return a
+ // FAILED_PRECONDITION.
// "DISABLED" - The queue is disabled.
//
// A queue becomes `DISABLED`
@@ -1508,13 +1497,13 @@ type Queue struct {
// queue.
//
// When a queue is disabled, tasks can still be added to a queue
- // but the tasks are not dispatched and CloudTasks.LeaseTasks
- // calls
- // return a `FAILED_PRECONDITION` error.
+ // but the tasks are not dispatched and
+ // LeaseTasks calls return a
+ // `FAILED_PRECONDITION` error.
//
// To permanently delete this queue and all of its tasks,
// call
- // CloudTasks.DeleteQueue.
+ // DeleteQueue.
State string `json:"state,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -1572,11 +1561,12 @@ type RateLimits struct {
// be
// continuously refilled with new tokens based
// on
- // RateLimits.max_tasks_dispatched_per_second.
+ // max_tasks_dispatched_per_second.
//
- // Cloud Tasks will pick the value of `max_burst_size` based on the
+ // Cloud Tasks will pick the value of `max_burst_size` based on
+ // the
// value of
- // RateLimits.max_tasks_dispatched_per_second.
+ // max_tasks_dispatched_per_second.
//
// For App Engine queues that were created or updated
// using
@@ -1584,15 +1574,14 @@ type RateLimits struct {
// to
// [bucket_size](/appengine/docs/standard/python/config/queueref#bucke
// t_size).
- // Since `max_burst_size` is output only, if CloudTasks.UpdateQueue
- // is
- // called on a queue created by `queue.yaml/xml`, `max_burst_size` will
- // be
- // reset based on the value of
- // RateLimits.max_tasks_dispatched_per_second,
- // regardless of whether RateLimits.max_tasks_dispatched_per_second
- // is
- // updated.
+ // Since `max_burst_size` is output only, if
+ // UpdateQueue is called on a queue
+ // created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ // on the value of
+ // max_tasks_dispatched_per_second,
+ // regardless of whether
+ // max_tasks_dispatched_per_second
+ // is updated.
//
MaxBurstSize int64 `json:"maxBurstSize,omitempty"`
@@ -1630,11 +1619,10 @@ type RateLimits struct {
//
// * For App Engine queues, the maximum allowed value is 500.
// * This field is output only for [pull
- // queues](google.cloud.tasks.v2beta2.PullTarget).
- // In addition to the `max_tasks_dispatched_per_second` limit, a
- // maximum of
- // 10 QPS of CloudTasks.LeaseTasks requests are allowed per pull
- // queue.
+ // queues](google.cloud.tasks.v2beta2.PullTarget). In
+ // addition to the `max_tasks_dispatched_per_second` limit, a
+ // maximum of 10 QPS of LeaseTasks
+ // requests are allowed per pull queue.
//
//
// This field has the same meaning as
@@ -1679,8 +1667,9 @@ func (s *RateLimits) UnmarshalJSON(data []byte) error {
return nil
}
-// RenewLeaseRequest: Request message for renewing a lease using
-// CloudTasks.RenewLease.
+// RenewLeaseRequest: Request message for renewing a lease
+// using
+// RenewLease.
type RenewLeaseRequest struct {
// LeaseDuration: Required.
//
@@ -1695,7 +1684,7 @@ type RenewLeaseRequest struct {
// will be
// returned.
//
- // By default response_view is Task.View.BASIC; not all
+ // By default response_view is BASIC; not all
// information is retrieved by default because some data, such
// as
// payloads, might be desirable to return only when needed because
@@ -1703,10 +1692,10 @@ type RenewLeaseRequest struct {
// it
// contains.
//
- // Authorization for Task.View.FULL requires
- // `cloudtasks.tasks.fullView`
- // [Google IAM](/iam/) permission on the
- // Task.name resource.
+ // Authorization for FULL requires
+ // `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on
+ // the
+ // Task resource.
//
// Possible values:
// "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
@@ -1714,25 +1703,27 @@ type RenewLeaseRequest struct {
// contain
// sensitive data.
//
- // This view does not include (AppEngineHttpRequest.payload
- // and PullMessage.payload). These payloads are desirable to
- // return only when needed, because they can be large and because
- // of the sensitivity of the data that you choose to store in it.
+ // This view does not include the
+ // (payload in AppEngineHttpRequest and
+ // payload in PullMessage). These payloads are
+ // desirable to return only when needed, because they can be large
+ // and because of the sensitivity of the data that you choose to
+ // store in it.
// "FULL" - All information is returned.
//
- // Authorization for Task.View.FULL requires
+ // Authorization for FULL requires
// `cloudtasks.tasks.fullView` [Google
// IAM](https://cloud.google.com/iam/)
- // permission on the Queue.name resource.
+ // permission on the Queue resource.
ResponseView string `json:"responseView,omitempty"`
// ScheduleTime: Required.
//
// The task's current schedule time, available in the
- // Task.schedule_time
- // returned in LeaseTasksResponse.tasks or
- // CloudTasks.RenewLease. This restriction is to ensure that your
- // worker currently holds the lease.
+ // schedule_time returned by
+ // LeaseTasks response or
+ // RenewLease response. This restriction is
+ // to ensure that your worker currently holds the lease.
ScheduleTime string `json:"scheduleTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "LeaseDuration") to
@@ -1758,7 +1749,7 @@ func (s *RenewLeaseRequest) MarshalJSON() ([]byte, error) {
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// ResumeQueueRequest: Request message for CloudTasks.ResumeQueue.
+// ResumeQueueRequest: Request message for ResumeQueue.
type ResumeQueueRequest struct {
}
@@ -1775,8 +1766,9 @@ type RetryConfig struct {
// MaxBackoff: A task will be [scheduled](Task.schedule_time) for retry
// between
- // RetryConfig.min_backoff and RetryConfig.max_backoff duration after
- // it fails, if the queue's RetryConfig specifies that the task should
+ // min_backoff and
+ // max_backoff duration after it fails,
+ // if the queue's RetryConfig specifies that the task should
// be
// retried.
//
@@ -1799,23 +1791,24 @@ type RetryConfig struct {
// MaxDoublings: The time between retries will double `max_doublings`
// times.
//
- // A task's retry interval starts at RetryConfig.min_backoff,
- // then doubles `max_doublings` times, then increases linearly,
- // and
- // finally retries retries at intervals of
- // RetryConfig.max_backoff up to max_attempts times.
+ // A task's retry interval starts at
+ // min_backoff, then doubles
+ // `max_doublings` times, then increases linearly, and finally
+ // retries retries at intervals of
+ // max_backoff up to
+ // max_attempts times.
//
- // For example, if RetryConfig.min_backoff is
- // 10s,
- // RetryConfig.max_backoff is 300s, and `max_doublings` is 3,
- // then the a task will first be retried in 10s. The retry interval
- // will double three times, and then increase linearly by 2^3 *
- // 10s.
- // Finally, the task will retry at intervals of
- // RetryConfig.max_backoff until the task has been
- // attempted
- // `max_attempts` times. Thus, the requests will retry at 10s, 20s,
- // 40s, 80s, 160s, 240s, 300s, 300s, ....
+ // For example, if min_backoff is 10s,
+ // max_backoff is 300s, and
+ // `max_doublings` is 3, then the a task will first be retried in
+ // 10s. The retry interval will double three times, and then
+ // increase linearly by 2^3 * 10s. Finally, the task will retry
+ // at
+ // intervals of max_backoff until the
+ // task has been attempted max_attempts
+ // times. Thus, the requests will retry at 10s, 20s, 40s, 80s,
+ // 160s,
+ // 240s, 300s, 300s, ....
//
// If unspecified when the queue is created, Cloud Tasks will pick
// the
@@ -1832,14 +1825,14 @@ type RetryConfig struct {
MaxDoublings int64 `json:"maxDoublings,omitempty"`
// MaxRetryDuration: If positive, `max_retry_duration` specifies the
- // time limit for retrying a
- // failed task, measured from when the task was first attempted.
- // Once
- // `max_retry_duration` time has passed *and* the task has been
- // attempted
- // RetryConfig.max_attempts times, no further attempts will be made
- // and
- // the task will be deleted.
+ // time limit for
+ // retrying a failed task, measured from when the task was
+ // first
+ // attempted. Once `max_retry_duration` time has passed *and* the
+ // task has been attempted max_attempts
+ // times, no further attempts will be made and the task will
+ // be
+ // deleted.
//
// If zero, then the task age is unlimited.
//
@@ -1863,8 +1856,9 @@ type RetryConfig struct {
// MinBackoff: A task will be [scheduled](Task.schedule_time) for retry
// between
- // RetryConfig.min_backoff and RetryConfig.max_backoff duration after
- // it fails, if the queue's RetryConfig specifies that the task should
+ // min_backoff and
+ // max_backoff duration after it fails,
+ // if the queue's RetryConfig specifies that the task should
// be
// retried.
//
@@ -1912,13 +1906,13 @@ func (s *RetryConfig) MarshalJSON() ([]byte, error) {
// RunTaskRequest: Request message for forcing a task to run now
// using
-// CloudTasks.RunTask.
+// RunTask.
type RunTaskRequest struct {
// ResponseView: The response_view specifies which subset of the Task
// will be
// returned.
//
- // By default response_view is Task.View.BASIC; not all
+ // By default response_view is BASIC; not all
// information is retrieved by default because some data, such
// as
// payloads, might be desirable to return only when needed because
@@ -1926,10 +1920,10 @@ type RunTaskRequest struct {
// it
// contains.
//
- // Authorization for Task.View.FULL requires
- // `cloudtasks.tasks.fullView`
- // [Google IAM](/iam/) permission on the
- // Task.name resource.
+ // Authorization for FULL requires
+ // `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on
+ // the
+ // Task resource.
//
// Possible values:
// "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
@@ -1937,16 +1931,18 @@ type RunTaskRequest struct {
// contain
// sensitive data.
//
- // This view does not include (AppEngineHttpRequest.payload
- // and PullMessage.payload). These payloads are desirable to
- // return only when needed, because they can be large and because
- // of the sensitivity of the data that you choose to store in it.
+ // This view does not include the
+ // (payload in AppEngineHttpRequest and
+ // payload in PullMessage). These payloads are
+ // desirable to return only when needed, because they can be large
+ // and because of the sensitivity of the data that you choose to
+ // store in it.
// "FULL" - All information is returned.
//
- // Authorization for Task.View.FULL requires
+ // Authorization for FULL requires
// `cloudtasks.tasks.fullView` [Google
// IAM](https://cloud.google.com/iam/)
- // permission on the Queue.name resource.
+ // permission on the Queue resource.
ResponseView string `json:"responseView,omitempty"`
// ForceSendFields is a list of field names (e.g. "ResponseView") to
@@ -2127,8 +2123,10 @@ func (s *Status) MarshalJSON() ([]byte, error) {
// Task: A unit of scheduled work.
type Task struct {
// AppEngineHttpRequest: App Engine HTTP request that is sent to the
- // task's target. Can be set
- // only if Queue.app_engine_http_target is set.
+ // task's target. Can
+ // be set only if
+ // app_engine_http_target is set
+ // on the queue.
//
// An App Engine task is a task that has AppEngineHttpRequest set.
AppEngineHttpRequest *AppEngineHttpRequest `json:"appEngineHttpRequest,omitempty"`
@@ -2154,7 +2152,7 @@ type Task struct {
// g_projects)
// * `LOCATION_ID` is the canonical ID for the task's location.
// The list of available locations can be obtained by calling
- // google.cloud.location.Locations.ListLocations.
+ // ListLocations.
// For more information, see
// https://cloud.google.com/about/locations/.
// * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
@@ -2163,14 +2161,11 @@ type Task struct {
// hyphens (-), or underscores (_). The maximum length is 500
// characters.
//
- // Optionally caller-specified in CreateTaskRequest.
+ // Optionally caller-specified in CreateTask.
Name string `json:"name,omitempty"`
- // PullMessage: Pull message contains data that should be used by the
- // caller of
- // CloudTasks.LeaseTasks to process the task. Can be set only
- // if
- // Queue.pull_target is set.
+ // PullMessage: LeaseTasks to process the task. Can be
+ // set only if pull_target is set on the queue.
//
// A pull task is a task that has PullMessage set.
PullMessage *PullMessage `json:"pullMessage,omitempty"`
@@ -2184,7 +2179,7 @@ type Task struct {
// For pull queues, this is the time when the task is available to
// be leased; if a task is currently leased, this is the time when
// the current lease expires, that is, the time that the task was
- // leased plus the LeaseTasksRequest.lease_duration.
+ // leased plus the lease_duration.
//
// `schedule_time` will be truncated to the nearest microsecond.
ScheduleTime string `json:"scheduleTime,omitempty"`
@@ -2202,16 +2197,18 @@ type Task struct {
// contain
// sensitive data.
//
- // This view does not include (AppEngineHttpRequest.payload
- // and PullMessage.payload). These payloads are desirable to
- // return only when needed, because they can be large and because
- // of the sensitivity of the data that you choose to store in it.
+ // This view does not include the
+ // (payload in AppEngineHttpRequest and
+ // payload in PullMessage). These payloads are
+ // desirable to return only when needed, because they can be large
+ // and because of the sensitivity of the data that you choose to
+ // store in it.
// "FULL" - All information is returned.
//
- // Authorization for Task.View.FULL requires
+ // Authorization for FULL requires
// `cloudtasks.tasks.fullView` [Google
// IAM](https://cloud.google.com/iam/)
- // permission on the Queue.name resource.
+ // permission on the Queue resource.
View string `json:"view,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -2263,7 +2260,7 @@ type TaskStatus struct {
// FirstAttemptStatus: Output only. The status of the task's first
// attempt.
//
- // Only AttemptStatus.dispatch_time will be set.
+ // Only dispatch_time will be set.
// The other AttemptStatus information is not retained by Cloud
// Tasks.
//
@@ -2736,7 +2733,7 @@ type ProjectsLocationsQueuesCreateCall struct {
// Read
// [Overview of Queue Management and
// queue.yaml](/cloud-tasks/docs/queue-yaml)
-// carefully before using this method.
+// before using this method.
func (r *ProjectsLocationsQueuesService) Create(parent string, queue *Queue) *ProjectsLocationsQueuesCreateCall {
c := &ProjectsLocationsQueuesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.parent = parent
@@ -2830,7 +2827,7 @@ func (c *ProjectsLocationsQueuesCreateCall) Do(opts ...googleapi.CallOption) (*Q
}
return ret, nil
// {
- // "description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.",
+ // "description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\nbefore using this method.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.create",
@@ -2839,7 +2836,7 @@ func (c *ProjectsLocationsQueuesCreateCall) Do(opts ...googleapi.CallOption) (*Q
// ],
// "parameters": {
// "parent": {
- // "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\ngoogle.cloud.location.Locations.ListLocations.",
+ // "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.",
// "location": "path",
// "pattern": "^projects/[^/]+/locations/[^/]+$",
// "required": true,
@@ -2885,7 +2882,7 @@ type ProjectsLocationsQueuesDeleteCall struct {
// Read
// [Overview of Queue Management and
// queue.yaml](/cloud-tasks/docs/queue-yaml)
-// carefully before using this method.
+// before using this method.
func (r *ProjectsLocationsQueuesService) Delete(name string) *ProjectsLocationsQueuesDeleteCall {
c := &ProjectsLocationsQueuesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -2973,7 +2970,7 @@ func (c *ProjectsLocationsQueuesDeleteCall) Do(opts ...googleapi.CallOption) (*E
}
return ret, nil
// {
- // "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.",
+ // "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\nbefore using this method.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
// "httpMethod": "DELETE",
// "id": "cloudtasks.projects.locations.queues.delete",
@@ -3327,9 +3324,9 @@ func (c *ProjectsLocationsQueuesListCall) Filter(filter string) *ProjectsLocatio
//
// The maximum page size is 9800. If unspecified, the page size will
// be the maximum. Fewer queues than requested might be returned,
-// even if more queues exist; use
-// ListQueuesResponse.next_page_token to determine if more
-// queues exist.
+// even if more queues exist; use the
+// next_page_token in the
+// response to determine if more queues exist.
func (c *ProjectsLocationsQueuesListCall) PageSize(pageSize int64) *ProjectsLocationsQueuesListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
@@ -3342,10 +3339,10 @@ func (c *ProjectsLocationsQueuesListCall) PageSize(pageSize int64) *ProjectsLoca
// To
// request the next page of results, page_token must be the value
// of
-// ListQueuesResponse.next_page_token returned from the previous
-// call to CloudTasks.ListQueues method. It is an error to
-// switch the value of ListQueuesRequest.filter while iterating
-// through pages.
+// next_page_token returned
+// from the previous call to ListQueues
+// method. It is an error to switch the value of the
+// filter while iterating through pages.
func (c *ProjectsLocationsQueuesListCall) PageToken(pageToken string) *ProjectsLocationsQueuesListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
@@ -3459,13 +3456,13 @@ func (c *ProjectsLocationsQueuesListCall) Do(opts ...googleapi.CallOption) (*Lis
// "type": "string"
// },
// "pageSize": {
- // "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use\nListQueuesResponse.next_page_token to determine if more\nqueues exist.",
+ // "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use the\nnext_page_token in the\nresponse to determine if more queues exist.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
- // "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListQueuesResponse.next_page_token returned from the previous\ncall to CloudTasks.ListQueues method. It is an error to\nswitch the value of ListQueuesRequest.filter while iterating\nthrough pages.",
+ // "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nnext_page_token returned\nfrom the previous call to ListQueues\nmethod. It is an error to switch the value of the\nfilter while iterating through pages.",
// "location": "query",
// "type": "string"
// },
@@ -3538,7 +3535,7 @@ type ProjectsLocationsQueuesPatchCall struct {
// Read
// [Overview of Queue Management and
// queue.yaml](/cloud-tasks/docs/queue-yaml)
-// carefully before using this method.
+// before using this method.
func (r *ProjectsLocationsQueuesService) Patch(name string, queue *Queue) *ProjectsLocationsQueuesPatchCall {
c := &ProjectsLocationsQueuesPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -3641,7 +3638,7 @@ func (c *ProjectsLocationsQueuesPatchCall) Do(opts ...googleapi.CallOption) (*Qu
}
return ret, nil
// {
- // "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.",
+ // "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\nbefore using this method.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
// "httpMethod": "PATCH",
// "id": "cloudtasks.projects.locations.queues.patch",
@@ -3650,7 +3647,7 @@ func (c *ProjectsLocationsQueuesPatchCall) Do(opts ...googleapi.CallOption) (*Qu
// ],
// "parameters": {
// "name": {
- // "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.",
+ // "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueue,\nafter which it becomes output only.",
// "location": "path",
// "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
// "required": true,
@@ -3690,12 +3687,12 @@ type ProjectsLocationsQueuesPauseCall struct {
// Pause: Pauses the queue.
//
-// If a queue is paused then the system will stop executing the
-// tasks in the queue until it is resumed via
-// CloudTasks.ResumeQueue. Tasks can still be added when the
-// queue is paused. The state of the queue is stored in
-// Queue.state; if paused it will be set to
-// Queue.State.PAUSED.
+// If a queue is paused then the system will stop dispatching
+// tasks
+// until the queue is resumed via
+// ResumeQueue. Tasks can still be added
+// when the queue is paused. A queue is paused if its
+// state is PAUSED.
func (r *ProjectsLocationsQueuesService) Pause(name string, pausequeuerequest *PauseQueueRequest) *ProjectsLocationsQueuesPauseCall {
c := &ProjectsLocationsQueuesPauseCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -3789,7 +3786,7 @@ func (c *ProjectsLocationsQueuesPauseCall) Do(opts ...googleapi.CallOption) (*Qu
}
return ret, nil
// {
- // "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop executing the\ntasks in the queue until it is resumed via\nCloudTasks.ResumeQueue. Tasks can still be added when the\nqueue is paused. The state of the queue is stored in\nQueue.state; if paused it will be set to\nQueue.State.PAUSED.",
+ // "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop dispatching tasks\nuntil the queue is resumed via\nResumeQueue. Tasks can still be added\nwhen the queue is paused. A queue is paused if its\nstate is PAUSED.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.pause",
@@ -3976,9 +3973,10 @@ type ProjectsLocationsQueuesResumeCall struct {
// Resume: Resume a queue.
//
// This method resumes a queue after it has been
-// Queue.State.PAUSED or Queue.State.DISABLED. The state of
-// a queue is stored in Queue.state; after calling this method it
-// will be set to Queue.State.RUNNING.
+// PAUSED or
+// DISABLED. The state of a queue is stored
+// in the queue's state; after calling this method it
+// will be set to RUNNING.
//
// WARNING: Resuming many high-QPS queues at the same time can
// lead to target overloading. If you are resuming high-QPS
@@ -4079,7 +4077,7 @@ func (c *ProjectsLocationsQueuesResumeCall) Do(opts ...googleapi.CallOption) (*Q
}
return ret, nil
// {
- // "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nQueue.State.PAUSED or Queue.State.DISABLED. The state of\na queue is stored in Queue.state; after calling this method it\nwill be set to Queue.State.RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).",
+ // "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.resume",
@@ -4272,7 +4270,7 @@ type ProjectsLocationsQueuesTestIamPermissionsCall struct {
// Queue.
// If the resource does not exist, this will return an empty set
// of
-// permissions, not a google.rpc.Code.NOT_FOUND error.
+// permissions, not a NOT_FOUND error.
//
// Note: This operation is designed to be used for building
// permission-aware
@@ -4372,7 +4370,7 @@ func (c *ProjectsLocationsQueuesTestIamPermissionsCall) Do(opts ...googleapi.Cal
}
return ret, nil
// {
- // "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a google.rpc.Code.NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ // "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.testIamPermissions",
@@ -4415,18 +4413,17 @@ type ProjectsLocationsQueuesTasksAcknowledgeCall struct {
// Acknowledge: Acknowledges a pull task.
//
-// The worker, that is, the entity that received this task in
-// a LeaseTasksResponse, must call this method to indicate that
-// the work associated with the task has finished.
+// The worker, that is, the entity that
+// leased this task must call this method
+// to indicate that the work associated with the task has finished.
//
-// The worker must acknowledge a task within
-// the
-// LeaseTasksRequest.lease_duration or the lease will expire and
-// the task will become ready to be returned in a
-// different
-// LeaseTasksResponse. After the task is acknowledged, it will
-// not be returned by a later CloudTasks.LeaseTasks,
-// CloudTasks.GetTask, or CloudTasks.ListTasks.
+// The worker must acknowledge a task within the
+// lease_duration or the lease
+// will expire and the task will become available to be leased
+// again. After the task is acknowledged, it will not be returned
+// by a later LeaseTasks,
+// GetTask, or
+// ListTasks.
//
// To acknowledge multiple tasks at the same time, use
// [HTTP batching](/storage/docs/json_api/v1/how-tos/batch)
@@ -4527,7 +4524,7 @@ func (c *ProjectsLocationsQueuesTasksAcknowledgeCall) Do(opts ...googleapi.CallO
}
return ret, nil
// {
- // "description": "Acknowledges a pull task.\n\nThe worker, that is, the entity that received this task in\na LeaseTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nLeaseTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nLeaseTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.LeaseTasks,\nCloudTasks.GetTask, or CloudTasks.ListTasks.\n\nTo acknowledge multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.",
+ // "description": "Acknowledges a pull task.\n\nThe worker, that is, the entity that\nleased this task must call this method\nto indicate that the work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nlease_duration or the lease\nwill expire and the task will become available to be leased\nagain. After the task is acknowledged, it will not be returned\nby a later LeaseTasks,\nGetTask, or\nListTasks.\n\nTo acknowledge multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:acknowledge",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.tasks.acknowledge",
@@ -4570,10 +4567,11 @@ type ProjectsLocationsQueuesTasksCancelLeaseCall struct {
// CancelLease: Cancel a pull task's lease.
//
-// The worker can use this method to cancel a task's lease
-// by setting Task.schedule_time to now. This will make the
-// task
-// available to be leased to the next caller of CloudTasks.LeaseTasks.
+// The worker can use this method to cancel a task's lease by
+// setting its schedule_time to now. This will
+// make the task available to be leased to the next caller
+// of
+// LeaseTasks.
func (r *ProjectsLocationsQueuesTasksService) CancelLease(name string, cancelleaserequest *CancelLeaseRequest) *ProjectsLocationsQueuesTasksCancelLeaseCall {
c := &ProjectsLocationsQueuesTasksCancelLeaseCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -4667,7 +4665,7 @@ func (c *ProjectsLocationsQueuesTasksCancelLeaseCall) Do(opts ...googleapi.CallO
}
return ret, nil
// {
- // "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease\nby setting Task.schedule_time to now. This will make the task\navailable to be leased to the next caller of CloudTasks.LeaseTasks.",
+ // "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease by\nsetting its schedule_time to now. This will\nmake the task available to be leased to the next caller of\nLeaseTasks.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
@@ -5001,7 +4999,7 @@ func (r *ProjectsLocationsQueuesTasksService) Get(name string) *ProjectsLocation
// be
// returned.
//
-// By default response_view is Task.View.BASIC; not all
+// By default response_view is BASIC; not all
// information is retrieved by default because some data, such
// as
// payloads, might be desirable to return only when needed because
@@ -5009,10 +5007,10 @@ func (r *ProjectsLocationsQueuesTasksService) Get(name string) *ProjectsLocation
// it
// contains.
//
-// Authorization for Task.View.FULL requires
-// `cloudtasks.tasks.fullView`
-// [Google IAM](/iam/) permission on the
-// Task.name resource.
+// Authorization for FULL requires
+// `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on
+// the
+// Task resource.
//
// Possible values:
// "VIEW_UNSPECIFIED"
@@ -5133,7 +5131,7 @@ func (c *ProjectsLocationsQueuesTasksGetCall) Do(opts ...googleapi.CallOption) (
// "type": "string"
// },
// "responseView": {
- // "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
+ // "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
// "enum": [
// "VIEW_UNSPECIFIED",
// "BASIC",
@@ -5166,28 +5164,28 @@ type ProjectsLocationsQueuesTasksLeaseCall struct {
}
// Lease: Leases tasks from a pull queue for
-// LeaseTasksRequest.lease_duration.
+// lease_duration.
//
-// This method is invoked by the worker to obtain a
-// lease. The worker must acknowledge the task
-// via
-// CloudTasks.AcknowledgeTask after they have performed the
-// work
-// associated with the task.
+// This method is invoked by the worker to obtain a lease. The
+// worker must acknowledge the task via
+// AcknowledgeTask after they have
+// performed the work associated with the task.
//
-// The payload is intended to store data that the worker needs
-// to perform the work associated with the task. To return the
-// payloads in the LeaseTasksResponse,
-// set
-// LeaseTasksRequest.response_view to Task.View.FULL.
+// The payload is intended to store data that
+// the worker needs to perform the work associated with the task.
+// To
+// return the payloads in the response, set
+// response_view to
+// FULL.
//
-// A maximum of 10 qps of CloudTasks.LeaseTasks requests are allowed
-// per
-// queue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this
-// limit
-// is exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned
-// when
-// RateLimits.max_tasks_dispatched_per_second is exceeded.
+// A maximum of 10 qps of LeaseTasks
+// requests are allowed per
+// queue. RESOURCE_EXHAUSTED
+// is returned when this limit is
+// exceeded. RESOURCE_EXHAUSTED
+// is also returned when
+// max_tasks_dispatched_per_second
+// is exceeded.
func (r *ProjectsLocationsQueuesTasksService) Lease(parent string, leasetasksrequest *LeaseTasksRequest) *ProjectsLocationsQueuesTasksLeaseCall {
c := &ProjectsLocationsQueuesTasksLeaseCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.parent = parent
@@ -5281,7 +5279,7 @@ func (c *ProjectsLocationsQueuesTasksLeaseCall) Do(opts ...googleapi.CallOption)
}
return ret, nil
// {
- // "description": "Leases tasks from a pull queue for LeaseTasksRequest.lease_duration.\n\nThis method is invoked by the worker to obtain a\nlease. The worker must acknowledge the task via\nCloudTasks.AcknowledgeTask after they have performed the work\nassociated with the task.\n\nThe payload is intended to store data that the worker needs\nto perform the work associated with the task. To return the\npayloads in the LeaseTasksResponse, set\nLeaseTasksRequest.response_view to Task.View.FULL.\n\nA maximum of 10 qps of CloudTasks.LeaseTasks requests are allowed per\nqueue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit\nis exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when\nRateLimits.max_tasks_dispatched_per_second is exceeded.",
+ // "description": "Leases tasks from a pull queue for\nlease_duration.\n\nThis method is invoked by the worker to obtain a lease. The\nworker must acknowledge the task via\nAcknowledgeTask after they have\nperformed the work associated with the task.\n\nThe payload is intended to store data that\nthe worker needs to perform the work associated with the task. To\nreturn the payloads in the response, set\nresponse_view to\nFULL.\n\nA maximum of 10 qps of LeaseTasks\nrequests are allowed per\nqueue. RESOURCE_EXHAUSTED\nis returned when this limit is\nexceeded. RESOURCE_EXHAUSTED\nis also returned when\nmax_tasks_dispatched_per_second\nis exceeded.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:lease",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.tasks.lease",
@@ -5324,10 +5322,9 @@ type ProjectsLocationsQueuesTasksListCall struct {
// List: Lists the tasks in a queue.
//
-// By default response_view is Task.View.BASIC; not all
-// information is retrieved by default due to
-// performance
-// considerations; ListTasksRequest.response_view controls the
+// By default, only the BASIC view is retrieved
+// due to performance considerations;
+// response_view controls the
// subset of information which is returned.
func (r *ProjectsLocationsQueuesTasksService) List(parent string) *ProjectsLocationsQueuesTasksListCall {
c := &ProjectsLocationsQueuesTasksListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -5353,8 +5350,8 @@ func (c *ProjectsLocationsQueuesTasksListCall) OrderBy(orderBy string) *Projects
// The maximum page size is 1000. If unspecified, the page size will
// be the maximum. Fewer tasks than requested might be returned,
// even if more tasks exist; use
-// ListTasksResponse.next_page_token to determine if more tasks
-// exist.
+// next_page_token in the
+// response to determine if more tasks exist.
func (c *ProjectsLocationsQueuesTasksListCall) PageSize(pageSize int64) *ProjectsLocationsQueuesTasksListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
@@ -5367,8 +5364,9 @@ func (c *ProjectsLocationsQueuesTasksListCall) PageSize(pageSize int64) *Project
// To
// request the next page of results, page_token must be the value
// of
-// ListTasksResponse.next_page_token returned from the previous
-// call to CloudTasks.ListTasks method.
+// next_page_token returned
+// from the previous call to ListTasks
+// method.
//
// The page token is valid for only 2 hours.
func (c *ProjectsLocationsQueuesTasksListCall) PageToken(pageToken string) *ProjectsLocationsQueuesTasksListCall {
@@ -5381,7 +5379,7 @@ func (c *ProjectsLocationsQueuesTasksListCall) PageToken(pageToken string) *Proj
// be
// returned.
//
-// By default response_view is Task.View.BASIC; not all
+// By default response_view is BASIC; not all
// information is retrieved by default because some data, such
// as
// payloads, might be desirable to return only when needed because
@@ -5389,10 +5387,10 @@ func (c *ProjectsLocationsQueuesTasksListCall) PageToken(pageToken string) *Proj
// it
// contains.
//
-// Authorization for Task.View.FULL requires
-// `cloudtasks.tasks.fullView`
-// [Google IAM](/iam/) permission on the
-// Task.name resource.
+// Authorization for FULL requires
+// `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on
+// the
+// Task resource.
//
// Possible values:
// "VIEW_UNSPECIFIED"
@@ -5497,7 +5495,7 @@ func (c *ProjectsLocationsQueuesTasksListCall) Do(opts ...googleapi.CallOption)
}
return ret, nil
// {
- // "description": "Lists the tasks in a queue.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default due to performance\nconsiderations; ListTasksRequest.response_view controls the\nsubset of information which is returned.",
+ // "description": "Lists the tasks in a queue.\n\nBy default, only the BASIC view is retrieved\ndue to performance considerations;\nresponse_view controls the\nsubset of information which is returned.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
// "httpMethod": "GET",
// "id": "cloudtasks.projects.locations.queues.tasks.list",
@@ -5511,13 +5509,13 @@ func (c *ProjectsLocationsQueuesTasksListCall) Do(opts ...googleapi.CallOption)
// "type": "string"
// },
// "pageSize": {
- // "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nListTasksResponse.next_page_token to determine if more tasks\nexist.",
+ // "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nnext_page_token in the\nresponse to determine if more tasks exist.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
- // "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListTasksResponse.next_page_token returned from the previous\ncall to CloudTasks.ListTasks method.\n\nThe page token is valid for only 2 hours.",
+ // "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nnext_page_token returned\nfrom the previous call to ListTasks\nmethod.\n\nThe page token is valid for only 2 hours.",
// "location": "query",
// "type": "string"
// },
@@ -5529,7 +5527,7 @@ func (c *ProjectsLocationsQueuesTasksListCall) Do(opts ...googleapi.CallOption)
// "type": "string"
// },
// "responseView": {
- // "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
+ // "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the\nTask resource.",
// "enum": [
// "VIEW_UNSPECIFIED",
// "BASIC",
@@ -5586,7 +5584,7 @@ type ProjectsLocationsQueuesTasksRenewLeaseCall struct {
//
// The worker can use this method to extend the lease by a new
// duration, starting from now. The new task lease will be
-// returned in Task.schedule_time.
+// returned in the task's schedule_time.
func (r *ProjectsLocationsQueuesTasksService) RenewLease(name string, renewleaserequest *RenewLeaseRequest) *ProjectsLocationsQueuesTasksRenewLeaseCall {
c := &ProjectsLocationsQueuesTasksRenewLeaseCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -5680,7 +5678,7 @@ func (c *ProjectsLocationsQueuesTasksRenewLeaseCall) Do(opts ...googleapi.CallOp
}
return ret, nil
// {
- // "description": "Renew the current lease of a pull task.\n\nThe worker can use this method to extend the lease by a new\nduration, starting from now. The new task lease will be\nreturned in Task.schedule_time.",
+ // "description": "Renew the current lease of a pull task.\n\nThe worker can use this method to extend the lease by a new\nduration, starting from now. The new task lease will be\nreturned in the task's schedule_time.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:renewLease",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.tasks.renewLease",
@@ -5724,37 +5722,37 @@ type ProjectsLocationsQueuesTasksRunCall struct {
// Run: Forces a task to run now.
//
// This command is meant to be used for manual debugging. For
-// example, CloudTasks.RunTask can be used to retry a failed
+// example, RunTask can be used to retry a failed
// task after a fix has been made or to manually force a task to
// be
// dispatched now.
//
// When this method is called, Cloud Tasks will dispatch the task to
// its
-// target, even if the queue is Queue.State.PAUSED.
+// target, even if the queue is PAUSED.
//
// The dispatched task is returned. That is, the task that is
// returned
-// contains the Task.status after the task is dispatched but
+// contains the status after the task is dispatched but
// before the task is received by its target.
//
// If Cloud Tasks receives a successful response from the
// task's
// handler, then the task will be deleted; otherwise the
// task's
-// Task.schedule_time will be reset to the time that
-// CloudTasks.RunTask was called plus the retry delay specified
+// schedule_time will be reset to the time that
+// RunTask was called plus the retry delay specified
// in the queue and task's RetryConfig.
//
-// CloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when
-// it is called on a task that has already succeeded or
-// permanently
-// failed. google.rpc.Code.FAILED_PRECONDITION is returned
-// when
-// CloudTasks.RunTask is called on task that is dispatched or
-// already running.
+// RunTask returns
+// NOT_FOUND when it is called on a
+// task that has already succeeded or permanently
+// failed. FAILED_PRECONDITION
+// is returned when RunTask is called on task
+// that is dispatched or already running.
//
-// CloudTasks.RunTask cannot be called on pull tasks.
+// RunTask cannot be called on
+// pull tasks.
func (r *ProjectsLocationsQueuesTasksService) Run(name string, runtaskrequest *RunTaskRequest) *ProjectsLocationsQueuesTasksRunCall {
c := &ProjectsLocationsQueuesTasksRunCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -5848,7 +5846,7 @@ func (c *ProjectsLocationsQueuesTasksRunCall) Do(opts ...googleapi.CallOption) (
}
return ret, nil
// {
- // "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, CloudTasks.RunTask can be used to retry a failed\ntask after a fix has been made or to manually force a task to be\ndispatched now.\n\nWhen this method is called, Cloud Tasks will dispatch the task to its\ntarget, even if the queue is Queue.State.PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the Task.status after the task is dispatched but\nbefore the task is received by its target.\n\nIf Cloud Tasks receives a successful response from the task's\nhandler, then the task will be deleted; otherwise the task's\nTask.schedule_time will be reset to the time that\nCloudTasks.RunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nCloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when\nit is called on a task that has already succeeded or permanently\nfailed. google.rpc.Code.FAILED_PRECONDITION is returned when\nCloudTasks.RunTask is called on task that is dispatched or\nalready running.\n\nCloudTasks.RunTask cannot be called on pull tasks.",
+ // "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, RunTask can be used to retry a failed\ntask after a fix has been made or to manually force a task to be\ndispatched now.\n\nWhen this method is called, Cloud Tasks will dispatch the task to its\ntarget, even if the queue is PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the status after the task is dispatched but\nbefore the task is received by its target.\n\nIf Cloud Tasks receives a successful response from the task's\nhandler, then the task will be deleted; otherwise the task's\nschedule_time will be reset to the time that\nRunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nRunTask returns\nNOT_FOUND when it is called on a\ntask that has already succeeded or permanently\nfailed. FAILED_PRECONDITION\nis returned when RunTask is called on task\nthat is dispatched or already running.\n\nRunTask cannot be called on\npull tasks.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.tasks.run",
diff --git a/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-api.json b/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-api.json
index ef318a270..4c4c99233 100644
--- a/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-api.json
+++ b/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-api.json
@@ -1,67 +1,357 @@
{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/trace.append": {
+ "description": "Write Trace data for a project or application"
+ },
+ "https://www.googleapis.com/auth/trace.readonly": {
+ "description": "Read Trace data for a project or application"
+ }
+ }
+ }
+ },
"basePath": "",
- "documentationLink": "https://cloud.google.com/trace",
- "id": "cloudtrace:v1",
- "revision": "20180109",
+ "baseUrl": "https://cloudtrace.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Trace",
+ "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n",
"discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "Traces": {
- "properties": {
- "traces": {
- "description": "List of traces.",
- "type": "array",
- "items": {
- "$ref": "Trace"
- }
+ "documentationLink": "https://cloud.google.com/trace",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudtrace:v1",
+ "kind": "discovery#restDescription",
+ "name": "cloudtrace",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "projects": {
+ "methods": {
+ "patchTraces": {
+ "description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.",
+ "flatPath": "v1/projects/{projectId}/traces",
+ "httpMethod": "PATCH",
+ "id": "cloudtrace.projects.patchTraces",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/traces",
+ "request": {
+ "$ref": "Traces"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ]
+ }
+ },
+ "resources": {
+ "traces": {
+ "methods": {
+ "get": {
+ "description": "Gets a single trace by its ID.",
+ "flatPath": "v1/projects/{projectId}/traces/{traceId}",
+ "httpMethod": "GET",
+ "id": "cloudtrace.projects.traces.get",
+ "parameterOrder": [
+ "projectId",
+ "traceId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "traceId": {
+ "description": "ID of the trace to return.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/traces/{traceId}",
+ "response": {
+ "$ref": "Trace"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ]
+ },
+ "list": {
+ "description": "Returns of a list of traces that match the specified filter conditions.",
+ "flatPath": "v1/projects/{projectId}/traces",
+ "httpMethod": "GET",
+ "id": "cloudtrace.projects.traces.list",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "endTime": {
+ "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime",
+ "location": "query",
+ "type": "string"
+ },
+ "filter": {
+ "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of traces to return. If not specified or \u003c= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime",
+ "location": "query",
+ "type": "string"
+ },
+ "view": {
+ "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
+ "enum": [
+ "VIEW_TYPE_UNSPECIFIED",
+ "MINIMAL",
+ "ROOTSPAN",
+ "COMPLETE"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}/traces",
+ "response": {
+ "$ref": "ListTracesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20180312",
+ "rootUrl": "https://cloudtrace.googleapis.com/",
+ "schemas": {
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "ListTracesResponse": {
+ "description": "The response message for the `ListTraces` method.",
+ "id": "ListTracesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
+ "type": "string"
+ },
+ "traces": {
+ "description": "List of trace records returned.",
+ "items": {
+ "$ref": "Trace"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Trace": {
+ "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.",
+ "id": "Trace",
+ "properties": {
+ "projectId": {
+ "description": "Project ID of the Cloud project where the trace data is stored.",
+ "type": "string"
+ },
+ "spans": {
+ "description": "Collection of spans in the trace.",
+ "items": {
+ "$ref": "TraceSpan"
+ },
+ "type": "array"
+ },
+ "traceId": {
+ "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string.",
+ "type": "string"
}
},
- "id": "Traces",
- "description": "List of new or updated traces.",
"type": "object"
},
"TraceSpan": {
"description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace.",
- "type": "object",
+ "id": "TraceSpan",
"properties": {
+ "endTime": {
+ "description": "End time of the span in nanoseconds from the UNIX epoch.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"kind": {
"description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.",
- "type": "string",
+ "enum": [
+ "SPAN_KIND_UNSPECIFIED",
+ "RPC_SERVER",
+ "RPC_CLIENT"
+ ],
"enumDescriptions": [
"Unspecified.",
"Indicates that the span covers server-side handling of an RPC or other\nremote network request.",
"Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
],
- "enum": [
- "SPAN_KIND_UNSPECIFIED",
- "RPC_SERVER",
- "RPC_CLIENT"
- ]
+ "type": "string"
},
"labels": {
- "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/path`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/route`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`",
+ "type": "object"
},
"name": {
"description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans.",
"type": "string"
},
- "spanId": {
- "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.",
- "format": "uint64",
- "type": "string"
- },
"parentSpanId": {
"description": "ID of the parent span, if any. Optional.",
"format": "uint64",
"type": "string"
},
- "endTime": {
- "description": "End time of the span in nanoseconds from the UNIX epoch.",
- "format": "google-datetime",
+ "spanId": {
+ "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.",
+ "format": "uint64",
"type": "string"
},
"startTime": {
@@ -70,315 +360,25 @@
"type": "string"
}
},
- "id": "TraceSpan"
+ "type": "object"
},
- "ListTracesResponse": {
- "description": "The response message for the `ListTraces` method.",
- "type": "object",
+ "Traces": {
+ "description": "List of new or updated traces.",
+ "id": "Traces",
"properties": {
"traces": {
- "description": "List of trace records returned.",
- "type": "array",
+ "description": "List of traces.",
"items": {
"$ref": "Trace"
- }
- },
- "nextPageToken": {
- "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
- "type": "string"
+ },
+ "type": "array"
}
},
- "id": "ListTracesResponse"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Trace": {
- "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "Project ID of the Cloud project where the trace data is stored.",
- "type": "string"
- },
- "spans": {
- "description": "Collection of spans in the trace.",
- "type": "array",
- "items": {
- "$ref": "TraceSpan"
- }
- },
- "traceId": {
- "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string.",
- "type": "string"
- }
- },
- "id": "Trace"
+ "type": "object"
}
},
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "Cloud Trace",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/trace.readonly": {
- "description": "Read Trace data for a project or application"
- },
- "https://www.googleapis.com/auth/trace.append": {
- "description": "Write Trace data for a project or application"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudtrace.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudtrace",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Trace API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "patchTraces": {
- "description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.",
- "request": {
- "$ref": "Traces"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.append"
- ],
- "parameters": {
- "projectId": {
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/traces",
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.patchTraces"
- }
- },
- "resources": {
- "traces": {
- "methods": {
- "list": {
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.traces.list",
- "description": "Returns of a list of traces that match the specified filter conditions.",
- "response": {
- "$ref": "ListTracesResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "parameters": {
- "orderBy": {
- "description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string"
- },
- "filter": {
- "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
- "type": "string",
- "location": "query"
- },
- "endTime": {
- "location": "query",
- "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
- "type": "string"
- },
- "startTime": {
- "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Maximum number of traces to return. If not specified or \u003c= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "VIEW_TYPE_UNSPECIFIED",
- "MINIMAL",
- "ROOTSPAN",
- "COMPLETE"
- ],
- "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/traces"
- },
- "get": {
- "flatPath": "v1/projects/{projectId}/traces/{traceId}",
- "path": "v1/projects/{projectId}/traces/{traceId}",
- "id": "cloudtrace.projects.traces.get",
- "description": "Gets a single trace by its ID.",
- "response": {
- "$ref": "Trace"
- },
- "parameterOrder": [
- "projectId",
- "traceId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "parameters": {
- "traceId": {
- "location": "path",
- "description": "ID of the trace to return.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "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.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "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.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudtrace.googleapis.com/",
"servicePath": "",
- "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n",
- "kind": "discovery#restDescription"
-}
+ "title": "Stackdriver Trace API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-gen.go b/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-gen.go
index d692d2ab8..39bc34064 100644
--- a/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-gen.go
+++ b/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-gen.go
@@ -261,9 +261,11 @@ type TraceSpan struct {
// * `/http/client_region`
// * `/http/host`
// * `/http/method`
+ // * `/http/path`
// * `/http/redirected_url`
// * `/http/request/size`
// * `/http/response/size`
+ // * `/http/route`
// * `/http/status_code`
// * `/http/url`
// * `/http/user_agent`
diff --git a/vendor/google.golang.org/api/cloudtrace/v2/cloudtrace-api.json b/vendor/google.golang.org/api/cloudtrace/v2/cloudtrace-api.json
index 422f413a6..fd0f3b495 100644
--- a/vendor/google.golang.org/api/cloudtrace/v2/cloudtrace-api.json
+++ b/vendor/google.golang.org/api/cloudtrace/v2/cloudtrace-api.json
@@ -1,10 +1,237 @@
{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/trace.append": {
+ "description": "Write Trace data for a project or application"
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://cloudtrace.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "Cloud Trace",
+ "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n",
"discoveryVersion": "v1",
- "version_module": true,
+ "documentationLink": "https://cloud.google.com/trace",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "cloudtrace:v2",
+ "kind": "discovery#restDescription",
+ "name": "cloudtrace",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "projects": {
+ "resources": {
+ "traces": {
+ "methods": {
+ "batchWrite": {
+ "description": "Sends new spans to new or existing traces. You cannot update\nexisting spans.",
+ "flatPath": "v2/projects/{projectsId}/traces:batchWrite",
+ "httpMethod": "POST",
+ "id": "cloudtrace.projects.traces.batchWrite",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the project where the spans belong. The format is\n`projects/[PROJECT_ID]`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/{+name}/traces:batchWrite",
+ "request": {
+ "$ref": "BatchWriteSpansRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ]
+ }
+ },
+ "resources": {
+ "spans": {
+ "methods": {
+ "createSpan": {
+ "description": "Creates a new span.",
+ "flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}",
+ "httpMethod": "POST",
+ "id": "cloudtrace.projects.traces.spans.createSpan",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;\nit is a 32-character hexadecimal encoding of a 16-byte array.\n\n[SPAN_ID] is a unique identifier for a span within a trace; it\nis a 16-character hexadecimal encoding of an 8-byte array.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/{+name}",
+ "request": {
+ "$ref": "Span"
+ },
+ "response": {
+ "$ref": "Span"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20180130",
+ "rootUrl": "https://cloudtrace.googleapis.com/",
"schemas": {
+ "Annotation": {
+ "description": "Text annotation with a set of attributes.",
+ "id": "Annotation",
+ "properties": {
+ "attributes": {
+ "$ref": "Attributes",
+ "description": "A set of attributes on the annotation. You can have up to 4 attributes\nper Annotation."
+ },
+ "description": {
+ "$ref": "TruncatableString",
+ "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes."
+ }
+ },
+ "type": "object"
+ },
+ "AttributeValue": {
+ "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
+ "id": "AttributeValue",
+ "properties": {
+ "boolValue": {
+ "description": "A Boolean value represented by `true` or `false`.",
+ "type": "boolean"
+ },
+ "intValue": {
+ "description": "A 64-bit signed integer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "stringValue": {
+ "$ref": "TruncatableString",
+ "description": "A string up to 256 bytes long."
+ }
+ },
+ "type": "object"
+ },
"Attributes": {
"description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
- "type": "object",
+ "id": "Attributes",
"properties": {
"attributeMap": {
"additionalProperties": {
@@ -19,11 +246,64 @@
"type": "integer"
}
},
- "id": "Attributes"
+ "type": "object"
+ },
+ "BatchWriteSpansRequest": {
+ "description": "The request message for the `BatchWriteSpans` method.",
+ "id": "BatchWriteSpansRequest",
+ "properties": {
+ "spans": {
+ "description": "A list of new spans. The span names must not match existing\nspans, or the results are undefined.",
+ "items": {
+ "$ref": "Span"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "Link": {
+ "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.",
+ "id": "Link",
+ "properties": {
+ "attributes": {
+ "$ref": "Attributes",
+ "description": "A set of attributes on the link. You have have up to 32 attributes per\nlink."
+ },
+ "spanId": {
+ "description": "The [SPAN_ID] for a span within a trace.",
+ "type": "string"
+ },
+ "traceId": {
+ "description": "The [TRACE_ID] for a trace within a project.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The relationship of the current span relative to the linked span.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CHILD_LINKED_SPAN",
+ "PARENT_LINKED_SPAN"
+ ],
+ "enumDescriptions": [
+ "The relationship of the two spans is unknown.",
+ "The linked span is a child of the current span.",
+ "The linked span is a parent of the current span."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
},
"Links": {
"description": "A collection of links, which are references from this span to a span\nin the same or different trace.",
- "type": "object",
+ "id": "Links",
"properties": {
"droppedLinksCount": {
"description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
@@ -32,92 +312,40 @@
},
"link": {
"description": "A collection of links.",
- "type": "array",
"items": {
"$ref": "Link"
- }
+ },
+ "type": "array"
}
},
- "id": "Links"
- },
- "StackTrace": {
- "description": "A call stack appearing in a trace.",
- "type": "object",
- "properties": {
- "stackTraceHashId": {
- "description": "The hash ID is used to conserve network bandwidth for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSubsequent spans within the same request can refer\nto that stack trace by only setting `stackTraceHashId`.",
- "format": "int64",
- "type": "string"
- },
- "stackFrames": {
- "$ref": "StackFrames",
- "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
- }
- },
- "id": "StackTrace"
- },
- "TruncatableString": {
- "description": "Represents a string that might be shortened to a specified length.",
- "type": "object",
- "properties": {
- "truncatedByteCount": {
- "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.",
- "format": "int32",
- "type": "integer"
- },
- "value": {
- "description": "The shortened string. For example, if the original string is 500\nbytes long and the limit of the string is 128 bytes, then\n`value` contains the first 128 bytes of the 500-byte string.\n\nTruncation always happens on a UTF8 character boundary. If there\nare multi-byte characters in the string, then the length of the\nshortened string might be less than the size limit.",
- "type": "string"
- }
- },
- "id": "TruncatableString"
- },
- "TimeEvent": {
- "description": "A time-stamped annotation or message event in the Span.",
- "type": "object",
- "properties": {
- "messageEvent": {
- "$ref": "MessageEvent",
- "description": "An event describing a message sent/received between Spans."
- },
- "time": {
- "description": "The timestamp indicating the time the event occurred.",
- "format": "google-datetime",
- "type": "string"
- },
- "annotation": {
- "$ref": "Annotation",
- "description": "Text annotation with a set of attributes."
- }
- },
- "id": "TimeEvent"
+ "type": "object"
},
"MessageEvent": {
"description": "An event describing a message sent/received between Spans.",
- "type": "object",
+ "id": "MessageEvent",
"properties": {
- "type": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "SENT",
- "RECEIVED"
- ],
- "description": "Type of MessageEvent. Indicates whether the message was sent or\nreceived.",
- "type": "string",
- "enumDescriptions": [
- "Unknown event type.",
- "Indicates a sent message.",
- "Indicates a received message."
- ]
+ "compressedSizeBytes": {
+ "description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.",
+ "format": "int64",
+ "type": "string"
},
"id": {
"description": "An identifier for the MessageEvent's message that can be used to match\nSENT and RECEIVED MessageEvents. It is recommended to be unique within\na Span.",
"format": "int64",
"type": "string"
},
- "compressedSizeBytes": {
- "description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.",
- "format": "int64",
+ "type": {
+ "description": "Type of MessageEvent. Indicates whether the message was sent or\nreceived.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "SENT",
+ "RECEIVED"
+ ],
+ "enumDescriptions": [
+ "Unknown event type.",
+ "Indicates a sent message.",
+ "Indicates a received message."
+ ],
"type": "string"
},
"uncompressedSizeBytes": {
@@ -126,23 +354,97 @@
"type": "string"
}
},
- "id": "MessageEvent"
+ "type": "object"
+ },
+ "Module": {
+ "description": "Binary module.",
+ "id": "Module",
+ "properties": {
+ "buildId": {
+ "$ref": "TruncatableString",
+ "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)."
+ },
+ "module": {
+ "$ref": "TruncatableString",
+ "description": "For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes)."
+ }
+ },
+ "type": "object"
+ },
+ "Span": {
+ "description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous\u0026mdash;there may be\ngaps or overlaps between spans in a trace.",
+ "id": "Span",
+ "properties": {
+ "attributes": {
+ "$ref": "Attributes",
+ "description": "A set of attributes on the span. You can have up to 32 attributes per\nspan."
+ },
+ "childSpanCount": {
+ "description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect missing child spans.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "displayName": {
+ "$ref": "TruncatableString",
+ "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces."
+ },
+ "endTime": {
+ "description": "The end time of the span. On the client side, this is the time kept by\nthe local machine where the span execution ends. On the server side, this\nis the time when the server application handler stops running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "links": {
+ "$ref": "Links",
+ "description": "Links associated with the span. You can have up to 128 links per Span."
+ },
+ "name": {
+ "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;\nit is a 32-character hexadecimal encoding of a 16-byte array.\n\n[SPAN_ID] is a unique identifier for a span within a trace; it\nis a 16-character hexadecimal encoding of an 8-byte array.",
+ "type": "string"
+ },
+ "parentSpanId": {
+ "description": "The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.",
+ "type": "string"
+ },
+ "sameProcessAsParentSpan": {
+ "description": "(Optional) Set this parameter to indicate whether this span is in\nthe same process as its parent. If you do not set this parameter,\nStackdriver Trace is unable to take advantage of this helpful\ninformation.",
+ "type": "boolean"
+ },
+ "spanId": {
+ "description": "The [SPAN_ID] portion of the span's resource name.",
+ "type": "string"
+ },
+ "stackTrace": {
+ "$ref": "StackTrace",
+ "description": "Stack trace captured at the start of the span."
+ },
+ "startTime": {
+ "description": "The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "An optional final status for this span."
+ },
+ "timeEvents": {
+ "$ref": "TimeEvents",
+ "description": "A set of time events. You can have up to 32 annotations and 128 message\nevents per span."
+ }
+ },
+ "type": "object"
},
"StackFrame": {
"description": "Represents a single stack frame in a stack trace.",
- "type": "object",
+ "id": "StackFrame",
"properties": {
+ "columnNumber": {
+ "description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.",
+ "format": "int64",
+ "type": "string"
+ },
"fileName": {
- "description": "The name of the source file where the function call appears (up to 256\nbytes).",
- "$ref": "TruncatableString"
- },
- "sourceVersion": {
- "description": "The version of the deployed source code (up to 128 bytes).",
- "$ref": "TruncatableString"
- },
- "originalFunctionName": {
- "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes).",
- "$ref": "TruncatableString"
+ "$ref": "TruncatableString",
+ "description": "The name of the source file where the function call appears (up to 256\nbytes)."
},
"functionName": {
"$ref": "TruncatableString",
@@ -157,83 +459,108 @@
"$ref": "Module",
"description": "The binary module from where the code was loaded."
},
- "columnNumber": {
- "description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "StackFrame"
- },
- "Link": {
- "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.",
- "type": "object",
- "properties": {
- "type": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "CHILD_LINKED_SPAN",
- "PARENT_LINKED_SPAN"
- ],
- "description": "The relationship of the current span relative to the linked span.",
- "type": "string",
- "enumDescriptions": [
- "The relationship of the two spans is unknown.",
- "The linked span is a child of the current span.",
- "The linked span is a parent of the current span."
- ]
- },
- "traceId": {
- "description": "The [TRACE_ID] for a trace within a project.",
- "type": "string"
- },
- "attributes": {
- "description": "A set of attributes on the link. You have have up to 32 attributes per\nlink.",
- "$ref": "Attributes"
- },
- "spanId": {
- "description": "The [SPAN_ID] for a span within a trace.",
- "type": "string"
- }
- },
- "id": "Link"
- },
- "Annotation": {
- "properties": {
- "attributes": {
- "description": "A set of attributes on the annotation. You can have up to 4 attributes\nper Annotation.",
- "$ref": "Attributes"
- },
- "description": {
+ "originalFunctionName": {
"$ref": "TruncatableString",
- "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes."
+ "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes)."
+ },
+ "sourceVersion": {
+ "$ref": "TruncatableString",
+ "description": "The version of the deployed source code (up to 128 bytes)."
}
},
- "id": "Annotation",
- "description": "Text annotation with a set of attributes.",
"type": "object"
},
"StackFrames": {
+ "description": "A collection of stack frames, which can be truncated.",
+ "id": "StackFrames",
"properties": {
- "frame": {
- "description": "Stack frames in this call stack.",
- "type": "array",
- "items": {
- "$ref": "StackFrame"
- }
- },
"droppedFramesCount": {
"description": "The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack frames were dropped.",
"format": "int32",
"type": "integer"
+ },
+ "frame": {
+ "description": "Stack frames in this call stack.",
+ "items": {
+ "$ref": "StackFrame"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "StackTrace": {
+ "description": "A call stack appearing in a trace.",
+ "id": "StackTrace",
+ "properties": {
+ "stackFrames": {
+ "$ref": "StackFrames",
+ "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
+ },
+ "stackTraceHashId": {
+ "description": "The hash ID is used to conserve network bandwidth for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSubsequent spans within the same request can refer\nto that stack trace by only setting `stackTraceHashId`.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TimeEvent": {
+ "description": "A time-stamped annotation or message event in the Span.",
+ "id": "TimeEvent",
+ "properties": {
+ "annotation": {
+ "$ref": "Annotation",
+ "description": "Text annotation with a set of attributes."
+ },
+ "messageEvent": {
+ "$ref": "MessageEvent",
+ "description": "An event describing a message sent/received between Spans."
+ },
+ "time": {
+ "description": "The timestamp indicating the time the event occurred.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "StackFrames",
- "description": "A collection of stack frames, which can be truncated.",
"type": "object"
},
"TimeEvents": {
+ "description": "A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation\non the span, consisting of either user-supplied key:value pairs, or\ndetails of a message sent/received between Spans.",
+ "id": "TimeEvents",
"properties": {
+ "droppedAnnotationsCount": {
+ "description": "The number of dropped annotations in all the included time events.\nIf the value is 0, then no annotations were dropped.",
+ "format": "int32",
+ "type": "integer"
+ },
"droppedMessageEventsCount": {
"description": "The number of dropped message events in all the included time events.\nIf the value is 0, then no message events were dropped.",
"format": "int32",
@@ -241,360 +568,33 @@
},
"timeEvent": {
"description": "A collection of `TimeEvent`s.",
- "type": "array",
"items": {
"$ref": "TimeEvent"
- }
- },
- "droppedAnnotationsCount": {
- "description": "The number of dropped annotations in all the included time events.\nIf the value is 0, then no annotations were dropped.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TimeEvents",
- "description": "A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation\non the span, consisting of either user-supplied key:value pairs, or\ndetails of a message sent/received between Spans.",
- "type": "object"
- },
- "Module": {
- "description": "Binary module.",
- "type": "object",
- "properties": {
- "module": {
- "$ref": "TruncatableString",
- "description": "For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes)."
- },
- "buildId": {
- "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes).",
- "$ref": "TruncatableString"
- }
- },
- "id": "Module"
- },
- "Status": {
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "BatchWriteSpansRequest": {
- "description": "The request message for the `BatchWriteSpans` method.",
- "type": "object",
- "properties": {
- "spans": {
- "description": "A list of new spans. The span names must not match existing\nspans, or the results are undefined.",
- "type": "array",
- "items": {
- "$ref": "Span"
- }
- }
- },
- "id": "BatchWriteSpansRequest"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Span": {
- "description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous—