OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update to latest versions of API declarations

Browse Source
This commit is contained in:
Sebastian Thiel
2018-10-13 13:49:14 +02:00
parent 5a67475b54
commit 255c7f5ad5
1508 changed files with 819225 additions and 838421 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
etc/api/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
View File

@@ -1,4 +1,20 @@
{ {
"canonicalName": "Abusive Experience Report",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/xapi.zoo": {
"description": "Test scope for access to the Zoo service"
}
}
}
},
"rootUrl": "https://abusiveexperiencereport.googleapis.com/",
"ownerDomain": "google.com",
"name": "abusiveexperiencereport",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Abusive Experience Report API",
"ownerName": "Google", "ownerName": "Google",
"resources": { "resources": {
"sites": { "sites": {
@@ -33,28 +49,28 @@
"violatingSites": { "violatingSites": {
"methods": { "methods": {
"list": { "list": {
"flatPath": "v1/violatingSites",
"path": "v1/violatingSites",
"id": "abusiveexperiencereport.violatingSites.list",
"description": "Lists sites with Abusive Experience Report statuses of \"Failing\".", "description": "Lists sites with Abusive Experience Report statuses of \"Failing\".",
"httpMethod": "GET",
"parameterOrder": [],
"response": { "response": {
"$ref": "ViolatingSitesResponse" "$ref": "ViolatingSitesResponse"
}, },
"parameters": {}, "parameterOrder": [],
"httpMethod": "GET",
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/xapi.zoo" "https://www.googleapis.com/auth/xapi.zoo"
], ],
"flatPath": "v1/violatingSites", "parameters": {}
"id": "abusiveexperiencereport.violatingSites.list",
"path": "v1/violatingSites"
} }
} }
} }
}, },
"parameters": { "parameters": {
"fields": { "fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.", "description": "Selector specifying which fields to include in a partial response.",
"type": "string" "type": "string",
"location": "query"
}, },
"uploadType": { "uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
@@ -62,11 +78,18 @@
"location": "query" "location": "query"
}, },
"callback": { "callback": {
"location": "query",
"description": "JSONP", "description": "JSONP",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
"$.xgafv": { "$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [ "enumDescriptions": [
"v1 error format", "v1 error format",
"v2 error format" "v2 error format"
@@ -75,11 +98,15 @@
"enum": [ "enum": [
"1", "1",
"2" "2"
], ]
"description": "V1 error format.",
"type": "string"
}, },
"alt": { "alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"enumDescriptions": [ "enumDescriptions": [
"Responses with Content-Type of application/json", "Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type", "Media download with context-dependent Content-Type",
@@ -87,50 +114,28 @@
], ],
"location": "query", "location": "query",
"description": "Data format for response.", "description": "Data format for response.",
"default": "json", "default": "json"
"enum": [
"json",
"media",
"proto"
],
"type": "string"
}, },
"access_token": { "access_token": {
"location": "query",
"description": "OAuth access token.", "description": "OAuth access token.",
"type": "string", "type": "string"
"location": "query"
}, },
"key": { "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", "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", "location": "query",
"description": "Pretty-print response.", "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": "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": { "upload_protocol": {
"location": "query", "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string" "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"
},
"prettyPrint": { "prettyPrint": {
"description": "Returns response with indentations and line breaks.", "description": "Returns response with indentations and line breaks.",
"type": "boolean", "type": "boolean",
@@ -140,17 +145,19 @@
}, },
"version": "v1", "version": "v1",
"baseUrl": "https://abusiveexperiencereport.googleapis.com/", "baseUrl": "https://abusiveexperiencereport.googleapis.com/",
"servicePath": "",
"description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.",
"kind": "discovery#restDescription", "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": "", "basePath": "",
"documentationLink": "https://developers.google.com/abusive-experience-report/",
"id": "abusiveexperiencereport:v1", "id": "abusiveexperiencereport:v1",
"revision": "20171129", "documentationLink": "https://developers.google.com/abusive-experience-report/",
"revision": "20180904",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"version_module": true, "version_module": true,
"schemas": { "schemas": {
"ViolatingSitesResponse": { "ViolatingSitesResponse": {
"description": "Response message for ListViolatingSites.",
"type": "object",
"properties": { "properties": {
"violatingSites": { "violatingSites": {
"description": "A list of summaries of violating sites.", "description": "A list of summaries of violating sites.",
@@ -160,11 +167,12 @@
} }
} }
}, },
"id": "ViolatingSitesResponse", "id": "ViolatingSitesResponse"
"description": "Response message for ListViolatingSites.",
"type": "object"
}, },
"SiteSummaryResponse": { "SiteSummaryResponse": {
"id": "SiteSummaryResponse",
"description": "Response message for GetSiteSummary.\nDo not confuse with same message in google.ads.experiencereport.v1",
"type": "object",
"properties": { "properties": {
"underReview": { "underReview": {
"description": "Whether the site is currently under review.", "description": "Whether the site is currently under review.",
@@ -203,6 +211,8 @@
"type": "string" "type": "string"
}, },
"filterStatus": { "filterStatus": {
"description": "The abusive experience enforcement status of the site.",
"type": "string",
"enumDescriptions": [ "enumDescriptions": [
"N/A.", "N/A.",
"Ad filtering is on.", "Ad filtering is on.",
@@ -216,35 +226,14 @@
"OFF", "OFF",
"PAUSED", "PAUSED",
"PENDING" "PENDING"
], ]
"description": "The abusive experience enforcement status of the site.",
"type": "string"
} }
}, }
"id": "SiteSummaryResponse",
"description": "Response message for GetSiteSummary.",
"type": "object"
} }
}, },
"protocol": "rest", "protocol": "rest",
"icons": { "icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif" "x16": "http://www.google.com/images/icons/product/search-16.gif"
}, }
"canonicalName": "Abusive Experience Report",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/xapi.zoo": {
"description": "Test scope for access to the Zoo service"
}
}
}
},
"rootUrl": "https://abusiveexperiencereport.googleapis.com/",
"ownerDomain": "google.com",
"name": "abusiveexperiencereport",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Abusive Experience Report API"
} }

149
etc/api/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
View File

@@ -1,42 +1,29 @@
{ {
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": true,
"resources": { "resources": {
"ampUrls": { "ampUrls": {
"methods": { "methods": {
"batchGet": { "batchGet": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "BatchGetAmpUrlsResponse"
},
"parameters": {},
"flatPath": "v1/ampUrls:batchGet",
"id": "acceleratedmobilepageurl.ampUrls.batchGet",
"path": "v1/ampUrls:batchGet",
"request": { "request": {
"$ref": "BatchGetAmpUrlsRequest" "$ref": "BatchGetAmpUrlsRequest"
}, },
"description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format)." "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
"response": {
"$ref": "BatchGetAmpUrlsResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {},
"flatPath": "v1/ampUrls:batchGet",
"path": "v1/ampUrls:batchGet",
"id": "acceleratedmobilepageurl.ampUrls.batchGet"
} }
} }
} }
}, },
"parameters": { "parameters": {
"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": { "key": {
"location": "query", "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.", "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.",
@@ -47,65 +34,70 @@
"type": "string", "type": "string",
"location": "query" "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": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"upload_protocol": { "upload_protocol": {
"location": "query", "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string" "type": "string"
}, },
"prettyPrint": { "quotaUser": {
"location": "query", "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"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.", "description": "Returns response with indentations and line breaks.",
"type": "boolean", "type": "boolean",
"default": "true" "default": "true",
"location": "query"
}, },
"uploadType": { "uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string", "type": "string"
"location": "query"
}, },
"fields": { "fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string", "type": "string",
"location": "query" "location": "query",
"description": "Selector specifying which fields to include in a partial response."
}, },
"callback": { "callback": {
"type": "string",
"location": "query", "location": "query",
"description": "JSONP", "description": "JSONP"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string" "type": "string"
}, },
"$.xgafv": { "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [ "enum": [
"1", "1",
"2" "2"
], ],
"description": "V1 error format.", "description": "V1 error format.",
"type": "string"
},
"alt": {
"type": "string", "type": "string",
"enumDescriptions": [ "enumDescriptions": [
"v1 error format", "Responses with Content-Type of application/json",
"v2 error format" "Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
], ],
"location": "query" "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
]
} }
}, },
"schemas": { "schemas": {
@@ -131,6 +123,8 @@
"type": "object" "type": "object"
}, },
"AmpUrl": { "AmpUrl": {
"description": "AMP URL response for a requested URL.",
"type": "object",
"properties": { "properties": {
"cdnAmpUrl": { "cdnAmpUrl": {
"description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.", "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.",
@@ -145,18 +139,12 @@
"type": "string" "type": "string"
} }
}, },
"id": "AmpUrl", "id": "AmpUrl"
"description": "AMP URL response for a requested URL.",
"type": "object"
}, },
"AmpUrlError": { "AmpUrlError": {
"description": "AMP URL Error resource for a requested URL that couldn't be found.", "description": "AMP URL Error resource for a requested URL that couldn't be found.",
"type": "object", "type": "object",
"properties": { "properties": {
"errorMessage": {
"description": "An optional descriptive error message.",
"type": "string"
},
"errorCode": { "errorCode": {
"enumDescriptions": [ "enumDescriptions": [
"Not specified error.", "Not specified error.",
@@ -180,6 +168,10 @@
"originalUrl": { "originalUrl": {
"description": "The original non-AMP URL.", "description": "The original non-AMP URL.",
"type": "string" "type": "string"
},
"errorMessage": {
"description": "An optional descriptive error message.",
"type": "string"
} }
}, },
"id": "AmpUrlError" "id": "AmpUrlError"
@@ -196,41 +188,38 @@
} }
}, },
"lookupStrategy": { "lookupStrategy": {
"enum": [
"FETCH_LIVE_DOC",
"IN_INDEX_DOC"
],
"description": "The lookup_strategy being requested.", "description": "The lookup_strategy being requested.",
"type": "string", "type": "string",
"enumDescriptions": [ "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.", "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." "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."
],
"enum": [
"FETCH_LIVE_DOC",
"IN_INDEX_DOC"
] ]
} }
}, },
"id": "BatchGetAmpUrlsRequest" "id": "BatchGetAmpUrlsRequest"
} }
}, },
"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", "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"
},
"version": "v1", "version": "v1",
"baseUrl": "https://acceleratedmobilepageurl.googleapis.com/", "baseUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"servicePath": "",
"description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
"kind": "discovery#restDescription", "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/", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"basePath": "", "basePath": "",
"ownerDomain": "google.com", "ownerDomain": "google.com",
"name": "acceleratedmobilepageurl", "name": "acceleratedmobilepageurl",
"batchPath": "batch", "batchPath": "batch",
"revision": "20171202",
"documentationLink": "https://developers.google.com/amp/cache/",
"id": "acceleratedmobilepageurl:v1", "id": "acceleratedmobilepageurl:v1",
"title": "Accelerated Mobile Pages (AMP) URL API", "documentationLink": "https://developers.google.com/amp/cache/",
"discoveryVersion": "v1", "revision": "20180917",
"ownerName": "Google", "title": "Accelerated Mobile Pages (AMP) URL API"
"version_module": true
} }

1018
etc/api/accesscontextmanager/v1beta/accesscontextmanager-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

8
etc/api/adexchangebuyer/v1.2/adexchangebuyer-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/-1DKqIhPUpLfO8DBj8P3gNrIPtE\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/uABUoWqndqmjrMc68QEVWTXXr9Q\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "adexchangebuyer:v1.2", "id": "adexchangebuyer:v1.2",
"name": "adexchangebuyer", "name": "adexchangebuyer",
"canonicalName": "Ad Exchange Buyer", "canonicalName": "Ad Exchange Buyer",
"version": "v1.2", "version": "v1.2",
"revision": "20170810", "revision": "20180823",
"title": "Ad Exchange Buyer API", "title": "Ad Exchange Buyer API",
"description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

8
etc/api/adexchangebuyer/v1.3/adexchangebuyer-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/_RwUq281eKa7d-tJKPdh-IE_OEk\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/0aAEgAvTLkUnHNX04VaZtSdc2Jk\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "adexchangebuyer:v1.3", "id": "adexchangebuyer:v1.3",
"name": "adexchangebuyer", "name": "adexchangebuyer",
"canonicalName": "Ad Exchange Buyer", "canonicalName": "Ad Exchange Buyer",
"version": "v1.3", "version": "v1.3",
"revision": "20170810", "revision": "20180823",
"title": "Ad Exchange Buyer API", "title": "Ad Exchange Buyer API",
"description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

68
etc/api/adexchangebuyer/v1.4/adexchangebuyer-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/nD15-sVgx0hSdEaD_RN4E40IFV8\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/MJwOf3EG-7RF4hB9GZz8eDlZZS0\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "adexchangebuyer:v1.4", "id": "adexchangebuyer:v1.4",
"name": "adexchangebuyer", "name": "adexchangebuyer",
"canonicalName": "Ad Exchange Buyer", "canonicalName": "Ad Exchange Buyer",
"version": "v1.4", "version": "v1.4",
"revision": "20170810", "revision": "20180823",
"title": "Ad Exchange Buyer API", "title": "Ad Exchange Buyer API",
"description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -82,6 +82,10 @@
"type": "object", "type": "object",
"description": "Configuration data for an Ad Exchange buyer account.", "description": "Configuration data for an Ad Exchange buyer account.",
"properties": { "properties": {
"applyPretargetingToNonGuaranteedDeals": {
"type": "boolean",
"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."
},
"bidderLocation": { "bidderLocation": {
"type": "array", "type": "array",
"description": "Your bidder locations that have distinct URLs.", "description": "Your bidder locations that have distinct URLs.",
@@ -370,7 +374,7 @@
"properties": { "properties": {
"HTMLSnippet": { "HTMLSnippet": {
"type": "string", "type": "string",
"description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set." "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set."
}, },
"accountId": { "accountId": {
"type": "integer", "type": "integer",
@@ -497,6 +501,10 @@
} }
} }
}, },
"creativeStatusIdentityType": {
"type": "string",
"description": "Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole."
},
"dealsStatus": { "dealsStatus": {
"type": "string", "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." "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."
@@ -568,7 +576,7 @@
}, },
"nativeAd": { "nativeAd": {
"type": "object", "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.)", "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": { "properties": {
"advertiser": { "advertiser": {
"type": "string" "type": "string"
@@ -781,7 +789,11 @@
}, },
"videoURL": { "videoURL": {
"type": "string", "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." "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."
},
"videoVastXML": {
"type": "string",
"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."
}, },
"width": { "width": {
"type": "integer", "type": "integer",
@@ -2158,10 +2170,6 @@
"id": "PublisherProfileApiProto", "id": "PublisherProfileApiProto",
"type": "object", "type": "object",
"properties": { "properties": {
"accountId": {
"type": "string",
"description": "Deprecated: use the seller.account_id. The account id of the seller."
},
"audience": { "audience": {
"type": "string", "type": "string",
"description": "Publisher provided info on its audience." "description": "Publisher provided info on its audience."
@@ -2333,6 +2341,12 @@
"$ref": "TargetingValueDayPartTargeting", "$ref": "TargetingValueDayPartTargeting",
"description": "The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING." "description": "The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING."
}, },
"demogAgeCriteriaValue": {
"$ref": "TargetingValueDemogAgeCriteria"
},
"demogGenderCriteriaValue": {
"$ref": "TargetingValueDemogGenderCriteria"
},
"longValue": { "longValue": {
"type": "string", "type": "string",
"description": "The long value to exclude/include.", "description": "The long value to exclude/include.",
@@ -2347,7 +2361,15 @@
"TargetingValueCreativeSize": { "TargetingValueCreativeSize": {
"id": "TargetingValueCreativeSize", "id": "TargetingValueCreativeSize",
"type": "object", "type": "object",
"description": "Next Id: 7",
"properties": { "properties": {
"allowedFormats": {
"type": "array",
"description": "The formats allowed by the publisher.",
"items": {
"type": "string"
}
},
"companionSizes": { "companionSizes": {
"type": "array", "type": "array",
"description": "For video size type, the list of companion sizes.", "description": "For video size type, the list of companion sizes.",
@@ -2413,6 +2435,30 @@
} }
} }
}, },
"TargetingValueDemogAgeCriteria": {
"id": "TargetingValueDemogAgeCriteria",
"type": "object",
"properties": {
"demogAgeCriteriaIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"TargetingValueDemogGenderCriteria": {
"id": "TargetingValueDemogGenderCriteria",
"type": "object",
"properties": {
"demogGenderCriteriaIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"TargetingValueSize": { "TargetingValueSize": {
"id": "TargetingValueSize", "id": "TargetingValueSize",
"type": "object", "type": "object",

8028
etc/api/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
View File

File diff suppressed because it is too large Load Diff

291
etc/api/adexperiencereport/v1/adexperiencereport-api.json
View File

@@ -1,64 +1,15 @@
{ {
"revision": "20180911",
"documentationLink": "https://developers.google.com/ad-experience-report/",
"id": "adexperiencereport:v1",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"version_module": true, "version_module": true,
"schemas": { "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": {
"desktopSummary": {
"description": "Summary for the desktop review of the site.",
"$ref": "PlatformSummary"
},
"mobileSummary": {
"$ref": "PlatformSummary",
"description": "Summary for the mobile review of the site."
},
"reviewedSite": {
"description": "The name of the site reviewed.",
"type": "string"
}
},
"id": "SiteSummaryResponse"
},
"PlatformSummary": { "PlatformSummary": {
"id": "PlatformSummary",
"description": "Summary of the ad experience rating of a site for a specific platform.",
"type": "object",
"properties": { "properties": {
"enforcementTime": {
"description": "The date on which ad filtering begins.",
"format": "google-datetime",
"type": "string"
},
"region": {
"description": "The assigned regions for the site and platform.",
"type": "array",
"items": {
"enum": [
"REGION_UNKNOWN",
"REGION_A",
"REGION_B"
],
"type": "string"
},
"enumDescriptions": [
"Ad standard not yet defined for your region.",
"Region A.",
"Region B."
]
},
"filterStatus": { "filterStatus": {
"description": "The ad filtering status of the site.", "description": "The ad filtering status of the site.",
"type": "string", "type": "string",
@@ -91,6 +42,7 @@
"type": "string" "type": "string"
}, },
"betterAdsStatus": { "betterAdsStatus": {
"type": "string",
"enumDescriptions": [ "enumDescriptions": [
"Not reviewed.", "Not reviewed.",
"Passing.", "Passing.",
@@ -103,19 +55,72 @@
"WARNING", "WARNING",
"FAILING" "FAILING"
], ],
"description": "The status of the site reviewed for the Better Ads Standards.", "description": "The status of the site reviewed for the Better Ads Standards."
},
"enforcementTime": {
"description": "The date on which ad filtering begins.",
"format": "google-datetime",
"type": "string" "type": "string"
},
"region": {
"enumDescriptions": [
"Ad standard not yet defined for your region.",
"Region A.",
"Region B.",
"Region C."
],
"description": "The assigned regions for the site and platform.",
"type": "array",
"items": {
"enum": [
"REGION_UNKNOWN",
"REGION_A",
"REGION_B",
"REGION_C"
],
"type": "string"
}
}
}
},
"ViolatingSitesResponse": {
"description": "Response message for ListViolatingSites.",
"type": "object",
"properties": {
"violatingSites": {
"description": "A list of summaries of violating sites.",
"type": "array",
"items": {
"$ref": "SiteSummaryResponse"
}
} }
}, },
"id": "PlatformSummary", "id": "ViolatingSitesResponse"
"description": "Summary of the ad experience rating of a site for a specific platform.", },
"type": "object" "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": {
"description": "Summary for the desktop review of the site.",
"$ref": "PlatformSummary"
}
},
"id": "SiteSummaryResponse"
} }
}, },
"protocol": "rest", "protocol": "rest",
"icons": { "icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif" "x32": "http://www.google.com/images/icons/product/search-32.gif"
}, },
"canonicalName": "Ad Experience Report", "canonicalName": "Ad Experience Report",
"auth": { "auth": {
@@ -131,44 +136,20 @@
"ownerDomain": "google.com", "ownerDomain": "google.com",
"name": "adexperiencereport", "name": "adexperiencereport",
"batchPath": "batch", "batchPath": "batch",
"title": "Google Ad Experience Report API", "title": "Ad Experience Report API",
"ownerName": "Google", "ownerName": "Google",
"resources": { "resources": {
"violatingSites": {
"methods": {
"list": {
"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",
"description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\"."
}
}
},
"sites": { "sites": {
"methods": { "methods": {
"get": { "get": {
"path": "v1/{+name}",
"id": "adexperiencereport.sites.get",
"description": "Gets a summary of the ad experience rating of a site.", "description": "Gets a summary of the ad experience rating of a site.",
"response": { "httpMethod": "GET",
"$ref": "SiteSummaryResponse"
},
"parameterOrder": [ "parameterOrder": [
"name" "name"
], ],
"httpMethod": "GET", "response": {
"scopes": [ "$ref": "SiteSummaryResponse"
"https://www.googleapis.com/auth/xapi.zoo" },
],
"parameters": { "parameters": {
"name": { "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.", "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.",
@@ -178,47 +159,42 @@
"location": "path" "location": "path"
} }
}, },
"flatPath": "v1/sites/{sitesId}" "scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
],
"flatPath": "v1/sites/{sitesId}",
"id": "adexperiencereport.sites.get",
"path": "v1/{+name}"
}
}
},
"violatingSites": {
"methods": {
"list": {
"path": "v1/violatingSites",
"id": "adexperiencereport.violatingSites.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"
} }
} }
} }
}, },
"parameters": { "parameters": {
"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"
},
"$.xgafv": {
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
]
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"alt": { "alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string", "type": "string",
"enumDescriptions": [ "enumDescriptions": [
"Responses with Content-Type of application/json", "Responses with Content-Type of application/json",
@@ -227,20 +203,20 @@
], ],
"location": "query", "location": "query",
"description": "Data format for response.", "description": "Data format for response.",
"default": "json", "default": "json"
"enum": [
"json",
"media",
"proto"
]
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
}, },
"key": { "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.", "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"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
@@ -249,10 +225,25 @@
"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.", "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": "string"
}, },
"pp": { "prettyPrint": {
"description": "Pretty-print response.",
"type": "boolean", "type": "boolean",
"default": "true", "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": {
"type": "string",
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query" "location": "query"
}, },
"oauth_token": { "oauth_token": {
@@ -260,15 +251,18 @@
"description": "OAuth 2.0 token for the current user.", "description": "OAuth 2.0 token for the current user.",
"type": "string" "type": "string"
}, },
"bearer_token": { "$.xgafv": {
"description": "OAuth bearer token.", "description": "V1 error format.",
"type": "string", "type": "string",
"location": "query" "enumDescriptions": [
}, "v1 error format",
"upload_protocol": { "v2 error format"
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", ],
"type": "string", "location": "query",
"location": "query" "enum": [
"1",
"2"
]
} }
}, },
"version": "v1", "version": "v1",
@@ -276,8 +270,5 @@
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.", "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
"servicePath": "", "servicePath": "",
"basePath": "", "basePath": ""
"revision": "20171129",
"documentationLink": "https://developers.google.com/ad-experience-report/",
"id": "adexperiencereport:v1"
} }

6
etc/api/admin/datatransfer_v1/admin-api.json
View File

@@ -1,6 +1,6 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/69RNEuIs-2cMvhRHgpkaoTAmcFU\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/PJB_zqya-G8YVADxM394C0jmFUA\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "admin:datatransfer_v1", "id": "admin:datatransfer_v1",
"name": "admin", "name": "admin",
@@ -59,12 +59,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

800
etc/api/admin/directory_v1/admin-api.json
View File

@@ -1,14 +1,14 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/Kj9xn8poaVUzROuH45_u0sIJuaA\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/3gWnYLZX6BDruNsFQ2Dxff52vJg\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "admin:directory_v1", "id": "admin:directory_v1",
"name": "admin", "name": "admin",
"canonicalName": "directory", "canonicalName": "directory",
"version": "directory_v1", "version": "directory_v1",
"revision": "20171127", "revision": "20180917",
"title": "Admin Directory API", "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.", "description": "Manages enterprise resources such as users and groups, administrative notifications, security features, and more.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
"ownerName": "Google", "ownerName": "Google",
"packagePath": "admin", "packagePath": "admin",
@@ -59,12 +59,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -312,6 +312,89 @@
} }
} }
}, },
"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": { "CalendarResource": {
"id": "CalendarResource", "id": "CalendarResource",
"type": "object", "type": "object",
@@ -356,23 +439,33 @@
}, },
"resourceDescription": { "resourceDescription": {
"type": "string", "type": "string",
"description": "Description of the resource, visible only to admins. The brief description of the calendar resource." "description": "Description of the resource, visible only to admins."
}, },
"resourceEmail": { "resourceEmail": {
"type": "string", "type": "string",
"description": "The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource. The read-only email for the calendar resource. Generated as part of creating a new calendar resource." "description": "The read-only email for the calendar resource. Generated as part of creating a new calendar resource."
}, },
"resourceId": { "resourceId": {
"type": "string", "type": "string",
"description": "The unique ID for the calendar resource." "description": "The unique ID for the calendar resource.",
"annotations": {
"required": [
"directory.resources.calendars.insert"
]
}
}, },
"resourceName": { "resourceName": {
"type": "string", "type": "string",
"description": "The name of the calendar resource. For example, \"Training Room 1A\". The name of the calendar resource. For example, Training Room 1A" "description": "The name of the calendar resource. For example, \"Training Room 1A\".",
"annotations": {
"required": [
"directory.resources.calendars.insert"
]
}
}, },
"resourceType": { "resourceType": {
"type": "string", "type": "string",
"description": "The type of the calendar resource, intended for non-room resources. The type of the calendar resource. Used for grouping resources in the calendar user interface." "description": "The type of the calendar resource, intended for non-room resources."
}, },
"userVisibleDescription": { "userVisibleDescription": {
"type": "string", "type": "string",
@@ -500,6 +593,45 @@
"type": "string", "type": "string",
"description": "Chromebook boot mode (Read-only)" "description": "Chromebook boot mode (Read-only)"
}, },
"cpuStatusReports": {
"type": "array",
"description": "Reports of CPU utilization and temperature (Read-only)",
"items": {
"type": "object",
"properties": {
"cpuTemperatureInfo": {
"type": "array",
"description": "List of CPU temperature samples.",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "CPU label"
},
"temperature": {
"type": "integer",
"description": "Temperature in Celsius degrees.",
"format": "int32"
}
}
}
},
"cpuUtilizationPercentageInfo": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"reportTime": {
"type": "string",
"description": "Date and time the report was received.",
"format": "date-time"
}
}
}
},
"deviceFiles": { "deviceFiles": {
"type": "array", "type": "array",
"description": "List of device files to download (Read-only)", "description": "List of device files to download (Read-only)",
@@ -513,7 +645,7 @@
}, },
"downloadUrl": { "downloadUrl": {
"type": "string", "type": "string",
"description": "File downlod URL" "description": "File download URL"
}, },
"name": { "name": {
"type": "string", "type": "string",
@@ -530,6 +662,38 @@
"type": "string", "type": "string",
"description": "Unique identifier of Chrome OS Device (Read-only)" "description": "Unique identifier of Chrome OS Device (Read-only)"
}, },
"diskVolumeReports": {
"type": "array",
"description": "Reports of disk space and other info about mounted/connected volumes.",
"items": {
"type": "object",
"properties": {
"volumeInfo": {
"type": "array",
"description": "Disk volumes",
"items": {
"type": "object",
"properties": {
"storageFree": {
"type": "string",
"description": "Free disk space [in bytes]",
"format": "int64"
},
"storageTotal": {
"type": "string",
"description": "Total disk space [in bytes]",
"format": "int64"
},
"volumeId": {
"type": "string",
"description": "Volume id"
}
}
}
}
}
}
},
"etag": { "etag": {
"type": "string", "type": "string",
"description": "ETag of the resource." "description": "ETag of the resource."
@@ -619,6 +783,62 @@
"description": "Final date the device will be supported (Read-only)", "description": "Final date the device will be supported (Read-only)",
"format": "date-time" "format": "date-time"
}, },
"systemRamFreeReports": {
"type": "array",
"description": "Reports of amounts of available RAM memory (Read-only)",
"items": {
"type": "object",
"properties": {
"reportTime": {
"type": "string",
"description": "Date and time the report was received.",
"format": "date-time"
},
"systemRamFreeInfo": {
"type": "array",
"items": {
"type": "string",
"format": "int64"
}
}
}
}
},
"systemRamTotal": {
"type": "string",
"description": "Total RAM on the device [in bytes] (Read-only)",
"format": "int64"
},
"tpmVersionInfo": {
"type": "object",
"description": "Trusted Platform Module (TPM) (Read-only)",
"properties": {
"family": {
"type": "string",
"description": "TPM family."
},
"firmwareVersion": {
"type": "string",
"description": "TPM firmware version."
},
"manufacturer": {
"type": "string",
"description": "TPM manufacturer code."
},
"specLevel": {
"type": "string",
"description": "TPM specification level."
},
"tpmModel": {
"type": "string",
"description": "TPM model number."
},
"vendorSpecific": {
"type": "string",
"description": "Vendor-specific information such as Vendor ID."
}
}
},
"willAutoRenew": { "willAutoRenew": {
"type": "boolean", "type": "boolean",
"description": "Will Chromebook auto renew after support end date (Read-only)" "description": "Will Chromebook auto renew after support end date (Read-only)"
@@ -923,7 +1143,12 @@
}, },
"name": { "name": {
"type": "string", "type": "string",
"description": "The name of the feature." "description": "The name of the feature.",
"annotations": {
"required": [
"directory.resources.features.insert"
]
}
} }
} }
}, },
@@ -933,7 +1158,51 @@
"description": "JSON template for a \"feature instance\".", "description": "JSON template for a \"feature instance\".",
"properties": { "properties": {
"feature": { "feature": {
"$ref": "Feature" "$ref": "Feature",
"description": "The feature that this is an instance of. A calendar resource may have multiple instances of a 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."
} }
} }
}, },
@@ -1029,6 +1298,10 @@
"type": "object", "type": "object",
"description": "JSON template for Member resource in Directory API.", "description": "JSON template for Member resource in Directory API.",
"properties": { "properties": {
"delivery_settings": {
"type": "string",
"description": "Delivery settings of member"
},
"email": { "email": {
"type": "string", "type": "string",
"description": "Email of member (Read-only)" "description": "Email of member (Read-only)"
@@ -1094,7 +1367,7 @@
"properties": { "properties": {
"isMember": { "isMember": {
"type": "boolean", "type": "boolean",
"description": "Identifies whether given user is a member or not.", "description": "Identifies whether the given user is a member of the group. Membership can be direct or nested.",
"readOnly": true "readOnly": true
} }
} }
@@ -1722,6 +1995,15 @@
"type": "object", "type": "object",
"description": "JSON template for Schema resource in Directory API.", "description": "JSON template for Schema resource in Directory API.",
"properties": { "properties": {
"displayName": {
"type": "string",
"description": "Display name for the schema.",
"annotations": {
"required": [
"directory.schemas.insert"
]
}
},
"etag": { "etag": {
"type": "string", "type": "string",
"description": "ETag of the resource." "description": "ETag of the resource."
@@ -1764,6 +2046,16 @@
"type": "object", "type": "object",
"description": "JSON template for FieldSpec resource for Schemas in Directory API.", "description": "JSON template for FieldSpec resource for Schemas in Directory API.",
"properties": { "properties": {
"displayName": {
"type": "string",
"description": "Display Name of the field.",
"annotations": {
"required": [
"directory.schemas.insert",
"directory.schemas.update"
]
}
},
"etag": { "etag": {
"type": "string", "type": "string",
"description": "ETag of the resource." "description": "ETag of the resource."
@@ -1992,6 +2284,10 @@
"type": "string" "type": "string"
} }
}, },
"archived": {
"type": "boolean",
"description": "Indicates if user is archived."
},
"changePasswordAtNextLogin": { "changePasswordAtNextLogin": {
"type": "boolean", "type": "boolean",
"description": "Boolean indicating if the user should change password in next login" "description": "Boolean indicating if the user should change password in next login"
@@ -2157,7 +2453,7 @@
}, },
"suspended": { "suspended": {
"type": "boolean", "type": "boolean",
"description": "Indicates if user is suspended" "description": "Indicates if user is suspended."
}, },
"suspensionReason": { "suspensionReason": {
"type": "string", "type": "string",
@@ -2616,6 +2912,10 @@
"type": "string", "type": "string",
"description": "The path to the home directory for this account." "description": "The path to the home directory for this account."
}, },
"operatingSystemType": {
"type": "string",
"description": "The operating system type for this account."
},
"primary": { "primary": {
"type": "boolean", "type": "boolean",
"description": "If this is user's primary account within the SystemId." "description": "If this is user's primary account within the SystemId."
@@ -3042,7 +3342,7 @@
}, },
"query": { "query": {
"type": "string", "type": "string",
"description": "Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?hl=en&answer=1698333", "description": "Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?answer=1698333",
"location": "query" "location": "query"
}, },
"sortOrder": { "sortOrder": {
@@ -3568,7 +3868,7 @@
"id": "directory.groups.list", "id": "directory.groups.list",
"path": "groups", "path": "groups",
"httpMethod": "GET", "httpMethod": "GET",
"description": "Retrieve all groups in a domain (paginated)", "description": "Retrieve all groups of a domain or of a user given a userKey (paginated)",
"parameters": { "parameters": {
"customer": { "customer": {
"type": "string", "type": "string",
@@ -3587,14 +3887,43 @@
"minimum": "1", "minimum": "1",
"location": "query" "location": "query"
}, },
"orderBy": {
"type": "string",
"description": "Column to use for sorting results",
"enum": [
"email"
],
"enumDescriptions": [
"Email of the group."
],
"location": "query"
},
"pageToken": { "pageToken": {
"type": "string", "type": "string",
"description": "Token to specify next page in the list", "description": "Token to specify next page in the list",
"location": "query" "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-groups",
"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"
},
"userKey": { "userKey": {
"type": "string", "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", "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" "location": "query"
} }
}, },
@@ -3811,17 +4140,17 @@
"id": "directory.members.hasMember", "id": "directory.members.hasMember",
"path": "groups/{groupKey}/hasMember/{memberKey}", "path": "groups/{groupKey}/hasMember/{memberKey}",
"httpMethod": "GET", "httpMethod": "GET",
"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.",
"parameters": { "parameters": {
"groupKey": { "groupKey": {
"type": "string", "type": "string",
"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.",
"required": true, "required": true,
"location": "path" "location": "path"
}, },
"memberKey": { "memberKey": {
"type": "string", "type": "string",
"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.",
"required": true, "required": true,
"location": "path" "location": "path"
} }
@@ -3879,6 +4208,11 @@
"required": true, "required": true,
"location": "path" "location": "path"
}, },
"includeDerivedMembership": {
"type": "boolean",
"description": "Whether to list indirect memberships. Default: false.",
"location": "query"
},
"maxResults": { "maxResults": {
"type": "integer", "type": "integer",
"description": "Maximum number of results to return. Default is 200", "description": "Maximum number of results to return. Default is 200",
@@ -4149,7 +4483,7 @@
}, },
"query": { "query": {
"type": "string", "type": "string",
"description": "Search string in the format given at http://support.google.com/a/bin/answer.py?hl=en&answer=1408863#search", "description": "Search string in the format given at http://support.google.com/a/bin/answer.py?answer=1408863#search",
"location": "query" "location": "query"
}, },
"sortOrder": { "sortOrder": {
@@ -4599,6 +4933,197 @@
}, },
"resources": { "resources": {
"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"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return.",
"format": "int32",
"minimum": "1",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Token to specify the next page in the list.",
"location": "query"
}
},
"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": { "calendars": {
"methods": { "methods": {
"delete": { "delete": {
@@ -4705,10 +5230,20 @@
"maximum": "500", "maximum": "500",
"location": "query" "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": { "pageToken": {
"type": "string", "type": "string",
"description": "Token to specify the next page in the list.", "description": "Token to specify the next page in the list.",
"location": "query" "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 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"
} }
}, },
"parameterOrder": [ "parameterOrder": [
@@ -4789,6 +5324,227 @@
] ]
} }
} }
},
"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"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return.",
"format": "int32",
"minimum": "1",
"maximum": "500",
"location": "query"
},
"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"
]
}
}
} }
} }
}, },

14
etc/api/admin/reports_v1/admin-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/ihRyJbFbPCCQX3d-n__-D1aHPn0\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/4CwJz4rRiRXvebZ8Q6JKY8uxMSU\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "admin:reports_v1", "id": "admin:reports_v1",
"name": "admin", "name": "admin",
"canonicalName": "reports", "canonicalName": "reports",
"version": "reports_v1", "version": "reports_v1",
"revision": "20171204", "revision": "20180806",
"title": "Admin Reports API", "title": "Admin Reports API",
"description": "Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.", "description": "Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -59,12 +59,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -469,7 +469,7 @@
"type": "string", "type": "string",
"description": "Application name for which the events are to be retrieved.", "description": "Application name for which the events are to be retrieved.",
"required": true, "required": true,
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)", "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)",
"location": "path" "location": "path"
}, },
"customerId": { "customerId": {
@@ -548,7 +548,7 @@
"type": "string", "type": "string",
"description": "Application name for which the events are to be retrieved.", "description": "Application name for which the events are to be retrieved.",
"required": true, "required": true,
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)", "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)",
"location": "path" "location": "path"
}, },
"customerId": { "customerId": {
@@ -664,7 +664,7 @@
"parameters": { "parameters": {
"type": "string", "type": "string",
"description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.", "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)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)", "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" "location": "query"
} }
}, },

49
etc/api/adsense/v1.4/adsense-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/TTXWgFbjrx98gGXeBWLzHzeUQ9s\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/VFSsULaTDYsumIWIHcFJ5XZR9mI\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "adsense:v1.4", "id": "adsense:v1.4",
"name": "adsense", "name": "adsense",
"canonicalName": "AdSense", "canonicalName": "AdSense",
"version": "v1.4", "version": "v1.4",
"revision": "20171211", "revision": "20181010",
"title": "AdSense Management API", "title": "AdSense Management API",
"description": "Accesses AdSense publishers' inventory and generates performance reports.", "description": "Accesses AdSense publishers' inventory and generates performance reports.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -60,12 +60,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -205,7 +205,15 @@
"properties": { "properties": {
"adCode": { "adCode": {
"type": "string", "type": "string",
"description": "The ad code snippet." "description": "The Auto ad code snippet. The ad code snippet."
},
"ampBody": {
"type": "string",
"description": "The AMP Auto ad code snippet that goes in the body of an AMP page."
},
"ampHead": {
"type": "string",
"description": "The AMP Auto ad code snippet that goes in the head of an AMP page."
}, },
"kind": { "kind": {
"type": "string", "type": "string",
@@ -920,6 +928,37 @@
"resources": { "resources": {
"adclients": { "adclients": {
"methods": { "methods": {
"getAdCode": {
"id": "adsense.accounts.adclients.getAdCode",
"path": "accounts/{accountId}/adclients/{adClientId}/adcode",
"httpMethod": "GET",
"description": "Get Auto ad code for a given ad client.",
"parameters": {
"accountId": {
"type": "string",
"description": "Account which contains the ad client.",
"required": true,
"location": "path"
},
"adClientId": {
"type": "string",
"description": "Ad client to get the code for.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"accountId",
"adClientId"
],
"response": {
"$ref": "AdCode"
},
"scopes": [
"https://www.googleapis.com/auth/adsense",
"https://www.googleapis.com/auth/adsense.readonly"
]
},
"list": { "list": {
"id": "adsense.accounts.adclients.list", "id": "adsense.accounts.adclients.list",
"path": "accounts/{accountId}/adclients", "path": "accounts/{accountId}/adclients",

8
etc/api/adsensehost/v4.1/adsensehost-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/NyT1DTQF4vZhuR57A8Mt2b6CZc4\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/yVoojSNpAozfRnEt8PzynEAHIK8\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "adsensehost:v4.1", "id": "adsensehost:v4.1",
"name": "adsensehost", "name": "adsensehost",
"canonicalName": "AdSense Host", "canonicalName": "AdSense Host",
"version": "v4.1", "version": "v4.1",
"revision": "20171211", "revision": "20181010",
"title": "AdSense Host API", "title": "AdSense Host API",
"description": "Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.", "description": "Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -63,12 +63,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

781
etc/api/alertcenter/v1beta1/alertcenter-api.json Normal file
View File

@@ -0,0 +1,781 @@
{
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"GmailMessageInfo": {
"description": "Details of a message in phishing spike alert.",
"type": "object",
"properties": {
"messageId": {
"description": "Message id.",
"type": "string"
},
"attachmentsSha256Hash": {
"description": "SHA256 Hash of email's attachment and all MIME parts.",
"type": "array",
"items": {
"type": "string"
}
},
"messageBodySnippet": {
"description": "Snippet of the message body text. (Only available for reported emails)",
"type": "string"
},
"date": {
"type": "string",
"description": "The date the malicious email was sent.",
"format": "google-datetime"
},
"recipient": {
"description": "Recipient of this email.",
"type": "string"
},
"md5HashSubject": {
"description": "MD5 Hash of email's subject. (Only available for reported emails).",
"type": "string"
},
"md5HashMessageBody": {
"description": "Hash of message body text.",
"type": "string"
},
"subjectText": {
"description": "Email subject text. (Only available for reported emails).",
"type": "string"
}
},
"id": "GmailMessageInfo"
},
"DomainWideTakeoutInitiated": {
"description": "A takeout operation for the entire domain was initiated by an admin. Derived\nfrom audit logs.",
"type": "object",
"properties": {
"takeoutRequestId": {
"description": "takeout request id.",
"type": "string"
},
"email": {
"description": "Email of the admin who initiated the takeout.",
"type": "string"
}
},
"id": "DomainWideTakeoutInitiated"
},
"AccountWarning": {
"description": "Alerts for user account warning events.",
"type": "object",
"properties": {
"email": {
"description": "Required. Email of the user that this event belongs to.",
"type": "string"
},
"loginDetails": {
"$ref": "LoginDetails",
"description": "Optional. Details of the login action associated with the warning event.\nThis is only available for:\nSuspicious login\nSuspicious login (less secure app)\nUser suspended (suspicious activity)"
}
},
"id": "AccountWarning"
},
"DomainId": {
"description": "Domain id of Gmail phishing alerts.",
"type": "object",
"properties": {
"customerPrimaryDomain": {
"description": "The primary domain for the customer.",
"type": "string"
}
},
"id": "DomainId"
},
"MailPhishing": {
"description": "Proto for all phishing alerts with common payload.\nSupported types are any of the following:\nUser reported phishing\nUser reported spam spike\nSuspicious message reported\nPhishing reclassification\nMalware reclassification",
"type": "object",
"properties": {
"domainId": {
"$ref": "DomainId",
"description": "Domain id."
},
"maliciousEntity": {
"$ref": "MaliciousEntity",
"description": "Entity whose actions triggered a Gmail phishing alert."
},
"isInternal": {
"type": "boolean",
"description": "If true, the email is originated from within the organization."
},
"messages": {
"description": "Every alert could contain multiple messages.",
"type": "array",
"items": {
"$ref": "GmailMessageInfo"
}
}
},
"id": "MailPhishing"
},
"StateSponsoredAttack": {
"description": "A state sponsored attack alert. Derived from audit logs.",
"type": "object",
"properties": {
"email": {
"description": "The email of the user this incident was created for.",
"type": "string"
}
},
"id": "StateSponsoredAttack"
},
"Alert": {
"type": "object",
"properties": {
"startTime": {
"description": "Required. The time this alert became active.",
"format": "google-datetime",
"type": "string"
},
"customerId": {
"type": "string",
"description": "Output only. The unique identifier of the Google account of the customer."
},
"source": {
"description": "Required. A unique identifier for the system that is reported the alert.\n\nSupported sources are any of the following:\n * \"Google Operations\"\n * \"Mobile device management\"\n * \"Gmail phishing\"\n * \"Domain wide takeout\"\n * \"Government attack warning\"\n * \"Google identity\"",
"type": "string"
},
"createTime": {
"description": "Output only. The time this alert was created. Assigned by the server.",
"format": "google-datetime",
"type": "string"
},
"alertId": {
"type": "string",
"description": "Output only. The unique identifier for the alert."
},
"type": {
"description": "Required. The type of the alert.\n\nSupported types are any of the following:\n * \"Google Operations\"\n * \"Device compromised\"\n * \"Suspicious activity\"\n * \"User reported phishing\"\n * \"Misconfigured whitelist\"\n * \"Customer takeout initiated\"\n * \"Government attack warning\"\n * \"User reported spam spike\"\n * \"Suspicious message reported\"\n * \"Phishing reclassification\"\n * \"Malware reclassification\"\nLINT.IfChange\n * \"Suspicious login\"\n * \"Suspicious login (less secure app)\"\n * \"User suspended\"\n * \"Leaked password\"\n * \"User suspended (suspicious activity)\"\n * \"User suspended (spam)\"\n * \"User suspended (spam through relay)\"\nLINT.ThenChange(//depot/google3/apps/albert/data/albert_enums.proto)",
"type": "string"
},
"securityInvestigationToolLink": {
"description": "Output only. An optional Security Investigation Tool query for this\nalert.",
"type": "string"
},
"endTime": {
"description": "Optional. The time this alert was no longer active. If provided, the\nend time must not be earlier than the start time. If not provided, the end\ntime will default to the start time.",
"format": "google-datetime",
"type": "string"
},
"data": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Optional. Specific data associated with this alert.\ne.g. google.apps.alertcenter.type.DeviceCompromised.",
"type": "object"
}
},
"id": "Alert",
"description": "An alert affecting a customer.\nAll fields are read-only once created."
},
"LoginDetails": {
"description": "Details of the login action",
"type": "object",
"properties": {
"ipAddress": {
"description": "Required. Human readable IP address (e.g., 11.22.33.44) that is\nassociated with the warning event.",
"type": "string"
},
"loginTime": {
"description": "Required. Login time that is associated with the warning event.",
"format": "google-datetime",
"type": "string"
}
},
"id": "LoginDetails"
},
"DeviceCompromisedSecurityDetail": {
"id": "DeviceCompromisedSecurityDetail",
"description": "Detailed information of a single MDM device compromised event.",
"type": "object",
"properties": {
"resourceId": {
"description": "The device resource id.",
"type": "string"
},
"serialNumber": {
"description": "The serial number of the device.",
"type": "string"
},
"deviceCompromisedState": {
"description": "Device compromised state includes: \"Compromised\" and \"Not Compromised\".",
"type": "string"
},
"deviceModel": {
"description": "The model of the device.",
"type": "string"
},
"iosVendorId": {
"description": "Required for IOS, empty for others.",
"type": "string"
},
"deviceType": {
"description": "The type of the device.",
"type": "string"
},
"deviceId": {
"description": "Required. Device Info.",
"type": "string"
}
}
},
"Csv": {
"description": "Representation of a CSV file attachment, as a list of column headers and\na list of data rows.",
"type": "object",
"properties": {
"headers": {
"description": "List of headers for data columns in a CSV file.",
"type": "array",
"items": {
"type": "string"
}
},
"dataRows": {
"description": "List of data rows in a CSV file, as string arrays rather than as a\nsingle comma-separated string.",
"type": "array",
"items": {
"$ref": "CsvRow"
}
}
},
"id": "Csv"
},
"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"
},
"PhishingSpike": {
"description": "Alert for a spike in user reported phishing.\nThis will be deprecated in favor of MailPhishing.",
"type": "object",
"properties": {
"isInternal": {
"description": "If true, the email is originated from within the organization.",
"type": "boolean"
},
"messages": {
"description": "Every alert could contain multiple messages.",
"type": "array",
"items": {
"$ref": "GmailMessageInfo"
}
},
"domainId": {
"$ref": "DomainId",
"description": "Domain id."
},
"maliciousEntity": {
"$ref": "MaliciousEntity",
"description": "Entity whose actions triggered a Gmail phishing alert."
}
},
"id": "PhishingSpike"
},
"DeviceCompromised": {
"id": "DeviceCompromised",
"description": "A mobile device compromised alert. Derived from audit logs.",
"type": "object",
"properties": {
"events": {
"description": "Required. List of security events.",
"type": "array",
"items": {
"$ref": "DeviceCompromisedSecurityDetail"
}
},
"email": {
"description": "The email of the user this alert was created for.",
"type": "string"
}
}
},
"MaliciousEntity": {
"description": "Entity whose actions triggered a Gmail phishing alert.",
"type": "object",
"properties": {
"fromHeader": {
"description": "Sender email address.",
"type": "string"
}
},
"id": "MaliciousEntity"
},
"GoogleOperations": {
"description": "An incident reported by Google Operations for a G Suite application.",
"type": "object",
"properties": {
"title": {
"description": "One-line incident description.",
"type": "string"
},
"description": {
"description": "Detailed, freeform incident description.",
"type": "string"
},
"affectedUserEmails": {
"description": "List of emails which correspond to the users directly affected by the\nincident.",
"type": "array",
"items": {
"type": "string"
}
},
"attachmentData": {
"$ref": "Attachment",
"description": "Optional application-specific data for an incident, provided when the\nG Suite application which reported the incident cannot be completely\nrestored to a valid state."
}
},
"id": "GoogleOperations"
},
"ListAlertFeedbackResponse": {
"type": "object",
"properties": {
"feedback": {
"description": "The list of alert feedback.\nResult is ordered descending by creation time.",
"type": "array",
"items": {
"$ref": "AlertFeedback"
}
}
},
"id": "ListAlertFeedbackResponse",
"description": "Response message for an alert feedback listing request."
},
"BadWhitelist": {
"id": "BadWhitelist",
"description": "Alert for setting the domain or ip that malicious email comes from as\nwhitelisted domain or ip in Gmail advanced settings.",
"type": "object",
"properties": {
"messages": {
"description": "Every alert could contain multiple messages.",
"type": "array",
"items": {
"$ref": "GmailMessageInfo"
}
},
"sourceIp": {
"description": "The source ip address of the malicious email. e.g. \"127.0.0.1\".",
"type": "string"
},
"domainId": {
"description": "Domain id.",
"$ref": "DomainId"
},
"maliciousEntity": {
"$ref": "MaliciousEntity",
"description": "Entity whose actions triggered a Gmail phishing alert."
}
}
},
"Attachment": {
"description": "Attachment with application-specific information about an alert.",
"type": "object",
"properties": {
"csv": {
"description": "CSV file attachment.",
"$ref": "Csv"
}
},
"id": "Attachment"
},
"AlertFeedback": {
"description": "A customer feedback about an alert.",
"type": "object",
"properties": {
"type": {
"enumDescriptions": [
"Feedback type is not specified.",
"Alert report is not useful.",
"Alert report is somewhat useful.",
"Alert report is very useful."
],
"enum": [
"ALERT_FEEDBACK_TYPE_UNSPECIFIED",
"NOT_USEFUL",
"SOMEWHAT_USEFUL",
"VERY_USEFUL"
],
"description": "Required. The type of the feedback.",
"type": "string"
},
"feedbackId": {
"description": "Output only. A unique identifier for the feedback. When creating a new\nfeedback the system will assign one.",
"type": "string"
},
"customerId": {
"description": "Output only. The unique identifier of the Google account of the customer.",
"type": "string"
},
"createTime": {
"description": "Output only. The time this feedback was created. Assigned by the server.",
"format": "google-datetime",
"type": "string"
},
"email": {
"description": "Output only. The email of the user that provided the feedback.",
"type": "string"
},
"alertId": {
"description": "Output only. The alert identifier.",
"type": "string"
}
},
"id": "AlertFeedback"
},
"SuspiciousActivitySecurityDetail": {
"description": "Detailed information of a single MDM suspicious activity event.",
"type": "object",
"properties": {
"oldValue": {
"description": "Old value of the device property before change.",
"type": "string"
},
"serialNumber": {
"description": "The serial number of the device.",
"type": "string"
},
"deviceProperty": {
"type": "string",
"description": "Device property which is changed."
},
"newValue": {
"type": "string",
"description": "New value of the device property after change."
},
"deviceModel": {
"description": "The model of the device.",
"type": "string"
},
"iosVendorId": {
"type": "string",
"description": "Required for IOS, empty for others."
},
"deviceType": {
"description": "The type of the device.",
"type": "string"
},
"deviceId": {
"description": "Required. Device Info.",
"type": "string"
},
"resourceId": {
"description": "The device resource id.",
"type": "string"
}
},
"id": "SuspiciousActivitySecurityDetail"
},
"ListAlertsResponse": {
"description": "Response message for an alert listing request.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "If not empty, indicates that there may be more alerts that match the\nrequest; this value can be passed in a new ListAlertsRequest to get the\nnext page of values.",
"type": "string"
},
"alerts": {
"description": "The list of alerts.",
"type": "array",
"items": {
"$ref": "Alert"
}
}
},
"id": "ListAlertsResponse"
},
"SuspiciousActivity": {
"description": "A mobile suspicious activity alert. Derived from audit logs.",
"type": "object",
"properties": {
"events": {
"description": "Required. List of security events.",
"type": "array",
"items": {
"$ref": "SuspiciousActivitySecurityDetail"
}
},
"email": {
"description": "The email of the user this alert was created for.",
"type": "string"
}
},
"id": "SuspiciousActivity"
},
"CsvRow": {
"description": "Representation of a single data row in a CSV file.",
"type": "object",
"properties": {
"entries": {
"description": "Data entries in a CSV file row, as a string array rather than a single\ncomma-separated string.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "CsvRow"
}
},
"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": "AlertCenter",
"rootUrl": "https://alertcenter.googleapis.com/",
"ownerDomain": "google.com",
"name": "alertcenter",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "G Suite Alert Center API",
"ownerName": "Google",
"resources": {
"alerts": {
"resources": {
"feedback": {
"methods": {
"list": {
"response": {
"$ref": "ListAlertFeedbackResponse"
},
"parameterOrder": [
"alertId"
],
"httpMethod": "GET",
"parameters": {
"alertId": {
"description": "Required. The alert identifier.\nIf the alert does not exist returns a NOT_FOUND error.",
"required": true,
"type": "string",
"location": "path"
},
"customerId": {
"description": "Optional. The unique identifier of the Google account of the customer the\nalert is associated with. This is obfuscated and not the plain customer\nID as stored internally. Inferred from the caller identity if not provided.",
"type": "string",
"location": "query"
}
},
"flatPath": "v1beta1/alerts/{alertId}/feedback",
"path": "v1beta1/alerts/{alertId}/feedback",
"id": "alertcenter.alerts.feedback.list",
"description": "Lists all the feedback for an alert."
},
"create": {
"flatPath": "v1beta1/alerts/{alertId}/feedback",
"path": "v1beta1/alerts/{alertId}/feedback",
"id": "alertcenter.alerts.feedback.create",
"request": {
"$ref": "AlertFeedback"
},
"description": "Creates a new alert feedback.",
"response": {
"$ref": "AlertFeedback"
},
"parameterOrder": [
"alertId"
],
"httpMethod": "POST",
"parameters": {
"alertId": {
"location": "path",
"description": "Required. The identifier of the alert this feedback belongs to.\nReturns a NOT_FOUND error if no such alert.",
"required": true,
"type": "string"
},
"customerId": {
"description": "Optional. The unique identifier of the Google account of the customer the\nalert's feedback is associated with. This is obfuscated and not the\nplain customer ID as stored internally. Inferred from the caller identity\nif not provided.",
"type": "string",
"location": "query"
}
}
}
}
}
},
"methods": {
"list": {
"path": "v1beta1/alerts",
"id": "alertcenter.alerts.list",
"description": "Lists all the alerts for the current user and application.",
"response": {
"$ref": "ListAlertsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
"filter": {
"location": "query",
"description": "Optional. Query string for filtering alert results.\nThis string must be specified as an expression or list of expressions,\nusing the following grammar:\n\n### Expressions\n\nAn expression has the general form `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e`.\n\nA field or value which contains a space or a colon must be enclosed by\ndouble quotes.\n\n#### Operators\n\nOperators follow the BNF specification:\n\n`\u003cequalityOperator\u003e ::= \"=\" | \":\"`\n\n`\u003crelationalOperator\u003e ::= \"\u003c\" | \"\u003e\" | \"\u003c=\" | \"\u003e=\"`\n\nRelational operators are defined only for timestamp fields. Equality\noperators are defined only for string fields.\n\n#### Timestamp fields\n\nThe value supplied for a timestamp field must be an\n[RFC 3339](https://tools.ietf.org/html/rfc3339) date-time string.\n\nSupported timestamp fields are `create_time`, `start_time`, and `end_time`.\n\n#### String fields\n\nThe value supplied for a string field may be an arbitrary string.\n\n#### Examples\n\nTo query for all alerts created on or after April 5, 2018:\n\n`create_time \u003e= \"2018-04-05T00:00:00Z\"`\n\nTo query for all alerts from the source \"Gmail phishing\":\n\n`source:\"Gmail phishing\"`\n\n### Joining expressions\n\nExpressions may be joined to form a more complex query. The BNF\nspecification is:\n\n`\u003cexpressionList\u003e ::= \u003cexpression\u003e | \u003cexpressionList\u003e \u003cconjunction\u003e\n\u003cexpressionList\u003e | \u003cnegation\u003e \u003cexpressionList\u003e`\n`\u003cconjunction\u003e ::= \"AND\" | \"OR\" | \"\"`\n`\u003cnegation\u003e ::= \"NOT\"`\n\nUsing the empty string as a conjunction acts as an implicit AND.\n\nThe precedence of joining operations, from highest to lowest, is NOT, AND,\nOR.\n\n#### Examples\n\nTo query for all alerts which started in 2017:\n\n`start_time \u003e= \"2017-01-01T00:00:00Z\" AND start_time \u003c\n\"2018-01-01T00:00:00Z\"`\n\nTo query for all user reported phishing alerts from the source\n\"Gmail phishing\":\n\n`type:\"User reported phishing\" source:\"Gmail phishing\"`",
"type": "string"
},
"pageToken": {
"location": "query",
"description": "Optional. A token identifying a page of results the server should return.\nIf empty, a new iteration is started. To continue an iteration, pass in\nthe value from the previous ListAlertsResponse's next_page_token field.",
"type": "string"
},
"orderBy": {
"location": "query",
"description": "Optional. Sort the list results by a certain order.\nIf not specified results may be returned in arbitrary order.\nYou can sort the results in a descending order based on the creation\ntimestamp using order_by=\"create_time desc\".\nCurrently, only sorting by create_time desc is supported.",
"type": "string"
},
"customerId": {
"location": "query",
"description": "Optional. The unique identifier of the Google account of the customer the\nalerts are associated with. This is obfuscated and not the plain\ncustomer ID as stored internally. Inferred from the caller identity if not\nprovided.",
"type": "string"
},
"pageSize": {
"type": "integer",
"location": "query",
"description": "Optional. Requested page size. Server may return fewer items than\nrequested. If unspecified, server will pick an appropriate default.",
"format": "int32"
}
},
"flatPath": "v1beta1/alerts"
},
"get": {
"description": "Gets the specified alert.",
"httpMethod": "GET",
"parameterOrder": [
"alertId"
],
"response": {
"$ref": "Alert"
},
"parameters": {
"customerId": {
"type": "string",
"location": "query",
"description": "Optional. The unique identifier of the Google account of the customer the\nalert is associated with. This is obfuscated and not the plain customer\nID as stored internally. Inferred from the caller identity if not provided."
},
"alertId": {
"description": "Required. The identifier of the alert to retrieve.",
"required": true,
"type": "string",
"location": "path"
}
},
"flatPath": "v1beta1/alerts/{alertId}",
"id": "alertcenter.alerts.get",
"path": "v1beta1/alerts/{alertId}"
},
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"alertId"
],
"httpMethod": "DELETE",
"parameters": {
"customerId": {
"location": "query",
"description": "Optional. The unique identifier of the Google account of the customer the\nalert is associated with. This is obfuscated and not the plain customer\nID as stored internally. Inferred from the caller identity if not provided.",
"type": "string"
},
"alertId": {
"description": "Required. The identifier of the alert to delete.",
"required": true,
"type": "string",
"location": "path"
}
},
"flatPath": "v1beta1/alerts/{alertId}",
"path": "v1beta1/alerts/{alertId}",
"id": "alertcenter.alerts.delete",
"description": "Marks the specified alert for deletion. An alert that has been marked for\ndeletion will be excluded from the results of a List operation by default,\nand will be removed from the Alert Center after 30 days.\nMarking an alert for deletion will have no effect on an alert which has\nalready been marked for deletion. Attempting to mark a nonexistent alert\nfor deletion will return NOT_FOUND."
}
}
}
},
"parameters": {
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
}
},
"version": "v1beta1",
"baseUrl": "https://alertcenter.googleapis.com/",
"kind": "discovery#restDescription",
"description": "G Suite Alert Center API to view and manage alerts on issues affecting your domain.",
"servicePath": "",
"basePath": "",
"id": "alertcenter:v1beta1",
"revision": "20181011",
"documentationLink": "https://developers.google.com/admin-sdk/alertcenter/"
}

8
etc/api/analytics/v2.4/analytics-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/kYN47VW3boRYzE7pkj4HK3FyEC0\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/hmO83jgNTOCnU85JSkMPWj7Ip_M\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "analytics:v2.4", "id": "analytics:v2.4",
"name": "analytics", "name": "analytics",
"version": "v2.4", "version": "v2.4",
"revision": "20170807", "revision": "20180622",
"title": "Google Analytics API", "title": "Google Analytics API",
"description": "Views and manages your Google Analytics data.", "description": "Views and manages your Google Analytics data.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

264
etc/api/analytics/v3/analytics-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/DSG2TEF18bxTdYooKf_C2-FmmME\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/f7gUowL84DOqKDxouYQxy9m4z6s\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "analytics:v3", "id": "analytics:v3",
"name": "analytics", "name": "analytics",
"version": "v3", "version": "v3",
"revision": "20170807", "revision": "20180622",
"title": "Google Analytics API", "title": "Google Analytics API",
"description": "Views and manages your Google Analytics data.", "description": "Views and manages your Google Analytics data.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -86,6 +86,9 @@
}, },
"https://www.googleapis.com/auth/analytics.readonly": { "https://www.googleapis.com/auth/analytics.readonly": {
"description": "View your Google Analytics data" "description": "View your Google Analytics data"
},
"https://www.googleapis.com/auth/analytics.user.deletion": {
"description": "Manage Google Analytics user deletion requests"
} }
} }
} }
@@ -291,6 +294,116 @@
} }
} }
}, },
"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": {
"shareAnonymouslyWithOthers": {
"type": "boolean"
},
"shareWithGoogleProducts": {
"type": "boolean"
},
"shareWithSpecialists": {
"type": "boolean"
},
"shareWithSupport": {
"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": {
"shareAnonymouslyWithOthers": {
"type": "boolean"
},
"shareWithGoogleProducts": {
"type": "boolean"
},
"shareWithSpecialists": {
"type": "boolean"
},
"shareWithSupport": {
"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": { "Accounts": {
"id": "Accounts", "id": "Accounts",
"type": "object", "type": "object",
@@ -2051,6 +2164,43 @@
} }
} }
}, },
"HashClientIdRequest": {
"id": "HashClientIdRequest",
"type": "object",
"description": "JSON template for a hash Client Id request resource.",
"properties": {
"clientId": {
"type": "string"
},
"kind": {
"type": "string",
"default": "analytics#hashClientIdRequest"
},
"webPropertyId": {
"type": "string"
}
}
},
"HashClientIdResponse": {
"id": "HashClientIdResponse",
"type": "object",
"description": "JSON template for a hash Client Id response resource.",
"properties": {
"clientId": {
"type": "string"
},
"hashedClientId": {
"type": "string"
},
"kind": {
"type": "string",
"default": "analytics#hashClientIdResponse"
},
"webPropertyId": {
"type": "string"
}
}
},
"IncludeConditions": { "IncludeConditions": {
"id": "IncludeConditions", "id": "IncludeConditions",
"type": "object", "type": "object",
@@ -3311,6 +3461,46 @@
} }
} }
}, },
"UserDeletionRequest": {
"id": "UserDeletionRequest",
"type": "object",
"description": "JSON template for a user deletion request resource.",
"properties": {
"deletionRequestTime": {
"type": "string",
"description": "This marks the point in time for which all user data before should be deleted",
"format": "date-time",
"readOnly": true
},
"firebaseProjectId": {
"type": "string",
"description": "Firebase Project Id"
},
"id": {
"type": "object",
"description": "User ID.",
"properties": {
"type": {
"type": "string",
"description": "Type of user"
},
"userId": {
"type": "string",
"description": "The User's id"
}
}
},
"kind": {
"type": "string",
"description": "Value is \"analytics#userDeletionRequest\".",
"default": "analytics#userDeletionRequest"
},
"webPropertyId": {
"type": "string",
"description": "Web property ID of the form UA-XXXXX-YY."
}
}
},
"UserRef": { "UserRef": {
"id": "UserRef", "id": "UserRef",
"type": "object", "type": "object",
@@ -3481,6 +3671,14 @@
"format": "date-time", "format": "date-time",
"readOnly": true "readOnly": true
}, },
"dataRetentionResetOnNewActivity": {
"type": "boolean",
"description": "Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).\nSet to false to delete data associated with the user identifer automatically after the rentention period.\nThis property cannot be set on insert."
},
"dataRetentionTtl": {
"type": "string",
"description": "The length of time for which user and event data is retained.\nThis property cannot be set on insert."
},
"defaultProfileId": { "defaultProfileId": {
"type": "string", "type": "string",
"description": "Default view (profile) ID.", "description": "Default view (profile) ID.",
@@ -4052,6 +4250,26 @@
} }
} }
}, },
"clientId": {
"methods": {
"hashClientId": {
"id": "analytics.management.clientId.hashClientId",
"path": "management/clientId:hashClientId",
"httpMethod": "POST",
"description": "Hashes the given Client ID.",
"request": {
"$ref": "HashClientIdRequest"
},
"response": {
"$ref": "HashClientIdResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"customDataSources": { "customDataSources": {
"methods": { "methods": {
"list": { "list": {
@@ -7226,6 +7444,44 @@
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/analytics.provision" "https://www.googleapis.com/auth/analytics.provision"
] ]
},
"createAccountTree": {
"id": "analytics.provisioning.createAccountTree",
"path": "provisioning/createAccountTree",
"httpMethod": "POST",
"description": "Provision account.",
"request": {
"$ref": "AccountTreeRequest"
},
"response": {
"$ref": "AccountTreeResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.provision"
]
}
}
},
"userDeletion": {
"resources": {
"userDeletionRequest": {
"methods": {
"upsert": {
"id": "analytics.userDeletion.userDeletionRequest.upsert",
"path": "userDeletion/userDeletionRequests:upsert",
"httpMethod": "POST",
"description": "Insert or update a user deletion requests.",
"request": {
"$ref": "UserDeletionRequest"
},
"response": {
"$ref": "UserDeletionRequest"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.user.deletion"
]
}
}
} }
} }
} }

903
etc/api/analyticsreporting/v4/analyticsreporting-api.json
View File

File diff suppressed because it is too large Load Diff

1701
etc/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
View File

File diff suppressed because it is too large Load Diff

175
etc/api/androidenterprise/v1/androidenterprise-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/-HO9dhVgxPgZ9hKtuist_vTUbZU\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/VXl-dpyN2AX1dYkKJFycE5ldDiY\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "androidenterprise:v1", "id": "androidenterprise:v1",
"name": "androidenterprise", "name": "androidenterprise",
"canonicalName": "Android Enterprise", "canonicalName": "Android Enterprise",
"version": "v1", "version": "v1",
"revision": "20171206", "revision": "20181003",
"title": "Google Play EMM API", "title": "Google Play EMM API",
"description": "Manages the deployment of apps to Android for Work users.", "description": "Manages the deployment of apps to Android for Work users.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -120,17 +120,77 @@
}, },
"permission": { "permission": {
"type": "array", "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.", "description": "Deprecated. Use PlaySearch.approveApps.",
"items": { "items": {
"type": "string" "type": "string"
} }
},
"playSearch": {
"$ref": "AdministratorWebTokenSpecPlaySearch",
"description": "Options for displaying the Play Search page."
},
"privateApps": {
"$ref": "AdministratorWebTokenSpecPrivateApps",
"description": "Options for displaying the Private Apps page."
},
"storeBuilder": {
"$ref": "AdministratorWebTokenSpecStoreBuilder",
"description": "Options for displaying the Store Builder page."
},
"webApps": {
"$ref": "AdministratorWebTokenSpecWebApps",
"description": "Options for displaying the Web Apps page."
}
}
},
"AdministratorWebTokenSpecPlaySearch": {
"id": "AdministratorWebTokenSpecPlaySearch",
"type": "object",
"properties": {
"approveApps": {
"type": "boolean",
"description": "Allow access to the iframe in approve mode. Default is false."
},
"enabled": {
"type": "boolean",
"description": "Whether the Play Search page is displayed. Default is true."
}
}
},
"AdministratorWebTokenSpecPrivateApps": {
"id": "AdministratorWebTokenSpecPrivateApps",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the Private Apps page is displayed. Default is true."
}
}
},
"AdministratorWebTokenSpecStoreBuilder": {
"id": "AdministratorWebTokenSpecStoreBuilder",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the Store Builder page is displayed. Default is true."
}
}
},
"AdministratorWebTokenSpecWebApps": {
"id": "AdministratorWebTokenSpecWebApps",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the Web Apps page is displayed. Default is true."
} }
} }
}, },
"AndroidDevicePolicyConfig": { "AndroidDevicePolicyConfig": {
"id": "AndroidDevicePolicyConfig", "id": "AndroidDevicePolicyConfig",
"type": "object", "type": "object",
"description": "The Android Device Policy configuration of an enterprise.", "description": "Deprecated and unused.",
"properties": { "properties": {
"kind": { "kind": {
"type": "string", "type": "string",
@@ -139,7 +199,7 @@
}, },
"state": { "state": {
"type": "string", "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." "description": "Deprecated and unused."
} }
} }
}, },
@@ -424,12 +484,7 @@
}, },
"primaryDomain": { "primaryDomain": {
"type": "string", "type": "string",
"description": "The enterprise's primary domain, such as \"example.com\".", "description": "The enterprise's primary domain, such as \"example.com\"."
"annotations": {
"required": [
"androidenterprise.enterprises.insert"
]
}
} }
} }
}, },
@@ -683,6 +738,23 @@
} }
} }
}, },
"MaintenanceWindow": {
"id": "MaintenanceWindow",
"type": "object",
"description": "Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window.",
"properties": {
"durationMs": {
"type": "string",
"description": "Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).",
"format": "int64"
},
"startTimeAfterMidnightMs": {
"type": "string",
"description": "Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.",
"format": "int64"
}
}
},
"ManagedConfiguration": { "ManagedConfiguration": {
"id": "ManagedConfiguration", "id": "ManagedConfiguration",
"type": "object", "type": "object",
@@ -758,6 +830,11 @@
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsSettings\".", "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsSettings\".",
"default": "androidenterprise#managedConfigurationsSettings" "default": "androidenterprise#managedConfigurationsSettings"
}, },
"lastUpdatedTimestampMillis": {
"type": "string",
"description": "The last updated time of the managed configuration settings in milliseconds since 1970-01-01T00:00:00Z.",
"format": "int64"
},
"managedProperty": { "managedProperty": {
"type": "array", "type": "array",
"description": "The set of managed properties for this configuration.", "description": "The set of managed properties for this configuration.",
@@ -859,6 +936,10 @@
"type": "string", "type": "string",
"description": "The Android ID of the device. This field will always be present." "description": "The Android ID of the device. This field will always be present."
}, },
"dpcPackageName": {
"type": "string",
"description": "Policy app on the device."
},
"managementType": { "managementType": {
"type": "string", "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." "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."
@@ -1012,9 +1093,17 @@
"type": "object", "type": "object",
"description": "The device policy for a given managed device.", "description": "The device policy for a given managed device.",
"properties": { "properties": {
"autoUpdatePolicy": {
"type": "string",
"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."
},
"maintenanceWindow": {
"$ref": "MaintenanceWindow",
"description": "The maintenance window defining when apps running in the foreground should be updated."
},
"productAvailabilityPolicy": { "productAvailabilityPolicy": {
"type": "string", "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." "description": "The availability granted to the device for the specified products. \"all\" gives the device access to all products, regardless of approval status. \"all\" does not enable automatic visibility of \"alpha\" or \"beta\" tracks. \"whitelist\" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default."
}, },
"productPolicy": { "productPolicy": {
"type": "array", "type": "array",
@@ -1065,7 +1154,7 @@
}, },
"description": { "description": {
"type": "string", "type": "string",
"description": "A localized promotional description, if available." "description": "The localized promotional description, if available."
}, },
"detailsUrl": { "detailsUrl": {
"type": "string", "type": "string",
@@ -1086,7 +1175,7 @@
}, },
"lastUpdatedTimestampMillis": { "lastUpdatedTimestampMillis": {
"type": "string", "type": "string",
"description": "The time (in milliseconds since epoch) when application was last published. (Timestamp is approximate within 7 days of actual publish time.)", "description": "The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch.",
"format": "int64" "format": "int64"
}, },
"minAndroidSdkVersion": { "minAndroidSdkVersion": {
@@ -1096,7 +1185,7 @@
}, },
"permissions": { "permissions": {
"type": "array", "type": "array",
"description": "The permissions required for this app.", "description": "A list of permissions required by the app.",
"items": { "items": {
"$ref": "ProductPermission" "$ref": "ProductPermission"
} }
@@ -1535,7 +1624,7 @@
}, },
"link": { "link": {
"type": "array", "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.", "description": "Ordered list of pages a user should be able to reach from this page. The list can't include this page. It is recommended that the basic pages are created first, before adding the links between pages.\n\nThe API doesn't verify that the pages exist or the pages are reachable.",
"items": { "items": {
"type": "string" "type": "string"
} }
@@ -1974,26 +2063,6 @@
"https://www.googleapis.com/auth/androidenterprise" "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": { "enroll": {
"id": "androidenterprise.enterprises.enroll", "id": "androidenterprise.enterprises.enroll",
"path": "enterprises/enroll", "path": "enterprises/enroll",
@@ -2066,7 +2135,7 @@
"id": "androidenterprise.enterprises.getAndroidDevicePolicyConfig", "id": "androidenterprise.enterprises.getAndroidDevicePolicyConfig",
"path": "enterprises/{enterpriseId}/androidDevicePolicyConfig", "path": "enterprises/{enterpriseId}/androidDevicePolicyConfig",
"httpMethod": "GET", "httpMethod": "GET",
"description": "Returns the Android Device Policy config resource.", "description": "Deprecated and unused.",
"parameters": { "parameters": {
"enterpriseId": { "enterpriseId": {
"type": "string", "type": "string",
@@ -2144,32 +2213,6 @@
"https://www.googleapis.com/auth/androidenterprise" "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": { "list": {
"id": "androidenterprise.enterprises.list", "id": "androidenterprise.enterprises.list",
"path": "enterprises", "path": "enterprises",
@@ -2273,7 +2316,7 @@
"id": "androidenterprise.enterprises.setAndroidDevicePolicyConfig", "id": "androidenterprise.enterprises.setAndroidDevicePolicyConfig",
"path": "enterprises/{enterpriseId}/androidDevicePolicyConfig", "path": "enterprises/{enterpriseId}/androidDevicePolicyConfig",
"httpMethod": "PUT", "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.", "description": "Deprecated and unused.",
"parameters": { "parameters": {
"enterpriseId": { "enterpriseId": {
"type": "string", "type": "string",

5252
etc/api/androidmanagement/v1/androidmanagement-api.json
View File

File diff suppressed because it is too large Load Diff

17
etc/api/androidpublisher/v1.1/androidpublisher-api.json
View File

@@ -1,14 +1,14 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/VxIc5srE4gMSXl83OJ7lOi7ZNVw\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/wbdcynonJja7tRoJFzOo01Xdrh4\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "androidpublisher:v1.1", "id": "androidpublisher:v1.1",
"name": "androidpublisher", "name": "androidpublisher",
"canonicalName": "Android Publisher", "canonicalName": "Android Publisher",
"version": "v1.1", "version": "v1.1",
"revision": "20171030", "revision": "20181009",
"title": "Google Play Developer API", "title": "Google Play Developer API",
"description": "Lets Android application developers access their Google Play accounts.", "description": "Accesses Android application developers' Google Play accounts.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
"ownerName": "Google", "ownerName": "Google",
"icons": { "icons": {
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -102,13 +102,18 @@
}, },
"purchaseState": { "purchaseState": {
"type": "integer", "type": "integer",
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Cancelled", "description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled",
"format": "int32" "format": "int32"
}, },
"purchaseTime": { "purchaseTime": {
"type": "string", "type": "string",
"description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).", "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
"format": "int64" "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) \n- Promo (i.e. purchased using a promo code)",
"format": "int32"
} }
} }
}, },

10
etc/api/androidpublisher/v1/androidpublisher-api.json
View File

@@ -1,14 +1,14 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/xBYE5dsDkH9Dr1-OQbrbXKASDg8\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/fparelneh7TE9qKzoMjEcU2XZ9o\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "androidpublisher:v1", "id": "androidpublisher:v1",
"name": "androidpublisher", "name": "androidpublisher",
"canonicalName": "Android Publisher", "canonicalName": "Android Publisher",
"version": "v1", "version": "v1",
"revision": "20171030", "revision": "20181009",
"title": "Google Play Developer API", "title": "Google Play Developer API",
"description": "Lets Android application developers access their Google Play accounts.", "description": "Accesses Android application developers' Google Play accounts.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
"ownerName": "Google", "ownerName": "Google",
"icons": { "icons": {
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

430
etc/api/androidpublisher/v2/androidpublisher-api.json
View File

@@ -1,14 +1,14 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/6dRjzWCszNTQjv1EQoJBlq-Xgrs\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/RACbk2SfJM1Du-DTMcEBiBV45lU\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "androidpublisher:v2", "id": "androidpublisher:v2",
"name": "androidpublisher", "name": "androidpublisher",
"canonicalName": "Android Publisher", "canonicalName": "Android Publisher",
"version": "v2", "version": "v2",
"revision": "20171030", "revision": "20181009",
"title": "Google Play Developer API", "title": "Google Play Developer API",
"description": "Lets Android application developers access their Google Play accounts.", "description": "Accesses Android application developers' Google Play accounts.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
"ownerName": "Google", "ownerName": "Google",
"icons": { "icons": {
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -212,6 +212,42 @@
} }
} }
}, },
"Bundle": {
"id": "Bundle",
"type": "object",
"properties": {
"sha1": {
"type": "string",
"description": "A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command."
},
"sha256": {
"type": "string",
"description": "A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command."
},
"versionCode": {
"type": "integer",
"description": "The version code of the Android App Bundle. As specified in the Android App Bundle's base module APK manifest file.",
"format": "int32"
}
}
},
"BundlesListResponse": {
"id": "BundlesListResponse",
"type": "object",
"properties": {
"bundles": {
"type": "array",
"items": {
"$ref": "Bundle"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#bundlesListResponse\".",
"default": "androidpublisher#bundlesListResponse"
}
}
},
"Comment": { "Comment": {
"id": "Comment", "id": "Comment",
"type": "object", "type": "object",
@@ -315,48 +351,6 @@
} }
} }
}, },
"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": { "ExpansionFile": {
"id": "ExpansionFile", "id": "ExpansionFile",
"type": "object", "type": "object",
@@ -544,6 +538,10 @@
"$ref": "Price", "$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." "description": "Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency."
}, },
"gracePeriod": {
"type": "string",
"description": "Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = \"P3D\" (three days) and \"P7D\" (seven days)"
},
"listings": { "listings": {
"type": "object", "type": "object",
"description": "List of localized title and description data.", "description": "List of localized title and description data.",
@@ -740,13 +738,18 @@
}, },
"purchaseState": { "purchaseState": {
"type": "integer", "type": "integer",
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Cancelled", "description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled",
"format": "int32" "format": "int32"
}, },
"purchaseTimeMillis": { "purchaseTimeMillis": {
"type": "string", "type": "string",
"description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).", "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
"format": "int64" "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) \n- Promo (i.e. purchased using a promo code)",
"format": "int32"
} }
} }
}, },
@@ -857,6 +860,22 @@
} }
} }
}, },
"SubscriptionCancelSurveyResult": {
"id": "SubscriptionCancelSurveyResult",
"type": "object",
"description": "Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).",
"properties": {
"cancelSurveyReason": {
"type": "integer",
"description": "The cancellation reason the user chose in the survey. Possible values are: \n- Other \n- I don't use this service enough \n- Technical issues \n- Cost-related reasons \n- I found a better app",
"format": "int32"
},
"userInputCancelReason": {
"type": "string",
"description": "The customized input cancel reason from the user. Only present when cancelReason is 0."
}
}
},
"SubscriptionDeferralInfo": { "SubscriptionDeferralInfo": {
"id": "SubscriptionDeferralInfo", "id": "SubscriptionDeferralInfo",
"type": "object", "type": "object",
@@ -874,6 +893,22 @@
} }
} }
}, },
"SubscriptionPriceChange": {
"id": "SubscriptionPriceChange",
"type": "object",
"description": "Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion.",
"properties": {
"newPrice": {
"$ref": "Price",
"description": "The new price the subscription will renew with if the price change is accepted by the user."
},
"state": {
"type": "integer",
"description": "The current state of the price change. Possible values are: \n- Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. \n- Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next.",
"format": "int32"
}
}
},
"SubscriptionPurchase": { "SubscriptionPurchase": {
"id": "SubscriptionPurchase", "id": "SubscriptionPurchase",
"type": "object", "type": "object",
@@ -885,9 +920,13 @@
}, },
"cancelReason": { "cancelReason": {
"type": "integer", "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", "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" "format": "int32"
}, },
"cancelSurveyResult": {
"$ref": "SubscriptionCancelSurveyResult",
"description": "Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey)."
},
"countryCode": { "countryCode": {
"type": "string", "type": "string",
"description": "ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted." "description": "ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted."
@@ -896,23 +935,39 @@
"type": "string", "type": "string",
"description": "A developer-specified string that contains supplemental information about an order." "description": "A developer-specified string that contains supplemental information about an order."
}, },
"emailAddress": {
"type": "string",
"description": "The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'."
},
"expiryTimeMillis": { "expiryTimeMillis": {
"type": "string", "type": "string",
"description": "Time at which the subscription will expire, in milliseconds since the Epoch.", "description": "Time at which the subscription will expire, in milliseconds since the Epoch.",
"format": "int64" "format": "int64"
}, },
"familyName": {
"type": "string",
"description": "The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'."
},
"givenName": {
"type": "string",
"description": "The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'."
},
"kind": { "kind": {
"type": "string", "type": "string",
"description": "This kind represents a subscriptionPurchase object in the androidpublisher service.", "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
"default": "androidpublisher#subscriptionPurchase" "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": { "orderId": {
"type": "string", "type": "string",
"description": "The order id of the latest recurring order associated with the purchase of the subscription." "description": "The order id of the latest recurring order associated with the purchase of the subscription."
}, },
"paymentState": { "paymentState": {
"type": "integer", "type": "integer",
"description": "The payment state of the subscription. Possible values are: \n- Payment pending \n- Payment received \n- Free trial", "description": "The payment state of the subscription. Possible values are: \n- Payment pending \n- Payment received \n- Free trial \n- Pending deferred upgrade/downgrade",
"format": "int32" "format": "int32"
}, },
"priceAmountMicros": { "priceAmountMicros": {
@@ -920,10 +975,27 @@
"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.", "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" "format": "int64"
}, },
"priceChange": {
"$ref": "SubscriptionPriceChange",
"description": "The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied.\n\nOnce the subscription renews with the new price or the subscription is canceled, no price change information will be returned."
},
"priceCurrencyCode": { "priceCurrencyCode": {
"type": "string", "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\"." "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\"."
}, },
"profileId": {
"type": "string",
"description": "The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'."
},
"profileName": {
"type": "string",
"description": "The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'."
},
"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": { "startTimeMillis": {
"type": "string", "type": "string",
"description": "Time at which the subscription was granted, in milliseconds since the Epoch.", "description": "Time at which the subscription was granted, in milliseconds since the Epoch.",
@@ -1006,7 +1078,8 @@
"type": "object", "type": "object",
"properties": { "properties": {
"track": { "track": {
"type": "string" "type": "string",
"description": "Identifier for this track."
}, },
"userFraction": { "userFraction": {
"type": "number", "type": "number",
@@ -1014,6 +1087,7 @@
}, },
"versionCodes": { "versionCodes": {
"type": "array", "type": "array",
"description": "Version codes to make active on this track. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases.",
"items": { "items": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
@@ -1100,7 +1174,7 @@
"VoidedPurchase": { "VoidedPurchase": {
"id": "VoidedPurchase", "id": "VoidedPurchase",
"type": "object", "type": "object",
"description": "A VoidedPurchase resource indicates a purchase that was either cancelled/refunded/charged-back.", "description": "A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.",
"properties": { "properties": {
"kind": { "kind": {
"type": "string", "type": "string",
@@ -1118,7 +1192,7 @@
}, },
"voidedTimeMillis": { "voidedTimeMillis": {
"type": "string", "type": "string",
"description": "The time at which the purchase was cancelled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).", "description": "The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).",
"format": "int64" "format": "int64"
} }
} }
@@ -1663,6 +1737,91 @@
} }
} }
}, },
"bundles": {
"methods": {
"list": {
"id": "androidpublisher.edits.bundles.list",
"path": "{packageName}/edits/{editId}/bundles",
"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": "BundlesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
},
"upload": {
"id": "androidpublisher.edits.bundles.upload",
"path": "{packageName}/edits/{editId}/bundles",
"httpMethod": "POST",
"description": "Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.",
"parameters": {
"ackBundleInstallationWarning": {
"type": "boolean",
"description": "Must be set to true if the bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB).",
"location": "query"
},
"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": "Bundle"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"supportsMediaUpload": true,
"mediaUpload": {
"accept": [
"application/octet-stream"
],
"maxSize": "2GB",
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/bundles"
},
"resumable": {
"multipart": true,
"path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/bundles"
}
}
}
}
}
},
"deobfuscationfiles": { "deobfuscationfiles": {
"methods": { "methods": {
"upload": { "upload": {
@@ -2587,19 +2746,9 @@
}, },
"track": { "track": {
"type": "string", "type": "string",
"description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
"required": true, "required": true,
"enum": [ "pattern": "(alpha|beta|production|rollout|internal)",
"alpha",
"beta",
"production",
"rollout"
],
"enumDescriptions": [
"",
"",
"",
""
],
"location": "path" "location": "path"
} }
}, },
@@ -2634,19 +2783,9 @@
}, },
"track": { "track": {
"type": "string", "type": "string",
"description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
"required": true, "required": true,
"enum": [ "pattern": "(alpha|beta|production|rollout|internal)",
"alpha",
"beta",
"production",
"rollout"
],
"enumDescriptions": [
"",
"",
"",
""
],
"location": "path" "location": "path"
} }
}, },
@@ -2684,19 +2823,9 @@
}, },
"track": { "track": {
"type": "string", "type": "string",
"description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
"required": true, "required": true,
"enum": [ "pattern": "(alpha|beta|production|rollout|internal)",
"alpha",
"beta",
"production",
"rollout"
],
"enumDescriptions": [
"",
"",
"",
""
],
"location": "path" "location": "path"
} }
}, },
@@ -2739,20 +2868,8 @@
}, },
"track": { "track": {
"type": "string", "type": "string",
"description": "The track type to read or modify.", "description": "The track to read or modify.",
"required": true, "required": true,
"enum": [
"alpha",
"beta",
"production",
"rollout"
],
"enumDescriptions": [
"",
"",
"",
""
],
"location": "path" "location": "path"
} }
}, },
@@ -2818,20 +2935,8 @@
}, },
"track": { "track": {
"type": "string", "type": "string",
"description": "The track type to read or modify.", "description": "The track to read or modify.",
"required": true, "required": true,
"enum": [
"alpha",
"beta",
"production",
"rollout"
],
"enumDescriptions": [
"",
"",
"",
""
],
"location": "path" "location": "path"
} }
}, },
@@ -2870,20 +2975,8 @@
}, },
"track": { "track": {
"type": "string", "type": "string",
"description": "The track type to read or modify.", "description": "The track to read or modify.",
"required": true, "required": true,
"enum": [
"alpha",
"beta",
"production",
"rollout"
],
"enumDescriptions": [
"",
"",
"",
""
],
"location": "path" "location": "path"
} }
}, },
@@ -2906,49 +2999,6 @@
} }
} }
}, },
"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": { "inappproducts": {
"methods": { "methods": {
"delete": { "delete": {
@@ -3153,6 +3203,42 @@
} }
} }
}, },
"orders": {
"methods": {
"refund": {
"id": "androidpublisher.orders.refund",
"path": "{packageName}/orders/{orderId}:refund",
"httpMethod": "POST",
"description": "Refund a user's subscription or in-app purchase order.",
"parameters": {
"orderId": {
"type": "string",
"description": "The order ID provided to the user when the subscription or in-app order was purchased.",
"required": true,
"location": "path"
},
"packageName": {
"type": "string",
"description": "The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').",
"required": true,
"location": "path"
},
"revoke": {
"type": "boolean",
"description": "Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional)",
"location": "query"
}
},
"parameterOrder": [
"packageName",
"orderId"
],
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
}
}
},
"purchases": { "purchases": {
"resources": { "resources": {
"products": { "products": {
@@ -3385,7 +3471,7 @@
"id": "androidpublisher.purchases.voidedpurchases.list", "id": "androidpublisher.purchases.voidedpurchases.list",
"path": "{packageName}/purchases/voidedpurchases", "path": "{packageName}/purchases/voidedpurchases",
"httpMethod": "GET", "httpMethod": "GET",
"description": "Lists the purchases that were cancelled, refunded or charged-back.", "description": "Lists the purchases that were canceled, refunded or charged-back.",
"parameters": { "parameters": {
"endTime": { "endTime": {
"type": "string", "type": "string",

3386
etc/api/androidpublisher/v3/androidpublisher-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

53
etc/api/api-list.yaml
View File

@@ -7,6 +7,8 @@ api:
- v1 - v1
acceleratedmobilepageurl: acceleratedmobilepageurl:
- v1 - v1
accesscontextmanager:
- v1beta
adexchangebuyer: adexchangebuyer:
- v1.3 - v1.3
- v1.4 - v1.4
@@ -23,6 +25,8 @@ api:
- v1.4 - v1.4
adsensehost: adsensehost:
- v4.1 - v4.1
alertcenter:
- v1beta1
analytics: analytics:
- v3 - v3
analyticsreporting: analyticsreporting:
@@ -35,6 +39,7 @@ api:
- v1 - v1
androidpublisher: androidpublisher:
- v2 - v2
- v3
appengine: appengine:
- v1 - v1
- v1beta4 - v1beta4
@@ -51,16 +56,22 @@ api:
- v2 - v2
bigquerydatatransfer: bigquerydatatransfer:
- v1 - v1
binaryauthorization:
- v1beta1
blogger: blogger:
- v3 - v3
books: books:
- v1 - v1
calendar: calendar:
- v3 - v3
chat:
- v1
civicinfo: civicinfo:
- v2 - v2
classroom: classroom:
- v1 - v1
cloudasset:
- v1beta1
cloudbilling: cloudbilling:
- v1 - v1
cloudbuild: cloudbuild:
@@ -80,18 +91,26 @@ api:
- v2 - v2
cloudmonitoring: cloudmonitoring:
- v2beta2 - v2beta2
cloudprofiler:
- v2
cloudresourcemanager: cloudresourcemanager:
- v1 - v1
- v1beta1 - v1beta1
- v2
cloudsearch: cloudsearch:
- v1 - v1
cloudshell:
- v1
cloudtasks: cloudtasks:
- v2beta2 - v2beta2
- v2beta3
cloudtrace: cloudtrace:
- v1 - v1
- v2 - v2
clouduseraccounts: clouduseraccounts:
- vm_beta - vm_beta
composer:
- v1
compute: compute:
- v1 - v1
consumersurveys: consumersurveys:
@@ -118,11 +137,16 @@ api:
dfareporting: dfareporting:
- v2.8 - v2.8
- v3.0 - v3.0
- v3.2
dialogflow: dialogflow:
- v2
- v2beta1 - v2beta1
digitalassetlinks:
- v1
discovery: discovery:
- v1 - v1
dlp: dlp:
- v2
- v2beta1 - v2beta1
dns: dns:
- v1 - v1
@@ -133,13 +157,18 @@ api:
drive: drive:
- v2 - v2
- v3 - v3
file:
- v1beta1
firebasedynamiclinks: firebasedynamiclinks:
- v1 - v1
firebasehosting:
- v1beta1
firebaseremoteconfig: firebaseremoteconfig:
- v1 - v1
firebaserules: firebaserules:
- v1 - v1
firestore: firestore:
- v1
- v1beta1 - v1beta1
fitness: fitness:
- v1 - v1
@@ -165,8 +194,16 @@ api:
- v1 - v1
iam: iam:
- v1 - v1
iamcredentials:
- v1
iap:
- v1beta1
identitytoolkit: identitytoolkit:
- v3 - v3
indexing:
- v3
jobs:
- v3
kgsearch: kgsearch:
- v1 - v1
language: language:
@@ -196,6 +233,7 @@ api:
- v1beta - v1beta
pagespeedonline: pagespeedonline:
- v2 - v2
- v4
partners: partners:
- v2 - v2
people: people:
@@ -221,6 +259,8 @@ api:
- v1beta2 - v1beta2
qpxexpress: qpxexpress:
- v1 - v1
redis:
- v1
replicapool: replicapool:
- v1beta2 - v1beta2
replicapoolupdater: replicapoolupdater:
@@ -238,14 +278,20 @@ api:
- v1 - v1
searchconsole: searchconsole:
- v1 - v1
servicebroker:
- v1
serviceconsumermanagement: serviceconsumermanagement:
- v1 - v1
servicecontrol: servicecontrol:
- v1 - v1
servicemanagement: servicemanagement:
- v1 - v1
servicenetworking:
- v1beta
serviceregistry: serviceregistry:
- alpha - alpha
serviceusage:
- v1
serviceuser: serviceuser:
- v1 - v1
sheets: sheets:
@@ -282,9 +328,12 @@ api:
- v1 - v1
testing: testing:
- v1 - v1
texttospeech:
- v1
toolresults: toolresults:
- v1beta3 - v1beta3
tpu: tpu:
- v1
- v1alpha1 - v1alpha1
translate: translate:
- v2 - v2
@@ -293,6 +342,7 @@ api:
vault: vault:
- v1 - v1
videointelligence: videointelligence:
- v1
- v1beta1 - v1beta1
vision: vision:
- v1 - v1
@@ -300,9 +350,12 @@ api:
- v1 - v1
webmasters: webmasters:
- v3 - v3
websecurityscanner:
- v1beta
youtube: youtube:
- v3 - v3
youtubeanalytics: youtubeanalytics:
- v1 - v1
- v2
youtubereporting: youtubereporting:
- v1 - v1

5063
etc/api/appengine/v1/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

1547
etc/api/appengine/v1alpha/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

5522
etc/api/appengine/v1beta/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

3053
etc/api/appengine/v1beta4/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

3255
etc/api/appengine/v1beta5/appengine-api.json
View File

File diff suppressed because it is too large Load Diff

30
etc/api/appsactivity/v1/appsactivity-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/xZ3PWWweD7cKnq3JhviTJwoQwLk\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/kg_U6U5i2XPBFjnOz4xe6aDxN24\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "appsactivity:v1", "id": "appsactivity:v1",
"name": "appsactivity", "name": "appsactivity",
"version": "v1", "version": "v1",
"revision": "20171207", "revision": "20181011",
"title": "G Suite Activity API", "title": "Drive Activity API",
"description": "Provides a historical view of activity.", "description": "Provides a historical view of activity.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
"ownerName": "Google", "ownerName": "Google",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -71,18 +71,6 @@
"scopes": { "scopes": {
"https://www.googleapis.com/auth/activity": { "https://www.googleapis.com/auth/activity": {
"description": "View the activity history of your Google apps" "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"
} }
} }
} }
@@ -285,6 +273,7 @@
"enum": [ "enum": [
"commenter", "commenter",
"owner", "owner",
"publishedReader",
"reader", "reader",
"writer" "writer"
], ],
@@ -292,6 +281,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -476,11 +466,7 @@
"$ref": "ListActivitiesResponse" "$ref": "ListActivitiesResponse"
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/activity", "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"
] ]
} }
} }

8
etc/api/appstate/v1/appstate-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/lmDs6aA0qIx7-jGEac2TXZTTp7I\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/QVpS9PD25kYc1LPN2F9-_0rvV5Y\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "appstate:v1", "id": "appstate:v1",
"name": "appstate", "name": "appstate",
"canonicalName": "App State", "canonicalName": "App State",
"version": "v1", "version": "v1",
"revision": "20171207", "revision": "20181004",
"title": "Google App State API", "title": "Google App State API",
"description": "The Google App State API.", "description": "The Google App State API.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

430
etc/api/bigquery/v2/bigquery-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/RHgdSKr7KDuh1e1sszGVdMKFPWE\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/kNaWPiDorJ4a-XoVjJgcrtZLb_0\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "bigquery:v2", "id": "bigquery:v2",
"name": "bigquery", "name": "bigquery",
"version": "v2", "version": "v2",
"revision": "20171202", "revision": "20181005",
"title": "BigQuery API", "title": "BigQuery API",
"description": "A data platform for customers to create, manage, share and query data.", "description": "A data platform for customers to create, manage, share and query data.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -94,6 +94,22 @@
} }
}, },
"schemas": { "schemas": {
"BigQueryModelTraining": {
"id": "BigQueryModelTraining",
"type": "object",
"properties": {
"currentIteration": {
"type": "integer",
"description": "[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.",
"format": "int32"
},
"expectedTotalIterations": {
"type": "string",
"description": "[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.",
"format": "int64"
}
}
},
"BigtableColumn": { "BigtableColumn": {
"id": "BigtableColumn", "id": "BigtableColumn",
"type": "object", "type": "object",
@@ -174,6 +190,19 @@
} }
} }
}, },
"Clustering": {
"id": "Clustering",
"type": "object",
"properties": {
"fields": {
"type": "array",
"description": "[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.",
"items": {
"type": "string"
}
}
}
},
"CsvOptions": { "CsvOptions": {
"id": "CsvOptions", "id": "CsvOptions",
"type": "object", "type": "object",
@@ -253,6 +282,11 @@
"$ref": "DatasetReference", "$ref": "DatasetReference",
"description": "[Required] A reference that identifies the dataset." "description": "[Required] A reference that identifies the dataset."
}, },
"defaultPartitionExpirationMs": {
"type": "string",
"description": "[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.",
"format": "int64"
},
"defaultTableExpirationMs": { "defaultTableExpirationMs": {
"type": "string", "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.", "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.",
@@ -281,7 +315,7 @@
}, },
"labels": { "labels": {
"type": "object", "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.", "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 Creating and Updating Dataset Labels for more information.",
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
} }
@@ -293,7 +327,7 @@
}, },
"location": { "location": {
"type": "string", "type": "string",
"description": "The geographic location where the dataset should reside. Possible values include EU and US. The default value is US." "description": "The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/dataset-locations."
}, },
"selfLink": { "selfLink": {
"type": "string", "type": "string",
@@ -334,6 +368,10 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
} }
},
"location": {
"type": "string",
"description": "[Experimental] The geographic location where the data resides."
} }
} }
} }
@@ -377,6 +415,20 @@
} }
} }
}, },
"DestinationTableProperties": {
"id": "DestinationTableProperties",
"type": "object",
"properties": {
"description": {
"type": "string",
"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."
},
"friendlyName": {
"type": "string",
"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."
}
}
},
"EncryptionConfiguration": { "EncryptionConfiguration": {
"id": "EncryptionConfiguration", "id": "EncryptionConfiguration",
"type": "object", "type": "object",
@@ -438,11 +490,24 @@
"description": "Relative amount of time the slowest shard spent on CPU-bound tasks.", "description": "Relative amount of time the slowest shard spent on CPU-bound tasks.",
"format": "double" "format": "double"
}, },
"endMs": {
"type": "string",
"description": "Stage end time represented as milliseconds since epoch.",
"format": "int64"
},
"id": { "id": {
"type": "string", "type": "string",
"description": "Unique ID for stage within plan.", "description": "Unique ID for stage within plan.",
"format": "int64" "format": "int64"
}, },
"inputStages": {
"type": "array",
"description": "IDs for stages that are inputs to this stage.",
"items": {
"type": "string",
"format": "int64"
}
},
"name": { "name": {
"type": "string", "type": "string",
"description": "Human-readable name for stage." "description": "Human-readable name for stage."
@@ -492,6 +557,11 @@
"description": "Total number of bytes written to shuffle and spilled to disk.", "description": "Total number of bytes written to shuffle and spilled to disk.",
"format": "int64" "format": "int64"
}, },
"startMs": {
"type": "string",
"description": "Stage start time represented as milliseconds since epoch.",
"format": "int64"
},
"status": { "status": {
"type": "string", "type": "string",
"description": "Current status for the stage." "description": "Current status for the stage."
@@ -592,7 +662,7 @@
}, },
"maxBadRecords": { "maxBadRecords": {
"type": "integer", "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.", "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. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.",
"format": "int32" "format": "int32"
}, },
"schema": { "schema": {
@@ -695,6 +765,10 @@
"id": "GoogleSheetsOptions", "id": "GoogleSheetsOptions",
"type": "object", "type": "object",
"properties": { "properties": {
"range": {
"type": "string",
"description": "[Beta] [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: !:"
},
"skipLeadingRows": { "skipLeadingRows": {
"type": "string", "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.", "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.",
@@ -702,6 +776,37 @@
} }
} }
}, },
"IterationResult": {
"id": "IterationResult",
"type": "object",
"properties": {
"durationMs": {
"type": "string",
"description": "[Output-only, Beta] Time taken to run the training iteration in milliseconds.",
"format": "int64"
},
"evalLoss": {
"type": "number",
"description": "[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.",
"format": "double"
},
"index": {
"type": "integer",
"description": "[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.",
"format": "int32"
},
"learnRate": {
"type": "number",
"description": "[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.",
"format": "double"
},
"trainingLoss": {
"type": "number",
"description": "[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.",
"format": "double"
}
}
},
"Job": { "Job": {
"id": "Job", "id": "Job",
"type": "object", "type": "object",
@@ -776,9 +881,18 @@
"$ref": "JobConfigurationExtract", "$ref": "JobConfigurationExtract",
"description": "[Pick one] Configures an extract job." "description": "[Pick one] Configures an extract job."
}, },
"jobTimeoutMs": {
"type": "string",
"description": "[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.",
"format": "int64"
},
"jobType": {
"type": "string",
"description": "[Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN."
},
"labels": { "labels": {
"type": "object", "type": "object",
"description": "[Experimental] 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.", "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": { "additionalProperties": {
"type": "string" "type": "string"
} }
@@ -799,7 +913,7 @@
"properties": { "properties": {
"compression": { "compression": {
"type": "string", "type": "string",
"description": "[Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE." "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."
}, },
"destinationFormat": { "destinationFormat": {
"type": "string", "type": "string",
@@ -845,7 +959,11 @@
}, },
"autodetect": { "autodetect": {
"type": "boolean", "type": "boolean",
"description": "Indicates if we should automatically infer the options and schema for CSV and JSON sources." "description": "[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources."
},
"clustering": {
"$ref": "Clustering",
"description": "[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered."
}, },
"createDisposition": { "createDisposition": {
"type": "string", "type": "string",
@@ -853,12 +971,16 @@
}, },
"destinationEncryptionConfiguration": { "destinationEncryptionConfiguration": {
"$ref": "EncryptionConfiguration", "$ref": "EncryptionConfiguration",
"description": "[Experimental] Custom encryption configuration (e.g., Cloud KMS keys)." "description": "Custom encryption configuration (e.g., Cloud KMS keys)."
}, },
"destinationTable": { "destinationTable": {
"$ref": "TableReference", "$ref": "TableReference",
"description": "[Required] The destination table to load the data into." "description": "[Required] The destination table to load the data into."
}, },
"destinationTableProperties": {
"$ref": "DestinationTableProperties",
"description": "[Beta] [Optional] Properties with which to create the destination table if it is new."
},
"encoding": { "encoding": {
"type": "string", "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." "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."
@@ -873,7 +995,7 @@
}, },
"maxBadRecords": { "maxBadRecords": {
"type": "integer", "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.", "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. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.",
"format": "int32" "format": "int32"
}, },
"nullMarker": { "nullMarker": {
@@ -919,7 +1041,7 @@
}, },
"sourceFormat": { "sourceFormat": {
"type": "string", "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." "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."
}, },
"sourceUris": { "sourceUris": {
"type": "array", "type": "array",
@@ -930,7 +1052,11 @@
}, },
"timePartitioning": { "timePartitioning": {
"$ref": "TimePartitioning", "$ref": "TimePartitioning",
"description": "If specified, configures time-based partitioning for the destination table." "description": "Time-based partitioning specification for the destination table."
},
"useAvroLogicalTypes": {
"type": "boolean",
"description": "If sourceFormat is set to \"AVRO\", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER). The default value will be true once this feature launches, but can be set now in preparation."
}, },
"writeDisposition": { "writeDisposition": {
"type": "string", "type": "string",
@@ -947,17 +1073,21 @@
"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.", "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" "default": "false"
}, },
"clustering": {
"$ref": "Clustering",
"description": "[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered."
},
"createDisposition": { "createDisposition": {
"type": "string", "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." "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": { "defaultDataset": {
"$ref": "DatasetReference", "$ref": "DatasetReference",
"description": "[Optional] Specifies the default dataset to use for unqualified table names in the query." "description": "[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names."
}, },
"destinationEncryptionConfiguration": { "destinationEncryptionConfiguration": {
"$ref": "EncryptionConfiguration", "$ref": "EncryptionConfiguration",
"description": "[Experimental] Custom encryption configuration (e.g., Cloud KMS keys)." "description": "Custom encryption configuration (e.g., Cloud KMS keys)."
}, },
"destinationTable": { "destinationTable": {
"$ref": "TableReference", "$ref": "TableReference",
@@ -1018,11 +1148,12 @@
}, },
"timePartitioning": { "timePartitioning": {
"$ref": "TimePartitioning", "$ref": "TimePartitioning",
"description": "If specified, configures time-based partitioning for the destination table." "description": "Time-based partitioning specification for the destination table."
}, },
"useLegacySql": { "useLegacySql": {
"type": "boolean", "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." "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": { "useQueryCache": {
"type": "boolean", "type": "boolean",
@@ -1052,7 +1183,7 @@
}, },
"destinationEncryptionConfiguration": { "destinationEncryptionConfiguration": {
"$ref": "EncryptionConfiguration", "$ref": "EncryptionConfiguration",
"description": "[Experimental] Custom encryption configuration (e.g., Cloud KMS keys)." "description": "Custom encryption configuration (e.g., Cloud KMS keys)."
}, },
"destinationTable": { "destinationTable": {
"$ref": "TableReference", "$ref": "TableReference",
@@ -1153,6 +1284,10 @@
] ]
} }
}, },
"location": {
"type": "string",
"description": "The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location."
},
"projectId": { "projectId": {
"type": "string", "type": "string",
"description": "[Required] The ID of the project containing this job.", "description": "[Required] The ID of the project containing this job.",
@@ -1168,6 +1303,11 @@
"id": "JobStatistics", "id": "JobStatistics",
"type": "object", "type": "object",
"properties": { "properties": {
"completionRatio": {
"type": "number",
"description": "[TrustedTester] [Output-only] Job progress (0.0 -\u003e 1.0) for LOAD and EXTRACT jobs.",
"format": "double"
},
"creationTime": { "creationTime": {
"type": "string", "type": "string",
"description": "[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.", "description": "[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.",
@@ -1190,6 +1330,13 @@
"$ref": "JobStatistics2", "$ref": "JobStatistics2",
"description": "[Output-only] Statistics for a query job." "description": "[Output-only] Statistics for a query job."
}, },
"quotaDeferments": {
"type": "array",
"description": "[Output-only] Quotas which delayed this job's start time.",
"items": {
"type": "string"
}
},
"startTime": { "startTime": {
"type": "string", "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.", "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.",
@@ -1217,17 +1364,31 @@
}, },
"ddlOperationPerformed": { "ddlOperationPerformed": {
"type": "string", "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." "description": "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": { "ddlTargetTable": {
"$ref": "TableReference", "$ref": "TableReference",
"description": "[Output-only, Experimental] The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries." "description": "The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries."
}, },
"estimatedBytesProcessed": { "estimatedBytesProcessed": {
"type": "string", "type": "string",
"description": "[Output-only] The original estimate of bytes processed for the job.", "description": "[Output-only] The original estimate of bytes processed for the job.",
"format": "int64" "format": "int64"
}, },
"modelTraining": {
"$ref": "BigQueryModelTraining",
"description": "[Output-only, Beta] Information about create model query job progress."
},
"modelTrainingCurrentIteration": {
"type": "integer",
"description": "[Output-only, Beta] Deprecated; do not use.",
"format": "int32"
},
"modelTrainingExpectedTotalIteration": {
"type": "string",
"description": "[Output-only, Beta] Deprecated; do not use.",
"format": "int64"
},
"numDmlAffectedRows": { "numDmlAffectedRows": {
"type": "string", "type": "string",
"description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.", "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.",
@@ -1242,18 +1403,43 @@
}, },
"referencedTables": { "referencedTables": {
"type": "array", "type": "array",
"description": "[Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.", "description": "[Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.",
"items": { "items": {
"$ref": "TableReference" "$ref": "TableReference"
} }
}, },
"reservationUsage": {
"type": "array",
"description": "[Output-only] Job resource usage breakdown by reservation.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "[Output-only] Reservation name or \"unreserved\" for on-demand resources usage."
},
"slotMs": {
"type": "string",
"description": "[Output-only] Slot-milliseconds the job spent in the given reservation.",
"format": "int64"
}
}
}
},
"schema": { "schema": {
"$ref": "TableSchema", "$ref": "TableSchema",
"description": "[Output-only, Experimental] The schema of the results. Present only for successful dry run of non-legacy SQL queries." "description": "[Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries."
}, },
"statementType": { "statementType": {
"type": "string", "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." "description": "The type of query statement, if valid. Possible values (new values might be added in the future): \"SELECT\": SELECT query. \"INSERT\": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language \"UPDATE\": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language \"DELETE\": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language \"MERGE\": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language \"CREATE_TABLE\": CREATE [OR REPLACE] TABLE without AS SELECT. \"CREATE_TABLE_AS_SELECT\": CREATE [OR REPLACE] TABLE ... AS SELECT ... \"DROP_TABLE\": DROP TABLE query. \"CREATE_VIEW\": CREATE [OR REPLACE] VIEW ... AS SELECT ... \"DROP_VIEW\": DROP VIEW query."
},
"timeline": {
"type": "array",
"description": "[Output-only] [Beta] Describes a timeline of job execution.",
"items": {
"$ref": "QueryTimelineSample"
}
}, },
"totalBytesBilled": { "totalBytesBilled": {
"type": "string", "type": "string",
@@ -1265,6 +1451,11 @@
"description": "[Output-only] Total bytes processed for the job.", "description": "[Output-only] Total bytes processed for the job.",
"format": "int64" "format": "int64"
}, },
"totalPartitionsProcessed": {
"type": "string",
"description": "[Output-only] Total number of partitions processed from all partitioned tables referenced in the job.",
"format": "int64"
},
"totalSlotMs": { "totalSlotMs": {
"type": "string", "type": "string",
"description": "[Output-only] Slot-milliseconds for the job.", "description": "[Output-only] Slot-milliseconds for the job.",
@@ -1272,7 +1463,7 @@
}, },
"undeclaredQueryParameters": { "undeclaredQueryParameters": {
"type": "array", "type": "array",
"description": "[Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.", "description": "Standard SQL only: list of undeclared query parameters detected during a dry run validation.",
"items": { "items": {
"$ref": "QueryParameter" "$ref": "QueryParameter"
} }
@@ -1357,6 +1548,37 @@
"id": "JsonValue", "id": "JsonValue",
"type": "any" "type": "any"
}, },
"ModelDefinition": {
"id": "ModelDefinition",
"type": "object",
"properties": {
"modelOptions": {
"type": "object",
"description": "[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"lossType": {
"type": "string"
},
"modelType": {
"type": "string"
}
}
},
"trainingRuns": {
"type": "array",
"description": "[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.",
"items": {
"$ref": "TrainingRun"
}
}
}
},
"ProjectList": { "ProjectList": {
"id": "ProjectList", "id": "ProjectList",
"type": "object", "type": "object",
@@ -1516,6 +1738,10 @@
"description": "The resource type of the request.", "description": "The resource type of the request.",
"default": "bigquery#queryRequest" "default": "bigquery#queryRequest"
}, },
"location": {
"type": "string",
"description": "The geographic location where the job should run. Required except for US and EU."
},
"maxResults": { "maxResults": {
"type": "integer", "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.", "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.",
@@ -1622,6 +1848,37 @@
} }
} }
}, },
"QueryTimelineSample": {
"id": "QueryTimelineSample",
"type": "object",
"properties": {
"activeUnits": {
"type": "string",
"description": "Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.",
"format": "int64"
},
"completedUnits": {
"type": "string",
"description": "Total parallel units of work completed by this query.",
"format": "int64"
},
"elapsedMs": {
"type": "string",
"description": "Milliseconds elapsed since the start of query execution.",
"format": "int64"
},
"pendingUnits": {
"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": { "Streamingbuffer": {
"id": "Streamingbuffer", "id": "Streamingbuffer",
"type": "object", "type": "object",
@@ -1647,6 +1904,10 @@
"id": "Table", "id": "Table",
"type": "object", "type": "object",
"properties": { "properties": {
"clustering": {
"$ref": "Clustering",
"description": "[Beta] Clustering specification for the table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered."
},
"creationTime": { "creationTime": {
"type": "string", "type": "string",
"description": "[Output-only] The time when this table was created, in milliseconds since the epoch.", "description": "[Output-only] The time when this table was created, in milliseconds since the epoch.",
@@ -1658,15 +1919,15 @@
}, },
"encryptionConfiguration": { "encryptionConfiguration": {
"$ref": "EncryptionConfiguration", "$ref": "EncryptionConfiguration",
"description": "[Experimental] Custom encryption configuration (e.g., Cloud KMS keys)." "description": "Custom encryption configuration (e.g., Cloud KMS keys)."
}, },
"etag": { "etag": {
"type": "string", "type": "string",
"description": "[Output-only] A hash of this resource." "description": "[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change."
}, },
"expirationTime": { "expirationTime": {
"type": "string", "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.", "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" "format": "int64"
}, },
"externalDataConfiguration": { "externalDataConfiguration": {
@@ -1688,7 +1949,7 @@
}, },
"labels": { "labels": {
"type": "object", "type": "object",
"description": "[Experimental] 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.", "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": { "additionalProperties": {
"type": "string" "type": "string"
} }
@@ -1702,6 +1963,10 @@
"type": "string", "type": "string",
"description": "[Output-only] The geographic location where the table resides. This value is inherited from the dataset." "description": "[Output-only] The geographic location where the table resides. This value is inherited from the dataset."
}, },
"model": {
"$ref": "ModelDefinition",
"description": "[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries."
},
"numBytes": { "numBytes": {
"type": "string", "type": "string",
"description": "[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.", "description": "[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.",
@@ -1735,7 +2000,7 @@
}, },
"timePartitioning": { "timePartitioning": {
"$ref": "TimePartitioning", "$ref": "TimePartitioning",
"description": "If specified, configures time-based partitioning for this table." "description": "Time-based partitioning specification for this table."
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -1911,6 +2176,10 @@
"items": { "items": {
"type": "object", "type": "object",
"properties": { "properties": {
"clustering": {
"$ref": "Clustering",
"description": "[Beta] Clustering specification for this table, if configured."
},
"creationTime": { "creationTime": {
"type": "string", "type": "string",
"description": "The time when this table was created, in milliseconds since the epoch.", "description": "The time when this table was created, in milliseconds since the epoch.",
@@ -1936,7 +2205,7 @@
}, },
"labels": { "labels": {
"type": "object", "type": "object",
"description": "[Experimental] The labels associated with this table. You can use these to organize and group your tables.", "description": "The labels associated with this table. You can use these to organize and group your tables.",
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
} }
@@ -1947,7 +2216,7 @@
}, },
"timePartitioning": { "timePartitioning": {
"$ref": "TimePartitioning", "$ref": "TimePartitioning",
"description": "The time-based partitioning for this table." "description": "The time-based partitioning specification for this table, if configured."
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -2038,12 +2307,17 @@
"properties": { "properties": {
"expirationMs": { "expirationMs": {
"type": "string", "type": "string",
"description": "[Optional] Number of milliseconds for which to keep the storage for a partition.", "description": "[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.",
"format": "int64" "format": "int64"
}, },
"field": { "field": {
"type": "string", "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." "description": "[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED."
},
"requirePartitionFilter": {
"type": "boolean",
"description": "[Beta] [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.",
"default": "false"
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -2051,6 +2325,67 @@
} }
} }
}, },
"TrainingRun": {
"id": "TrainingRun",
"type": "object",
"properties": {
"iterationResults": {
"type": "array",
"description": "[Output-only, Beta] List of each iteration results.",
"items": {
"$ref": "IterationResult"
}
},
"startTime": {
"type": "string",
"description": "[Output-only, Beta] Training run start time in milliseconds since the epoch.",
"format": "date-time"
},
"state": {
"type": "string",
"description": "[Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user."
},
"trainingOptions": {
"type": "object",
"description": "[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.",
"properties": {
"earlyStop": {
"type": "boolean"
},
"l1Reg": {
"type": "number",
"format": "double"
},
"l2Reg": {
"type": "number",
"format": "double"
},
"learnRate": {
"type": "number",
"format": "double"
},
"learnRateStrategy": {
"type": "string"
},
"lineSearchInitLearnRate": {
"type": "number",
"format": "double"
},
"maxIteration": {
"type": "string",
"format": "int64"
},
"minRelProgress": {
"type": "number",
"format": "double"
},
"warmStart": {
"type": "boolean"
}
}
}
}
},
"UserDefinedFunctionResource": { "UserDefinedFunctionResource": {
"id": "UserDefinedFunctionResource", "id": "UserDefinedFunctionResource",
"type": "object", "type": "object",
@@ -2312,6 +2647,11 @@
"required": true, "required": true,
"location": "path" "location": "path"
}, },
"location": {
"type": "string",
"description": "[Experimental] The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location.",
"location": "query"
},
"projectId": { "projectId": {
"type": "string", "type": "string",
"description": "[Required] Project ID of the job to cancel", "description": "[Required] Project ID of the job to cancel",
@@ -2343,6 +2683,11 @@
"required": true, "required": true,
"location": "path" "location": "path"
}, },
"location": {
"type": "string",
"description": "[Experimental] The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location.",
"location": "query"
},
"projectId": { "projectId": {
"type": "string", "type": "string",
"description": "[Required] Project ID of the requested job", "description": "[Required] Project ID of the requested job",
@@ -2375,6 +2720,11 @@
"required": true, "required": true,
"location": "path" "location": "path"
}, },
"location": {
"type": "string",
"description": "[Experimental] The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location.",
"location": "query"
},
"maxResults": { "maxResults": {
"type": "integer", "type": "integer",
"description": "Maximum number of results to read", "description": "Maximum number of results to read",
@@ -2475,12 +2825,24 @@
"description": "Whether to display jobs owned by all users in the project. Default false", "description": "Whether to display jobs owned by all users in the project. Default false",
"location": "query" "location": "query"
}, },
"maxCreationTime": {
"type": "string",
"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"
},
"maxResults": { "maxResults": {
"type": "integer", "type": "integer",
"description": "Maximum number of results to return", "description": "Maximum number of results to return",
"format": "uint32", "format": "uint32",
"location": "query" "location": "query"
}, },
"minCreationTime": {
"type": "string",
"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"
},
"pageToken": { "pageToken": {
"type": "string", "type": "string",
"description": "Page token, returned by a previous call, to request the next page of results", "description": "Page token, returned by a previous call, to request the next page of results",

2805
etc/api/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
View File

File diff suppressed because it is too large Load Diff

780
etc/api/binaryauthorization/v1beta1/binaryauthorization-api.json Normal file
View File

@@ -0,0 +1,780 @@
{
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"Attestor": {
"properties": {
"updateTime": {
"description": "Output only. Time when the attestor was last updated.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Required. The resource name, in the format:\n`projects/*/attestors/*`. This field may not be updated.",
"type": "string"
},
"description": {
"description": "Optional. A descriptive comment. This field may be updated.\nThe field may be displayed in chooser dialogs.",
"type": "string"
},
"userOwnedDrydockNote": {
"description": "A Drydock ATTESTATION_AUTHORITY Note, created by the user.",
"$ref": "UserOwnedDrydockNote"
}
},
"id": "Attestor",
"description": "An attestor that attests to container image\nartifacts. An existing attestor cannot be modified except where\nindicated.",
"type": "object"
},
"AdmissionWhitelistPattern": {
"description": "An admission whitelist pattern exempts images\nfrom checks by admission rules.",
"type": "object",
"properties": {
"namePattern": {
"description": "An image name pattern to whitelist, in the form `registry/path/to/image`.\nThis supports a trailing `*` as a wildcard, but this is allowed only in\ntext after the `registry/` part.",
"type": "string"
}
},
"id": "AdmissionWhitelistPattern"
},
"UserOwnedDrydockNote": {
"description": "An user owned drydock note references a Drydock\nATTESTATION_AUTHORITY Note created by the user.",
"type": "object",
"properties": {
"publicKeys": {
"description": "Optional. Public keys that verify attestations signed by this\nattestor. This field may be updated.\n\nIf this field is non-empty, one of the specified public keys must\nverify that an attestation was signed by this attestor for the\nimage specified in the admission request.\n\nIf this field is empty, this attestor always returns that no\nvalid attestations exist.",
"type": "array",
"items": {
"$ref": "AttestorPublicKey"
}
},
"noteReference": {
"description": "Required. The Drydock resource name of a ATTESTATION_AUTHORITY Note,\ncreated by the user, in the format: `projects/*/notes/*` (or the legacy\n`providers/*/notes/*`). This field may not be updated.\n\nAn attestation by this attestor is stored as a Drydock\nATTESTATION_AUTHORITY Occurrence that names a container image and that\nlinks to this Note. Drydock is an external dependency.",
"type": "string"
},
"delegationServiceAccountEmail": {
"description": "Output only. This field will contain the service account email address\nthat this Attestor will use as the principal when querying Container\nAnalysis. Attestor administrators must grant this service account the\nIAM role needed to read attestations from the note_reference in\nContainer Analysis (`containeranalysis.notes.occurrences.viewer`).\n\nThis email address is fixed for the lifetime of the Attestor, but callers\nshould not make any other assumptions about the service account email;\nfuture versions may use an email based on a different naming pattern.",
"type": "string"
}
},
"id": "UserOwnedDrydockNote"
},
"TestIamPermissionsResponse": {
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object"
},
"ListAttestorsResponse": {
"properties": {
"attestors": {
"description": "The list of attestors.",
"type": "array",
"items": {
"$ref": "Attestor"
}
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. Pass this value in the\nListAttestorsRequest.page_token field in the subsequent call to the\n`ListAttestors` method to retrieve the next page of results.",
"type": "string"
}
},
"id": "ListAttestorsResponse",
"description": "Response message for BinauthzManagementService.ListAttestors.",
"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": {
"properties": {
"description": {
"description": "Optional. A descriptive comment.",
"type": "string"
},
"admissionWhitelistPatterns": {
"description": "Optional. Admission policy whitelisting. A matching admission request will\nalways be permitted. This feature is typically used to exclude Google or\nthird-party infrastructure images from Binary Authorization policies.",
"type": "array",
"items": {
"$ref": "AdmissionWhitelistPattern"
}
},
"updateTime": {
"description": "Output only. Time when the policy was last updated.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Output only. The resource name, in the format `projects/*/policy`. There is\nat most one policy per project.",
"type": "string"
},
"defaultAdmissionRule": {
"$ref": "AdmissionRule",
"description": "Required. Default admission rule for a cluster without a per-cluster\nadmission rule."
},
"clusterAdmissionRules": {
"additionalProperties": {
"$ref": "AdmissionRule"
},
"description": "Optional. Per-cluster admission rules. Cluster spec format:\n`location.clusterId`. There can be at most one admission rule per cluster\nspec.\nA `location` is either a compute zone (e.g. us-central1-a) or a region\n(e.g. us-central1).\nFor `clusterId` syntax restrictions see\nhttps://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters.",
"type": "object"
}
},
"id": "Policy",
"description": "A policy for container image binary authorization.",
"type": "object"
},
"AdmissionRule": {
"description": "An admission rule specifies either that all container images\nused in a pod creation request must be attested to by one or more\nattestors, that all pod creations will be allowed, or that all\npod creations will be denied.\n\nImages matching an admission whitelist pattern\nare exempted from admission rules and will never block a pod creation.",
"type": "object",
"properties": {
"requireAttestationsBy": {
"description": "Optional. The resource names of the attestors that must attest to\na container image, in the format `projects/*/attestors/*`. Each\nattestor must exist before a policy can reference it. To add an attestor\nto a policy the principal issuing the policy change request must be able\nto read the attestor resource.\n\nNote: this field must be non-empty when the evaluation_mode field specifies\nREQUIRE_ATTESTATION, otherwise it must be empty.",
"type": "array",
"items": {
"type": "string"
}
},
"evaluationMode": {
"enum": [
"EVALUATION_MODE_UNSPECIFIED",
"ALWAYS_ALLOW",
"REQUIRE_ATTESTATION",
"ALWAYS_DENY"
],
"description": "Required. How this admission rule will be evaluated.",
"type": "string",
"enumDescriptions": [
"Mandatory.",
"This rule allows all all pod creations.",
"This rule allows a pod creation if all the attestors listed in\n'require_attestations_by' have valid attestations for all of the\nimages in the pod spec.",
"This rule denies all pod creations."
]
},
"enforcementMode": {
"enumDescriptions": [
"Mandatory.",
"Enforce the admission rule by blocking the pod creation."
],
"enum": [
"ENFORCEMENT_MODE_UNSPECIFIED",
"ENFORCED_BLOCK_AND_AUDIT_LOG"
],
"description": "Required. The action when a pod creation is denied by the admission rule.",
"type": "string"
}
},
"id": "AdmissionRule"
},
"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": "IamPolicy"
}
},
"id": "SetIamPolicyRequest"
},
"IamPolicy": {
"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**JSON 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\n**YAML Example**\n\n bindings:\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 role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\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": "IamPolicy"
},
"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` .\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`.",
"type": "string"
},
"condition": {
"$ref": "Expr",
"description": "Unimplemented. 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."
}
},
"id": "Binding"
},
"Expr": {
"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",
"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"
},
"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"
},
"AttestorPublicKey": {
"description": "An attestator public key that will be used to\nverify attestations signed by this attestor.",
"type": "object",
"properties": {
"asciiArmoredPgpPublicKey": {
"description": "ASCII-armored representation of a PGP public key, as the entire output by\nthe command `gpg --export --armor foo@example.com` (either LF or CRLF\nline endings).",
"type": "string"
},
"comment": {
"description": "Optional. A descriptive comment. This field may be updated.",
"type": "string"
},
"id": {
"description": "Output only. This field will be overwritten with key ID information, for\nexample, an identifier extracted from a PGP public key. This field may not\nbe updated.",
"type": "string"
}
},
"id": "AttestorPublicKey"
}
},
"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": "Binary Authorization",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://binaryauthorization.googleapis.com/",
"ownerDomain": "google.com",
"name": "binaryauthorization",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Binary Authorization API",
"ownerName": "Google",
"resources": {
"projects": {
"methods": {
"updatePolicy": {
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"name"
],
"httpMethod": "PUT",
"parameters": {
"name": {
"location": "path",
"description": "Output only. The resource name, in the format `projects/*/policy`. There is\nat most one policy per project.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/policy$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/policy",
"path": "v1beta1/{+name}",
"id": "binaryauthorization.projects.updatePolicy",
"description": "Creates or updates a project's policy, and returns a copy of the\nnew policy. A policy is always updated as a whole, to avoid race\nconditions with concurrent policy enforcement (or management!)\nrequests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT\nif the request is malformed.",
"request": {
"$ref": "Policy"
}
},
"getPolicy": {
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The resource name of the policy to retrieve,\nin the format `projects/*/policy`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/policy$",
"location": "path"
}
},
"flatPath": "v1beta1/projects/{projectsId}/policy",
"path": "v1beta1/{+name}",
"id": "binaryauthorization.projects.getPolicy",
"description": "Gets the policy for this project. Returns a default\npolicy if the project does not have one."
}
},
"resources": {
"policy": {
"methods": {
"setIamPolicy": {
"path": "v1beta1/{+resource}:setIamPolicy",
"id": "binaryauthorization.projects.policy.setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"response": {
"$ref": "IamPolicy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/policy$",
"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"
}
},
"flatPath": "v1beta1/projects/{projectsId}/policy:setIamPolicy"
},
"testIamPermissions": {
"httpMethod": "POST",
"parameterOrder": [
"resource"
],
"response": {
"$ref": "TestIamPermissionsResponse"
},
"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/[^/]+/policy$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/policy:testIamPermissions",
"id": "binaryauthorization.projects.policy.testIamPermissions",
"path": "v1beta1/{+resource}: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"
}
},
"getIamPolicy": {
"response": {
"$ref": "IamPolicy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "GET",
"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/[^/]+/policy$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/policy:getIamPolicy",
"path": "v1beta1/{+resource}:getIamPolicy",
"id": "binaryauthorization.projects.policy.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."
}
}
},
"attestors": {
"methods": {
"update": {
"description": "Updates an attestor.\nReturns NOT_FOUND if the attestor does not exist.",
"request": {
"$ref": "Attestor"
},
"response": {
"$ref": "Attestor"
},
"parameterOrder": [
"name"
],
"httpMethod": "PUT",
"parameters": {
"name": {
"location": "path",
"description": "Required. The resource name, in the format:\n`projects/*/attestors/*`. This field may not be updated.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/attestors/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/attestors/{attestorsId}",
"path": "v1beta1/{+name}",
"id": "binaryauthorization.projects.attestors.update"
},
"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.",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"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": "^projects/[^/]+/attestors/[^/]+$"
}
},
"flatPath": "v1beta1/projects/{projectsId}/attestors/{attestorsId}:testIamPermissions",
"path": "v1beta1/{+resource}:testIamPermissions",
"id": "binaryauthorization.projects.attestors.testIamPermissions"
},
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"description": "Required. The name of the attestors to delete, in the format\n`projects/*/attestors/*`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/attestors/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/attestors/{attestorsId}",
"path": "v1beta1/{+name}",
"id": "binaryauthorization.projects.attestors.delete",
"description": "Deletes an attestor. Returns NOT_FOUND if the\nattestor does not exist."
},
"list": {
"flatPath": "v1beta1/projects/{projectsId}/attestors",
"path": "v1beta1/{+parent}/attestors",
"id": "binaryauthorization.projects.attestors.list",
"description": "Lists attestors.\nReturns INVALID_ARGUMENT if the project does not exist.",
"response": {
"$ref": "ListAttestorsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"location": "query",
"description": "A token identifying a page of results the server should return. Typically,\nthis is the value of ListAttestorsResponse.next_page_token returned\nfrom the previous call to the `ListAttestors` method.",
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If\nunspecified, the server will pick an appropriate default.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The resource name of the project associated with the\nattestors, in the format `projects/*`.",
"required": true,
"type": "string"
}
}
},
"create": {
"request": {
"$ref": "Attestor"
},
"description": "Creates an attestor, and returns a copy of the new\nattestor. Returns NOT_FOUND if the project does not exist,\nINVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the\nattestor already exists.",
"response": {
"$ref": "Attestor"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"attestorId": {
"location": "query",
"description": "Required. The attestors ID.",
"type": "string"
},
"parent": {
"description": "Required. The parent of this attestor.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"flatPath": "v1beta1/projects/{projectsId}/attestors",
"path": "v1beta1/{+parent}/attestors",
"id": "binaryauthorization.projects.attestors.create"
},
"setIamPolicy": {
"id": "binaryauthorization.projects.attestors.setIamPolicy",
"path": "v1beta1/{+resource}:setIamPolicy",
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
"$ref": "SetIamPolicyRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"resource"
],
"response": {
"$ref": "IamPolicy"
},
"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/[^/]+/attestors/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/attestors/{attestorsId}: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": "IamPolicy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "GET",
"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/[^/]+/attestors/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/attestors/{attestorsId}:getIamPolicy",
"path": "v1beta1/{+resource}:getIamPolicy",
"id": "binaryauthorization.projects.attestors.getIamPolicy"
},
"get": {
"response": {
"$ref": "Attestor"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"location": "path",
"description": "Required. The name of the attestor to retrieve, in the format\n`projects/*/attestors/*`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/attestors/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/attestors/{attestorsId}",
"path": "v1beta1/{+name}",
"id": "binaryauthorization.projects.attestors.get",
"description": "Gets an attestor.\nReturns NOT_FOUND if the attestor does not exist."
}
}
}
}
}
},
"parameters": {
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"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"
},
"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"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"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"
}
},
"version": "v1beta1",
"baseUrl": "https://binaryauthorization.googleapis.com/",
"kind": "discovery#restDescription",
"description": "The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters.\n",
"servicePath": "",
"basePath": "",
"id": "binaryauthorization:v1beta1",
"documentationLink": "https://cloud.google.com/binary-authorization/",
"revision": "20181005"
}

6
etc/api/blogger/v2/blogger-api.json
View File

@@ -1,6 +1,6 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/Mm4a0u3lPNBqEzKCYhfhIpC2Mw4\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/89hug8dMIq7YUctbwKQlKrklq4s\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "blogger:v2", "id": "blogger:v2",
"name": "blogger", "name": "blogger",
@@ -60,12 +60,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

6
etc/api/blogger/v3/blogger-api.json
View File

@@ -1,6 +1,6 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/Goh5bsNuqq7lTY-yMf_QcKSL760\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/oScwAt9t2vnOyaWZEl8KR7zqocU\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "blogger:v3", "id": "blogger:v3",
"name": "blogger", "name": "blogger",
@@ -60,12 +60,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

142
etc/api/books/v1/books-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/q1aPzEOdugLS9_Y8FK61EmJhEHg\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/8P7g5wNCVmRGHn94JiqOIxt3z6w\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "books:v1", "id": "books:v1",
"name": "books", "name": "books",
"version": "v1", "version": "v1",
"revision": "20170313", "revision": "20180824",
"title": "Books API", "title": "Books API",
"description": "Searches for books and manages your Google Books library.", "description": "Searches for books and manages your Google Books library.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -890,6 +890,42 @@
} }
} }
}, },
"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": { "Geolayerdata": {
"id": "Geolayerdata", "id": "Geolayerdata",
"type": "object", "type": "object",
@@ -1161,6 +1197,9 @@
"iconUrl": { "iconUrl": {
"type": "string" "type": "string"
}, },
"is_document_mature": {
"type": "boolean"
},
"kind": { "kind": {
"type": "string", "type": "string",
"description": "Resource type.", "description": "Resource type.",
@@ -1444,6 +1483,14 @@
"notification": { "notification": {
"type": "object", "type": "object",
"properties": { "properties": {
"matchMyInterests": {
"type": "object",
"properties": {
"opted_state": {
"type": "string"
}
}
},
"moreFromAuthors": { "moreFromAuthors": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -1460,6 +1507,14 @@
} }
} }
}, },
"priceDrop": {
"type": "object",
"properties": {
"opted_state": {
"type": "string"
}
}
},
"rewardExpirations": { "rewardExpirations": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -1902,6 +1957,10 @@
"type": "string" "type": "string"
} }
}, },
"comicsContent": {
"type": "boolean",
"description": "Whether the volume has comics content."
},
"contentVersion": { "contentVersion": {
"type": "string", "type": "string",
"description": "An identifier for the version of the volume content (text & images). (In LITE projection)" "description": "An identifier for the version of the volume content (text & images). (In LITE projection)"
@@ -2507,6 +2566,81 @@
} }
} }
}, },
"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": { "layers": {
"methods": { "methods": {
"get": { "get": {

473
etc/api/calendar/v3/calendar-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/scONkfl8xf1hlctGIhfPw6jkAJ8\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/a36_uBoi3HOoPcM986UMcorr9VU\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "calendar:v3", "id": "calendar:v3",
"name": "calendar", "name": "calendar",
"version": "v3", "version": "v3",
"revision": "20171205", "revision": "20181009",
"title": "Calendar API", "title": "Calendar API",
"description": "Manipulates events and other calendar data.", "description": "Manipulates events and other calendar data.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -72,8 +72,17 @@
"https://www.googleapis.com/auth/calendar": { "https://www.googleapis.com/auth/calendar": {
"description": "Manage your calendars" "description": "Manage your calendars"
}, },
"https://www.googleapis.com/auth/calendar.events": {
"description": "View and edit events on all your calendars"
},
"https://www.googleapis.com/auth/calendar.events.readonly": {
"description": "View events on all your calendars"
},
"https://www.googleapis.com/auth/calendar.readonly": { "https://www.googleapis.com/auth/calendar.readonly": {
"description": "View your calendars" "description": "View your calendars"
},
"https://www.googleapis.com/auth/calendar.settings.readonly": {
"description": "View your Calendar settings"
} }
} }
} }
@@ -165,6 +174,10 @@
"id": "Calendar", "id": "Calendar",
"type": "object", "type": "object",
"properties": { "properties": {
"conferenceProperties": {
"$ref": "ConferenceProperties",
"description": "Conferencing properties for this calendar, for example what types of conferences are allowed."
},
"description": { "description": {
"type": "string", "type": "string",
"description": "Description of the calendar. Optional." "description": "Description of the calendar. Optional."
@@ -247,6 +260,10 @@
"type": "string", "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." "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": { "defaultReminders": {
"type": "array", "type": "array",
"description": "The default reminders that the authenticated user has for this calendar.", "description": "The default reminders that the authenticated user has for this calendar.",
@@ -337,23 +354,11 @@
"properties": { "properties": {
"method": { "method": {
"type": "string", "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.", "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. \nRequired when adding a notification."
"annotations": {
"required": [
"calendar.calendarList.insert",
"calendar.calendarList.update"
]
}
}, },
"type": { "type": {
"type": "string", "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).", "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 attendee responds to the event invitation. \n- \"agenda\" - An agenda with the events of the day (sent out in the morning). \nRequired when adding a notification."
"annotations": {
"required": [
"calendar.calendarList.insert",
"calendar.calendarList.update"
]
}
} }
} }
}, },
@@ -455,6 +460,183 @@
} }
} }
}, },
"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."
},
"parameters": {
"$ref": "ConferenceParameters",
"description": "Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming."
},
"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."
}
}
},
"ConferenceParameters": {
"id": "ConferenceParameters",
"type": "object",
"properties": {
"addOnParameters": {
"$ref": "ConferenceParametersAddOnParameters",
"description": "Additional add-on specific data."
}
}
},
"ConferenceParametersAddOnParameters": {
"id": "ConferenceParametersAddOnParameters",
"type": "object",
"properties": {
"parameters": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"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": {
"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."
},
"entryPointFeatures": {
"type": "array",
"description": "Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.",
"items": {
"type": "string"
}
},
"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."
},
"regionCode": {
"type": "string",
"description": "The CLDR/ISO 3166 region code for the country associated with this phone access. Example: \"SE\" for Sweden.\nCalendar backend will populate this field only for EntryPointType.PHONE."
},
"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": { "Error": {
"id": "Error", "id": "Error",
"type": "object", "type": "object",
@@ -501,6 +683,10 @@
"type": "string", "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." "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": { "created": {
"type": "string", "type": "string",
"description": "Creation time of the event (as a RFC3339 timestamp). Read-only.", "description": "Creation time of the event (as a RFC3339 timestamp). Read-only.",
@@ -520,7 +706,7 @@
}, },
"id": { "id": {
"type": "string", "type": "string",
"description": "The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API" "description": "The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API"
}, },
"self": { "self": {
"type": "boolean", "type": "boolean",
@@ -683,7 +869,7 @@
}, },
"id": { "id": {
"type": "string", "type": "string",
"description": "The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API" "description": "The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API"
}, },
"self": { "self": {
"type": "boolean", "type": "boolean",
@@ -694,7 +880,7 @@
}, },
"originalStartTime": { "originalStartTime": {
"$ref": "EventDateTime", "$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." "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable."
}, },
"privateCopy": { "privateCopy": {
"type": "boolean", "type": "boolean",
@@ -761,7 +947,7 @@
}, },
"status": { "status": {
"type": "string", "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." "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 (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.\nA cancelled status represents two different states depending on the event type: \n- Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.\nCancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. \n- All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.\nDeleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.\nIf an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated."
}, },
"summary": { "summary": {
"type": "string", "type": "string",
@@ -794,14 +980,7 @@
}, },
"fileUrl": { "fileUrl": {
"type": "string", "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.", "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.\nRequired when adding an attachment."
"annotations": {
"required": [
"calendar.events.import",
"calendar.events.insert",
"calendar.events.update"
]
}
}, },
"iconLink": { "iconLink": {
"type": "string", "type": "string",
@@ -837,18 +1016,11 @@
}, },
"email": { "email": {
"type": "string", "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.", "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.\nRequired when adding an attendee."
"annotations": {
"required": [
"calendar.events.import",
"calendar.events.insert",
"calendar.events.update"
]
}
}, },
"id": { "id": {
"type": "string", "type": "string",
"description": "The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API" "description": "The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API"
}, },
"optional": { "optional": {
"type": "boolean", "type": "boolean",
@@ -861,7 +1033,7 @@
}, },
"resource": { "resource": {
"type": "boolean", "type": "boolean",
"description": "Whether the attendee is a resource. Read-only. The default is 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.",
"default": "false" "default": "false"
}, },
"responseStatus": { "responseStatus": {
@@ -901,30 +1073,12 @@
"properties": { "properties": {
"method": { "method": {
"type": "string", "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.", "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. \nRequired when adding a reminder."
"annotations": {
"required": [
"calendar.calendarList.insert",
"calendar.calendarList.update",
"calendar.events.import",
"calendar.events.insert",
"calendar.events.update"
]
}
}, },
"minutes": { "minutes": {
"type": "integer", "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).", "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).\nRequired when adding a reminder.",
"format": "int32", "format": "int32"
"annotations": {
"required": [
"calendar.calendarList.insert",
"calendar.calendarList.update",
"calendar.events.import",
"calendar.events.insert",
"calendar.events.update"
]
}
} }
} }
}, },
@@ -1032,12 +1186,12 @@
"properties": { "properties": {
"calendarExpansionMax": { "calendarExpansionMax": {
"type": "integer", "type": "integer",
"description": "Maximal number of calendars for which FreeBusy information is to be provided. Optional.", "description": "Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.",
"format": "int32" "format": "int32"
}, },
"groupExpansionMax": { "groupExpansionMax": {
"type": "integer", "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.", "description": "Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.",
"format": "int32" "format": "int32"
}, },
"items": { "items": {
@@ -1049,12 +1203,12 @@
}, },
"timeMax": { "timeMax": {
"type": "string", "type": "string",
"description": "The end of the interval for the query.", "description": "The end of the interval for the query formatted as per RFC3339.",
"format": "date-time" "format": "date-time"
}, },
"timeMin": { "timeMin": {
"type": "string", "type": "string",
"description": "The start of the interval for the query.", "description": "The start of the interval for the query formatted as per RFC3339.",
"format": "date-time" "format": "date-time"
}, },
"timeZone": { "timeZone": {
@@ -1453,7 +1607,7 @@
"id": "calendar.calendarList.delete", "id": "calendar.calendarList.delete",
"path": "users/me/calendarList/{calendarId}", "path": "users/me/calendarList/{calendarId}",
"httpMethod": "DELETE", "httpMethod": "DELETE",
"description": "Deletes an entry on the user's calendar list.", "description": "Removes a calendar from the user's calendar list.",
"parameters": { "parameters": {
"calendarId": { "calendarId": {
"type": "string", "type": "string",
@@ -1473,7 +1627,7 @@
"id": "calendar.calendarList.get", "id": "calendar.calendarList.get",
"path": "users/me/calendarList/{calendarId}", "path": "users/me/calendarList/{calendarId}",
"httpMethod": "GET", "httpMethod": "GET",
"description": "Returns an entry on the user's calendar list.", "description": "Returns a calendar from the user's calendar list.",
"parameters": { "parameters": {
"calendarId": { "calendarId": {
"type": "string", "type": "string",
@@ -1497,7 +1651,7 @@
"id": "calendar.calendarList.insert", "id": "calendar.calendarList.insert",
"path": "users/me/calendarList", "path": "users/me/calendarList",
"httpMethod": "POST", "httpMethod": "POST",
"description": "Adds an entry to the user's calendar list.", "description": "Inserts an existing calendar into the user's calendar list.",
"parameters": { "parameters": {
"colorRgbFormat": { "colorRgbFormat": {
"type": "boolean", "type": "boolean",
@@ -1519,7 +1673,7 @@
"id": "calendar.calendarList.list", "id": "calendar.calendarList.list",
"path": "users/me/calendarList", "path": "users/me/calendarList",
"httpMethod": "GET", "httpMethod": "GET",
"description": "Returns entries on the user's calendar list.", "description": "Returns the calendars on the user's calendar list.",
"parameters": { "parameters": {
"maxResults": { "maxResults": {
"type": "integer", "type": "integer",
@@ -1579,7 +1733,7 @@
"id": "calendar.calendarList.patch", "id": "calendar.calendarList.patch",
"path": "users/me/calendarList/{calendarId}", "path": "users/me/calendarList/{calendarId}",
"httpMethod": "PATCH", "httpMethod": "PATCH",
"description": "Updates an entry on the user's calendar list. This method supports patch semantics.", "description": "Updates an existing calendar on the user's calendar list. This method supports patch semantics.",
"parameters": { "parameters": {
"calendarId": { "calendarId": {
"type": "string", "type": "string",
@@ -1610,7 +1764,7 @@
"id": "calendar.calendarList.update", "id": "calendar.calendarList.update",
"path": "users/me/calendarList/{calendarId}", "path": "users/me/calendarList/{calendarId}",
"httpMethod": "PUT", "httpMethod": "PUT",
"description": "Updates an entry on the user's calendar list.", "description": "Updates an existing calendar on the user's calendar list.",
"parameters": { "parameters": {
"calendarId": { "calendarId": {
"type": "string", "type": "string",
@@ -1851,7 +2005,10 @@
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.readonly" "https://www.googleapis.com/auth/calendar.events",
"https://www.googleapis.com/auth/calendar.events.readonly",
"https://www.googleapis.com/auth/calendar.readonly",
"https://www.googleapis.com/auth/calendar.settings.readonly"
] ]
} }
} }
@@ -1895,7 +2052,22 @@
}, },
"sendNotifications": { "sendNotifications": {
"type": "boolean", "type": "boolean",
"description": "Whether to send notifications about the deletion of the event. Optional. The default is False.", "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.",
"location": "query"
},
"sendUpdates": {
"type": "string",
"description": "Guests who should receive notifications about the deletion of the event.",
"enum": [
"all",
"externalOnly",
"none"
],
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
],
"location": "query" "location": "query"
} }
}, },
@@ -1904,7 +2076,8 @@
"eventId" "eventId"
], ],
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar" "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events"
] ]
}, },
"get": { "get": {
@@ -1952,6 +2125,8 @@
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events",
"https://www.googleapis.com/auth/calendar.events.readonly",
"https://www.googleapis.com/auth/calendar.readonly" "https://www.googleapis.com/auth/calendar.readonly"
] ]
}, },
@@ -1967,6 +2142,14 @@
"required": true, "required": true,
"location": "path" "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": { "supportsAttachments": {
"type": "boolean", "type": "boolean",
"description": "Whether API client performing operation supports event attachments. Optional. The default is False.", "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
@@ -1983,7 +2166,8 @@
"$ref": "Event" "$ref": "Event"
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar" "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events"
] ]
}, },
"insert": { "insert": {
@@ -1998,6 +2182,14 @@
"required": true, "required": true,
"location": "path" "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": { "maxAttendees": {
"type": "integer", "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.", "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.",
@@ -2007,7 +2199,22 @@
}, },
"sendNotifications": { "sendNotifications": {
"type": "boolean", "type": "boolean",
"description": "Whether to send notifications about the creation of the new event. Optional. The default is False.", "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.",
"location": "query"
},
"sendUpdates": {
"type": "string",
"description": "Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.",
"enum": [
"all",
"externalOnly",
"none"
],
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
],
"location": "query" "location": "query"
}, },
"supportsAttachments": { "supportsAttachments": {
@@ -2026,7 +2233,8 @@
"$ref": "Event" "$ref": "Event"
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar" "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events"
] ]
}, },
"instances": { "instances": {
@@ -2108,6 +2316,8 @@
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events",
"https://www.googleapis.com/auth/calendar.events.readonly",
"https://www.googleapis.com/auth/calendar.readonly" "https://www.googleapis.com/auth/calendar.readonly"
], ],
"supportsSubscription": true "supportsSubscription": true
@@ -2236,6 +2446,8 @@
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events",
"https://www.googleapis.com/auth/calendar.events.readonly",
"https://www.googleapis.com/auth/calendar.readonly" "https://www.googleapis.com/auth/calendar.readonly"
], ],
"supportsSubscription": true "supportsSubscription": true
@@ -2266,7 +2478,22 @@
}, },
"sendNotifications": { "sendNotifications": {
"type": "boolean", "type": "boolean",
"description": "Whether to send notifications about the change of the event's organizer. Optional. The default is False.", "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.",
"location": "query"
},
"sendUpdates": {
"type": "string",
"description": "Guests who should receive notifications about the change of the event's organizer.",
"enum": [
"all",
"externalOnly",
"none"
],
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
],
"location": "query" "location": "query"
} }
}, },
@@ -2279,7 +2506,8 @@
"$ref": "Event" "$ref": "Event"
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar" "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events"
] ]
}, },
"patch": { "patch": {
@@ -2299,6 +2527,14 @@
"required": true, "required": true,
"location": "path" "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": { "eventId": {
"type": "string", "type": "string",
"description": "Event identifier.", "description": "Event identifier.",
@@ -2314,7 +2550,22 @@
}, },
"sendNotifications": { "sendNotifications": {
"type": "boolean", "type": "boolean",
"description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.", "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.",
"location": "query"
},
"sendUpdates": {
"type": "string",
"description": "Guests who should receive notifications about the event update (for example, title changes, etc.).",
"enum": [
"all",
"externalOnly",
"none"
],
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
],
"location": "query" "location": "query"
}, },
"supportsAttachments": { "supportsAttachments": {
@@ -2334,7 +2585,8 @@
"$ref": "Event" "$ref": "Event"
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar" "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events"
] ]
}, },
"quickAdd": { "quickAdd": {
@@ -2351,7 +2603,22 @@
}, },
"sendNotifications": { "sendNotifications": {
"type": "boolean", "type": "boolean",
"description": "Whether to send notifications about the creation of the event. Optional. The default is False.", "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.",
"location": "query"
},
"sendUpdates": {
"type": "string",
"description": "Guests who should receive notifications about the creation of the new event.",
"enum": [
"all",
"externalOnly",
"none"
],
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
],
"location": "query" "location": "query"
}, },
"text": { "text": {
@@ -2369,7 +2636,8 @@
"$ref": "Event" "$ref": "Event"
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar" "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events"
] ]
}, },
"update": { "update": {
@@ -2389,6 +2657,14 @@
"required": true, "required": true,
"location": "path" "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": { "eventId": {
"type": "string", "type": "string",
"description": "Event identifier.", "description": "Event identifier.",
@@ -2404,7 +2680,22 @@
}, },
"sendNotifications": { "sendNotifications": {
"type": "boolean", "type": "boolean",
"description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.", "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.",
"location": "query"
},
"sendUpdates": {
"type": "string",
"description": "Guests who should receive notifications about the event update (for example, title changes, etc.).",
"enum": [
"all",
"externalOnly",
"none"
],
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
],
"location": "query" "location": "query"
}, },
"supportsAttachments": { "supportsAttachments": {
@@ -2424,7 +2715,8 @@
"$ref": "Event" "$ref": "Event"
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar" "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events"
] ]
}, },
"watch": { "watch": {
@@ -2555,6 +2847,8 @@
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.events",
"https://www.googleapis.com/auth/calendar.events.readonly",
"https://www.googleapis.com/auth/calendar.readonly" "https://www.googleapis.com/auth/calendar.readonly"
], ],
"supportsSubscription": true "supportsSubscription": true
@@ -2604,7 +2898,8 @@
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.readonly" "https://www.googleapis.com/auth/calendar.readonly",
"https://www.googleapis.com/auth/calendar.settings.readonly"
] ]
}, },
"list": { "list": {
@@ -2636,7 +2931,8 @@
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.readonly" "https://www.googleapis.com/auth/calendar.readonly",
"https://www.googleapis.com/auth/calendar.settings.readonly"
], ],
"supportsSubscription": true "supportsSubscription": true
}, },
@@ -2673,7 +2969,8 @@
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar",
"https://www.googleapis.com/auth/calendar.readonly" "https://www.googleapis.com/auth/calendar.readonly",
"https://www.googleapis.com/auth/calendar.settings.readonly"
], ],
"supportsSubscription": true "supportsSubscription": true
} }

1110
etc/api/chat/v1/chat-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

401
etc/api/civicinfo/v2/civicinfo-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/sNrwy4GBJh0JDl02KcW1-1MdJOM\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/0E0HMJczMJ5Gh20_HlZDoM2DlbU\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "civicinfo:v2", "id": "civicinfo:v2",
"name": "civicinfo", "name": "civicinfo",
"canonicalName": "Civic Info", "canonicalName": "Civic Info",
"version": "v2", "version": "v2",
"revision": "20161102", "revision": "20180716",
"title": "Google Civic Information API", "title": "Google Civic Information API",
"description": "Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.", "description": "Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -237,6 +237,10 @@
"description": "A number specifying the position of this contest on the voter's ballot.", "description": "A number specifying the position of this contest on the voter's ballot.",
"format": "int64" "format": "int64"
}, },
"ballotTitle": {
"type": "string",
"description": "The official title on the ballot for this contest, only where available."
},
"candidates": { "candidates": {
"type": "array", "type": "array",
"description": "The candidate choices for this contest.", "description": "The candidate choices for this contest.",
@@ -518,6 +522,15 @@
} }
} }
}, },
"FieldMetadataProto": {
"id": "FieldMetadataProto",
"type": "object",
"properties": {
"internal": {
"$ref": "InternalFieldMetadataProto"
}
}
},
"GeographicDivision": { "GeographicDivision": {
"id": "GeographicDivision", "id": "GeographicDivision",
"type": "object", "type": "object",
@@ -544,6 +557,112 @@
} }
} }
}, },
"InternalFieldMetadataProto": {
"id": "InternalFieldMetadataProto",
"type": "object",
"properties": {
"isAuto": {
"type": "boolean"
},
"sourceSummary": {
"$ref": "InternalSourceSummaryProto"
}
}
},
"InternalSourceSummaryProto": {
"id": "InternalSourceSummaryProto",
"type": "object",
"properties": {
"dataset": {
"type": "string"
},
"provider": {
"type": "string"
}
}
},
"LivegraphBacktraceRecordInfo": {
"id": "LivegraphBacktraceRecordInfo",
"type": "object",
"properties": {
"dataSourcePublishMsec": {
"type": "string",
"format": "int64"
},
"expId": {
"type": "string"
},
"expInfo": {
"$ref": "LivegraphBacktraceRecordInfoExpInfo"
},
"isRecon": {
"type": "boolean"
},
"isWlmThrottled": {
"type": "boolean"
},
"numberOfTriples": {
"type": "string",
"format": "int64"
},
"priority": {
"type": "string"
},
"process": {
"type": "string"
},
"proxyReceiveMsec": {
"type": "string",
"format": "int64"
},
"proxySentMsec": {
"type": "string",
"format": "int64"
},
"recordId": {
"type": "string"
},
"shouldMonitorLatency": {
"type": "boolean"
},
"subscriberReceiveMsec": {
"type": "string",
"format": "int64"
},
"topicBuildFinishMsec": {
"type": "string",
"format": "int64"
},
"topicBuildStartMsec": {
"type": "string",
"format": "int64"
},
"version": {
"type": "string"
}
}
},
"LivegraphBacktraceRecordInfoExpInfo": {
"id": "LivegraphBacktraceRecordInfoExpInfo",
"type": "object",
"properties": {
"deletedIns": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MessageSet": {
"id": "MessageSet",
"type": "object",
"properties": {
"recordMessageSetExt": {
"$ref": "LivegraphBacktraceRecordInfo"
}
}
},
"Office": { "Office": {
"id": "Office", "id": "Office",
"type": "object", "type": "object",
@@ -642,6 +761,26 @@
} }
} }
}, },
"PointProto": {
"id": "PointProto",
"type": "object",
"properties": {
"latE7": {
"type": "integer",
"format": "uint32"
},
"lngE7": {
"type": "integer",
"format": "uint32"
},
"metadata": {
"$ref": "FieldMetadataProto"
},
"temporaryData": {
"$ref": "MessageSet"
}
}
},
"PollingLocation": { "PollingLocation": {
"id": "PollingLocation", "id": "PollingLocation",
"type": "object", "type": "object",
@@ -710,30 +849,9 @@
"dependentLocalityName": { "dependentLocalityName": {
"type": "string" "type": "string"
}, },
"dependentThoroughfareLeadingType": {
"type": "string"
},
"dependentThoroughfareName": { "dependentThoroughfareName": {
"type": "string" "type": "string"
}, },
"dependentThoroughfarePostDirection": {
"type": "string"
},
"dependentThoroughfarePreDirection": {
"type": "string"
},
"dependentThoroughfareTrailingType": {
"type": "string"
},
"dependentThoroughfaresConnector": {
"type": "string"
},
"dependentThoroughfaresIndicator": {
"type": "string"
},
"dependentThoroughfaresType": {
"type": "string"
},
"firmName": { "firmName": {
"type": "string" "type": "string"
}, },
@@ -770,23 +888,51 @@
"subPremiseName": { "subPremiseName": {
"type": "string" "type": "string"
}, },
"thoroughfareLeadingType": {
"type": "string"
},
"thoroughfareName": { "thoroughfareName": {
"type": "string" "type": "string"
}, },
"thoroughfareNumber": { "thoroughfareNumber": {
"type": "string" "type": "string"
}
}
},
"Provenance": {
"id": "Provenance",
"type": "object",
"properties": {
"collidedSegmentSource": {
"$ref": "StreetSegmentList"
}, },
"thoroughfarePostDirection": { "ctclContestUuid": {
"type": "string" "type": "string"
}, },
"thoroughfarePreDirection": { "ctclOfficeUuid": {
"type": "string" "type": "string"
}, },
"thoroughfareTrailingType": { "datasetId": {
"type": "string",
"format": "int64"
},
"precinctId": {
"type": "string",
"format": "int64"
},
"precinctSplitId": {
"type": "string",
"format": "int64"
},
"tsStreetSegmentId": {
"type": "string" "type": "string"
},
"vip5PrecinctId": {
"type": "string"
},
"vip5StreetSegmentId": {
"type": "string"
},
"vipStreetSegmentId": {
"type": "string",
"format": "int64"
} }
} }
}, },
@@ -916,6 +1062,189 @@
} }
} }
}, },
"StreetSegment": {
"id": "StreetSegment",
"type": "object",
"properties": {
"administrationRegionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"beforeGeocodeId": {
"type": "string"
},
"catalistUniquePrecinctCode": {
"type": "string"
},
"city": {
"type": "string"
},
"cityCouncilDistrict": {
"type": "string"
},
"congressionalDistrict": {
"type": "string"
},
"contestIds": {
"type": "array",
"items": {
"type": "string"
}
},
"countyCouncilDistrict": {
"type": "string"
},
"countyFips": {
"type": "string"
},
"datasetId": {
"type": "string",
"format": "int64"
},
"earlyVoteSiteByIds": {
"type": "array",
"items": {
"type": "string"
}
},
"endHouseNumber": {
"type": "string",
"format": "int64"
},
"geocodedPoint": {
"$ref": "PointProto"
},
"geographicDivisionOcdIds": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"type": "string"
},
"judicialDistrict": {
"type": "string"
},
"mailOnly": {
"type": "boolean"
},
"municipalDistrict": {
"type": "string"
},
"ncoaAddress": {
"type": "string"
},
"oddOrEvens": {
"type": "array",
"items": {
"type": "string"
}
},
"originalId": {
"type": "string"
},
"pollinglocationByIds": {
"type": "array",
"items": {
"type": "string"
}
},
"precinctName": {
"type": "string"
},
"precinctOcdId": {
"type": "string"
},
"provenances": {
"type": "array",
"items": {
"$ref": "Provenance"
}
},
"published": {
"type": "boolean"
},
"schoolDistrict": {
"type": "string"
},
"startHouseNumber": {
"type": "string",
"format": "int64"
},
"startLatE7": {
"type": "string",
"format": "int64"
},
"startLngE7": {
"type": "string",
"format": "int64"
},
"state": {
"type": "string"
},
"stateHouseDistrict": {
"type": "string"
},
"stateSenateDistrict": {
"type": "string"
},
"streetName": {
"type": "string"
},
"subAdministrativeAreaName": {
"type": "string"
},
"surrogateId": {
"type": "string",
"format": "int64"
},
"targetsmartUniquePrecinctCode": {
"type": "string"
},
"townshipDistrict": {
"type": "string"
},
"unitNumber": {
"type": "string"
},
"unitType": {
"type": "string"
},
"vanPrecinctCode": {
"type": "string"
},
"voterGeographicDivisionOcdIds": {
"type": "array",
"items": {
"type": "string"
}
},
"wardDistrict": {
"type": "string"
},
"wildcard": {
"type": "boolean"
},
"zip": {
"type": "string"
}
}
},
"StreetSegmentList": {
"id": "StreetSegmentList",
"type": "object",
"properties": {
"segments": {
"type": "array",
"items": {
"$ref": "StreetSegment"
}
}
}
},
"VoterInfoRequest": { "VoterInfoRequest": {
"id": "VoterInfoRequest", "id": "VoterInfoRequest",
"type": "object", "type": "object",
@@ -974,7 +1303,7 @@
}, },
"otherElections": { "otherElections": {
"type": "array", "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.", "description": "When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user.",
"items": { "items": {
"$ref": "Election" "$ref": "Election"
} }
@@ -989,6 +1318,12 @@
"precinctId": { "precinctId": {
"type": "string" "type": "string"
}, },
"segments": {
"type": "array",
"items": {
"$ref": "StreetSegment"
}
},
"state": { "state": {
"type": "array", "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.", "description": "Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.",
@@ -1070,7 +1405,7 @@
}, },
"electionId": { "electionId": {
"type": "string", "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", "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}/electionsIf no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field.",
"default": "0", "default": "0",
"format": "int64", "format": "int64",
"location": "query" "location": "query"

4380
etc/api/classroom/v1/classroom-api.json
View File

File diff suppressed because it is too large Load Diff

701
etc/api/cloudasset/v1beta1/cloudasset-api.json Normal file
View File

@@ -0,0 +1,701 @@
{
"canonicalName": "Cloud Asset",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://cloudasset.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudasset",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Cloud Asset API",
"ownerName": "Google",
"resources": {
"organizations": {
"methods": {
"batchGetAssetsHistory": {
"response": {
"$ref": "BatchGetAssetsHistoryResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The relative name of the root asset. It can only be an\norganization number (such as \"organizations/123\"), a project ID (such as\n\"projects/my-project-id\")\", or a project number (such as \"projects/12345\").",
"required": true,
"type": "string",
"pattern": "^organizations/[^/]+$",
"location": "path"
},
"assetNames": {
"repeated": true,
"location": "query",
"description": "A list of the full names of the assets. For example:\n`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.\nSee [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more info.\n\nThe request becomes a no-op if the asset name list is empty, and the max\nsize of the asset name list is 100 in one request.",
"type": "string"
},
"contentType": {
"description": "Required. The content type.",
"type": "string",
"location": "query",
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"RESOURCE",
"IAM_POLICY"
]
},
"readTimeWindow.endTime": {
"description": "End time of the time window (exclusive).\nCurrent timestamp if not specified.",
"format": "google-datetime",
"type": "string",
"location": "query"
},
"readTimeWindow.startTime": {
"location": "query",
"description": "Start time of the time window (inclusive).",
"format": "google-datetime",
"type": "string"
}
},
"flatPath": "v1beta1/organizations/{organizationsId}:batchGetAssetsHistory",
"path": "v1beta1/{+parent}:batchGetAssetsHistory",
"id": "cloudasset.organizations.batchGetAssetsHistory",
"description": "Batch gets the update history of assets that overlap a time window.\nFor RESOURCE content, this API outputs history with asset in both\nnon-delete or deleted status.\nFor IAM_POLICY content, this API outputs history when the asset and its\nattached IAM POLICY both exist. This can create gaps in the output history."
},
"exportAssets": {
"request": {
"$ref": "ExportAssetsRequest"
},
"description": "Exports assets with time and resource types to a given Cloud Storage\nlocation. The output format is newline-delimited JSON.\nThis API implements the google.longrunning.Operation API allowing you\nto keep track of the export.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The relative name of the root asset. This can only be an organization\nnumber (such as \"organizations/123\"), a project ID (such as\n\"projects/my-project-id\"), or a project number (such as \"projects/12345\").",
"required": true,
"type": "string",
"pattern": "^organizations/[^/]+$",
"location": "path"
}
},
"flatPath": "v1beta1/organizations/{organizationsId}:exportAssets",
"path": "v1beta1/{+parent}:exportAssets",
"id": "cloudasset.organizations.exportAssets"
}
},
"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.",
"httpMethod": "GET",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"required": true,
"type": "string",
"pattern": "^organizations/[^/]+/operations/[^/]+/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/organizations/{organizationsId}/operations/{operationsId}/{operationsId1}",
"id": "cloudasset.organizations.operations.get",
"path": "v1beta1/{+name}"
}
}
}
}
},
"projects": {
"methods": {
"exportAssets": {
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"parent": {
"location": "path",
"description": "Required. The relative name of the root asset. This can only be an organization\nnumber (such as \"organizations/123\"), a project ID (such as\n\"projects/my-project-id\"), or a project number (such as \"projects/12345\").",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}:exportAssets",
"id": "cloudasset.projects.exportAssets",
"path": "v1beta1/{+parent}:exportAssets",
"description": "Exports assets with time and resource types to a given Cloud Storage\nlocation. The output format is newline-delimited JSON.\nThis API implements the google.longrunning.Operation API allowing you\nto keep track of the export.",
"request": {
"$ref": "ExportAssetsRequest"
}
},
"batchGetAssetsHistory": {
"description": "Batch gets the update history of assets that overlap a time window.\nFor RESOURCE content, this API outputs history with asset in both\nnon-delete or deleted status.\nFor IAM_POLICY content, this API outputs history when the asset and its\nattached IAM POLICY both exist. This can create gaps in the output history.",
"response": {
"$ref": "BatchGetAssetsHistoryResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The relative name of the root asset. It can only be an\norganization number (such as \"organizations/123\"), a project ID (such as\n\"projects/my-project-id\")\", or a project number (such as \"projects/12345\").",
"required": true,
"type": "string"
},
"assetNames": {
"repeated": true,
"location": "query",
"description": "A list of the full names of the assets. For example:\n`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.\nSee [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more info.\n\nThe request becomes a no-op if the asset name list is empty, and the max\nsize of the asset name list is 100 in one request.",
"type": "string"
},
"contentType": {
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"RESOURCE",
"IAM_POLICY"
],
"description": "Required. The content type.",
"type": "string",
"location": "query"
},
"readTimeWindow.endTime": {
"description": "End time of the time window (exclusive).\nCurrent timestamp if not specified.",
"format": "google-datetime",
"type": "string",
"location": "query"
},
"readTimeWindow.startTime": {
"description": "Start time of the time window (inclusive).",
"format": "google-datetime",
"type": "string",
"location": "query"
}
},
"flatPath": "v1beta1/projects/{projectsId}:batchGetAssetsHistory",
"path": "v1beta1/{+parent}:batchGetAssetsHistory",
"id": "cloudasset.projects.batchGetAssetsHistory"
}
},
"resources": {
"operations": {
"methods": {
"get": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/operations/[^/]+/[^/]+$",
"location": "path",
"description": "The name of the operation resource.",
"required": true,
"type": "string"
}
},
"flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}/{operationsId1}",
"path": "v1beta1/{+name}",
"id": "cloudasset.projects.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."
}
}
}
}
}
},
"parameters": {
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
},
"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"
]
},
"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"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"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"
},
"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"
}
},
"version": "v1beta1",
"baseUrl": "https://cloudasset.googleapis.com/",
"servicePath": "",
"description": "The cloud asset API manages the history and inventory of cloud resources.",
"kind": "discovery#restDescription",
"basePath": "",
"id": "cloudasset:v1beta1",
"documentationLink": "https://console.cloud.google.com/apis/api/cloudasset.googleapis.com/overview",
"revision": "20181008",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"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"
}
}
}
},
"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"
},
"BatchGetAssetsHistoryResponse": {
"description": "Batch get assets history response.",
"type": "object",
"properties": {
"assets": {
"description": "A list of assets with valid time windows.",
"type": "array",
"items": {
"$ref": "TemporalAsset"
}
}
},
"id": "BatchGetAssetsHistoryResponse"
},
"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` .\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`.",
"type": "string"
},
"condition": {
"description": "Unimplemented. 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.",
"$ref": "Expr"
}
},
"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": {
"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"
},
"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"
}
},
"id": "Expr"
},
"GcsDestination": {
"description": "A Cloud Storage location.",
"type": "object",
"properties": {
"uri": {
"description": "The path of the Cloud Storage objects. It's the same path that is used by\n gsutil. For example: \"gs://bucket_name/object_path\". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)\nfor more information.",
"type": "string"
}
},
"id": "GcsDestination"
},
"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"
}
},
"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",
"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"
},
"Resource": {
"description": "Representation of a cloud resource.",
"type": "object",
"properties": {
"data": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The content of the resource, in which some sensitive fields are scrubbed\naway and may not be present.",
"type": "object"
},
"discoveryDocumentUri": {
"description": "The URL of the discovery document containing the resource's JSON schema.\nFor example:\n`\"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest\"`.\nIt will be left unspecified for resources without a discovery-based API,\nsuch as Cloud Bigtable.",
"type": "string"
},
"parent": {
"description": "The full name of the immediate parent of this resource. See\n[Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more information.\n\nFor GCP assets, it is the parent resource defined in the [Cloud IAM policy\nhierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).\nFor example: `\"//cloudresourcemanager.googleapis.com/projects/my_project_123\"`.\n\nFor third-party assets, it is up to the users to define.",
"type": "string"
},
"resourceUrl": {
"description": "The REST URL for accessing the resource. An HTTP GET operation using this\nURL returns the resource itself.\nExample:\n`https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`.\nIt will be left unspecified for resources without a REST API.",
"type": "string"
},
"discoveryName": {
"description": "The JSON schema name listed in the discovery document.\nExample: \"Project\". It will be left unspecified for resources (such as\nCloud Bigtable) without a discovery-based API.",
"type": "string"
},
"version": {
"description": "The API version. Example: \"v1\".",
"type": "string"
}
},
"id": "Resource"
},
"ExportAssetsRequest": {
"description": "Export asset request.",
"type": "object",
"properties": {
"assetTypes": {
"description": "A list of asset types of which to take a snapshot for. For example:\n\"google.compute.disk\". If specified, only matching assets will be returned.",
"type": "array",
"items": {
"type": "string"
}
},
"readTime": {
"description": "Timestamp to take an asset snapshot. This can only be set to a timestamp\nbetween 2018-10-02 UTC (inclusive) and the current time. If not specified,\nthe current time will be used. Due to delays in resource data collection\nand indexing, there is a volatile window during which running the same\nquery may get different results.",
"format": "google-datetime",
"type": "string"
},
"contentType": {
"enumDescriptions": [
"Unspecified content type.",
"Resource metadata.",
"The actual IAM policy set on a resource."
],
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"RESOURCE",
"IAM_POLICY"
],
"description": "Asset content type. If not specified, no content but the asset name will be\nreturned.",
"type": "string"
},
"outputConfig": {
"$ref": "OutputConfig",
"description": "Required. Output configuration indicating where the results will be output\nto. All results will be in newline delimited JSON format."
}
},
"id": "ExportAssetsRequest"
},
"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"
}
}
},
"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**JSON 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\n**YAML Example**\n\n bindings:\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 role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\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"
},
"TimeWindow": {
"description": "A time window of [start_time, end_time).",
"type": "object",
"properties": {
"endTime": {
"description": "End time of the time window (exclusive).\nCurrent timestamp if not specified.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Start time of the time window (inclusive).",
"format": "google-datetime",
"type": "string"
}
},
"id": "TimeWindow"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"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"
},
"response": {
"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",
"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\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": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"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"
},
"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.",
"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.",
"type": "array",
"items": {
"$ref": "AuditLogConfig"
}
}
},
"id": "AuditConfig"
},
"Asset": {
"properties": {
"iamPolicy": {
"$ref": "Policy",
"description": "Representation of the actual Cloud IAM policy set on a cloud resource. For each\nresource, there must be at most one Cloud IAM policy set on it."
},
"resource": {
"description": "Representation of the resource.",
"$ref": "Resource"
},
"assetType": {
"description": "Type of the asset. Example: \"google.compute.disk\".",
"type": "string"
},
"name": {
"description": "The full name of the asset. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.\nSee [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more information.",
"type": "string"
}
},
"id": "Asset",
"description": "Cloud asset. This includes all Google Cloud Platform resources,\nCloud IAM policies, and other non-GCP assets.",
"type": "object"
},
"OutputConfig": {
"description": "Output configuration for export assets destination.",
"type": "object",
"properties": {
"gcsDestination": {
"description": "Destination on Cloud Storage.",
"$ref": "GcsDestination"
}
},
"id": "OutputConfig"
},
"TemporalAsset": {
"description": "Temporal asset. In addition to the asset, the temporal asset includes the\nstatus of the asset and valid from and to time of it.",
"type": "object",
"properties": {
"window": {
"description": "The time window when the asset data and state was observed.",
"$ref": "TimeWindow"
},
"asset": {
"$ref": "Asset",
"description": "Asset."
},
"deleted": {
"description": "If the asset is deleted or not.",
"type": "boolean"
}
},
"id": "TemporalAsset"
}
},
"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"
}

1391
etc/api/cloudbilling/v1/cloudbilling-api.json
View File

File diff suppressed because it is too large Load Diff

1707
etc/api/cloudbuild/v1/cloudbuild-api.json
View File

File diff suppressed because it is too large Load Diff

1176
etc/api/clouddebugger/v2/clouddebugger-api.json
View File

File diff suppressed because it is too large Load Diff

1261
etc/api/clouderrorreporting/v1beta1/clouderrorreporting-api.json
View File

File diff suppressed because it is too large Load Diff

1161
etc/api/cloudfunctions/v1/cloudfunctions-api.json
View File

File diff suppressed because it is too large Load Diff

1157
etc/api/cloudfunctions/v1beta2/cloudfunctions-api.json
View File

File diff suppressed because it is too large Load Diff

2193
etc/api/cloudiot/v1/cloudiot-api.json
View File

File diff suppressed because it is too large Load Diff

1112
etc/api/cloudiot/v1beta1/cloudiot-api.json
View File

File diff suppressed because it is too large Load Diff

2037
etc/api/cloudkms/v1/cloudkms-api.json
View File

File diff suppressed because it is too large Load Diff

342
etc/api/cloudprofiler/v2/cloudprofiler-api.json Normal file
View File

@@ -0,0 +1,342 @@
{
"canonicalName": "Cloud Profiler",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/monitoring": {
"description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
},
"https://www.googleapis.com/auth/monitoring.write": {
"description": "Publish metric data to your Google Cloud projects"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://cloudprofiler.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudprofiler",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Stackdriver Profiler API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"profiles": {
"methods": {
"createOffline": {
"response": {
"$ref": "Profile"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Parent project to create the profile in.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
],
"flatPath": "v2/projects/{projectsId}/profiles:createOffline",
"path": "v2/{+parent}/profiles:createOffline",
"id": "cloudprofiler.projects.profiles.createOffline",
"description": "CreateOfflineProfile creates a new profile resource in the offline mode.\nThe client provides the profile to create along with the profile bytes, the\nserver records it.",
"request": {
"$ref": "Profile"
}
},
"patch": {
"description": "UpdateProfile updates the profile bytes and labels on the profile resource\ncreated in the online mode. Updating the bytes for profiles created in the\noffline mode is currently not supported: the profile content must be\nprovided at the time of the profile creation.",
"request": {
"$ref": "Profile"
},
"response": {
"$ref": "Profile"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"description": "Field mask used to specify the fields to be overwritten. Currently only\nprofile_bytes and labels fields are supported by UpdateProfile, so only\nthose fields can be specified in the mask. When no mask is provided, all\nfields are overwritten.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"name": {
"location": "path",
"description": "Output only. Opaque, server-assigned, unique ID for this profile.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/profiles/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
],
"flatPath": "v2/projects/{projectsId}/profiles/{profilesId}",
"path": "v2/{+name}",
"id": "cloudprofiler.projects.profiles.patch"
},
"create": {
"path": "v2/{+parent}/profiles",
"id": "cloudprofiler.projects.profiles.create",
"request": {
"$ref": "CreateProfileRequest"
},
"description": "CreateProfile creates a new profile resource in the online mode.\n\nThe server ensures that the new profiles are created at a constant rate per\ndeployment, so the creation request may hang for some time until the next\nprofile session is available.\n\nThe request may fail with ABORTED error if the creation is not available\nwithin ~1m, the response will indicate the duration of the backoff the\nclient should take before attempting creating a profile again. The backoff\nduration is returned in google.rpc.RetryInfo extension on the response\nstatus. To a gRPC client, the extension will be return as a\nbinary-serialized proto in the trailing metadata item named\n\"google.rpc.retryinfo-bin\".",
"response": {
"$ref": "Profile"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.write"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Parent project to create the profile in.",
"required": true,
"type": "string"
}
},
"flatPath": "v2/projects/{projectsId}/profiles"
}
}
}
}
}
},
"parameters": {
"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"
},
"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"
},
"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"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"callback": {
"description": "JSONP",
"type": "string",
"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"
},
"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": "v2",
"baseUrl": "https://cloudprofiler.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Manages continuous profiling information.",
"servicePath": "",
"basePath": "",
"id": "cloudprofiler:v2",
"documentationLink": "https://cloud.google.com/profiler/",
"revision": "20181008",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"CreateProfileRequest": {
"properties": {
"profileType": {
"description": "One or more profile types that the agent is capable of providing.",
"type": "array",
"items": {
"enum": [
"PROFILE_TYPE_UNSPECIFIED",
"CPU",
"WALL",
"HEAP",
"THREADS",
"CONTENTION",
"PEAK_HEAP",
"HEAP_ALLOC"
],
"type": "string"
},
"enumDescriptions": [
"Unspecified profile type.",
"Thread CPU time sampling.",
"Wallclock time sampling. More expensive as stops all threads.",
"In-use heap profile. Represents a snapshot of the allocations that are\nlive at the time of the profiling.",
"Single-shot collection of all thread stacks.",
"Synchronization contention profile.",
"Peak heap profile.",
"Heap allocation profile. It represents the aggregation of all allocations\nmade over the duration of the profile. All allocations are included,\nincluding those that might have been freed by the end of the profiling\ninterval. The profile is in particular useful for garbage collecting\nlanguages to understand which parts of the code create most of the garbage\ncollection pressure to see if those can be optimized."
]
},
"deployment": {
"description": "Deployment details.",
"$ref": "Deployment"
}
},
"id": "CreateProfileRequest",
"description": "CreateProfileRequest describes a profile resource online creation request.\nThe deployment field must be populated. The profile_type specifies the list\nof profile types supported by the agent. The creation call will hang until a\nprofile of one of these types needs to be collected.",
"type": "object"
},
"Deployment": {
"description": "Deployment contains the deployment identification information.",
"type": "object",
"properties": {
"projectId": {
"description": "Project ID is the ID of a cloud project.\nValidation regex: `^a-z{4,61}[a-z0-9]$`.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels identify the deployment within the user universe and same target.\nValidation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.\nValue for an individual label must be \u003c= 512 bytes, the total\nsize of all label names and values must be \u003c= 1024 bytes.\n\nLabel named \"language\" can be used to record the programming language of\nthe profiled deployment. The standard choices for the value include \"java\",\n\"go\", \"python\", \"ruby\", \"nodejs\", \"php\", \"dotnet\".\n\nFor deployments running on Google Cloud Platform, \"zone\" or \"region\" label\nshould be present describing the deployment location. An example of a zone\nis \"us-central1-a\", an example of a region is \"us-central1\" or\n\"us-central\".",
"type": "object"
},
"target": {
"description": "Target is the service name used to group related deployments:\n* Service name for GAE Flex / Standard.\n* Cluster and container name for GKE.\n* User-specified string for direct GCE profiling (e.g. Java).\n* Job name for Dataflow.\nValidation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.",
"type": "string"
}
},
"id": "Deployment"
},
"Profile": {
"description": "Profile resource.",
"type": "object",
"properties": {
"duration": {
"description": "Duration of the profiling session.\nInput (for the offline mode) or output (for the online mode).\nThe field represents requested profiling duration. It may slightly differ\nfrom the effective profiling duration, which is recorded in the profile\ndata, in case the profiling can't be stopped immediately (e.g. in case\nstopping the profiling is handled asynchronously).",
"format": "google-duration",
"type": "string"
},
"profileType": {
"enumDescriptions": [
"Unspecified profile type.",
"Thread CPU time sampling.",
"Wallclock time sampling. More expensive as stops all threads.",
"In-use heap profile. Represents a snapshot of the allocations that are\nlive at the time of the profiling.",
"Single-shot collection of all thread stacks.",
"Synchronization contention profile.",
"Peak heap profile.",
"Heap allocation profile. It represents the aggregation of all allocations\nmade over the duration of the profile. All allocations are included,\nincluding those that might have been freed by the end of the profiling\ninterval. The profile is in particular useful for garbage collecting\nlanguages to understand which parts of the code create most of the garbage\ncollection pressure to see if those can be optimized."
],
"enum": [
"PROFILE_TYPE_UNSPECIFIED",
"CPU",
"WALL",
"HEAP",
"THREADS",
"CONTENTION",
"PEAK_HEAP",
"HEAP_ALLOC"
],
"description": "Type of profile.\nFor offline mode, this must be specified when creating the profile. For\nonline mode it is assigned and returned by the server.",
"type": "string"
},
"deployment": {
"description": "Deployment this profile corresponds to.",
"$ref": "Deployment"
},
"labels": {
"description": "Input only. Labels associated to this specific profile. These labels will\nget merged with the deployment labels for the final data set. See\ndocumentation on deployment labels for validation rules and limits.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"profileBytes": {
"description": "Input only. Profile bytes, as a gzip compressed serialized proto, the\nformat is https://github.com/google/pprof/blob/master/proto/profile.proto.",
"format": "byte",
"type": "string"
},
"name": {
"description": "Output only. Opaque, server-assigned, unique ID for this profile.",
"type": "string"
}
},
"id": "Profile"
}
},
"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"
}
}

2990
etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json
View File

File diff suppressed because it is too large Load Diff

1448
etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
View File

File diff suppressed because it is too large Load Diff

894
etc/api/cloudresourcemanager/v2/cloudresourcemanager-api.json Normal file
View File

@@ -0,0 +1,894 @@
{
"ownerName": "Google",
"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.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"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",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/operations/{operationsId}",
"path": "v1/{+name}",
"id": "cloudresourcemanager.operations.get"
}
}
},
"folders": {
"methods": {
"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"
},
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SearchFoldersResponse"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v2/folders:search",
"id": "cloudresourcemanager.folders.search",
"path": "v2/folders:search"
},
"patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Folder"
},
"parameters": {
"updateMask": {
"description": "Fields to be updated.\nOnly the `display_name` can be updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"name": {
"description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
"required": true,
"type": "string",
"pattern": "^folders/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2/folders/{foldersId}",
"id": "cloudresourcemanager.folders.patch",
"path": "v2/{+name}",
"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.",
"request": {
"$ref": "Folder"
}
},
"get": {
"response": {
"$ref": "Folder"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"location": "path",
"description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
"required": true,
"type": "string",
"pattern": "^folders/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v2/folders/{foldersId}",
"path": "v2/{+name}",
"id": "cloudresourcemanager.folders.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."
},
"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.",
"request": {
"$ref": "UndeleteFolderRequest"
},
"response": {
"$ref": "Folder"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"description": "The resource name of the Folder to undelete.\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": "v2/folders/{foldersId}:undelete",
"path": "v2/{+name}:undelete",
"id": "cloudresourcemanager.folders.undelete"
},
"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.",
"request": {
"$ref": "MoveFolderRequest"
},
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"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": "v2/folders/{foldersId}:move",
"path": "v2/{+name}:move",
"id": "cloudresourcemanager.folders.move"
},
"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.",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"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": "^folders/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2/folders/{foldersId}:testIamPermissions",
"path": "v2/{+resource}:testIamPermissions",
"id": "cloudresourcemanager.folders.testIamPermissions"
},
"delete": {
"flatPath": "v2/folders/{foldersId}",
"id": "cloudresourcemanager.folders.delete",
"path": "v2/{+name}",
"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.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Folder"
},
"parameters": {
"name": {
"location": "path",
"description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
"required": true,
"type": "string",
"pattern": "^folders/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"showDeleted": {
"description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false. This field is optional.",
"type": "boolean",
"location": "query"
},
"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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v2/folders",
"path": "v2/folders",
"id": "cloudresourcemanager.folders.list"
},
"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.",
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"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": "^folders/[^/]+$",
"location": "path"
}
},
"flatPath": "v2/folders/{foldersId}:setIamPolicy",
"path": "v2/{+resource}:setIamPolicy",
"id": "cloudresourcemanager.folders.setIamPolicy"
},
"create": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {
"parent": {
"location": "query",
"description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2/folders",
"path": "v2/folders",
"id": "cloudresourcemanager.folders.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, some errors\nmay be returned by the CreateFolder request, with status code\nFAILED_PRECONDITION and an error description. Other folder constraint\nviolations will be communicated in the Operation, with the specific\nPreconditionFailure returned via the details list in the Operation.error\nfield.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
"request": {
"$ref": "Folder"
}
},
"getIamPolicy": {
"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",
"pattern": "^folders/[^/]+$",
"location": "path"
}
},
"flatPath": "v2/folders/{foldersId}:getIamPolicy",
"path": "v2/{+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."
}
}
}
},
"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"
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"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"
},
"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": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
},
"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"
}
},
"version": "v2",
"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": "",
"revision": "20181008",
"documentationLink": "https://cloud.google.com/resource-manager",
"id": "cloudresourcemanager:v2",
"discoveryVersion": "v1",
"schemas": {
"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"
},
"SearchFoldersResponse": {
"description": "The response message for searching folders.",
"type": "object",
"properties": {
"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"
},
"folders": {
"description": "A possibly paginated folder search results.\nthe specified parent resource.",
"type": "array",
"items": {
"$ref": "Folder"
}
}
},
"id": "SearchFoldersResponse"
},
"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"
}
}
}
},
"id": "Status"
},
"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` .\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`.",
"type": "string"
},
"condition": {
"$ref": "Expr",
"description": "Unimplemented. 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."
}
},
"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": {
"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"
},
"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"
}
},
"id": "Expr"
},
"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\nThe displayName field in a query expression should use escaped quotes\nfor values that include whitespace to prevent unexpected behavior.\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\".|\n|displayName=\\\\\"Test String\\\\\"|Folders whose display name includes both \"Test\" and \"String\".|",
"type": "string"
}
},
"id": "SearchFoldersRequest"
},
"Folder": {
"description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
"type": "object",
"properties": {
"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"
},
"parent": {
"description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
"type": "string"
},
"createTime": {
"description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
"format": "google-datetime",
"type": "string"
},
"lifecycleState": {
"description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
"type": "string",
"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"
]
},
"name": {
"description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
"type": "string"
}
},
"id": "Folder"
},
"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": {
"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"
}
},
"id": "ProjectCreationStatus"
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
"type": "object",
"properties": {},
"id": "GetIamPolicyRequest"
},
"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"
},
"UndeleteFolderRequest": {
"description": "The UndeleteFolder request message.",
"type": "object",
"properties": {},
"id": "UndeleteFolderRequest"
},
"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"
},
"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**JSON 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\n**YAML Example**\n\n bindings:\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 role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\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"
},
"FolderOperation": {
"description": "Metadata describing a long running folder operation",
"type": "object",
"properties": {
"operationType": {
"description": "The type of this operation.",
"type": "string",
"enumDescriptions": [
"Operation type not specified.",
"A create folder operation.",
"A move folder operation."
],
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"CREATE",
"MOVE"
]
},
"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"
},
"FolderOperationError": {
"description": "A classification of the Folder Operation error.",
"type": "object",
"properties": {
"errorMessageId": {
"description": "The type of operation error experienced.",
"type": "string",
"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."
],
"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"
]
}
},
"id": "FolderOperationError"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"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"
}
},
"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"
},
"response": {
"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",
"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\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"
},
"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.",
"type": "object",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"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"
},
"ListFoldersResponse": {
"description": "The ListFolders response message.",
"type": "object",
"properties": {
"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"
},
"folders": {
"description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource.",
"type": "array",
"items": {
"$ref": "Folder"
}
}
},
"id": "ListFoldersResponse"
},
"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"
}
},
"id": "MoveFolderRequest"
}
},
"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"
},
"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": "Cloud Resource Manager API"
}

662
etc/api/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
View File

File diff suppressed because it is too large Load Diff

456
etc/api/cloudshell/v1/cloudshell-api.json Normal file
View File

@@ -0,0 +1,456 @@
{
"ownerName": "Google",
"resources": {
"operations": {
"methods": {
"cancel": {
"id": "cloudshell.operations.cancel",
"path": "v1/{+name}: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`.",
"request": {
"$ref": "CancelOperationRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"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"
},
"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`.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"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}",
"id": "cloudshell.operations.delete",
"path": "v1/{+name}"
},
"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",
"parameterOrder": [
"name"
],
"response": {
"$ref": "ListOperationsResponse"
},
"parameters": {
"name": {
"pattern": "^operations$",
"location": "path",
"description": "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"
},
"filter": {
"location": "query",
"description": "The standard list filter.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/operations",
"id": "cloudshell.operations.list",
"path": "v1/{+name}"
},
"get": {
"flatPath": "v1/operations/{operationsId}",
"id": "cloudshell.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": {
"pattern": "^operations/.+$",
"location": "path",
"description": "The name of the operation resource.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
},
"parameters": {
"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"
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"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"
},
"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"
},
"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"
},
"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"
}
},
"version": "v1",
"baseUrl": "https://cloudshell.googleapis.com/",
"servicePath": "",
"description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
"kind": "discovery#restDescription",
"basePath": "",
"documentationLink": "https://cloud.google.com/shell/docs/",
"id": "cloudshell:v1",
"revision": "20181011",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"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": {
"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"
},
"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"
}
}
},
"id": "Environment"
},
"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"
},
"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"
},
"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"
},
"PublicKey": {
"description": "A public SSH key, corresponding to a private SSH key held by the client.",
"type": "object",
"properties": {
"format": {
"enumDescriptions": [
"Unknown format. Do not use.",
"`ssh-dss` key format (see RFC4253).",
"`ssh-rsa` key format (see RFC4253).",
"`ecdsa-sha2-nistp256` key format (see RFC5656).",
"`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"
],
"description": "Required. Format of this key's content.",
"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"
},
"key": {
"description": "Required. Content of this key.",
"format": "byte",
"type": "string"
}
},
"id": "PublicKey"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"type": "object",
"properties": {},
"id": "CancelOperationRequest"
},
"StartEnvironmentMetadata": {
"description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
"type": "object",
"properties": {
"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."
],
"enum": [
"STATE_UNSPECIFIED",
"STARTING",
"UNARCHIVING_DISK",
"FINISHED"
],
"description": "Current state of the environment being started.",
"type": "string"
}
},
"id": "StartEnvironmentMetadata"
},
"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"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"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\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"
},
"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"
}
},
"id": "Operation"
}
},
"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"
}
}
}
},
"rootUrl": "https://cloudshell.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudshell",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Cloud Shell API"
}

524
etc/api/cloudshell/v1alpha1/cloudshell-api.json Normal file
View File

@@ -0,0 +1,524 @@
{
"schemas": {
"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": {
"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"
},
"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"
},
"StartEnvironmentRequest": {
"description": "Request message for StartEnvironment.",
"type": "object",
"properties": {
"accessToken": {
"description": "The initial access token passed to the environment. If this is present and\nvalid, the environment will be pre-authenticated with gcloud so that the\nuser can run gcloud commands in Cloud Shell without having to log in. This\ncode can be updated later by calling AuthorizeEnvironment.",
"type": "string"
}
},
"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"
},
"PublicKey": {
"description": "A public SSH key, corresponding to a private SSH key held by the client.",
"type": "object",
"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": {
"enum": [
"FORMAT_UNSPECIFIED",
"SSH_DSS",
"SSH_RSA",
"ECDSA_SHA2_NISTP256",
"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).",
"`ssh-rsa` key format (see RFC4253).",
"`ecdsa-sha2-nistp256` key format (see RFC5656).",
"`ecdsa-sha2-nistp384` key format (see RFC5656).",
"`ecdsa-sha2-nistp521` key format (see RFC5656)."
]
}
},
"id": "PublicKey"
},
"StartEnvironmentMetadata": {
"description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
"type": "object",
"properties": {
"state": {
"description": "Current state of the environment being started.",
"type": "string",
"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."
],
"enum": [
"STATE_UNSPECIFIED",
"STARTING",
"UNARCHIVING_DISK",
"FINISHED"
]
}
},
"id": "StartEnvironmentMetadata"
},
"AuthorizeEnvironmentRequest": {
"properties": {
"accessToken": {
"description": "The OAuth access token that should be sent to the environment.",
"type": "string"
}
},
"id": "AuthorizeEnvironmentRequest",
"description": "Request message for AuthorizeEnvironment.",
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"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"
},
"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"
}
},
"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"
},
"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": {
"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"
},
"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"
}
}
},
"id": "Environment"
},
"CreatePublicKeyRequest": {
"properties": {
"key": {
"$ref": "PublicKey",
"description": "Key that should be added to the environment."
}
},
"id": "CreatePublicKeyRequest",
"description": "Request message for CreatePublicKey.",
"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 Shell",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://cloudshell.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudshell",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Cloud Shell API",
"ownerName": "Google",
"resources": {
"users": {
"resources": {
"environments": {
"methods": {
"get": {
"path": "v1alpha1/{+name}",
"id": "cloudshell.users.environments.get",
"description": "Gets an environment. Returns NOT_FOUND if the environment does not exist.",
"response": {
"$ref": "Environment"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"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}"
},
"patch": {
"response": {
"$ref": "Environment"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"updateMask": {
"description": "Mask specifying which fields in the environment should be updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"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"
}
},
"flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
"path": "v1alpha1/{+name}",
"id": "cloudshell.users.environments.patch",
"request": {
"$ref": "Environment"
},
"description": "Updates an existing environment."
},
"authorize": {
"description": "Sends an access token to a running environment on behalf of a user. When\nthis completes, the environment will be authorized to run gcloud commands\nwithout requiring the user to manually authenticate.",
"request": {
"$ref": "AuthorizeEnvironmentRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"description": "Name of the resource that should receive the token, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.",
"required": true,
"type": "string",
"pattern": "^users/[^/]+/environments/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:authorize",
"id": "cloudshell.users.environments.authorize",
"path": "v1alpha1/{+name}:authorize"
},
"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"
},
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"pattern": "^users/[^/]+/environments/[^/]+$",
"location": "path",
"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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start",
"id": "cloudshell.users.environments.start",
"path": "v1alpha1/{+name}:start"
}
},
"resources": {
"publicKeys": {
"methods": {
"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.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"pattern": "^users/[^/]+/environments/[^/]+/publicKeys/[^/]+$",
"location": "path",
"description": "Name of the resource to be deleted, e.g.\n`users/me/environments/default/publicKeys/my-key`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}",
"id": "cloudshell.users.environments.publicKeys.delete",
"path": "v1alpha1/{+name}"
},
"create": {
"request": {
"$ref": "CreatePublicKeyRequest"
},
"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.",
"response": {
"$ref": "PublicKey"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Parent resource name, e.g. `users/me/environments/default`.",
"required": true,
"type": "string",
"pattern": "^users/[^/]+/environments/[^/]+$",
"location": "path"
}
},
"flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys",
"path": "v1alpha1/{+parent}/publicKeys",
"id": "cloudshell.users.environments.publicKeys.create"
}
}
}
}
}
}
}
},
"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"
},
"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"
},
"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"
},
"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"
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"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"
}
},
"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": "20181011",
"documentationLink": "https://cloud.google.com/shell/docs/",
"id": "cloudshell:v1alpha1",
"discoveryVersion": "v1",
"version_module": true
}

1750
etc/api/cloudtasks/v2beta2/cloudtasks-api.json
View File

File diff suppressed because it is too large Load Diff

1246
etc/api/cloudtasks/v2beta3/cloudtasks-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

299
etc/api/cloudtrace/v1/cloudtrace-api.json
View File

@@ -1,4 +1,21 @@
{ {
"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", "ownerDomain": "google.com",
"name": "cloudtrace", "name": "cloudtrace",
"batchPath": "batch", "batchPath": "batch",
@@ -7,72 +24,50 @@
"ownerName": "Google", "ownerName": "Google",
"resources": { "resources": {
"projects": { "projects": {
"methods": {
"patchTraces": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"projectId"
],
"httpMethod": "PATCH",
"parameters": {
"projectId": {
"location": "path",
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
"flatPath": "v1/projects/{projectId}/traces",
"path": "v1/projects/{projectId}/traces",
"id": "cloudtrace.projects.patchTraces",
"request": {
"$ref": "Traces"
},
"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."
}
},
"resources": { "resources": {
"traces": { "traces": {
"methods": { "methods": {
"list": { "list": {
"flatPath": "v1/projects/{projectId}/traces",
"id": "cloudtrace.projects.traces.list",
"path": "v1/projects/{projectId}/traces",
"description": "Returns of a list of traces that match the specified filter conditions.", "description": "Returns of a list of traces that match the specified filter conditions.",
"httpMethod": "GET", "httpMethod": "GET",
"response": {
"$ref": "ListTracesResponse"
},
"parameterOrder": [ "parameterOrder": [
"projectId" "projectId"
], ],
"response": {
"$ref": "ListTracesResponse"
},
"parameters": { "parameters": {
"filter": { "orderBy": {
"location": "query", "location": "query",
"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`.", "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" "type": "string"
}, },
"projectId": {
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
"type": "string",
"location": "path"
},
"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": { "endTime": {
"description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.", "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
"format": "google-datetime", "format": "google-datetime",
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
"startTime": { "pageToken": {
"description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.", "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.",
"format": "google-datetime",
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
"pageToken": { "startTime": {
"location": "query", "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.", "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
"format": "google-datetime",
"type": "string" "type": "string"
}, },
"pageSize": { "pageSize": {
@@ -82,38 +77,26 @@
"type": "integer" "type": "integer"
}, },
"view": { "view": {
"description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
"type": "string",
"location": "query",
"enum": [ "enum": [
"VIEW_TYPE_UNSPECIFIED", "VIEW_TYPE_UNSPECIFIED",
"MINIMAL", "MINIMAL",
"ROOTSPAN", "ROOTSPAN",
"COMPLETE" "COMPLETE"
] ],
}, "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
"orderBy": { "type": "string",
"location": "query", "location": "query"
"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"
},
"projectId": {
"location": "path",
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
"type": "string"
} }
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly" "https://www.googleapis.com/auth/trace.readonly"
] ],
"flatPath": "v1/projects/{projectId}/traces",
"id": "cloudtrace.projects.traces.list",
"path": "v1/projects/{projectId}/traces"
}, },
"get": { "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": { "response": {
"$ref": "Trace" "$ref": "Trace"
}, },
@@ -122,6 +105,10 @@
"traceId" "traceId"
], ],
"httpMethod": "GET", "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
],
"parameters": { "parameters": {
"projectId": { "projectId": {
"location": "path", "location": "path",
@@ -130,58 +117,87 @@
"type": "string" "type": "string"
}, },
"traceId": { "traceId": {
"location": "path",
"description": "ID of the trace to return.", "description": "ID of the trace to return.",
"required": true, "required": true,
"type": "string" "type": "string",
"location": "path"
} }
}, },
"scopes": [ "flatPath": "v1/projects/{projectId}/traces/{traceId}",
"https://www.googleapis.com/auth/cloud-platform", "path": "v1/projects/{projectId}/traces/{traceId}",
"https://www.googleapis.com/auth/trace.readonly" "id": "cloudtrace.projects.traces.get",
] "description": "Gets a single trace by its ID."
} }
} }
} }
},
"methods": {
"patchTraces": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"projectId"
],
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
"parameters": {
"projectId": {
"location": "path",
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
"type": "string"
}
},
"flatPath": "v1/projects/{projectId}/traces",
"path": "v1/projects/{projectId}/traces",
"id": "cloudtrace.projects.patchTraces",
"request": {
"$ref": "Traces"
},
"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."
}
} }
} }
}, },
"parameters": { "parameters": {
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": { "fields": {
"description": "Selector specifying which fields to include in a partial response.", "description": "Selector specifying which fields to include in a partial response.",
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"callback": { "callback": {
"description": "JSONP", "description": "JSONP",
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
"$.xgafv": { "oauth_token": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query", "location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"$.xgafv": {
"enum": [ "enum": [
"1", "1",
"2" "2"
], ],
"description": "V1 error format.", "description": "V1 error format.",
"type": "string" "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
}, },
"alt": { "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.", "description": "Data format for response.",
"default": "json", "default": "json",
"enum": [ "enum": [
@@ -189,39 +205,24 @@
"media", "media",
"proto" "proto"
], ],
"type": "string" "type": "string",
}, "enumDescriptions": [
"key": { "Responses with Content-Type of application/json",
"location": "query", "Media download with context-dependent Content-Type",
"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.", "Responses with Content-Type of application/x-protobuf"
"type": "string" ],
"location": "query"
}, },
"access_token": { "access_token": {
"description": "OAuth access token.", "description": "OAuth access token.",
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
"quotaUser": { "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.",
"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": "string"
},
"pp": {
"description": "Pretty-print response.",
"type": "boolean",
"default": "true",
"location": "query" "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": { "upload_protocol": {
"location": "query", "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -232,37 +233,40 @@
"description": "Returns response with indentations and line breaks.", "description": "Returns response with indentations and line breaks.",
"type": "boolean", "type": "boolean",
"default": "true" "default": "true"
},
"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", "version": "v1",
"baseUrl": "https://cloudtrace.googleapis.com/", "baseUrl": "https://cloudtrace.googleapis.com/",
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"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", "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. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.\n",
"servicePath": "", "servicePath": "",
"basePath": "", "basePath": "",
"id": "cloudtrace:v1", "revision": "20181004",
"documentationLink": "https://cloud.google.com/trace", "documentationLink": "https://cloud.google.com/trace",
"revision": "20171202", "id": "cloudtrace:v1",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"version_module": true, "version_module": true,
"schemas": { "schemas": {
"TraceSpan": { "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",
"properties": { "properties": {
"labels": { "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": { "additionalProperties": {
"type": "string" "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": { "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.", "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\nGoogle Cloud Platform Console.\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" "type": "string"
}, },
"spanId": { "spanId": {
"description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.", "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace. For example, `2205310701640571284`.",
"format": "uint64", "format": "uint64",
"type": "string" "type": "string"
}, },
@@ -282,28 +286,30 @@
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"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": [ "enum": [
"SPAN_KIND_UNSPECIFIED", "SPAN_KIND_UNSPECIFIED",
"RPC_SERVER", "RPC_SERVER",
"RPC_CLIENT" "RPC_CLIENT"
], ],
"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.", "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" "type": "string",
"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."
]
} }
}, },
"id": "TraceSpan" "id": "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"
}, },
"ListTracesResponse": { "ListTracesResponse": {
"description": "The response message for the `ListTraces` method.", "description": "The response message for the `ListTraces` method.",
"type": "object", "type": "object",
"properties": { "properties": {
"traces": { "traces": {
"description": "List of trace records returned.", "description": "List of trace records as specified by the view parameter.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "Trace" "$ref": "Trace"
@@ -323,8 +329,6 @@
"id": "Empty" "id": "Empty"
}, },
"Trace": { "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": { "properties": {
"projectId": { "projectId": {
"description": "Project ID of the Cloud project where the trace data is stored.", "description": "Project ID of the Cloud project where the trace data is stored.",
@@ -338,15 +342,15 @@
} }
}, },
"traceId": { "traceId": {
"description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string.", "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string. For example,\n`382d4f4c6b7bb2f4a972559d9085001d`.",
"type": "string" "type": "string"
} }
}, },
"id": "Trace" "id": "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"
}, },
"Traces": { "Traces": {
"description": "List of new or updated traces.",
"type": "object",
"properties": { "properties": {
"traces": { "traces": {
"description": "List of traces.", "description": "List of traces.",
@@ -356,29 +360,14 @@
} }
} }
}, },
"id": "Traces" "id": "Traces",
"description": "List of new or updated traces.",
"type": "object"
} }
}, },
"protocol": "rest",
"icons": { "icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif" "x16": "http://www.google.com/images/icons/product/search-16.gif"
}, }
"protocol": "rest",
"canonicalName": "Cloud Trace",
"auth": {
"oauth2": {
"scopes": {
"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"
},
"https://www.googleapis.com/auth/trace.readonly": {
"description": "Read Trace data for a project or application"
}
}
}
},
"rootUrl": "https://cloudtrace.googleapis.com/"
} }

467
etc/api/cloudtrace/v2/cloudtrace-api.json
View File

@@ -1,63 +1,66 @@
{ {
"id": "cloudtrace:v2",
"documentationLink": "https://cloud.google.com/trace",
"revision": "20171202",
"discoveryVersion": "v1",
"version_module": true, "version_module": true,
"schemas": { "schemas": {
"Links": { "Links": {
"description": "A collection of links, which are references from this span to a span\nin the same or different trace.", "description": "A collection of links, which are references from this span to a span\nin the same or different trace.",
"type": "object", "type": "object",
"properties": { "properties": {
"droppedLinksCount": {
"description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
"format": "int32",
"type": "integer"
},
"link": { "link": {
"description": "A collection of links.", "description": "A collection of links.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "Link" "$ref": "Link"
} }
},
"droppedLinksCount": {
"description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
"format": "int32",
"type": "integer"
} }
}, },
"id": "Links" "id": "Links"
}, },
"TruncatableString": {
"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",
"description": "Represents a string that might be shortened to a specified length.",
"type": "object"
},
"StackTrace": { "StackTrace": {
"description": "A call stack appearing in a trace.", "description": "A call stack appearing in a trace.",
"type": "object", "type": "object",
"properties": { "properties": {
"stackFrames": {
"$ref": "StackFrames",
"description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
},
"stackTraceHashId": { "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`.", "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", "format": "int64",
"type": "string" "type": "string"
},
"stackFrames": {
"$ref": "StackFrames",
"description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
} }
}, },
"id": "StackTrace" "id": "StackTrace"
}, },
"TruncatableString": { "TimeEvent": {
"description": "Represents a string that might be shortened to a specified length.", "description": "A time-stamped annotation or message event in the Span.",
"type": "object", "type": "object",
"properties": { "properties": {
"value": { "time": {
"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.", "description": "The timestamp indicating the time the event occurred.",
"format": "google-datetime",
"type": "string" "type": "string"
}, },
"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"
}
},
"id": "TruncatableString"
},
"TimeEvent": {
"properties": {
"annotation": { "annotation": {
"description": "Text annotation with a set of attributes.", "description": "Text annotation with a set of attributes.",
"$ref": "Annotation" "$ref": "Annotation"
@@ -65,40 +68,14 @@
"messageEvent": { "messageEvent": {
"$ref": "MessageEvent", "$ref": "MessageEvent",
"description": "An event describing a message sent/received between Spans." "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": "TimeEvent", "id": "TimeEvent"
"description": "A time-stamped annotation or message event in the Span.",
"type": "object"
}, },
"MessageEvent": { "MessageEvent": {
"description": "An event describing a message sent/received between Spans.", "description": "An event describing a message sent/received between Spans.",
"type": "object", "type": "object",
"properties": { "properties": {
"uncompressedSizeBytes": {
"description": "The number of uncompressed bytes sent or received.",
"format": "int64",
"type": "string"
},
"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."
]
},
"id": { "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.", "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", "format": "int64",
@@ -108,6 +85,25 @@
"description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.", "description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.",
"format": "int64", "format": "int64",
"type": "string" "type": "string"
},
"uncompressedSizeBytes": {
"description": "The number of uncompressed bytes sent or received.",
"format": "int64",
"type": "string"
},
"type": {
"enumDescriptions": [
"Unknown event type.",
"Indicates a sent message.",
"Indicates a received message."
],
"enum": [
"TYPE_UNSPECIFIED",
"SENT",
"RECEIVED"
],
"description": "Type of MessageEvent. Indicates whether the message was sent or\nreceived.",
"type": "string"
} }
}, },
"id": "MessageEvent" "id": "MessageEvent"
@@ -116,35 +112,35 @@
"description": "Represents a single stack frame in a stack trace.", "description": "Represents a single stack frame in a stack trace.",
"type": "object", "type": "object",
"properties": { "properties": {
"functionName": { "fileName": {
"description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes).", "$ref": "TruncatableString",
"description": "The name of the source file where the function call appears (up to 256\nbytes)."
},
"sourceVersion": {
"description": "The version of the deployed source code (up to 128 bytes).",
"$ref": "TruncatableString" "$ref": "TruncatableString"
}, },
"originalFunctionName": {
"$ref": "TruncatableString",
"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)."
},
"functionName": {
"$ref": "TruncatableString",
"description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes)."
},
"lineNumber": { "lineNumber": {
"description": "The line number in `file_name` where the function call appears.", "description": "The line number in `file_name` where the function call appears.",
"format": "int64", "format": "int64",
"type": "string" "type": "string"
}, },
"loadModule": { "loadModule": {
"description": "The binary module from where the code was loaded.", "$ref": "Module",
"$ref": "Module" "description": "The binary module from where the code was loaded."
}, },
"columnNumber": { "columnNumber": {
"description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.", "description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.",
"format": "int64", "format": "int64",
"type": "string" "type": "string"
},
"fileName": {
"$ref": "TruncatableString",
"description": "The name of the source file where the function call appears (up to 256\nbytes)."
},
"sourceVersion": {
"$ref": "TruncatableString",
"description": "The version of the deployed source code (up to 128 bytes)."
},
"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"
} }
}, },
"id": "StackFrame" "id": "StackFrame"
@@ -152,17 +148,17 @@
"Link": { "Link": {
"properties": { "properties": {
"type": { "type": {
"enum": [
"TYPE_UNSPECIFIED",
"CHILD_LINKED_SPAN",
"PARENT_LINKED_SPAN"
],
"description": "The relationship of the current span relative to the linked span.", "description": "The relationship of the current span relative to the linked span.",
"type": "string", "type": "string",
"enumDescriptions": [ "enumDescriptions": [
"The relationship of the two spans is unknown.", "The relationship of the two spans is unknown.",
"The linked span is a child of the current span.", "The linked span is a child of the current span.",
"The linked span is a parent of the current span." "The linked span is a parent of the current span."
],
"enum": [
"TYPE_UNSPECIFIED",
"CHILD_LINKED_SPAN",
"PARENT_LINKED_SPAN"
] ]
}, },
"traceId": { "traceId": {
@@ -170,8 +166,8 @@
"type": "string" "type": "string"
}, },
"attributes": { "attributes": {
"$ref": "Attributes", "description": "A set of attributes on the link. You have have up to 32 attributes per\nlink.",
"description": "A set of attributes on the link. You have have up to 32 attributes per\nlink." "$ref": "Attributes"
}, },
"spanId": { "spanId": {
"description": "The [SPAN_ID] for a span within a trace.", "description": "The [SPAN_ID] for a span within a trace.",
@@ -187,29 +183,29 @@
"type": "object", "type": "object",
"properties": { "properties": {
"description": { "description": {
"$ref": "TruncatableString", "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes.",
"description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes." "$ref": "TruncatableString"
}, },
"attributes": { "attributes": {
"$ref": "Attributes", "description": "A set of attributes on the annotation. You can have up to 4 attributes\nper Annotation.",
"description": "A set of attributes on the annotation. You can have up to 4 attributes\nper Annotation." "$ref": "Attributes"
} }
}, },
"id": "Annotation" "id": "Annotation"
}, },
"StackFrames": { "StackFrames": {
"properties": { "properties": {
"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": { "frame": {
"description": "Stack frames in this call stack.", "description": "Stack frames in this call stack.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "StackFrame" "$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"
} }
}, },
"id": "StackFrames", "id": "StackFrames",
@@ -241,21 +237,23 @@
"id": "TimeEvents" "id": "TimeEvents"
}, },
"Module": { "Module": {
"description": "Binary module.",
"type": "object",
"properties": { "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": { "buildId": {
"$ref": "TruncatableString", "$ref": "TruncatableString",
"description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)." "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)."
},
"module": {
"description": "For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes).",
"$ref": "TruncatableString"
} }
}, },
"id": "Module" "id": "Module",
"description": "Binary module.",
"type": "object"
}, },
"Status": { "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": { "properties": {
"message": { "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.", "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.",
@@ -265,11 +263,11 @@
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array", "type": "array",
"items": { "items": {
"type": "object",
"additionalProperties": { "additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.", "description": "Properties of the object. Contains field @type with type URL.",
"type": "any" "type": "any"
}, }
"type": "object"
} }
}, },
"code": { "code": {
@@ -278,9 +276,7 @@
"type": "integer" "type": "integer"
} }
}, },
"id": "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"
}, },
"BatchWriteSpansRequest": { "BatchWriteSpansRequest": {
"properties": { "properties": {
@@ -296,41 +292,13 @@
"description": "The request message for the `BatchWriteSpans` method.", "description": "The request message for the `BatchWriteSpans` method.",
"type": "object" "type": "object"
}, },
"Empty": {
"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 `{}`.",
"type": "object"
},
"Span": { "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—there may be\ngaps or overlaps between spans in a trace.", "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—there may be\ngaps or overlaps between spans in a trace.",
"type": "object", "type": "object",
"properties": { "properties": {
"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"
},
"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"
},
"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"
},
"displayName": {
"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.",
"$ref": "TruncatableString"
},
"timeEvents": {
"description": "A set of time events. You can have up to 32 annotations and 128 message\nevents per span.",
"$ref": "TimeEvents"
},
"links": { "links": {
"$ref": "Links", "description": "Links associated with the span. You can have up to 128 links per Span.",
"description": "Links associated with the span. You can have up to 128 links per Span." "$ref": "Links"
}, },
"attributes": { "attributes": {
"$ref": "Attributes", "$ref": "Attributes",
@@ -350,8 +318,8 @@
"type": "boolean" "type": "boolean"
}, },
"status": { "status": {
"$ref": "Status", "description": "An optional final status for this span.",
"description": "An optional final status for this span." "$ref": "Status"
}, },
"name": { "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.", "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.",
@@ -360,31 +328,61 @@
"stackTrace": { "stackTrace": {
"$ref": "StackTrace", "$ref": "StackTrace",
"description": "Stack trace captured at the start of the span." "description": "Stack trace captured at the start of the span."
},
"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"
},
"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"
},
"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"
},
"displayName": {
"$ref": "TruncatableString",
"description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\nGoogle Cloud Platform Console.\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."
},
"timeEvents": {
"$ref": "TimeEvents",
"description": "A set of time events. You can have up to 32 annotations and 128 message\nevents per span."
} }
}, },
"id": "Span" "id": "Span"
}, },
"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"
},
"AttributeValue": { "AttributeValue": {
"description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
"type": "object",
"properties": { "properties": {
"intValue": {
"description": "A 64-bit signed integer.",
"format": "int64",
"type": "string"
},
"stringValue": { "stringValue": {
"description": "A string up to 256 bytes long.", "$ref": "TruncatableString",
"$ref": "TruncatableString" "description": "A string up to 256 bytes long."
}, },
"boolValue": { "boolValue": {
"description": "A Boolean value represented by `true` or `false`.", "description": "A Boolean value represented by `true` or `false`.",
"type": "boolean" "type": "boolean"
},
"intValue": {
"description": "A 64-bit signed integer.",
"format": "int64",
"type": "string"
} }
}, },
"id": "AttributeValue", "id": "AttributeValue"
"description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
"type": "object"
}, },
"Attributes": { "Attributes": {
"description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
"type": "object",
"properties": { "properties": {
"droppedAttributesCount": { "droppedAttributesCount": {
"description": "The number of attributes that were discarded. Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.", "description": "The number of attributes that were discarded. Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.",
@@ -399,25 +397,23 @@
"type": "object" "type": "object"
} }
}, },
"id": "Attributes", "id": "Attributes"
"description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
"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", "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 Trace", "canonicalName": "Cloud Trace",
"auth": { "auth": {
"oauth2": { "oauth2": {
"scopes": { "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": { "https://www.googleapis.com/auth/trace.append": {
"description": "Write Trace data for a project or application" "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"
} }
} }
} }
@@ -433,144 +429,127 @@
"projects": { "projects": {
"resources": { "resources": {
"traces": { "traces": {
"methods": {
"batchWrite": {
"request": {
"$ref": "BatchWriteSpansRequest"
},
"description": "Sends new spans to new or existing traces. You cannot update\nexisting spans.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
"parameters": {
"name": {
"location": "path",
"description": "Required. The name of the project where the spans belong. The format is\n`projects/[PROJECT_ID]`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$"
}
},
"flatPath": "v2/projects/{projectsId}/traces:batchWrite",
"path": "v2/{+name}/traces:batchWrite",
"id": "cloudtrace.projects.traces.batchWrite"
}
},
"resources": { "resources": {
"spans": { "spans": {
"methods": { "methods": {
"create": { "createSpan": {
"response": { "description": "Creates a new span.",
"request": {
"$ref": "Span" "$ref": "Span"
}, },
"httpMethod": "POST",
"parameterOrder": [ "parameterOrder": [
"name" "name"
], ],
"httpMethod": "POST", "response": {
"$ref": "Span"
},
"parameters": { "parameters": {
"name": { "name": {
"pattern": "^projects/[^/]+/traces/[^/]+$",
"location": "path",
"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.", "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.",
"required": true, "required": true,
"type": "string" "type": "string",
"pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$",
"location": "path"
} }
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append" "https://www.googleapis.com/auth/trace.append"
], ],
"flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans", "flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}",
"path": "v2/{+name}/spans", "id": "cloudtrace.projects.traces.spans.createSpan",
"id": "cloudtrace.projects.traces.spans.create", "path": "v2/{+name}"
"request": {
"$ref": "Span"
},
"description": "Creates a new span."
} }
} }
} }
},
"methods": {
"batchWrite": {
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The name of the project where the spans belong. The format is\n`projects/[PROJECT_ID]`.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
"flatPath": "v2/projects/{projectsId}/traces:batchWrite",
"id": "cloudtrace.projects.traces.batchWrite",
"path": "v2/{+name}/traces:batchWrite",
"request": {
"$ref": "BatchWriteSpansRequest"
},
"description": "Sends new spans to new or existing traces. You cannot update\nexisting spans."
}
} }
} }
} }
} }
}, },
"parameters": { "parameters": {
"quotaUser": { "upload_protocol": {
"location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"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": "string" "location": "query"
}, },
"pp": { "prettyPrint": {
"description": "Pretty-print response.", "description": "Returns response with indentations and line breaks.",
"type": "boolean", "type": "boolean",
"default": "true", "default": "true",
"location": "query" "location": "query"
}, },
"bearer_token": { "quotaUser": {
"description": "OAuth bearer token.", "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": "string",
"location": "query" "location": "query"
}, },
"oauth_token": { "fields": {
"location": "query", "location": "query",
"description": "OAuth 2.0 token for the current user.", "description": "Selector specifying which fields to include in a partial response.",
"type": "string" "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": { "uploadType": {
"location": "query", "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string" "type": "string"
}, },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"callback": { "callback": {
"description": "JSONP", "description": "JSONP",
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"$.xgafv": { "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [ "enum": [
"1", "1",
"2" "2"
], ],
"description": "V1 error format.", "description": "V1 error format.",
"type": "string" "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
}, },
"alt": { "alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"enumDescriptions": [ "enumDescriptions": [
"Responses with Content-Type of application/json", "Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type", "Media download with context-dependent Content-Type",
@@ -578,23 +557,33 @@
], ],
"location": "query", "location": "query",
"description": "Data format for response.", "description": "Data format for response.",
"default": "json" "default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string"
}, },
"key": { "access_token": {
"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.", "description": "OAuth access token.",
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
"access_token": { "key": {
"location": "query", "location": "query",
"description": "OAuth access token.", "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" "type": "string"
} }
}, },
"version": "v2", "version": "v2",
"baseUrl": "https://cloudtrace.googleapis.com/", "baseUrl": "https://cloudtrace.googleapis.com/",
"servicePath": "", "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", "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. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.\n",
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"basePath": "" "basePath": "",
"id": "cloudtrace:v2",
"documentationLink": "https://cloud.google.com/trace",
"revision": "20181004",
"discoveryVersion": "v1"
} }

702
etc/api/composer/v1/composer-api.json Normal file
View File

File diff suppressed because one or more lines are too long

704
etc/api/composer/v1beta1/composer-api.json Normal file
View File

File diff suppressed because one or more lines are too long

13921
etc/api/compute/alpha/compute-api.json
View File

File diff suppressed because it is too large Load Diff

8686
etc/api/compute/beta/compute-api.json
View File

File diff suppressed because it is too large Load Diff

6654
etc/api/compute/v1/compute-api.json
View File

File diff suppressed because it is too large Load Diff

5113
etc/api/container/v1/container-api.json
View File

File diff suppressed because it is too large Load Diff

5615
etc/api/container/v1beta1/container-api.json
View File

File diff suppressed because it is too large Load Diff

4152
etc/api/content/v2/content-api.json
View File

File diff suppressed because it is too large Load Diff

1617
etc/api/content/v2sandbox/content-api.json
View File

File diff suppressed because it is too large Load Diff

378
etc/api/customsearch/v1/customsearch-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/vjsLOntBAplI6gHuETouIyrKBJI\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/2iWcS6EAVqIO3py2_4I7tTajAB4\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "customsearch:v1", "id": "customsearch:v1",
"name": "customsearch", "name": "customsearch",
"version": "v1", "version": "v1",
"revision": "20170615", "revision": "20181001",
"title": "CustomSearch API", "title": "CustomSearch API",
"description": "Searches over a website or collection of websites", "description": "Searches over a website or collection of websites",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -27,11 +27,9 @@
"description": "Data format for the response.", "description": "Data format for the response.",
"default": "json", "default": "json",
"enum": [ "enum": [
"atom",
"json" "json"
], ],
"enumDescriptions": [ "enumDescriptions": [
"Responses with Content-Type of application/atom+xml",
"Responses with Content-Type of application/json" "Responses with Content-Type of application/json"
], ],
"location": "query" "location": "query"
@@ -59,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -550,15 +548,17 @@
}, },
"imgDominantColor": { "imgDominantColor": {
"type": "string", "type": "string",
"description": "Returns images of a specific dominant color: yellow, green, teal, blue, purple, pink, white, gray, black and brown.", "description": "Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.",
"enum": [ "enum": [
"black", "black",
"blue", "blue",
"brown", "brown",
"gray", "gray",
"green", "green",
"orange",
"pink", "pink",
"purple", "purple",
"red",
"teal", "teal",
"white", "white",
"yellow" "yellow"
@@ -569,8 +569,10 @@
"brown", "brown",
"gray", "gray",
"green", "green",
"orange",
"pink", "pink",
"purple", "purple",
"red",
"teal", "teal",
"white", "white",
"yellow" "yellow"
@@ -741,13 +743,15 @@
"description": "Search safety level", "description": "Search safety level",
"default": "off", "default": "off",
"enum": [ "enum": [
"active",
"high", "high",
"medium", "medium",
"off" "off"
], ],
"enumDescriptions": [ "enumDescriptions": [
"Enables highest level of safe search filtering.", "Enables safe search filtering.",
"Enables moderate safe search filtering.", "(Deprecated) Same as active.",
"(Deprecated) Same as active.",
"Disables safe search filtering." "Disables safe search filtering."
], ],
"location": "query" "location": "query"
@@ -800,6 +804,362 @@
"$ref": "Search" "$ref": "Search"
} }
} }
},
"resources": {
"siterestrict": {
"methods": {
"list": {
"id": "search.cse.siterestrict.list",
"path": "v1/siterestrict",
"httpMethod": "GET",
"description": "Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. Uses a small set of url patterns.",
"parameters": {
"c2coff": {
"type": "string",
"description": "Turns off the translation between zh-CN and zh-TW.",
"location": "query"
},
"cr": {
"type": "string",
"description": "Country restrict(s).",
"location": "query"
},
"cx": {
"type": "string",
"description": "The custom search engine ID to scope this search query",
"location": "query"
},
"dateRestrict": {
"type": "string",
"description": "Specifies all search results are from a time period",
"location": "query"
},
"exactTerms": {
"type": "string",
"description": "Identifies a phrase that all documents in the search results must contain",
"location": "query"
},
"excludeTerms": {
"type": "string",
"description": "Identifies a word or phrase that should not appear in any documents in the search results",
"location": "query"
},
"fileType": {
"type": "string",
"description": "Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...",
"location": "query"
},
"filter": {
"type": "string",
"description": "Controls turning on or off the duplicate content filter.",
"enum": [
"0",
"1"
],
"enumDescriptions": [
"Turns off duplicate content filter.",
"Turns on duplicate content filter."
],
"location": "query"
},
"gl": {
"type": "string",
"description": "Geolocation of end user.",
"location": "query"
},
"googlehost": {
"type": "string",
"description": "The local Google domain to use to perform the search.",
"location": "query"
},
"highRange": {
"type": "string",
"description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
"location": "query"
},
"hl": {
"type": "string",
"description": "Sets the user interface language.",
"location": "query"
},
"hq": {
"type": "string",
"description": "Appends the extra query terms to the query.",
"location": "query"
},
"imgColorType": {
"type": "string",
"description": "Returns black and white, grayscale, or color images: mono, gray, and color.",
"enum": [
"color",
"gray",
"mono"
],
"enumDescriptions": [
"color",
"gray",
"mono"
],
"location": "query"
},
"imgDominantColor": {
"type": "string",
"description": "Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.",
"enum": [
"black",
"blue",
"brown",
"gray",
"green",
"orange",
"pink",
"purple",
"red",
"teal",
"white",
"yellow"
],
"enumDescriptions": [
"black",
"blue",
"brown",
"gray",
"green",
"orange",
"pink",
"purple",
"red",
"teal",
"white",
"yellow"
],
"location": "query"
},
"imgSize": {
"type": "string",
"description": "Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.",
"enum": [
"huge",
"icon",
"large",
"medium",
"small",
"xlarge",
"xxlarge"
],
"enumDescriptions": [
"huge",
"icon",
"large",
"medium",
"small",
"xlarge",
"xxlarge"
],
"location": "query"
},
"imgType": {
"type": "string",
"description": "Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.",
"enum": [
"clipart",
"face",
"lineart",
"news",
"photo"
],
"enumDescriptions": [
"clipart",
"face",
"lineart",
"news",
"photo"
],
"location": "query"
},
"linkSite": {
"type": "string",
"description": "Specifies that all search results should contain a link to a particular URL",
"location": "query"
},
"lowRange": {
"type": "string",
"description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
"location": "query"
},
"lr": {
"type": "string",
"description": "The language restriction for the search results",
"enum": [
"lang_ar",
"lang_bg",
"lang_ca",
"lang_cs",
"lang_da",
"lang_de",
"lang_el",
"lang_en",
"lang_es",
"lang_et",
"lang_fi",
"lang_fr",
"lang_hr",
"lang_hu",
"lang_id",
"lang_is",
"lang_it",
"lang_iw",
"lang_ja",
"lang_ko",
"lang_lt",
"lang_lv",
"lang_nl",
"lang_no",
"lang_pl",
"lang_pt",
"lang_ro",
"lang_ru",
"lang_sk",
"lang_sl",
"lang_sr",
"lang_sv",
"lang_tr",
"lang_zh-CN",
"lang_zh-TW"
],
"enumDescriptions": [
"Arabic",
"Bulgarian",
"Catalan",
"Czech",
"Danish",
"German",
"Greek",
"English",
"Spanish",
"Estonian",
"Finnish",
"French",
"Croatian",
"Hungarian",
"Indonesian",
"Icelandic",
"Italian",
"Hebrew",
"Japanese",
"Korean",
"Lithuanian",
"Latvian",
"Dutch",
"Norwegian",
"Polish",
"Portuguese",
"Romanian",
"Russian",
"Slovak",
"Slovenian",
"Serbian",
"Swedish",
"Turkish",
"Chinese (Simplified)",
"Chinese (Traditional)"
],
"location": "query"
},
"num": {
"type": "integer",
"description": "Number of search results to return",
"default": "10",
"format": "uint32",
"location": "query"
},
"orTerms": {
"type": "string",
"description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms",
"location": "query"
},
"q": {
"type": "string",
"description": "Query",
"required": true,
"location": "query"
},
"relatedSite": {
"type": "string",
"description": "Specifies that all search results should be pages that are related to the specified URL",
"location": "query"
},
"rights": {
"type": "string",
"description": "Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.",
"location": "query"
},
"safe": {
"type": "string",
"description": "Search safety level",
"default": "off",
"enum": [
"high",
"medium",
"off"
],
"enumDescriptions": [
"Enables highest level of safe search filtering.",
"Enables moderate safe search filtering.",
"Disables safe search filtering."
],
"location": "query"
},
"searchType": {
"type": "string",
"description": "Specifies the search type: image.",
"enum": [
"image"
],
"enumDescriptions": [
"custom image search"
],
"location": "query"
},
"siteSearch": {
"type": "string",
"description": "Specifies all search results should be pages from a given site",
"location": "query"
},
"siteSearchFilter": {
"type": "string",
"description": "Controls whether to include or exclude results from the site named in the as_sitesearch parameter",
"enum": [
"e",
"i"
],
"enumDescriptions": [
"exclude",
"include"
],
"location": "query"
},
"sort": {
"type": "string",
"description": "The sort expression to apply to the results",
"location": "query"
},
"start": {
"type": "integer",
"description": "The index of the first result to return",
"format": "uint32",
"location": "query"
}
},
"parameterOrder": [
"q"
],
"response": {
"$ref": "Search"
}
}
}
}
} }
} }
} }

7519
etc/api/dataflow/v1b3/dataflow-api.json
View File

File diff suppressed because it is too large Load Diff

4232
etc/api/dataproc/v1/dataproc-api.json
View File

File diff suppressed because it is too large Load Diff

3992
etc/api/dataproc/v1beta2/dataproc-api.json
View File

File diff suppressed because it is too large Load Diff

2662
etc/api/datastore/v1/datastore-api.json
View File

File diff suppressed because it is too large Load Diff

717
etc/api/datastore/v1beta1/datastore-api.json
View File

@@ -1,5 +1,4 @@
{ {
"title": "Google Cloud Datastore API",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"ownerName": "Google", "ownerName": "Google",
"version_module": true, "version_module": true,
@@ -7,121 +6,94 @@
"projects": { "projects": {
"methods": { "methods": {
"export": { "export": {
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"projectId"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"parameters": {
"projectId": {
"description": "Project ID against which to make the request.",
"required": true,
"type": "string",
"location": "path"
}
},
"flatPath": "v1beta1/projects/{projectId}:export",
"path": "v1beta1/projects/{projectId}:export",
"id": "datastore.projects.export",
"request": { "request": {
"$ref": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest" "$ref": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest"
}, },
"description": "Exports a copy of all or a subset of entities from Google Cloud Datastore\nto another storage system, such as Google Cloud Storage. Recent updates to\nentities may not be reflected in the export. The export occurs in the\nbackground and its progress can be monitored and managed via the\nOperation resource that is created. The output of an export may only be\nused once the associated operation is done. If an export operation is\ncancelled before completion it may leave partial data behind in Google\nCloud Storage.", "description": "Exports a copy of all or a subset of entities from Google Cloud Datastore\nto another storage system, such as Google Cloud Storage. Recent updates to\nentities may not be reflected in the export. The export occurs in the\nbackground and its progress can be monitored and managed via the\nOperation resource that is created. The output of an export may only be\nused once the associated operation is done. If an export operation is\ncancelled before completion it may leave partial data behind in Google\nCloud Storage."
"response": {
"$ref": "GoogleLongrunningOperation"
},
"parameterOrder": [
"projectId"
],
"httpMethod": "POST",
"parameters": {
"projectId": {
"description": "Project ID against which to make the request.",
"required": true,
"type": "string",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"flatPath": "v1beta1/projects/{projectId}:export",
"path": "v1beta1/projects/{projectId}:export",
"id": "datastore.projects.export"
}, },
"import": { "import": {
"flatPath": "v1beta1/projects/{projectId}:import",
"id": "datastore.projects.import",
"path": "v1beta1/projects/{projectId}:import",
"request": {
"$ref": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
},
"description": "Imports entities into Google Cloud Datastore. Existing entities with the\nsame key are overwritten. The import occurs in the background and its\nprogress can be monitored and managed via the Operation resource that is\ncreated. If an ImportEntities operation is cancelled, it is possible\nthat a subset of the data has already been imported to Cloud Datastore.",
"httpMethod": "POST",
"parameterOrder": [
"projectId"
],
"response": { "response": {
"$ref": "GoogleLongrunningOperation" "$ref": "GoogleLongrunningOperation"
}, },
"parameterOrder": [
"projectId"
],
"httpMethod": "POST",
"parameters": { "parameters": {
"projectId": { "projectId": {
"location": "path",
"description": "Project ID against which to make the request.", "description": "Project ID against which to make the request.",
"required": true, "required": true,
"type": "string", "type": "string"
"location": "path"
} }
}, },
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore" "https://www.googleapis.com/auth/datastore"
] ],
"flatPath": "v1beta1/projects/{projectId}:import",
"path": "v1beta1/projects/{projectId}:import",
"id": "datastore.projects.import",
"description": "Imports entities into Google Cloud Datastore. Existing entities with the\nsame key are overwritten. The import occurs in the background and its\nprogress can be monitored and managed via the Operation resource that is\ncreated. If an ImportEntities operation is cancelled, it is possible\nthat a subset of the data has already been imported to Cloud Datastore.",
"request": {
"$ref": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
}
} }
} }
} }
}, },
"parameters": { "parameters": {
"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": { "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.", "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" "type": "string",
"location": "query"
}, },
"access_token": { "access_token": {
"location": "query", "location": "query",
"description": "OAuth access token.", "description": "OAuth access token.",
"type": "string" "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"
},
"quotaUser": { "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.", "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": "string",
"location": "query" "location": "query"
}, },
"pp": { "uploadType": {
"location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"description": "Pretty-print response.", "type": "string",
"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": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query" "location": "query"
}, },
"fields": { "fields": {
@@ -129,16 +101,6 @@
"type": "string", "type": "string",
"location": "query" "location": "query"
}, },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"$.xgafv": { "$.xgafv": {
"enumDescriptions": [ "enumDescriptions": [
"v1 error format", "v1 error format",
@@ -151,45 +113,105 @@
], ],
"description": "V1 error format.", "description": "V1 error format.",
"type": "string" "type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"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"
} }
}, },
"schemas": { "schemas": {
"GoogleLongrunningOperation": { "GoogleDatastoreAdminV1IndexOperationMetadata": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "description": "Metadata for Index operations.",
"type": "object", "type": "object",
"properties": { "properties": {
"done": { "progressEntities": {
"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.", "$ref": "GoogleDatastoreAdminV1Progress",
"type": "boolean" "description": "An estimate of the number of entities processed."
}, },
"response": { "indexId": {
"additionalProperties": { "description": "The index resource ID that this operation is acting on.",
"description": "Properties of the object. Contains field @type with type URL.", "type": "string"
"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": { "common": {
"type": "string", "description": "Metadata common to all Datastore Admin operations.",
"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`." "$ref": "GoogleDatastoreAdminV1CommonMetadata"
},
"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\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"
} }
}, },
"id": "GoogleLongrunningOperation" "id": "GoogleDatastoreAdminV1IndexOperationMetadata"
},
"GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
"description": "Metadata for ImportEntities operations.",
"type": "object",
"properties": {
"common": {
"description": "Metadata common to all Datastore Admin operations.",
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
},
"progressBytes": {
"description": "An estimate of the number of bytes processed.",
"$ref": "GoogleDatastoreAdminV1beta1Progress"
},
"inputUrl": {
"description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.",
"type": "string"
},
"entityFilter": {
"description": "Description of which entities are being imported.",
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"progressEntities": {
"description": "An estimate of the number of entities processed.",
"$ref": "GoogleDatastoreAdminV1beta1Progress"
}
},
"id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
},
"GoogleDatastoreAdminV1beta1ImportEntitiesRequest": {
"description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities.",
"type": "object",
"properties": {
"inputUrl": {
"description": "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
"type": "string"
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
"description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported."
},
"labels": {
"description": "Client-assigned labels.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
}, },
"GoogleDatastoreAdminV1beta1EntityFilter": { "GoogleDatastoreAdminV1beta1EntityFilter": {
"description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
"type": "object", "type": "object",
"properties": { "properties": {
"kinds": { "kinds": {
@@ -207,42 +229,62 @@
} }
} }
}, },
"id": "GoogleDatastoreAdminV1beta1EntityFilter", "id": "GoogleDatastoreAdminV1beta1EntityFilter"
"description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']" },
"GoogleLongrunningOperation": {
"properties": {
"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\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"
},
"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"
}
},
"id": "GoogleLongrunningOperation",
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object"
}, },
"GoogleDatastoreAdminV1beta1CommonMetadata": { "GoogleDatastoreAdminV1beta1CommonMetadata": {
"description": "Metadata common to all Datastore Admin operations.", "description": "Metadata common to all Datastore Admin operations.",
"type": "object", "type": "object",
"properties": { "properties": {
"labels": {
"description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"endTime": {
"description": "The time the operation ended, either successfully or otherwise.",
"format": "google-datetime",
"type": "string"
},
"operationType": { "operationType": {
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
"ImportEntities."
],
"enum": [ "enum": [
"OPERATION_TYPE_UNSPECIFIED", "OPERATION_TYPE_UNSPECIFIED",
"EXPORT_ENTITIES", "EXPORT_ENTITIES",
"IMPORT_ENTITIES" "IMPORT_ENTITIES"
], ],
"description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.", "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
"type": "string", "type": "string"
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
"ImportEntities."
]
}, },
"state": { "state": {
"description": "The current state of the Operation.",
"type": "string",
"enumDescriptions": [ "enumDescriptions": [
"Unspecified.", "Unspecified.",
"Request is being prepared for processing.", "Request is being prepared for processing.",
@@ -262,91 +304,50 @@
"SUCCESSFUL", "SUCCESSFUL",
"FAILED", "FAILED",
"CANCELLED" "CANCELLED"
] ],
"description": "The current state of the Operation.",
"type": "string"
}, },
"startTime": { "startTime": {
"description": "The time that work began on the operation.", "description": "The time that work began on the operation.",
"format": "google-datetime", "format": "google-datetime",
"type": "string" "type": "string"
}
},
"id": "GoogleDatastoreAdminV1beta1CommonMetadata"
},
"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."
}
},
"id": "Status"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"properties": {
"common": {
"description": "Metadata common to all Datastore Admin operations.",
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
},
"progressBytes": {
"description": "An estimate of the number of bytes processed.",
"$ref": "GoogleDatastoreAdminV1beta1Progress"
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
"description": "Description of which entities are being exported."
},
"outputUrlPrefix": {
"type": "string",
"description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url."
},
"progressEntities": {
"$ref": "GoogleDatastoreAdminV1beta1Progress",
"description": "An estimate of the number of entities processed."
}
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata",
"description": "Metadata for ExportEntities operations.",
"type": "object"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesRequest": {
"properties": {
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
"description": "Description of what data from the project is included in the export."
},
"outputUrlPrefix": {
"description": "Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield. That value should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.",
"type": "string"
}, },
"labels": { "labels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "Client-assigned labels.", "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
"type": "object" "type": "object"
},
"endTime": {
"description": "The time the operation ended, either successfully or otherwise.",
"format": "google-datetime",
"type": "string"
} }
}, },
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest", "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
"description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", },
"type": "object" "GoogleDatastoreAdminV1EntityFilter": {
"description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
"type": "object",
"properties": {
"kinds": {
"description": "If empty, then this represents all kinds.",
"type": "array",
"items": {
"type": "string"
}
},
"namespaceIds": {
"description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "GoogleDatastoreAdminV1EntityFilter"
}, },
"GoogleDatastoreAdminV1beta1ExportEntitiesResponse": { "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
"description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
@@ -359,58 +360,7 @@
}, },
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse" "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse"
}, },
"GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
"type": "object",
"properties": {
"common": {
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations."
},
"progressBytes": {
"$ref": "GoogleDatastoreAdminV1beta1Progress",
"description": "An estimate of the number of bytes processed."
},
"inputUrl": {
"description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.",
"type": "string"
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
"description": "Description of which entities are being imported."
},
"progressEntities": {
"description": "An estimate of the number of entities processed.",
"$ref": "GoogleDatastoreAdminV1beta1Progress"
}
},
"id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
"description": "Metadata for ImportEntities operations."
},
"GoogleDatastoreAdminV1beta1ImportEntitiesRequest": {
"description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities.",
"type": "object",
"properties": {
"inputUrl": {
"description": "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
"type": "string"
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
"description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Client-assigned labels.",
"type": "object"
}
},
"id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
},
"GoogleDatastoreAdminV1beta1Progress": { "GoogleDatastoreAdminV1beta1Progress": {
"description": "Measures the progress of a particular metric.",
"type": "object",
"properties": { "properties": {
"workEstimated": { "workEstimated": {
"description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.", "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.",
@@ -423,7 +373,233 @@
"type": "string" "type": "string"
} }
}, },
"id": "GoogleDatastoreAdminV1beta1Progress" "id": "GoogleDatastoreAdminV1beta1Progress",
"description": "Measures the progress of a particular metric.",
"type": "object"
},
"GoogleDatastoreAdminV1ExportEntitiesResponse": {
"description": "The response for\ngoogle.datastore.admin.v1.DatastoreAdmin.ExportEntities.",
"type": "object",
"properties": {
"outputUrl": {
"description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
"type": "string"
}
},
"id": "GoogleDatastoreAdminV1ExportEntitiesResponse"
},
"GoogleDatastoreAdminV1ImportEntitiesMetadata": {
"description": "Metadata for ImportEntities operations.",
"type": "object",
"properties": {
"common": {
"description": "Metadata common to all Datastore Admin operations.",
"$ref": "GoogleDatastoreAdminV1CommonMetadata"
},
"progressBytes": {
"description": "An estimate of the number of bytes processed.",
"$ref": "GoogleDatastoreAdminV1Progress"
},
"inputUrl": {
"description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1.ExportEntitiesResponse.output_url field.",
"type": "string"
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1EntityFilter",
"description": "Description of which entities are being imported."
},
"progressEntities": {
"description": "An estimate of the number of entities processed.",
"$ref": "GoogleDatastoreAdminV1Progress"
}
},
"id": "GoogleDatastoreAdminV1ImportEntitiesMetadata"
},
"GoogleDatastoreAdminV1ExportEntitiesMetadata": {
"description": "Metadata for ExportEntities operations.",
"type": "object",
"properties": {
"common": {
"description": "Metadata common to all Datastore Admin operations.",
"$ref": "GoogleDatastoreAdminV1CommonMetadata"
},
"progressBytes": {
"$ref": "GoogleDatastoreAdminV1Progress",
"description": "An estimate of the number of bytes processed."
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1EntityFilter",
"description": "Description of which entities are being exported."
},
"outputUrlPrefix": {
"description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url.",
"type": "string"
},
"progressEntities": {
"$ref": "GoogleDatastoreAdminV1Progress",
"description": "An estimate of the number of entities processed."
}
},
"id": "GoogleDatastoreAdminV1ExportEntitiesMetadata"
},
"GoogleDatastoreAdminV1Progress": {
"description": "Measures the progress of a particular metric.",
"type": "object",
"properties": {
"workCompleted": {
"description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
"format": "int64",
"type": "string"
},
"workEstimated": {
"description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.",
"format": "int64",
"type": "string"
}
},
"id": "GoogleDatastoreAdminV1Progress"
},
"GoogleDatastoreAdminV1CommonMetadata": {
"properties": {
"operationType": {
"description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
"ImportEntities.",
"CreateIndex.",
"DeleteIndex."
],
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"EXPORT_ENTITIES",
"IMPORT_ENTITIES",
"CREATE_INDEX",
"DELETE_INDEX"
]
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"INITIALIZING",
"PROCESSING",
"CANCELLING",
"FINALIZING",
"SUCCESSFUL",
"FAILED",
"CANCELLED"
],
"description": "The current state of the Operation.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
"Request is being prepared for processing.",
"Request is actively being processed.",
"Request is in the process of being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation on the operation.",
"Request has been processed and is in its finalization stage.",
"Request has completed successfully.",
"Request has finished being processed, but encountered an error.",
"Request has finished being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation."
]
},
"startTime": {
"description": "The time that work began on the operation.",
"format": "google-datetime",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
"type": "object"
},
"endTime": {
"description": "The time the operation ended, either successfully or otherwise.",
"format": "google-datetime",
"type": "string"
}
},
"id": "GoogleDatastoreAdminV1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations.",
"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",
"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"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesRequest": {
"description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
"type": "object",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Client-assigned labels.",
"type": "object"
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
"description": "Description of what data from the project is included in the export."
},
"outputUrlPrefix": {
"description": "Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield. That value should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.",
"type": "string"
}
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"description": "Metadata for ExportEntities operations.",
"type": "object",
"properties": {
"progressEntities": {
"$ref": "GoogleDatastoreAdminV1beta1Progress",
"description": "An estimate of the number of entities processed."
},
"common": {
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations."
},
"progressBytes": {
"$ref": "GoogleDatastoreAdminV1beta1Progress",
"description": "An estimate of the number of bytes processed."
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
"description": "Description of which entities are being exported."
},
"outputUrlPrefix": {
"description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
"type": "string"
}
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
} }
}, },
"protocol": "rest", "protocol": "rest",
@@ -436,11 +612,11 @@
"auth": { "auth": {
"oauth2": { "oauth2": {
"scopes": { "scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/datastore": { "https://www.googleapis.com/auth/datastore": {
"description": "View and manage your Google Cloud Datastore data" "description": "View and manage your Google Cloud Datastore data"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
} }
} }
} }
@@ -453,7 +629,8 @@
"ownerDomain": "google.com", "ownerDomain": "google.com",
"name": "datastore", "name": "datastore",
"batchPath": "batch", "batchPath": "batch",
"revision": "20171205", "revision": "20181002",
"documentationLink": "https://cloud.google.com/datastore/", "documentationLink": "https://cloud.google.com/datastore/",
"id": "datastore:v1beta1" "id": "datastore:v1beta1",
"title": "Cloud Datastore API"
} }

2083
etc/api/datastore/v1beta3/datastore-api.json
View File

File diff suppressed because it is too large Load Diff

120
etc/api/deploymentmanager/alpha/deploymentmanager-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/YBhevoUFAfVyqSyxTJkhAWUX4fg\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/tdbJPMazx6MrJLWgJ0381Mo2V1Y\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "deploymentmanager:alpha", "id": "deploymentmanager:alpha",
"name": "deploymentmanager", "name": "deploymentmanager",
"canonicalName": "Deployment Manager Alpha", "canonicalName": "Deployment Manager Alpha",
"version": "alpha", "version": "alpha",
"revision": "20171201", "revision": "20180609",
"title": "Google Cloud Deployment Manager Alpha API", "title": "Google Cloud Deployment Manager Alpha API",
"description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.", "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -104,7 +104,7 @@
"AuditConfig": { "AuditConfig": {
"id": "AuditConfig", "id": "AuditConfig",
"type": "object", "type": "object",
"description": "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.\n\nIf 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.\n\nExample Policy with multiple AuditConfigs:\n\n{ \"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\" ] } ] } ] }\n\nFor 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.", "description": "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.\n\nIf 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.\n\nExample Policy with multiple AuditConfigs:\n\n{ \"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\" ] } ] } ] }\n\nFor 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.",
"properties": { "properties": {
"auditLogConfigs": { "auditLogConfigs": {
"type": "array", "type": "array",
@@ -175,11 +175,11 @@
"properties": { "properties": {
"condition": { "condition": {
"$ref": "Expr", "$ref": "Expr",
"description": "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." "description": "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 only visible as GOOGLE_INTERNAL or CONDITION_TRUSTED_TESTER."
}, },
"members": { "members": {
"type": "array", "type": "array",
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.", "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
"items": { "items": {
"type": "string" "type": "string"
} }
@@ -199,6 +199,10 @@
"type": "string", "type": "string",
"description": "The collection that identifies this resource within its service." "description": "The collection that identifies this resource within its service."
}, },
"methodMap": {
"$ref": "MethodMap",
"description": "Custom verb method mappings to support unordered list API mappings."
},
"options": { "options": {
"$ref": "Options", "$ref": "Options",
"description": "The options to apply to this resource-level override" "description": "The options to apply to this resource-level override"
@@ -580,6 +584,28 @@
} }
} }
}, },
"GlobalSetPolicyRequest": {
"id": "GlobalSetPolicyRequest",
"type": "object",
"properties": {
"bindings": {
"type": "array",
"description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
}
},
"etag": {
"type": "string",
"description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
"format": "byte"
},
"policy": {
"$ref": "Policy",
"description": "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 in general a valid policy but certain services (like Projects) might reject them."
}
}
},
"ImportFile": { "ImportFile": {
"id": "ImportFile", "id": "ImportFile",
"type": "object", "type": "object",
@@ -739,6 +765,33 @@
} }
} }
}, },
"MethodMap": {
"id": "MethodMap",
"type": "object",
"description": "Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy",
"properties": {
"create": {
"type": "string",
"description": "The action identifier for the create method to be used for this collection"
},
"delete": {
"type": "string",
"description": "The action identifier for the delete method to be used for this collection"
},
"get": {
"type": "string",
"description": "The action identifier for the get method to be used for this collection"
},
"setIamPolicy": {
"type": "string",
"description": "The action identifier for the setIamPolicy method to be used for this collection"
},
"update": {
"type": "string",
"description": "The action identifier for the update method to be used for this collection"
}
}
},
"Operation": { "Operation": {
"id": "Operation", "id": "Operation",
"type": "object", "type": "object",
@@ -746,7 +799,7 @@
"properties": { "properties": {
"clientOperationId": { "clientOperationId": {
"type": "string", "type": "string",
"description": "[Output Only] Reserved for future use." "description": "[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise."
}, },
"creationTimestamp": { "creationTimestamp": {
"type": "string", "type": "string",
@@ -825,7 +878,7 @@
}, },
"region": { "region": {
"type": "string", "type": "string",
"description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations." "description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
}, },
"selfLink": { "selfLink": {
"type": "string", "type": "string",
@@ -892,7 +945,7 @@
}, },
"zone": { "zone": {
"type": "string", "type": "string",
"description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations." "description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
} }
} }
}, },
@@ -946,7 +999,7 @@
"Policy": { "Policy": {
"id": "Policy", "id": "Policy",
"type": "object", "type": "object",
"description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `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.\n\n**Example**\n\n{ \"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\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).", "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `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.\n\n**JSON Example**\n\n{ \"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\"] } ] }\n\n**YAML Example**\n\nbindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer\n\n\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).",
"properties": { "properties": {
"auditConfigs": { "auditConfigs": {
"type": "array", "type": "array",
@@ -980,7 +1033,7 @@
}, },
"version": { "version": {
"type": "integer", "type": "integer",
"description": "Version of the `Policy`. The default version is 0.", "description": "Deprecated.",
"format": "int32" "format": "int32"
} }
} }
@@ -1527,7 +1580,7 @@
}, },
"name": { "name": {
"type": "string", "type": "string",
"description": "Name of the type provider." "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash."
}, },
"operation": { "operation": {
"$ref": "Operation", "$ref": "Operation",
@@ -1732,7 +1785,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -1910,7 +1963,6 @@
"type": "string", "type": "string",
"description": "The name of the deployment for this request.", "description": "The name of the deployment for this request.",
"required": true, "required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path" "location": "path"
}, },
"project": { "project": {
@@ -2007,6 +2059,22 @@
"httpMethod": "POST", "httpMethod": "POST",
"description": "Creates a deployment and all of the resources described by the deployment manifest.", "description": "Creates a deployment and all of the resources described by the deployment manifest.",
"parameters": { "parameters": {
"createPolicy": {
"type": "string",
"description": "Sets the policy to use for creating new resources.",
"default": "CREATE_OR_ACQUIRE",
"enum": [
"ACQUIRE",
"CREATE",
"CREATE_OR_ACQUIRE"
],
"enumDescriptions": [
"",
"",
""
],
"location": "query"
},
"preview": { "preview": {
"type": "boolean", "type": "boolean",
"description": "If set to true, creates a deployment and creates \"shell\" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.", "description": "If set to true, creates a deployment and creates \"shell\" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
@@ -2042,7 +2110,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2096,9 +2164,11 @@
"default": "CREATE_OR_ACQUIRE", "default": "CREATE_OR_ACQUIRE",
"enum": [ "enum": [
"ACQUIRE", "ACQUIRE",
"CREATE",
"CREATE_OR_ACQUIRE" "CREATE_OR_ACQUIRE"
], ],
"enumDescriptions": [ "enumDescriptions": [
"",
"", "",
"" ""
], ],
@@ -2180,7 +2250,7 @@
"resource" "resource"
], ],
"request": { "request": {
"$ref": "Policy" "$ref": "GlobalSetPolicyRequest"
}, },
"response": { "response": {
"$ref": "Policy" "$ref": "Policy"
@@ -2274,9 +2344,11 @@
"default": "CREATE_OR_ACQUIRE", "default": "CREATE_OR_ACQUIRE",
"enum": [ "enum": [
"ACQUIRE", "ACQUIRE",
"CREATE",
"CREATE_OR_ACQUIRE" "CREATE_OR_ACQUIRE"
], ],
"enumDescriptions": [ "enumDescriptions": [
"",
"", "",
"" ""
], ],
@@ -2394,7 +2466,7 @@
}, },
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2483,7 +2555,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2586,7 +2658,7 @@
}, },
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2716,7 +2788,7 @@
}, },
"type": { "type": {
"type": "string", "type": "string",
"description": "The name of the type provider for this request.", "description": "The name of the type provider type for this request.",
"required": true, "required": true,
"location": "path" "location": "path"
}, },
@@ -2779,7 +2851,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2829,7 +2901,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -3059,7 +3131,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {

73
etc/api/deploymentmanager/v2/deploymentmanager-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/GDaMgEo2rpzvf2TXCj_2gpZ3fIE\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/8P1VawsMUwsf17p08juP351T8n8\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "deploymentmanager:v2", "id": "deploymentmanager:v2",
"name": "deploymentmanager", "name": "deploymentmanager",
"canonicalName": "Deployment Manager", "canonicalName": "Deployment Manager",
"version": "v2", "version": "v2",
"revision": "20171201", "revision": "20180609",
"title": "Google Cloud Deployment Manager API", "title": "Google Cloud Deployment Manager API",
"description": "Declares, configures, and deploys complex solutions on Google Cloud Platform.", "description": "Declares, configures, and deploys complex solutions on Google Cloud Platform.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -89,7 +89,7 @@
"AuditConfig": { "AuditConfig": {
"id": "AuditConfig", "id": "AuditConfig",
"type": "object", "type": "object",
"description": "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.\n\nIf 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.\n\nExample Policy with multiple AuditConfigs:\n\n{ \"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\" ] } ] } ] }\n\nFor 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.", "description": "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.\n\nIf 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.\n\nExample Policy with multiple AuditConfigs:\n\n{ \"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\" ] } ] } ] }\n\nFor 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.",
"properties": { "properties": {
"auditLogConfigs": { "auditLogConfigs": {
"type": "array", "type": "array",
@@ -147,11 +147,11 @@
"properties": { "properties": {
"condition": { "condition": {
"$ref": "Expr", "$ref": "Expr",
"description": "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." "description": "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 only visible as GOOGLE_INTERNAL or CONDITION_TRUSTED_TESTER."
}, },
"members": { "members": {
"type": "array", "type": "array",
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.", "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
"items": { "items": {
"type": "string" "type": "string"
} }
@@ -374,6 +374,28 @@
} }
} }
}, },
"GlobalSetPolicyRequest": {
"id": "GlobalSetPolicyRequest",
"type": "object",
"properties": {
"bindings": {
"type": "array",
"description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
}
},
"etag": {
"type": "string",
"description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
"format": "byte"
},
"policy": {
"$ref": "Policy",
"description": "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 in general a valid policy but certain services (like Projects) might reject them."
}
}
},
"ImportFile": { "ImportFile": {
"id": "ImportFile", "id": "ImportFile",
"type": "object", "type": "object",
@@ -517,7 +539,7 @@
"properties": { "properties": {
"clientOperationId": { "clientOperationId": {
"type": "string", "type": "string",
"description": "[Output Only] Reserved for future use." "description": "[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise."
}, },
"creationTimestamp": { "creationTimestamp": {
"type": "string", "type": "string",
@@ -596,7 +618,7 @@
}, },
"region": { "region": {
"type": "string", "type": "string",
"description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations." "description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
}, },
"selfLink": { "selfLink": {
"type": "string", "type": "string",
@@ -663,7 +685,7 @@
}, },
"zone": { "zone": {
"type": "string", "type": "string",
"description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations." "description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
} }
} }
}, },
@@ -688,7 +710,7 @@
"Policy": { "Policy": {
"id": "Policy", "id": "Policy",
"type": "object", "type": "object",
"description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `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.\n\n**Example**\n\n{ \"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\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).", "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `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.\n\n**JSON Example**\n\n{ \"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\"] } ] }\n\n**YAML Example**\n\nbindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer\n\n\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).",
"properties": { "properties": {
"auditConfigs": { "auditConfigs": {
"type": "array", "type": "array",
@@ -722,7 +744,7 @@
}, },
"version": { "version": {
"type": "integer", "type": "integer",
"description": "Version of the `Policy`. The default version is 0.", "description": "Deprecated.",
"format": "int32" "format": "int32"
} }
} }
@@ -1138,7 +1160,6 @@
"type": "string", "type": "string",
"description": "The name of the deployment for this request.", "description": "The name of the deployment for this request.",
"required": true, "required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path" "location": "path"
}, },
"project": { "project": {
@@ -1235,6 +1256,20 @@
"httpMethod": "POST", "httpMethod": "POST",
"description": "Creates a deployment and all of the resources described by the deployment manifest.", "description": "Creates a deployment and all of the resources described by the deployment manifest.",
"parameters": { "parameters": {
"createPolicy": {
"type": "string",
"description": "Sets the policy to use for creating new resources.",
"default": "CREATE_OR_ACQUIRE",
"enum": [
"ACQUIRE",
"CREATE_OR_ACQUIRE"
],
"enumDescriptions": [
"",
""
],
"location": "query"
},
"preview": { "preview": {
"type": "boolean", "type": "boolean",
"description": "If set to true, creates a deployment and creates \"shell\" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.", "description": "If set to true, creates a deployment and creates \"shell\" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
@@ -1270,7 +1305,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -1408,7 +1443,7 @@
"resource" "resource"
], ],
"request": { "request": {
"$ref": "Policy" "$ref": "GlobalSetPolicyRequest"
}, },
"response": { "response": {
"$ref": "Policy" "$ref": "Policy"
@@ -1622,7 +1657,7 @@
}, },
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -1711,7 +1746,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -1814,7 +1849,7 @@
}, },
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -1869,7 +1904,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {

156
etc/api/deploymentmanager/v2beta/deploymentmanager-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/Os0QttejTkDUy1hcIScN6tyVIbQ\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/LkknaPBA2ag_gwJEt-rsY1S_xdU\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "deploymentmanager:v2beta", "id": "deploymentmanager:v2beta",
"name": "deploymentmanager", "name": "deploymentmanager",
"canonicalName": "Deployment Manager V2Beta", "canonicalName": "Deployment Manager V2Beta",
"version": "v2beta", "version": "v2beta",
"revision": "20171201", "revision": "20180609",
"title": "Google Cloud Deployment Manager API V2Beta Methods", "title": "Google Cloud Deployment Manager API V2Beta Methods",
"description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.", "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -58,12 +58,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -86,10 +86,25 @@
} }
}, },
"schemas": { "schemas": {
"AsyncOptions": {
"id": "AsyncOptions",
"type": "object",
"description": "Async options that determine when a resource should finish.",
"properties": {
"methodMatch": {
"type": "string",
"description": "Method regex where this policy will apply."
},
"pollingOptions": {
"$ref": "PollingOptions",
"description": "Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed."
}
}
},
"AuditConfig": { "AuditConfig": {
"id": "AuditConfig", "id": "AuditConfig",
"type": "object", "type": "object",
"description": "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.\n\nIf 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.\n\nExample Policy with multiple AuditConfigs:\n\n{ \"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\" ] } ] } ] }\n\nFor 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.", "description": "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.\n\nIf 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.\n\nExample Policy with multiple AuditConfigs:\n\n{ \"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\" ] } ] } ] }\n\nFor 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.",
"properties": { "properties": {
"auditLogConfigs": { "auditLogConfigs": {
"type": "array", "type": "array",
@@ -186,11 +201,11 @@
"properties": { "properties": {
"condition": { "condition": {
"$ref": "Expr", "$ref": "Expr",
"description": "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." "description": "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 only visible as GOOGLE_INTERNAL or CONDITION_TRUSTED_TESTER."
}, },
"members": { "members": {
"type": "array", "type": "array",
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.", "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
"items": { "items": {
"type": "string" "type": "string"
} }
@@ -500,6 +515,21 @@
} }
} }
}, },
"Diagnostic": {
"id": "Diagnostic",
"type": "object",
"description": "",
"properties": {
"field": {
"type": "string",
"description": "JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic."
},
"level": {
"type": "string",
"description": "Level to record this diagnostic."
}
}
},
"Expr": { "Expr": {
"id": "Expr", "id": "Expr",
"type": "object", "type": "object",
@@ -523,6 +553,28 @@
} }
} }
}, },
"GlobalSetPolicyRequest": {
"id": "GlobalSetPolicyRequest",
"type": "object",
"properties": {
"bindings": {
"type": "array",
"description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
}
},
"etag": {
"type": "string",
"description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
"format": "byte"
},
"policy": {
"$ref": "Policy",
"description": "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 in general a valid policy but certain services (like Projects) might reject them."
}
}
},
"ImportFile": { "ImportFile": {
"id": "ImportFile", "id": "ImportFile",
"type": "object", "type": "object",
@@ -689,7 +741,7 @@
"properties": { "properties": {
"clientOperationId": { "clientOperationId": {
"type": "string", "type": "string",
"description": "[Output Only] Reserved for future use." "description": "[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise."
}, },
"creationTimestamp": { "creationTimestamp": {
"type": "string", "type": "string",
@@ -768,7 +820,7 @@
}, },
"region": { "region": {
"type": "string", "type": "string",
"description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations." "description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
}, },
"selfLink": { "selfLink": {
"type": "string", "type": "string",
@@ -835,7 +887,7 @@
}, },
"zone": { "zone": {
"type": "string", "type": "string",
"description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations." "description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
} }
} }
}, },
@@ -862,6 +914,13 @@
"type": "object", "type": "object",
"description": "Options allows customized resource handling by Deployment Manager.", "description": "Options allows customized resource handling by Deployment Manager.",
"properties": { "properties": {
"asyncOptions": {
"type": "array",
"description": "Options regarding how to thread async requests.",
"items": {
"$ref": "AsyncOptions"
}
},
"inputMappings": { "inputMappings": {
"type": "array", "type": "array",
"description": "The mappings that apply for requests.", "description": "The mappings that apply for requests.",
@@ -882,7 +941,7 @@
"Policy": { "Policy": {
"id": "Policy", "id": "Policy",
"type": "object", "type": "object",
"description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `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.\n\n**Example**\n\n{ \"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\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).", "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `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.\n\n**JSON Example**\n\n{ \"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\"] } ] }\n\n**YAML Example**\n\nbindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer\n\n\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).",
"properties": { "properties": {
"auditConfigs": { "auditConfigs": {
"type": "array", "type": "array",
@@ -916,11 +975,41 @@
}, },
"version": { "version": {
"type": "integer", "type": "integer",
"description": "Version of the `Policy`. The default version is 0.", "description": "Deprecated.",
"format": "int32" "format": "int32"
} }
} }
}, },
"PollingOptions": {
"id": "PollingOptions",
"type": "object",
"description": "",
"properties": {
"diagnostics": {
"type": "array",
"description": "An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user.",
"items": {
"$ref": "Diagnostic"
}
},
"failCondition": {
"type": "string",
"description": "JsonPath expression that determines if the request failed."
},
"finishCondition": {
"type": "string",
"description": "JsonPath expression that determines if the request is completed."
},
"pollingLink": {
"type": "string",
"description": "JsonPath expression that evaluates to string, it indicates where to poll."
},
"targetLink": {
"type": "string",
"description": "JsonPath expression, after polling is completed, indicates where to fetch the resource."
}
}
},
"Resource": { "Resource": {
"id": "Resource", "id": "Resource",
"type": "object", "type": "object",
@@ -1411,7 +1500,7 @@
}, },
"name": { "name": {
"type": "string", "type": "string",
"description": "Name of the type provider." "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash."
}, },
"operation": { "operation": {
"$ref": "Operation", "$ref": "Operation",
@@ -1616,7 +1705,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -1794,7 +1883,6 @@
"type": "string", "type": "string",
"description": "The name of the deployment for this request.", "description": "The name of the deployment for this request.",
"required": true, "required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path" "location": "path"
}, },
"project": { "project": {
@@ -1891,6 +1979,22 @@
"httpMethod": "POST", "httpMethod": "POST",
"description": "Creates a deployment and all of the resources described by the deployment manifest.", "description": "Creates a deployment and all of the resources described by the deployment manifest.",
"parameters": { "parameters": {
"createPolicy": {
"type": "string",
"description": "Sets the policy to use for creating new resources.",
"default": "CREATE_OR_ACQUIRE",
"enum": [
"ACQUIRE",
"CREATE",
"CREATE_OR_ACQUIRE"
],
"enumDescriptions": [
"",
"",
""
],
"location": "query"
},
"preview": { "preview": {
"type": "boolean", "type": "boolean",
"description": "If set to true, creates a deployment and creates \"shell\" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.", "description": "If set to true, creates a deployment and creates \"shell\" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
@@ -1926,7 +2030,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -1980,9 +2084,11 @@
"default": "CREATE_OR_ACQUIRE", "default": "CREATE_OR_ACQUIRE",
"enum": [ "enum": [
"ACQUIRE", "ACQUIRE",
"CREATE",
"CREATE_OR_ACQUIRE" "CREATE_OR_ACQUIRE"
], ],
"enumDescriptions": [ "enumDescriptions": [
"",
"", "",
"" ""
], ],
@@ -2064,7 +2170,7 @@
"resource" "resource"
], ],
"request": { "request": {
"$ref": "Policy" "$ref": "GlobalSetPolicyRequest"
}, },
"response": { "response": {
"$ref": "Policy" "$ref": "Policy"
@@ -2158,9 +2264,11 @@
"default": "CREATE_OR_ACQUIRE", "default": "CREATE_OR_ACQUIRE",
"enum": [ "enum": [
"ACQUIRE", "ACQUIRE",
"CREATE",
"CREATE_OR_ACQUIRE" "CREATE_OR_ACQUIRE"
], ],
"enumDescriptions": [ "enumDescriptions": [
"",
"", "",
"" ""
], ],
@@ -2278,7 +2386,7 @@
}, },
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2367,7 +2475,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2470,7 +2578,7 @@
}, },
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2600,7 +2708,7 @@
}, },
"type": { "type": {
"type": "string", "type": "string",
"description": "The name of the type provider for this request.", "description": "The name of the type provider type for this request.",
"required": true, "required": true,
"location": "path" "location": "path"
}, },
@@ -2663,7 +2771,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2713,7 +2821,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {
@@ -2847,7 +2955,7 @@
"parameters": { "parameters": {
"filter": { "filter": {
"type": "string", "type": "string",
"description": "Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.", "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true).",
"location": "query" "location": "query"
}, },
"maxResults": { "maxResults": {

98
etc/api/dfareporting/v2.8/dfareporting-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/4goAvA_o9T_Nbyckne-XIOvJ_sE\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/b8e9X2OV7HztttOOjjAf6lAujg0\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "dfareporting:v2.8", "id": "dfareporting:v2.8",
"name": "dfareporting", "name": "dfareporting",
"version": "v2.8", "version": "v2.8",
"revision": "20171109", "revision": "20180830",
"title": "DCM/DFA Reporting And Trafficking API", "title": "DCM/DFA Reporting And Trafficking API",
"description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.", "description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -85,7 +85,7 @@
"Account": { "Account": {
"id": "Account", "id": "Account",
"type": "object", "type": "object",
"description": "Contains properties of a DCM account.", "description": "Contains properties of a Campaign Manager account.",
"properties": { "properties": {
"accountPermissionIds": { "accountPermissionIds": {
"type": "array", "type": "array",
@@ -262,7 +262,7 @@
"AccountPermission": { "AccountPermission": {
"id": "AccountPermission", "id": "AccountPermission",
"type": "object", "type": "object",
"description": "AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.", "description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.",
"properties": { "properties": {
"accountProfiles": { "accountProfiles": {
"type": "array", "type": "array",
@@ -374,7 +374,7 @@
"AccountUserProfile": { "AccountUserProfile": {
"id": "AccountUserProfile", "id": "AccountUserProfile",
"type": "object", "type": "object",
"description": "AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.", "description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -430,7 +430,7 @@
}, },
"traffickerType": { "traffickerType": {
"type": "string", "type": "string",
"description": "Trafficker type of this user profile.", "description": "Trafficker type of this user profile. This is a read-only field.",
"enum": [ "enum": [
"EXTERNAL_TRAFFICKER", "EXTERNAL_TRAFFICKER",
"INTERNAL_NON_TRAFFICKER", "INTERNAL_NON_TRAFFICKER",
@@ -544,7 +544,7 @@
"Ad": { "Ad": {
"id": "Ad", "id": "Ad",
"type": "object", "type": "object",
"description": "Contains properties of a DCM ad.", "description": "Contains properties of a Campaign Manager ad.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -602,6 +602,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -609,6 +610,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -790,6 +792,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -797,6 +800,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -863,7 +867,7 @@
"Advertiser": { "Advertiser": {
"id": "Advertiser", "id": "Advertiser",
"type": "object", "type": "object",
"description": "Contains properties of a DCM advertiser.", "description": "Contains properties of a Campaign Manager advertiser.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -1115,7 +1119,7 @@
"Campaign": { "Campaign": {
"id": "Campaign", "id": "Campaign",
"type": "object", "type": "object",
"description": "Contains properties of a DCM campaign.", "description": "Contains properties of a Campaign Manager campaign.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -1160,7 +1164,7 @@
}, },
"billingInvoiceCode": { "billingInvoiceCode": {
"type": "string", "type": "string",
"description": "Billing invoice code included in the DCM client billing invoices associated with the campaign." "description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign."
}, },
"clickThroughUrlSuffixProperties": { "clickThroughUrlSuffixProperties": {
"$ref": "ClickThroughUrlSuffixProperties", "$ref": "ClickThroughUrlSuffixProperties",
@@ -2065,7 +2069,7 @@
}, },
"backupImageFeatures": { "backupImageFeatures": {
"type": "array", "type": "array",
"description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"items": { "items": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -2227,7 +2231,7 @@
}, },
"companionCreatives": { "companionCreatives": {
"type": "array", "type": "array",
"description": "List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.", "description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
"items": { "items": {
"type": "string", "type": "string",
"format": "int64" "format": "int64"
@@ -2243,6 +2247,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -2250,6 +2255,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
} }
@@ -2311,7 +2317,7 @@
}, },
"htmlCodeLocked": { "htmlCodeLocked": {
"type": "boolean", "type": "boolean",
"description": "Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER." "description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER."
}, },
"id": { "id": {
"type": "string", "type": "string",
@@ -2367,7 +2373,7 @@
}, },
"requiredFlashVersion": { "requiredFlashVersion": {
"type": "integer", "type": "integer",
"description": "The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", "description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"format": "int32" "format": "int32"
}, },
"size": { "size": {
@@ -2450,6 +2456,7 @@
"FLASH_INPAGE", "FLASH_INPAGE",
"HTML5_BANNER", "HTML5_BANNER",
"IMAGE", "IMAGE",
"INSTREAM_AUDIO",
"INSTREAM_VIDEO", "INSTREAM_VIDEO",
"INSTREAM_VIDEO_REDIRECT", "INSTREAM_VIDEO_REDIRECT",
"INTERNAL_REDIRECT", "INTERNAL_REDIRECT",
@@ -2490,6 +2497,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -2606,7 +2614,7 @@
}, },
"detectedFeatures": { "detectedFeatures": {
"type": "array", "type": "array",
"description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"items": { "items": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -2839,7 +2847,7 @@
}, },
"originalBackup": { "originalBackup": {
"type": "boolean", "type": "boolean",
"description": "Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA." "description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA."
}, },
"position": { "position": {
"$ref": "OffsetPosition", "$ref": "OffsetPosition",
@@ -2888,7 +2896,7 @@
}, },
"role": { "role": {
"type": "string", "type": "string",
"description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.\nPRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.\nADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nTRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.\nFor VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.", "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.\nPRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.\nADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nTRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager.\nFor VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.",
"enum": [ "enum": [
"ADDITIONAL_FLASH", "ADDITIONAL_FLASH",
"ADDITIONAL_IMAGE", "ADDITIONAL_IMAGE",
@@ -3023,7 +3031,7 @@
}, },
"detectedFeatures": { "detectedFeatures": {
"type": "array", "type": "array",
"description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.", "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
"items": { "items": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -3338,7 +3346,7 @@
"properties": { "properties": {
"advertiserCustomEventId": { "advertiserCustomEventId": {
"type": "string", "type": "string",
"description": "Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.", "description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.",
"format": "int64" "format": "int64"
}, },
"advertiserCustomEventName": { "advertiserCustomEventName": {
@@ -3361,7 +3369,7 @@
}, },
"artworkLabel": { "artworkLabel": {
"type": "string", "type": "string",
"description": "Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion." "description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion."
}, },
"artworkType": { "artworkType": {
"type": "string", "type": "string",
@@ -4060,9 +4068,11 @@
"type": "string", "type": "string",
"description": "The date range relative to the date of when the report is run.", "description": "The date range relative to the date of when the report is run.",
"enum": [ "enum": [
"LAST_14_DAYS",
"LAST_24_MONTHS", "LAST_24_MONTHS",
"LAST_30_DAYS", "LAST_30_DAYS",
"LAST_365_DAYS", "LAST_365_DAYS",
"LAST_60_DAYS",
"LAST_7_DAYS", "LAST_7_DAYS",
"LAST_90_DAYS", "LAST_90_DAYS",
"MONTH_TO_DATE", "MONTH_TO_DATE",
@@ -4091,6 +4101,8 @@
"", "",
"", "",
"", "",
"",
"",
"" ""
] ]
}, },
@@ -4176,7 +4188,7 @@
}, },
"impressionRatio": { "impressionRatio": {
"type": "string", "type": "string",
"description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.", "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
"format": "int64" "format": "int64"
}, },
"priority": { "priority": {
@@ -4224,15 +4236,15 @@
"DfpSettings": { "DfpSettings": {
"id": "DfpSettings", "id": "DfpSettings",
"type": "object", "type": "object",
"description": "DFP Settings", "description": "Google Ad Manager Settings",
"properties": { "properties": {
"dfpNetworkCode": { "dfpNetworkCode": {
"type": "string", "type": "string",
"description": "DFP network code for this directory site." "description": "Ad Manager network code for this directory site."
}, },
"dfpNetworkName": { "dfpNetworkName": {
"type": "string", "type": "string",
"description": "DFP network name for this directory site." "description": "Ad Manager network name for this directory site."
}, },
"programmaticPlacementAccepted": { "programmaticPlacementAccepted": {
"type": "boolean", "type": "boolean",
@@ -4244,7 +4256,7 @@
}, },
"publisherPortalOnly": { "publisherPortalOnly": {
"type": "boolean", "type": "boolean",
"description": "Whether this directory site is available only via DoubleClick Publisher Portal." "description": "Whether this directory site is available only via Publisher Portal."
} }
} }
}, },
@@ -4631,7 +4643,7 @@
}, },
"dfpSettings": { "dfpSettings": {
"$ref": "DfpSettings", "$ref": "DfpSettings",
"description": "Directory site DFP settings." "description": "Directory site Ad Manager settings."
}, },
"instreamVideoPlacementAccepted": { "instreamVideoPlacementAccepted": {
"type": "boolean", "type": "boolean",
@@ -4681,7 +4693,7 @@
"DynamicTargetingKey": { "DynamicTargetingKey": {
"id": "DynamicTargetingKey", "id": "DynamicTargetingKey",
"type": "object", "type": "object",
"description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.", "description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
"properties": { "properties": {
"kind": { "kind": {
"type": "string", "type": "string",
@@ -4753,6 +4765,7 @@
"DBM_PARTNER", "DBM_PARTNER",
"DCM_ACCOUNT", "DCM_ACCOUNT",
"DCM_ADVERTISER", "DCM_ADVERTISER",
"DFP_NETWORK_CODE",
"ENCRYPTION_ENTITY_TYPE_UNKNOWN" "ENCRYPTION_ENTITY_TYPE_UNKNOWN"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -4761,6 +4774,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -4819,7 +4833,7 @@
}, },
"excludeFromAdxRequests": { "excludeFromAdxRequests": {
"type": "boolean", "type": "boolean",
"description": "Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network." "description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network."
}, },
"id": { "id": {
"type": "string", "type": "string",
@@ -5715,7 +5729,7 @@
}, },
"omnitureSettings": { "omnitureSettings": {
"$ref": "OmnitureSettings", "$ref": "OmnitureSettings",
"description": "Settings for DCM Omniture integration." "description": "Settings for Campaign Manager Omniture integration."
}, },
"subaccountId": { "subaccountId": {
"type": "string", "type": "string",
@@ -5899,7 +5913,7 @@
"InventoryItem": { "InventoryItem": {
"id": "InventoryItem", "id": "InventoryItem",
"type": "object", "type": "object",
"description": "Represents a buy from the DoubleClick Planning inventory store.", "description": "Represents a buy from the Planning inventory store.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -6606,7 +6620,7 @@
"Order": { "Order": {
"id": "Order", "id": "Order",
"type": "object", "type": "object",
"description": "Describes properties of a DoubleClick Planning order.", "description": "Describes properties of a Planning order.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -6752,7 +6766,7 @@
"OrderDocument": { "OrderDocument": {
"id": "OrderDocument", "id": "OrderDocument",
"type": "object", "type": "object",
"description": "Contains properties of a DoubleClick Planning order document.", "description": "Contains properties of a Planning order document.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -6983,6 +6997,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -6990,6 +7005,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -7822,7 +7838,7 @@
"Project": { "Project": {
"id": "Project", "id": "Project",
"type": "object", "type": "object",
"description": "Contains properties of a DoubleClick Planning project.", "description": "Contains properties of a Planning project.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -9228,7 +9244,7 @@
"Subaccount": { "Subaccount": {
"id": "Subaccount", "id": "Subaccount",
"type": "object", "type": "object",
"description": "Contains properties of a DCM subaccount.", "description": "Contains properties of a Campaign Manager subaccount.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -11030,6 +11046,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -11037,6 +11054,7 @@
"", "",
"", "",
"", "",
"",
"" ""
], ],
"location": "query" "location": "query"
@@ -13817,6 +13835,7 @@
"FLASH_INPAGE", "FLASH_INPAGE",
"HTML5_BANNER", "HTML5_BANNER",
"IMAGE", "IMAGE",
"INSTREAM_AUDIO",
"INSTREAM_VIDEO", "INSTREAM_VIDEO",
"INSTREAM_VIDEO_REDIRECT", "INSTREAM_VIDEO_REDIRECT",
"INTERNAL_REDIRECT", "INTERNAL_REDIRECT",
@@ -13857,6 +13876,7 @@
"", "",
"", "",
"", "",
"",
"" ""
], ],
"repeated": true, "repeated": true,
@@ -14198,7 +14218,7 @@
}, },
"dfpNetworkCode": { "dfpNetworkCode": {
"type": "string", "type": "string",
"description": "Select only directory sites with this DFP network code.", "description": "Select only directory sites with this Ad Manager network code.",
"location": "query" "location": "query"
}, },
"ids": { "ids": {
@@ -17094,6 +17114,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -17101,6 +17122,7 @@
"", "",
"", "",
"", "",
"",
"" ""
], ],
"repeated": true, "repeated": true,
@@ -18672,7 +18694,7 @@
"id": "dfareporting.sizes.list", "id": "dfareporting.sizes.list",
"path": "userprofiles/{profileId}/sizes", "path": "userprofiles/{profileId}/sizes",
"httpMethod": "GET", "httpMethod": "GET",
"description": "Retrieves a list of sizes, possibly filtered.", "description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.",
"parameters": { "parameters": {
"height": { "height": {
"type": "integer", "type": "integer",

98
etc/api/dfareporting/v3.0/dfareporting-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/MD943f1mGqBAwUueANXWEMkM_XU\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/-LtUvtDJiXIIviHUgGlobpxFMu0\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "dfareporting:v3.0", "id": "dfareporting:v3.0",
"name": "dfareporting", "name": "dfareporting",
"version": "v3.0", "version": "v3.0",
"revision": "20171109", "revision": "20180830",
"title": "DCM/DFA Reporting And Trafficking API", "title": "DCM/DFA Reporting And Trafficking API",
"description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.", "description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -85,7 +85,7 @@
"Account": { "Account": {
"id": "Account", "id": "Account",
"type": "object", "type": "object",
"description": "Contains properties of a DCM account.", "description": "Contains properties of a Campaign Manager account.",
"properties": { "properties": {
"accountPermissionIds": { "accountPermissionIds": {
"type": "array", "type": "array",
@@ -262,7 +262,7 @@
"AccountPermission": { "AccountPermission": {
"id": "AccountPermission", "id": "AccountPermission",
"type": "object", "type": "object",
"description": "AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.", "description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.",
"properties": { "properties": {
"accountProfiles": { "accountProfiles": {
"type": "array", "type": "array",
@@ -374,7 +374,7 @@
"AccountUserProfile": { "AccountUserProfile": {
"id": "AccountUserProfile", "id": "AccountUserProfile",
"type": "object", "type": "object",
"description": "AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.", "description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -430,7 +430,7 @@
}, },
"traffickerType": { "traffickerType": {
"type": "string", "type": "string",
"description": "Trafficker type of this user profile.", "description": "Trafficker type of this user profile. This is a read-only field.",
"enum": [ "enum": [
"EXTERNAL_TRAFFICKER", "EXTERNAL_TRAFFICKER",
"INTERNAL_NON_TRAFFICKER", "INTERNAL_NON_TRAFFICKER",
@@ -544,7 +544,7 @@
"Ad": { "Ad": {
"id": "Ad", "id": "Ad",
"type": "object", "type": "object",
"description": "Contains properties of a DCM ad.", "description": "Contains properties of a Campaign Manager ad.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -602,6 +602,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -609,6 +610,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -790,6 +792,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -797,6 +800,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -863,7 +867,7 @@
"Advertiser": { "Advertiser": {
"id": "Advertiser", "id": "Advertiser",
"type": "object", "type": "object",
"description": "Contains properties of a DCM advertiser.", "description": "Contains properties of a Campaign Manager advertiser.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -1138,7 +1142,7 @@
"Campaign": { "Campaign": {
"id": "Campaign", "id": "Campaign",
"type": "object", "type": "object",
"description": "Contains properties of a DCM campaign.", "description": "Contains properties of a Campaign Manager campaign.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -1183,7 +1187,7 @@
}, },
"billingInvoiceCode": { "billingInvoiceCode": {
"type": "string", "type": "string",
"description": "Billing invoice code included in the DCM client billing invoices associated with the campaign." "description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign."
}, },
"clickThroughUrlSuffixProperties": { "clickThroughUrlSuffixProperties": {
"$ref": "ClickThroughUrlSuffixProperties", "$ref": "ClickThroughUrlSuffixProperties",
@@ -2093,7 +2097,7 @@
}, },
"backupImageFeatures": { "backupImageFeatures": {
"type": "array", "type": "array",
"description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"items": { "items": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -2255,7 +2259,7 @@
}, },
"companionCreatives": { "companionCreatives": {
"type": "array", "type": "array",
"description": "List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.", "description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
"items": { "items": {
"type": "string", "type": "string",
"format": "int64" "format": "int64"
@@ -2271,6 +2275,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -2278,6 +2283,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
} }
@@ -2339,7 +2345,7 @@
}, },
"htmlCodeLocked": { "htmlCodeLocked": {
"type": "boolean", "type": "boolean",
"description": "Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER." "description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER."
}, },
"id": { "id": {
"type": "string", "type": "string",
@@ -2400,7 +2406,7 @@
}, },
"requiredFlashVersion": { "requiredFlashVersion": {
"type": "integer", "type": "integer",
"description": "The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", "description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"format": "int32" "format": "int32"
}, },
"size": { "size": {
@@ -2483,6 +2489,7 @@
"FLASH_INPAGE", "FLASH_INPAGE",
"HTML5_BANNER", "HTML5_BANNER",
"IMAGE", "IMAGE",
"INSTREAM_AUDIO",
"INSTREAM_VIDEO", "INSTREAM_VIDEO",
"INSTREAM_VIDEO_REDIRECT", "INSTREAM_VIDEO_REDIRECT",
"INTERNAL_REDIRECT", "INTERNAL_REDIRECT",
@@ -2523,6 +2530,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -2639,7 +2647,7 @@
}, },
"detectedFeatures": { "detectedFeatures": {
"type": "array", "type": "array",
"description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"items": { "items": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -2886,7 +2894,7 @@
}, },
"originalBackup": { "originalBackup": {
"type": "boolean", "type": "boolean",
"description": "Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA." "description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA."
}, },
"position": { "position": {
"$ref": "OffsetPosition", "$ref": "OffsetPosition",
@@ -2935,7 +2943,7 @@
}, },
"role": { "role": {
"type": "string", "type": "string",
"description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.\nPRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.\nADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nTRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.\nFor VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.", "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.\nPRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.\nADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nTRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager.\nFor VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.",
"enum": [ "enum": [
"ADDITIONAL_FLASH", "ADDITIONAL_FLASH",
"ADDITIONAL_IMAGE", "ADDITIONAL_IMAGE",
@@ -3070,7 +3078,7 @@
}, },
"detectedFeatures": { "detectedFeatures": {
"type": "array", "type": "array",
"description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.", "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
"items": { "items": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -3405,7 +3413,7 @@
"properties": { "properties": {
"advertiserCustomEventId": { "advertiserCustomEventId": {
"type": "string", "type": "string",
"description": "Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.", "description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.",
"format": "int64" "format": "int64"
}, },
"advertiserCustomEventName": { "advertiserCustomEventName": {
@@ -3428,7 +3436,7 @@
}, },
"artworkLabel": { "artworkLabel": {
"type": "string", "type": "string",
"description": "Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion." "description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion."
}, },
"artworkType": { "artworkType": {
"type": "string", "type": "string",
@@ -4127,9 +4135,11 @@
"type": "string", "type": "string",
"description": "The date range relative to the date of when the report is run.", "description": "The date range relative to the date of when the report is run.",
"enum": [ "enum": [
"LAST_14_DAYS",
"LAST_24_MONTHS", "LAST_24_MONTHS",
"LAST_30_DAYS", "LAST_30_DAYS",
"LAST_365_DAYS", "LAST_365_DAYS",
"LAST_60_DAYS",
"LAST_7_DAYS", "LAST_7_DAYS",
"LAST_90_DAYS", "LAST_90_DAYS",
"MONTH_TO_DATE", "MONTH_TO_DATE",
@@ -4158,6 +4168,8 @@
"", "",
"", "",
"", "",
"",
"",
"" ""
] ]
}, },
@@ -4243,7 +4255,7 @@
}, },
"impressionRatio": { "impressionRatio": {
"type": "string", "type": "string",
"description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.", "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
"format": "int64" "format": "int64"
}, },
"priority": { "priority": {
@@ -4291,15 +4303,15 @@
"DfpSettings": { "DfpSettings": {
"id": "DfpSettings", "id": "DfpSettings",
"type": "object", "type": "object",
"description": "DFP Settings", "description": "Google Ad Manager Settings",
"properties": { "properties": {
"dfpNetworkCode": { "dfpNetworkCode": {
"type": "string", "type": "string",
"description": "DFP network code for this directory site." "description": "Ad Manager network code for this directory site."
}, },
"dfpNetworkName": { "dfpNetworkName": {
"type": "string", "type": "string",
"description": "DFP network name for this directory site." "description": "Ad Manager network name for this directory site."
}, },
"programmaticPlacementAccepted": { "programmaticPlacementAccepted": {
"type": "boolean", "type": "boolean",
@@ -4311,7 +4323,7 @@
}, },
"publisherPortalOnly": { "publisherPortalOnly": {
"type": "boolean", "type": "boolean",
"description": "Whether this directory site is available only via DoubleClick Publisher Portal." "description": "Whether this directory site is available only via Publisher Portal."
} }
} }
}, },
@@ -4698,7 +4710,7 @@
}, },
"dfpSettings": { "dfpSettings": {
"$ref": "DfpSettings", "$ref": "DfpSettings",
"description": "Directory site DFP settings." "description": "Directory site Ad Manager settings."
}, },
"instreamVideoPlacementAccepted": { "instreamVideoPlacementAccepted": {
"type": "boolean", "type": "boolean",
@@ -4748,7 +4760,7 @@
"DynamicTargetingKey": { "DynamicTargetingKey": {
"id": "DynamicTargetingKey", "id": "DynamicTargetingKey",
"type": "object", "type": "object",
"description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.", "description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
"properties": { "properties": {
"kind": { "kind": {
"type": "string", "type": "string",
@@ -4820,6 +4832,7 @@
"DBM_PARTNER", "DBM_PARTNER",
"DCM_ACCOUNT", "DCM_ACCOUNT",
"DCM_ADVERTISER", "DCM_ADVERTISER",
"DFP_NETWORK_CODE",
"ENCRYPTION_ENTITY_TYPE_UNKNOWN" "ENCRYPTION_ENTITY_TYPE_UNKNOWN"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -4828,6 +4841,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -4886,7 +4900,7 @@
}, },
"excludeFromAdxRequests": { "excludeFromAdxRequests": {
"type": "boolean", "type": "boolean",
"description": "Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network." "description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network."
}, },
"id": { "id": {
"type": "string", "type": "string",
@@ -5796,7 +5810,7 @@
}, },
"omnitureSettings": { "omnitureSettings": {
"$ref": "OmnitureSettings", "$ref": "OmnitureSettings",
"description": "Settings for DCM Omniture integration." "description": "Settings for Campaign Manager Omniture integration."
}, },
"subaccountId": { "subaccountId": {
"type": "string", "type": "string",
@@ -5980,7 +5994,7 @@
"InventoryItem": { "InventoryItem": {
"id": "InventoryItem", "id": "InventoryItem",
"type": "object", "type": "object",
"description": "Represents a buy from the DoubleClick Planning inventory store.", "description": "Represents a buy from the Planning inventory store.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -6673,7 +6687,7 @@
"Order": { "Order": {
"id": "Order", "id": "Order",
"type": "object", "type": "object",
"description": "Describes properties of a DoubleClick Planning order.", "description": "Describes properties of a Planning order.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -6819,7 +6833,7 @@
"OrderDocument": { "OrderDocument": {
"id": "OrderDocument", "id": "OrderDocument",
"type": "object", "type": "object",
"description": "Contains properties of a DoubleClick Planning order document.", "description": "Contains properties of a Planning order document.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -7050,6 +7064,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -7057,6 +7072,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
}, },
@@ -7889,7 +7905,7 @@
"Project": { "Project": {
"id": "Project", "id": "Project",
"type": "object", "type": "object",
"description": "Contains properties of a DoubleClick Planning project.", "description": "Contains properties of a Planning project.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -9295,7 +9311,7 @@
"Subaccount": { "Subaccount": {
"id": "Subaccount", "id": "Subaccount",
"type": "object", "type": "object",
"description": "Contains properties of a DCM subaccount.", "description": "Contains properties of a Campaign Manager subaccount.",
"properties": { "properties": {
"accountId": { "accountId": {
"type": "string", "type": "string",
@@ -11111,6 +11127,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -11118,6 +11135,7 @@
"", "",
"", "",
"", "",
"",
"" ""
], ],
"location": "query" "location": "query"
@@ -14105,6 +14123,7 @@
"FLASH_INPAGE", "FLASH_INPAGE",
"HTML5_BANNER", "HTML5_BANNER",
"IMAGE", "IMAGE",
"INSTREAM_AUDIO",
"INSTREAM_VIDEO", "INSTREAM_VIDEO",
"INSTREAM_VIDEO_REDIRECT", "INSTREAM_VIDEO_REDIRECT",
"INTERNAL_REDIRECT", "INTERNAL_REDIRECT",
@@ -14145,6 +14164,7 @@
"", "",
"", "",
"", "",
"",
"" ""
], ],
"repeated": true, "repeated": true,
@@ -14486,7 +14506,7 @@
}, },
"dfpNetworkCode": { "dfpNetworkCode": {
"type": "string", "type": "string",
"description": "Select only directory sites with this DFP network code.", "description": "Select only directory sites with this Ad Manager network code.",
"location": "query" "location": "query"
}, },
"ids": { "ids": {
@@ -17156,6 +17176,7 @@
"APP_INTERSTITIAL", "APP_INTERSTITIAL",
"DISPLAY", "DISPLAY",
"DISPLAY_INTERSTITIAL", "DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO" "IN_STREAM_VIDEO"
], ],
"enumDescriptions": [ "enumDescriptions": [
@@ -17163,6 +17184,7 @@
"", "",
"", "",
"", "",
"",
"" ""
], ],
"repeated": true, "repeated": true,
@@ -18734,7 +18756,7 @@
"id": "dfareporting.sizes.list", "id": "dfareporting.sizes.list",
"path": "userprofiles/{profileId}/sizes", "path": "userprofiles/{profileId}/sizes",
"httpMethod": "GET", "httpMethod": "GET",
"description": "Retrieves a list of sizes, possibly filtered.", "description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.",
"parameters": { "parameters": {
"height": { "height": {
"type": "integer", "type": "integer",

20020
etc/api/dfareporting/v3.1/dfareporting-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

20056
etc/api/dfareporting/v3.2/dfareporting-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

4061
etc/api/dialogflow/v2/dialogflow-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

8031
etc/api/dialogflow/v2beta1/dialogflow-api.json
View File

File diff suppressed because it is too large Load Diff

374
etc/api/digitalassetlinks/v1/digitalassetlinks-api.json Normal file
View File

@@ -0,0 +1,374 @@
{
"resources": {
"statements": {
"methods": {
"list": {
"httpMethod": "GET",
"parameterOrder": [],
"response": {
"$ref": "ListResponse"
},
"parameters": {
"source.web.site": {
"description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED",
"type": "string",
"location": "query"
},
"source.androidApp.packageName": {
"description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
"type": "string",
"location": "query"
},
"source.androidApp.certificate.sha256Fingerprint": {
"description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).",
"type": "string",
"location": "query"
},
"relation": {
"location": "query",
"description": "Use only associations that match the specified relation.\n\nSee the [`Statement`](#Statement) message for a detailed definition of\nrelation strings.\n\nFor a query to match a statement, one of the following must be true:\n\n* both the query's and the statement's relation strings match exactly,\n or\n* the query's relation string is empty or missing.\n\nExample: A query with relation `delegate_permission/common.handle_all_urls`\nmatches an asset link with relation\n`delegate_permission/common.handle_all_urls`.",
"type": "string"
}
},
"flatPath": "v1/statements:list",
"id": "digitalassetlinks.statements.list",
"path": "v1/statements:list",
"description": "Retrieves a list of all statements from a given source that match the\nspecified target and statement string.\n\nThe API guarantees that all statements with secure source assets, such as\nHTTPS websites or Android apps, have been made in a secure way by the owner\nof those assets, as described in the [Digital Asset Links technical design\nspecification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).\nSpecifically, you should consider that for insecure websites (that is,\nwhere the URL starts with `http://` instead of `https://`), this guarantee\ncannot be made.\n\nThe `List` command is most useful in cases where the API client wants to\nknow all the ways in which two assets are related, or enumerate all the\nrelationships from a particular source asset. Example: a feature that\nhelps users navigate to related items. When a mobile app is running on a\ndevice, the feature would make it easy to navigate to the corresponding web\nsite or Google+ profile."
}
}
},
"assetlinks": {
"methods": {
"check": {
"description": "Determines whether the specified (directional) relationship exists between\nthe specified source and target assets.\n\nThe relation describes the intent of the link between the two assets as\nclaimed by the source asset. An example for such relationships is the\ndelegation of privileges or permissions.\n\nThis command is most often used by infrastructure systems to check\npreconditions for an action. For example, a client may want to know if it\nis OK to send a web URL to a particular mobile app instead. The client can\ncheck for the relevant asset link from the website to the mobile app to\ndecide if the operation should be allowed.\n\nA note about security: if you specify a secure asset as the source, such as\nan HTTPS website or an Android app, the API will ensure that any\nstatements used to generate the response have been made in a secure way by\nthe owner of that asset. Conversely, if the source asset is an insecure\nHTTP website (that is, the URL starts with `http://` instead of `https://`),\nthe API cannot verify its statements securely, and it is not possible to\nensure that the website's statements have not been altered by a third\nparty. For more information, see the [Digital Asset Links technical design\nspecification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).",
"response": {
"$ref": "CheckResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
"target.androidApp.packageName": {
"location": "query",
"description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
"type": "string"
},
"source.androidApp.certificate.sha256Fingerprint": {
"location": "query",
"description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).",
"type": "string"
},
"relation": {
"description": "Query string for the relation.\n\nWe identify relations with strings of the format `\u003ckind\u003e/\u003cdetail\u003e`, where\n`\u003ckind\u003e` must be one of a set of pre-defined purpose categories, and\n`\u003cdetail\u003e` is a free-form lowercase alphanumeric string that describes the\nspecific use case of the statement.\n\nRefer to [our API documentation](/digital-asset-links/v1/relation-strings)\nfor the current list of supported relations.\n\nFor a query to match an asset link, both the query's and the asset link's\nrelation strings must match exactly.\n\nExample: A query with relation `delegate_permission/common.handle_all_urls`\nmatches an asset link with relation\n`delegate_permission/common.handle_all_urls`.",
"type": "string",
"location": "query"
},
"target.web.site": {
"location": "query",
"description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED",
"type": "string"
},
"target.androidApp.certificate.sha256Fingerprint": {
"description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).",
"type": "string",
"location": "query"
},
"source.web.site": {
"description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED",
"type": "string",
"location": "query"
},
"source.androidApp.packageName": {
"description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
"type": "string",
"location": "query"
}
},
"flatPath": "v1/assetlinks:check",
"path": "v1/assetlinks:check",
"id": "digitalassetlinks.assetlinks.check"
}
}
}
},
"parameters": {
"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"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"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"
},
"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"
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"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"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
}
},
"schemas": {
"WebAsset": {
"properties": {
"site": {
"description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED",
"type": "string"
}
},
"id": "WebAsset",
"description": "Describes a web asset.",
"type": "object"
},
"ListResponse": {
"description": "Response message for the List call.",
"type": "object",
"properties": {
"debugString": {
"description": "Human-readable message containing information intended to help end users\nunderstand, reproduce and debug the result.\n\n\nThe message will be in English and we are currently not planning to offer\nany translations.\n\nPlease note that no guarantees are made about the contents or format of\nthis string. Any aspect of it may be subject to change without notice.\nYou should not attempt to programmatically parse this data. For\nprogrammatic access, use the error_code field below.",
"type": "string"
},
"maxAge": {
"description": "From serving time, how much longer the response should be considered valid\nbarring further updates.\nREQUIRED",
"format": "google-duration",
"type": "string"
},
"errorCode": {
"enumDescriptions": [
"",
"Unable to parse query.",
"Unable to fetch the asset links data.",
"Invalid HTTPS certificate .",
"HTTP redirects (e.g, 301) are not allowed.",
"Asset links data exceeds maximum size.",
"Can't parse HTTP response.",
"HTTP Content-type should be application/json.",
"JSON content is malformed.",
"A secure asset includes an insecure asset (security downgrade).",
"Too many includes (maybe a loop)."
],
"description": "Error codes that describe the result of the List operation.",
"type": "array",
"items": {
"enum": [
"ERROR_CODE_UNSPECIFIED",
"ERROR_CODE_INVALID_QUERY",
"ERROR_CODE_FETCH_ERROR",
"ERROR_CODE_FAILED_SSL_VALIDATION",
"ERROR_CODE_REDIRECT",
"ERROR_CODE_TOO_LARGE",
"ERROR_CODE_MALFORMED_HTTP_RESPONSE",
"ERROR_CODE_WRONG_CONTENT_TYPE",
"ERROR_CODE_MALFORMED_CONTENT",
"ERROR_CODE_SECURE_ASSET_INCLUDES_INSECURE",
"ERROR_CODE_FETCH_BUDGET_EXHAUSTED"
],
"type": "string"
}
},
"statements": {
"description": "A list of all the matching statements that have been found.",
"type": "array",
"items": {
"$ref": "Statement"
}
}
},
"id": "ListResponse"
},
"Statement": {
"description": "Describes a reliable statement that has been made about the relationship\nbetween a source asset and a target asset.\n\nStatements are always made by the source asset, either directly or by\ndelegating to a statement list that is stored elsewhere.\n\nFor more detailed definitions of statements and assets, please refer\nto our [API documentation landing\npage](/digital-asset-links/v1/getting-started).",
"type": "object",
"properties": {
"target": {
"description": "Every statement has a target asset.\nREQUIRED",
"$ref": "Asset"
},
"source": {
"description": "Every statement has a source asset.\nREQUIRED",
"$ref": "Asset"
},
"relation": {
"description": "The relation identifies the use of the statement as intended by the source\nasset's owner (that is, the person or entity who issued the statement).\nEvery complete statement has a relation.\n\nWe identify relations with strings of the format `\u003ckind\u003e/\u003cdetail\u003e`, where\n`\u003ckind\u003e` must be one of a set of pre-defined purpose categories, and\n`\u003cdetail\u003e` is a free-form lowercase alphanumeric string that describes the\nspecific use case of the statement.\n\nRefer to [our API documentation](/digital-asset-links/v1/relation-strings)\nfor the current list of supported relations.\n\nExample: `delegate_permission/common.handle_all_urls`\nREQUIRED",
"type": "string"
}
},
"id": "Statement"
},
"CertificateInfo": {
"description": "Describes an X509 certificate.",
"type": "object",
"properties": {
"sha256Fingerprint": {
"description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).",
"type": "string"
}
},
"id": "CertificateInfo"
},
"AndroidAppAsset": {
"description": "Describes an android app asset.",
"type": "object",
"properties": {
"certificate": {
"description": "Because there is no global enforcement of package name uniqueness, we also\nrequire a signing certificate, which in combination with the package name\nuniquely identifies an app.\n\nSome apps' signing keys are rotated, so they may be signed by different\nkeys over time. We treat these as distinct assets, since we use (package\nname, cert) as the unique ID. This should not normally pose any problems\nas both versions of the app will make the same or similar statements.\nOther assets making statements about the app will have to be updated when a\nkey is rotated, however.\n\n(Note that the syntaxes for publishing and querying for statements contain\nsyntactic sugar to easily let you specify apps that are known by multiple\ncertificates.)\nREQUIRED",
"$ref": "CertificateInfo"
},
"packageName": {
"description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
"type": "string"
}
},
"id": "AndroidAppAsset"
},
"Asset": {
"description": "Uniquely identifies an asset.\n\nA digital asset is an identifiable and addressable online entity that\ntypically provides some service or content. Examples of assets are websites,\nAndroid apps, Twitter feeds, and Plus Pages.",
"type": "object",
"properties": {
"web": {
"description": "Set if this is a web asset.",
"$ref": "WebAsset"
},
"androidApp": {
"$ref": "AndroidAppAsset",
"description": "Set if this is an Android App asset."
}
},
"id": "Asset"
},
"CheckResponse": {
"description": "Response message for the CheckAssetLinks call.",
"type": "object",
"properties": {
"linked": {
"description": "Set to true if the assets specified in the request are linked by the\nrelation specified in the request.",
"type": "boolean"
},
"debugString": {
"description": "Human-readable message containing information intended to help end users\nunderstand, reproduce and debug the result.\n\n\nThe message will be in English and we are currently not planning to offer\nany translations.\n\nPlease note that no guarantees are made about the contents or format of\nthis string. Any aspect of it may be subject to change without notice.\nYou should not attempt to programmatically parse this data. For\nprogrammatic access, use the error_code field below.",
"type": "string"
},
"maxAge": {
"description": "From serving time, how much longer the response should be considered valid\nbarring further updates.\nREQUIRED",
"format": "google-duration",
"type": "string"
},
"errorCode": {
"description": "Error codes that describe the result of the Check operation.",
"type": "array",
"items": {
"enum": [
"ERROR_CODE_UNSPECIFIED",
"ERROR_CODE_INVALID_QUERY",
"ERROR_CODE_FETCH_ERROR",
"ERROR_CODE_FAILED_SSL_VALIDATION",
"ERROR_CODE_REDIRECT",
"ERROR_CODE_TOO_LARGE",
"ERROR_CODE_MALFORMED_HTTP_RESPONSE",
"ERROR_CODE_WRONG_CONTENT_TYPE",
"ERROR_CODE_MALFORMED_CONTENT",
"ERROR_CODE_SECURE_ASSET_INCLUDES_INSECURE",
"ERROR_CODE_FETCH_BUDGET_EXHAUSTED"
],
"type": "string"
},
"enumDescriptions": [
"",
"Unable to parse query.",
"Unable to fetch the asset links data.",
"Invalid HTTPS certificate .",
"HTTP redirects (e.g, 301) are not allowed.",
"Asset links data exceeds maximum size.",
"Can't parse HTTP response.",
"HTTP Content-type should be application/json.",
"JSON content is malformed.",
"A secure asset includes an insecure asset (security downgrade).",
"Too many includes (maybe a loop)."
]
}
},
"id": "CheckResponse"
}
},
"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://digitalassetlinks.googleapis.com/",
"servicePath": "",
"description": "API for discovering relationships between online assets such as web sites or mobile apps.",
"kind": "discovery#restDescription",
"rootUrl": "https://digitalassetlinks.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "digitalassetlinks",
"batchPath": "batch",
"revision": "20181009",
"documentationLink": "https://developers.google.com/digital-asset-links/",
"id": "digitalassetlinks:v1",
"title": "Digital Asset Links API",
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": true
}

7
etc/api/discovery/v1/discovery-api.json
View File

@@ -1,10 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/K3nEDF6hixE8Pks2-9Ysn9j9prQ\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/PGGHNe1PXjqgoCOXElfJHYi-5fs\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "discovery:v1", "id": "discovery:v1",
"name": "discovery", "name": "discovery",
"version": "v1", "version": "v1",
"revision": "20181009",
"title": "APIs Discovery Service", "title": "APIs Discovery Service",
"description": "Provides information about other Google APIs, such as what APIs are available, the resource, and method details for each API.", "description": "Provides information about other Google APIs, such as what APIs are available, the resource, and method details for each API.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -56,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },

5082
etc/api/dlp/v2/dlp-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

701
etc/api/dns/v1/dns-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/kYaEhhTBm7CVpFDEtOaBWuwXKdQ\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/nE2v0f629312WixQdKCUFMQlo9A\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "dns:v1", "id": "dns:v1",
"name": "dns", "name": "dns",
"version": "v1", "version": "v1",
"revision": "20171204", "revision": "20180826",
"title": "Google Cloud DNS API", "title": "Google Cloud DNS API",
"description": "Configures and serves authoritative DNS records.", "description": "Configures and serves authoritative DNS records.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -108,6 +108,10 @@
"type": "string", "type": "string",
"description": "Unique identifier for the resource; defined by the server (output only)." "description": "Unique identifier for the resource; defined by the server (output only)."
}, },
"isServing": {
"type": "boolean",
"description": "If the DNS queries for the zone will be served."
},
"kind": { "kind": {
"type": "string", "type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dns#change\".", "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#change\".",
@@ -143,6 +147,9 @@
"$ref": "Change" "$ref": "Change"
} }
}, },
"header": {
"$ref": "ResponseHeader"
},
"kind": { "kind": {
"type": "string", "type": "string",
"description": "Type of resource.", "description": "Type of resource.",
@@ -154,6 +161,182 @@
} }
} }
}, },
"DnsKey": {
"id": "DnsKey",
"type": "object",
"description": "A DNSSEC key pair.",
"properties": {
"algorithm": {
"type": "string",
"description": "String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.",
"enum": [
"ecdsap256sha256",
"ecdsap384sha384",
"rsasha1",
"rsasha256",
"rsasha512"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"creationTime": {
"type": "string",
"description": "The time that this resource was created in the control plane. This is in RFC3339 text format. Output only."
},
"description": {
"type": "string",
"description": "A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function."
},
"digests": {
"type": "array",
"description": "Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.",
"items": {
"$ref": "DnsKeyDigest"
}
},
"id": {
"type": "string",
"description": "Unique identifier for the resource; defined by the server (output only)."
},
"isActive": {
"type": "boolean",
"description": "Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures."
},
"keyLength": {
"type": "integer",
"description": "Length of the key in bits. Specified at creation time then immutable.",
"format": "uint32"
},
"keyTag": {
"type": "integer",
"description": "The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.",
"format": "int32"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dns#dnsKey\".",
"default": "dns#dnsKey"
},
"publicKey": {
"type": "string",
"description": "Base64 encoded public half of this key. Output only."
},
"type": {
"type": "string",
"description": "One of \"KEY_SIGNING\" or \"ZONE_SIGNING\". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.",
"enum": [
"keySigning",
"zoneSigning"
],
"enumDescriptions": [
"",
""
]
}
}
},
"DnsKeyDigest": {
"id": "DnsKeyDigest",
"type": "object",
"properties": {
"digest": {
"type": "string",
"description": "The base-16 encoded bytes of this digest. Suitable for use in a DS resource record."
},
"type": {
"type": "string",
"description": "Specifies the algorithm used to calculate this digest.",
"enum": [
"sha1",
"sha256",
"sha384"
],
"enumDescriptions": [
"",
"",
""
]
}
}
},
"DnsKeySpec": {
"id": "DnsKeySpec",
"type": "object",
"description": "Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.",
"properties": {
"algorithm": {
"type": "string",
"description": "String mnemonic specifying the DNSSEC algorithm of this key.",
"enum": [
"ecdsap256sha256",
"ecdsap384sha384",
"rsasha1",
"rsasha256",
"rsasha512"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"keyLength": {
"type": "integer",
"description": "Length of the keys in bits.",
"format": "uint32"
},
"keyType": {
"type": "string",
"description": "One of \"KEY_SIGNING\" or \"ZONE_SIGNING\". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.",
"enum": [
"keySigning",
"zoneSigning"
],
"enumDescriptions": [
"",
""
]
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dns#dnsKeySpec\".",
"default": "dns#dnsKeySpec"
}
}
},
"DnsKeysListResponse": {
"id": "DnsKeysListResponse",
"type": "object",
"description": "The response to a request to enumerate DnsKeys in a ManagedZone.",
"properties": {
"dnsKeys": {
"type": "array",
"description": "The requested resources.",
"items": {
"$ref": "DnsKey"
}
},
"header": {
"$ref": "ResponseHeader"
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "dns#dnsKeysListResponse"
},
"nextPageToken": {
"type": "string",
"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.\n\nIn this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a \"snapshot\" of collections larger than the maximum page size."
}
}
},
"ManagedZone": { "ManagedZone": {
"id": "ManagedZone", "id": "ManagedZone",
"type": "object", "type": "object",
@@ -171,6 +354,10 @@
"type": "string", "type": "string",
"description": "The DNS name of this managed zone, for instance \"example.com.\"." "description": "The DNS name of this managed zone, for instance \"example.com.\"."
}, },
"dnssecConfig": {
"$ref": "ManagedZoneDnsSecConfig",
"description": "DNSSEC configuration."
},
"id": { "id": {
"type": "string", "type": "string",
"description": "Unique identifier for the resource; defined by the server (output only)", "description": "Unique identifier for the resource; defined by the server (output only)",
@@ -181,6 +368,13 @@
"description": "Identifies what kind of resource this is. Value: the fixed string \"dns#managedZone\".", "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#managedZone\".",
"default": "dns#managedZone" "default": "dns#managedZone"
}, },
"labels": {
"type": "object",
"description": "User labels.",
"additionalProperties": {
"type": "string"
}
},
"name": { "name": {
"type": "string", "type": "string",
"description": "User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes." "description": "User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes."
@@ -198,10 +392,82 @@
} }
} }
}, },
"ManagedZoneDnsSecConfig": {
"id": "ManagedZoneDnsSecConfig",
"type": "object",
"properties": {
"defaultKeySpecs": {
"type": "array",
"description": "Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.",
"items": {
"$ref": "DnsKeySpec"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dns#managedZoneDnsSecConfig\".",
"default": "dns#managedZoneDnsSecConfig"
},
"nonExistence": {
"type": "string",
"description": "Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.",
"enum": [
"nsec",
"nsec3"
],
"enumDescriptions": [
"",
""
]
},
"state": {
"type": "string",
"description": "Specifies whether DNSSEC is enabled, and what mode it is in.",
"enum": [
"off",
"on",
"transfer"
],
"enumDescriptions": [
"",
"",
""
]
}
}
},
"ManagedZoneOperationsListResponse": {
"id": "ManagedZoneOperationsListResponse",
"type": "object",
"properties": {
"header": {
"$ref": "ResponseHeader"
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "dns#managedZoneOperationsListResponse"
},
"nextPageToken": {
"type": "string",
"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token.\n\nIn this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size."
},
"operations": {
"type": "array",
"description": "The operation resources.",
"items": {
"$ref": "Operation"
}
}
}
},
"ManagedZonesListResponse": { "ManagedZonesListResponse": {
"id": "ManagedZonesListResponse", "id": "ManagedZonesListResponse",
"type": "object", "type": "object",
"properties": { "properties": {
"header": {
"$ref": "ResponseHeader"
},
"kind": { "kind": {
"type": "string", "type": "string",
"description": "Type of resource.", "description": "Type of resource.",
@@ -220,6 +486,82 @@
} }
} }
}, },
"Operation": {
"id": "Operation",
"type": "object",
"description": "An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.",
"properties": {
"dnsKeyContext": {
"$ref": "OperationDnsKeyContext",
"description": "Only populated if the operation targeted a DnsKey (output only)."
},
"id": {
"type": "string",
"description": "Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dns#operation\".",
"default": "dns#operation"
},
"startTime": {
"type": "string",
"description": "The time that this operation was started by the server. This is in RFC3339 text format (output only)."
},
"status": {
"type": "string",
"description": "Status of the operation. Can be one of the following: \"PENDING\" or \"DONE\" (output only).",
"enum": [
"done",
"pending"
],
"enumDescriptions": [
"",
""
]
},
"type": {
"type": "string",
"description": "Type of the operation. Operations include insert, update, and delete (output only)."
},
"user": {
"type": "string",
"description": "User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)"
},
"zoneContext": {
"$ref": "OperationManagedZoneContext",
"description": "Only populated if the operation targeted a ManagedZone (output only)."
}
}
},
"OperationDnsKeyContext": {
"id": "OperationDnsKeyContext",
"type": "object",
"properties": {
"newValue": {
"$ref": "DnsKey",
"description": "The post-operation DnsKey resource."
},
"oldValue": {
"$ref": "DnsKey",
"description": "The pre-operation DnsKey resource."
}
}
},
"OperationManagedZoneContext": {
"id": "OperationManagedZoneContext",
"type": "object",
"properties": {
"newValue": {
"$ref": "ManagedZone",
"description": "The post-operation ManagedZone resource."
},
"oldValue": {
"$ref": "ManagedZone",
"description": "The pre-operation ManagedZone resource."
}
}
},
"Project": { "Project": {
"id": "Project", "id": "Project",
"type": "object", "type": "object",
@@ -250,6 +592,11 @@
"type": "object", "type": "object",
"description": "Limits associated with a Project.", "description": "Limits associated with a Project.",
"properties": { "properties": {
"dnsKeysPerManagedZone": {
"type": "integer",
"description": "Maximum allowed number of DnsKeys per ManagedZone.",
"format": "int32"
},
"kind": { "kind": {
"type": "string", "type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"dns#quota\".", "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#quota\".",
@@ -284,6 +631,13 @@
"type": "integer", "type": "integer",
"description": "Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.", "description": "Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.",
"format": "int32" "format": "int32"
},
"whitelistedKeySpecs": {
"type": "array",
"description": "DNSSEC algorithm and key length types that can be used for DnsKeys.",
"items": {
"$ref": "DnsKeySpec"
}
} }
} }
}, },
@@ -308,6 +662,13 @@
"type": "string" "type": "string"
} }
}, },
"signatureRrdatas": {
"type": "array",
"description": "As defined in RFC 4034 (section 3.2).",
"items": {
"type": "string"
}
},
"ttl": { "ttl": {
"type": "integer", "type": "integer",
"description": "Number of seconds that this ResourceRecordSet can be cached by resolvers.", "description": "Number of seconds that this ResourceRecordSet can be cached by resolvers.",
@@ -323,6 +684,9 @@
"id": "ResourceRecordSetsListResponse", "id": "ResourceRecordSetsListResponse",
"type": "object", "type": "object",
"properties": { "properties": {
"header": {
"$ref": "ResponseHeader"
},
"kind": { "kind": {
"type": "string", "type": "string",
"description": "Type of resource.", "description": "Type of resource.",
@@ -340,6 +704,17 @@
} }
} }
} }
},
"ResponseHeader": {
"id": "ResponseHeader",
"type": "object",
"description": "Elements common to every response.",
"properties": {
"operationId": {
"type": "string",
"description": "For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only)."
}
}
} }
}, },
"resources": { "resources": {
@@ -351,6 +726,11 @@
"httpMethod": "POST", "httpMethod": "POST",
"description": "Atomically update the ResourceRecordSet collection.", "description": "Atomically update the ResourceRecordSet collection.",
"parameters": { "parameters": {
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"managedZone": { "managedZone": {
"type": "string", "type": "string",
"description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.", "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.",
@@ -391,6 +771,11 @@
"required": true, "required": true,
"location": "path" "location": "path"
}, },
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"managedZone": { "managedZone": {
"type": "string", "type": "string",
"description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.", "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.",
@@ -482,6 +867,216 @@
} }
} }
}, },
"dnsKeys": {
"methods": {
"get": {
"id": "dns.dnsKeys.get",
"path": "{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}",
"httpMethod": "GET",
"description": "Fetch the representation of an existing DnsKey.",
"parameters": {
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"digestType": {
"type": "string",
"description": "An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.",
"location": "query"
},
"dnsKeyId": {
"type": "string",
"description": "The identifier of the requested DnsKey.",
"required": true,
"location": "path"
},
"managedZone": {
"type": "string",
"description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Identifies the project addressed by this request.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"managedZone",
"dnsKeyId"
],
"response": {
"$ref": "DnsKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/ndev.clouddns.readonly",
"https://www.googleapis.com/auth/ndev.clouddns.readwrite"
]
},
"list": {
"id": "dns.dnsKeys.list",
"path": "{project}/managedZones/{managedZone}/dnsKeys",
"httpMethod": "GET",
"description": "Enumerate DnsKeys to a ResourceRecordSet collection.",
"parameters": {
"digestType": {
"type": "string",
"description": "An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.",
"location": "query"
},
"managedZone": {
"type": "string",
"description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.",
"required": true,
"location": "path"
},
"maxResults": {
"type": "integer",
"description": "Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.",
"format": "int32",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.",
"location": "query"
},
"project": {
"type": "string",
"description": "Identifies the project addressed by this request.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"managedZone"
],
"response": {
"$ref": "DnsKeysListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/ndev.clouddns.readonly",
"https://www.googleapis.com/auth/ndev.clouddns.readwrite"
]
}
}
},
"managedZoneOperations": {
"methods": {
"get": {
"id": "dns.managedZoneOperations.get",
"path": "{project}/managedZones/{managedZone}/operations/{operation}",
"httpMethod": "GET",
"description": "Fetch the representation of an existing Operation.",
"parameters": {
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"managedZone": {
"type": "string",
"description": "Identifies the managed zone addressed by this request.",
"required": true,
"location": "path"
},
"operation": {
"type": "string",
"description": "Identifies the operation addressed by this request.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Identifies the project addressed by this request.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"managedZone",
"operation"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/ndev.clouddns.readonly",
"https://www.googleapis.com/auth/ndev.clouddns.readwrite"
]
},
"list": {
"id": "dns.managedZoneOperations.list",
"path": "{project}/managedZones/{managedZone}/operations",
"httpMethod": "GET",
"description": "Enumerate Operations for the given ManagedZone.",
"parameters": {
"managedZone": {
"type": "string",
"description": "Identifies the managed zone addressed by this request.",
"required": true,
"location": "path"
},
"maxResults": {
"type": "integer",
"description": "Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.",
"format": "int32",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.",
"location": "query"
},
"project": {
"type": "string",
"description": "Identifies the project addressed by this request.",
"required": true,
"location": "path"
},
"sortBy": {
"type": "string",
"description": "Sorting criterion. The only supported values are START_TIME and ID.",
"default": "startTime",
"enum": [
"id",
"startTime"
],
"enumDescriptions": [
"",
""
],
"location": "query"
}
},
"parameterOrder": [
"project",
"managedZone"
],
"response": {
"$ref": "ManagedZoneOperationsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/ndev.clouddns.readonly",
"https://www.googleapis.com/auth/ndev.clouddns.readwrite"
]
}
}
},
"managedZones": { "managedZones": {
"methods": { "methods": {
"create": { "create": {
@@ -490,6 +1085,11 @@
"httpMethod": "POST", "httpMethod": "POST",
"description": "Create a new ManagedZone.", "description": "Create a new ManagedZone.",
"parameters": { "parameters": {
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"project": { "project": {
"type": "string", "type": "string",
"description": "Identifies the project addressed by this request.", "description": "Identifies the project addressed by this request.",
@@ -517,6 +1117,11 @@
"httpMethod": "DELETE", "httpMethod": "DELETE",
"description": "Delete a previously created ManagedZone.", "description": "Delete a previously created ManagedZone.",
"parameters": { "parameters": {
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"managedZone": { "managedZone": {
"type": "string", "type": "string",
"description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.", "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.",
@@ -545,6 +1150,11 @@
"httpMethod": "GET", "httpMethod": "GET",
"description": "Fetch the representation of an existing ManagedZone.", "description": "Fetch the representation of an existing ManagedZone.",
"parameters": { "parameters": {
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"managedZone": { "managedZone": {
"type": "string", "type": "string",
"description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.", "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.",
@@ -613,6 +1223,84 @@
"https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readonly",
"https://www.googleapis.com/auth/ndev.clouddns.readwrite" "https://www.googleapis.com/auth/ndev.clouddns.readwrite"
] ]
},
"patch": {
"id": "dns.managedZones.patch",
"path": "{project}/managedZones/{managedZone}",
"httpMethod": "PATCH",
"description": "Apply a partial update to an existing ManagedZone.",
"parameters": {
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"managedZone": {
"type": "string",
"description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Identifies the project addressed by this request.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"managedZone"
],
"request": {
"$ref": "ManagedZone"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/ndev.clouddns.readwrite"
]
},
"update": {
"id": "dns.managedZones.update",
"path": "{project}/managedZones/{managedZone}",
"httpMethod": "PUT",
"description": "Update an existing ManagedZone.",
"parameters": {
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"managedZone": {
"type": "string",
"description": "Identifies the managed zone addressed by this request. Can be the managed zone name or id.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Identifies the project addressed by this request.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"managedZone"
],
"request": {
"$ref": "ManagedZone"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/ndev.clouddns.readwrite"
]
} }
} }
}, },
@@ -624,6 +1312,11 @@
"httpMethod": "GET", "httpMethod": "GET",
"description": "Fetch the representation of an existing Project.", "description": "Fetch the representation of an existing Project.",
"parameters": { "parameters": {
"clientOperationId": {
"type": "string",
"description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.",
"location": "query"
},
"project": { "project": {
"type": "string", "type": "string",
"description": "Identifies the project addressed by this request.", "description": "Identifies the project addressed by this request.",

29
etc/api/dns/v1beta2/dns-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/Wmm2Vo9PjskhCswlTPYrBhP5H3I\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/wncGJUHVgzoAPJRXjv0oJvjDv38\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "dns:v1beta2", "id": "dns:v1beta2",
"name": "dns", "name": "dns",
"version": "v1beta2", "version": "v1beta2",
"revision": "20171204", "revision": "20180826",
"title": "Google Cloud DNS API", "title": "Google Cloud DNS API",
"description": "Configures and serves authoritative DNS records.", "description": "Configures and serves authoritative DNS records.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -368,6 +368,13 @@
"description": "Identifies what kind of resource this is. Value: the fixed string \"dns#managedZone\".", "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#managedZone\".",
"default": "dns#managedZone" "default": "dns#managedZone"
}, },
"labels": {
"type": "object",
"description": "User labels.",
"additionalProperties": {
"type": "string"
}
},
"name": { "name": {
"type": "string", "type": "string",
"description": "User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes." "description": "User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes."
@@ -454,15 +461,6 @@
} }
} }
}, },
"ManagedZonesDeleteResponse": {
"id": "ManagedZonesDeleteResponse",
"type": "object",
"properties": {
"header": {
"$ref": "ResponseHeader"
}
}
},
"ManagedZonesListResponse": { "ManagedZonesListResponse": {
"id": "ManagedZonesListResponse", "id": "ManagedZonesListResponse",
"type": "object", "type": "object",
@@ -1141,9 +1139,6 @@
"project", "project",
"managedZone" "managedZone"
], ],
"response": {
"$ref": "ManagedZonesDeleteResponse"
},
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/ndev.clouddns.readwrite" "https://www.googleapis.com/auth/ndev.clouddns.readwrite"
@@ -1233,7 +1228,7 @@
"id": "dns.managedZones.patch", "id": "dns.managedZones.patch",
"path": "{project}/managedZones/{managedZone}", "path": "{project}/managedZones/{managedZone}",
"httpMethod": "PATCH", "httpMethod": "PATCH",
"description": "Update an existing ManagedZone. This method supports patch semantics.", "description": "Apply a partial update to an existing ManagedZone.",
"parameters": { "parameters": {
"clientOperationId": { "clientOperationId": {
"type": "string", "type": "string",

29
etc/api/dns/v2beta1/dns-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/STXKkP7EeWGaQrB4Hta20Be1jDE\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/-SoIhqqh_Hn0l3aqStp_mp2kwds\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "dns:v2beta1", "id": "dns:v2beta1",
"name": "dns", "name": "dns",
"version": "v2beta1", "version": "v2beta1",
"revision": "20171204", "revision": "20180826",
"title": "Google Cloud DNS API", "title": "Google Cloud DNS API",
"description": "Configures and serves authoritative DNS records.", "description": "Configures and serves authoritative DNS records.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -368,6 +368,13 @@
"description": "Identifies what kind of resource this is. Value: the fixed string \"dns#managedZone\".", "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#managedZone\".",
"default": "dns#managedZone" "default": "dns#managedZone"
}, },
"labels": {
"type": "object",
"description": "User labels.",
"additionalProperties": {
"type": "string"
}
},
"name": { "name": {
"type": "string", "type": "string",
"description": "User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes." "description": "User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes."
@@ -454,15 +461,6 @@
} }
} }
}, },
"ManagedZonesDeleteResponse": {
"id": "ManagedZonesDeleteResponse",
"type": "object",
"properties": {
"header": {
"$ref": "ResponseHeader"
}
}
},
"ManagedZonesListResponse": { "ManagedZonesListResponse": {
"id": "ManagedZonesListResponse", "id": "ManagedZonesListResponse",
"type": "object", "type": "object",
@@ -1141,9 +1139,6 @@
"project", "project",
"managedZone" "managedZone"
], ],
"response": {
"$ref": "ManagedZonesDeleteResponse"
},
"scopes": [ "scopes": [
"https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/ndev.clouddns.readwrite" "https://www.googleapis.com/auth/ndev.clouddns.readwrite"
@@ -1233,7 +1228,7 @@
"id": "dns.managedZones.patch", "id": "dns.managedZones.patch",
"path": "{project}/managedZones/{managedZone}", "path": "{project}/managedZones/{managedZone}",
"httpMethod": "PATCH", "httpMethod": "PATCH",
"description": "Update an existing ManagedZone. This method supports patch semantics.", "description": "Apply a partial update to an existing ManagedZone.",
"parameters": { "parameters": {
"clientOperationId": { "clientOperationId": {
"type": "string", "type": "string",

74
etc/api/doubleclickbidmanager/v1/doubleclickbidmanager-api.json
View File

@@ -1,12 +1,12 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/fiMIPCbr-8OYnnFx-elRq37f8OU\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/wt31bQU3QIh3FtuHSYPOcRgOq78\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "doubleclickbidmanager:v1", "id": "doubleclickbidmanager:v1",
"name": "doubleclickbidmanager", "name": "doubleclickbidmanager",
"canonicalName": "DoubleClick Bid Manager", "canonicalName": "DoubleClick Bid Manager",
"version": "v1", "version": "v1",
"revision": "20170705", "revision": "20180821",
"title": "DoubleClick Bid Manager API", "title": "DoubleClick Bid Manager API",
"description": "API for viewing and managing your reports in DoubleClick Bid Manager.", "description": "API for viewing and managing your reports in DoubleClick Bid Manager.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -61,12 +61,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -143,16 +143,17 @@
"DownloadRequest": { "DownloadRequest": {
"id": "DownloadRequest", "id": "DownloadRequest",
"type": "object", "type": "object",
"description": "Request to fetch stored insertion orders, line items, TrueView ad groups and ads.", "description": "Request to fetch stored campaigns, insertion orders, line items, TrueView ad groups and ads.",
"properties": { "properties": {
"fileTypes": { "fileTypes": {
"type": "array", "type": "array",
"description": "File types that will be returned.", "description": "File types that will be returned.\n\nAcceptable values are: \n- \"AD\" \n- \"AD_GROUP\" \n- \"CAMPAIGN\" \n- \"INSERTION_ORDER\" \n- \"LINE_ITEM\"",
"items": { "items": {
"type": "string", "type": "string",
"enum": [ "enum": [
"AD", "AD",
"AD_GROUP", "AD_GROUP",
"CAMPAIGN",
"INSERTION_ORDER", "INSERTION_ORDER",
"LINE_ITEM" "LINE_ITEM"
], ],
@@ -160,13 +161,14 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
} }
}, },
"filterIds": { "filterIds": {
"type": "array", "type": "array",
"description": "The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified. Only one ID is allowed for the ADVERTISER_ID filter type. For INSERTION_ORDER_ID or LINE_ITEM_ID filter types, all IDs must be from the same Advertiser.", "description": "The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified.",
"items": { "items": {
"type": "string", "type": "string",
"format": "int64" "format": "int64"
@@ -174,13 +176,15 @@
}, },
"filterType": { "filterType": {
"type": "string", "type": "string",
"description": "Filter type used to filter line items to fetch.", "description": "Filter type used to filter entities to fetch.",
"enum": [ "enum": [
"ADVERTISER_ID", "ADVERTISER_ID",
"CAMPAIGN_ID",
"INSERTION_ORDER_ID", "INSERTION_ORDER_ID",
"LINE_ITEM_ID" "LINE_ITEM_ID"
], ],
"enumDescriptions": [ "enumDescriptions": [
"",
"", "",
"", "",
"" ""
@@ -188,7 +192,7 @@
}, },
"version": { "version": {
"type": "string", "type": "string",
"description": "SDF Version (column names, types, order) in which the entities will be returned. Default to 3." "description": "SDF Version (column names, types, order) in which the entities will be returned. Default to 3.1."
} }
} }
}, },
@@ -205,6 +209,10 @@
"type": "string", "type": "string",
"description": "Retrieved ads in SDF format." "description": "Retrieved ads in SDF format."
}, },
"campaigns": {
"type": "string",
"description": "Retrieved campaigns in SDF format."
},
"insertionOrders": { "insertionOrders": {
"type": "string", "type": "string",
"description": "Retrieved insertion orders in SDF format." "description": "Retrieved insertion orders in SDF format."
@@ -231,6 +239,7 @@
"FILTER_ADVERTISER_TIMEZONE", "FILTER_ADVERTISER_TIMEZONE",
"FILTER_AD_POSITION", "FILTER_AD_POSITION",
"FILTER_AGE", "FILTER_AGE",
"FILTER_AUTHORIZED_SELLER_STATE_ID",
"FILTER_BRANDSAFE_CHANNEL_ID", "FILTER_BRANDSAFE_CHANNEL_ID",
"FILTER_BROWSER", "FILTER_BROWSER",
"FILTER_BUDGET_SEGMENT_DESCRIPTION", "FILTER_BUDGET_SEGMENT_DESCRIPTION",
@@ -249,9 +258,14 @@
"FILTER_DATA_PROVIDER", "FILTER_DATA_PROVIDER",
"FILTER_DATE", "FILTER_DATE",
"FILTER_DAY_OF_WEEK", "FILTER_DAY_OF_WEEK",
"FILTER_DEVICE_MAKE",
"FILTER_DEVICE_MODEL",
"FILTER_DEVICE_TYPE",
"FILTER_DFP_ORDER_ID", "FILTER_DFP_ORDER_ID",
"FILTER_DMA", "FILTER_DMA",
"FILTER_DV360_ACTIVITY_ID",
"FILTER_EXCHANGE_ID", "FILTER_EXCHANGE_ID",
"FILTER_FLOODLIGHT_ACTIVITY_ID",
"FILTER_FLOODLIGHT_PIXEL_ID", "FILTER_FLOODLIGHT_PIXEL_ID",
"FILTER_GENDER", "FILTER_GENDER",
"FILTER_INSERTION_ORDER", "FILTER_INSERTION_ORDER",
@@ -461,6 +475,12 @@
"", "",
"", "",
"", "",
"",
"",
"",
"",
"",
"",
"" ""
] ]
}, },
@@ -533,6 +553,7 @@
"FILTER_ADVERTISER_TIMEZONE", "FILTER_ADVERTISER_TIMEZONE",
"FILTER_AD_POSITION", "FILTER_AD_POSITION",
"FILTER_AGE", "FILTER_AGE",
"FILTER_AUTHORIZED_SELLER_STATE_ID",
"FILTER_BRANDSAFE_CHANNEL_ID", "FILTER_BRANDSAFE_CHANNEL_ID",
"FILTER_BROWSER", "FILTER_BROWSER",
"FILTER_BUDGET_SEGMENT_DESCRIPTION", "FILTER_BUDGET_SEGMENT_DESCRIPTION",
@@ -551,9 +572,14 @@
"FILTER_DATA_PROVIDER", "FILTER_DATA_PROVIDER",
"FILTER_DATE", "FILTER_DATE",
"FILTER_DAY_OF_WEEK", "FILTER_DAY_OF_WEEK",
"FILTER_DEVICE_MAKE",
"FILTER_DEVICE_MODEL",
"FILTER_DEVICE_TYPE",
"FILTER_DFP_ORDER_ID", "FILTER_DFP_ORDER_ID",
"FILTER_DMA", "FILTER_DMA",
"FILTER_DV360_ACTIVITY_ID",
"FILTER_EXCHANGE_ID", "FILTER_EXCHANGE_ID",
"FILTER_FLOODLIGHT_ACTIVITY_ID",
"FILTER_FLOODLIGHT_PIXEL_ID", "FILTER_FLOODLIGHT_PIXEL_ID",
"FILTER_GENDER", "FILTER_GENDER",
"FILTER_INSERTION_ORDER", "FILTER_INSERTION_ORDER",
@@ -763,6 +789,12 @@
"", "",
"", "",
"", "",
"",
"",
"",
"",
"",
"",
"" ""
] ]
} }
@@ -807,6 +839,8 @@
"METRIC_BILLABLE_COST_USD", "METRIC_BILLABLE_COST_USD",
"METRIC_CLICKS", "METRIC_CLICKS",
"METRIC_CLICK_TO_POST_CLICK_CONVERSION_RATE", "METRIC_CLICK_TO_POST_CLICK_CONVERSION_RATE",
"METRIC_CM_POST_CLICK_REVENUE",
"METRIC_CM_POST_VIEW_REVENUE",
"METRIC_COMSCORE_VCE_AUDIENCE_AVG_FREQUENCY", "METRIC_COMSCORE_VCE_AUDIENCE_AVG_FREQUENCY",
"METRIC_COMSCORE_VCE_AUDIENCE_IMPRESSIONS", "METRIC_COMSCORE_VCE_AUDIENCE_IMPRESSIONS",
"METRIC_COMSCORE_VCE_AUDIENCE_IMPRESSIONS_SHARE", "METRIC_COMSCORE_VCE_AUDIENCE_IMPRESSIONS_SHARE",
@@ -816,6 +850,8 @@
"METRIC_COMSCORE_VCE_POPULATION", "METRIC_COMSCORE_VCE_POPULATION",
"METRIC_COMSCORE_VCE_UNIQUE_AUDIENCE", "METRIC_COMSCORE_VCE_UNIQUE_AUDIENCE",
"METRIC_CONVERSIONS_PER_MILLE", "METRIC_CONVERSIONS_PER_MILLE",
"METRIC_COOKIE_REACH_AVERAGE_IMPRESSION_FREQUENCY",
"METRIC_COOKIE_REACH_IMPRESSION_REACH",
"METRIC_CPM_FEE1_ADVERTISER", "METRIC_CPM_FEE1_ADVERTISER",
"METRIC_CPM_FEE1_PARTNER", "METRIC_CPM_FEE1_PARTNER",
"METRIC_CPM_FEE1_USD", "METRIC_CPM_FEE1_USD",
@@ -835,6 +871,7 @@
"METRIC_DATA_COST_ADVERTISER", "METRIC_DATA_COST_ADVERTISER",
"METRIC_DATA_COST_PARTNER", "METRIC_DATA_COST_PARTNER",
"METRIC_DATA_COST_USD", "METRIC_DATA_COST_USD",
"METRIC_DBM_ENGAGEMENT_RATE",
"METRIC_FEE10_ADVERTISER", "METRIC_FEE10_ADVERTISER",
"METRIC_FEE10_PARTNER", "METRIC_FEE10_PARTNER",
"METRIC_FEE10_USD", "METRIC_FEE10_USD",
@@ -898,6 +935,7 @@
"METRIC_FEE9_ADVERTISER", "METRIC_FEE9_ADVERTISER",
"METRIC_FEE9_PARTNER", "METRIC_FEE9_PARTNER",
"METRIC_FEE9_USD", "METRIC_FEE9_USD",
"METRIC_FLOODLIGHT_IMPRESSIONS",
"METRIC_IMPRESSIONS", "METRIC_IMPRESSIONS",
"METRIC_IMPRESSIONS_TO_CONVERSION_RATE", "METRIC_IMPRESSIONS_TO_CONVERSION_RATE",
"METRIC_LAST_CLICKS", "METRIC_LAST_CLICKS",
@@ -996,6 +1034,7 @@
"METRIC_REVENUE_VIEWABLE_ECPM_ADVERTISER", "METRIC_REVENUE_VIEWABLE_ECPM_ADVERTISER",
"METRIC_REVENUE_VIEWABLE_ECPM_PARTNER", "METRIC_REVENUE_VIEWABLE_ECPM_PARTNER",
"METRIC_REVENUE_VIEWABLE_ECPM_USD", "METRIC_REVENUE_VIEWABLE_ECPM_USD",
"METRIC_RICH_MEDIA_SCROLLS",
"METRIC_RICH_MEDIA_VIDEO_COMPLETIONS", "METRIC_RICH_MEDIA_VIDEO_COMPLETIONS",
"METRIC_RICH_MEDIA_VIDEO_FIRST_QUARTILE_COMPLETES", "METRIC_RICH_MEDIA_VIDEO_FIRST_QUARTILE_COMPLETES",
"METRIC_RICH_MEDIA_VIDEO_FULL_SCREENS", "METRIC_RICH_MEDIA_VIDEO_FULL_SCREENS",
@@ -1080,7 +1119,8 @@
"METRIC_UNKNOWN", "METRIC_UNKNOWN",
"METRIC_VIDEO_COMPANION_CLICKS", "METRIC_VIDEO_COMPANION_CLICKS",
"METRIC_VIDEO_COMPANION_IMPRESSIONS", "METRIC_VIDEO_COMPANION_IMPRESSIONS",
"METRIC_VIDEO_COMPLETION_RATE" "METRIC_VIDEO_COMPLETION_RATE",
"METRIC_VIEWABLE_BID_REQUESTS"
], ],
"enumDescriptions": [ "enumDescriptions": [
"", "",
@@ -1386,6 +1426,14 @@
"", "",
"", "",
"", "",
"",
"",
"",
"",
"",
"",
"",
"",
"" ""
] ]
} }
@@ -1407,6 +1455,7 @@
"TYPE_GENERAL", "TYPE_GENERAL",
"TYPE_INVENTORY_AVAILABILITY", "TYPE_INVENTORY_AVAILABILITY",
"TYPE_KEYWORD", "TYPE_KEYWORD",
"TYPE_LINEAR_TV_SEARCH_LIFT",
"TYPE_NIELSEN_AUDIENCE_PROFILE", "TYPE_NIELSEN_AUDIENCE_PROFILE",
"TYPE_NIELSEN_DAILY_REACH_BUILD", "TYPE_NIELSEN_DAILY_REACH_BUILD",
"TYPE_NIELSEN_ONLINE_GLOBAL_MARKET", "TYPE_NIELSEN_ONLINE_GLOBAL_MARKET",
@@ -1457,6 +1506,7 @@
"", "",
"", "",
"", "",
"",
"" ""
] ]
} }
@@ -1978,7 +2028,7 @@
"id": "doubleclickbidmanager.lineitems.downloadlineitems", "id": "doubleclickbidmanager.lineitems.downloadlineitems",
"path": "lineitems/downloadlineitems", "path": "lineitems/downloadlineitems",
"httpMethod": "POST", "httpMethod": "POST",
"description": "Retrieves line items in CSV format.", "description": "Retrieves line items in CSV format. TrueView line items are not supported.",
"request": { "request": {
"$ref": "DownloadLineItemsRequest" "$ref": "DownloadLineItemsRequest"
}, },
@@ -1993,7 +2043,7 @@
"id": "doubleclickbidmanager.lineitems.uploadlineitems", "id": "doubleclickbidmanager.lineitems.uploadlineitems",
"path": "lineitems/uploadlineitems", "path": "lineitems/uploadlineitems",
"httpMethod": "POST", "httpMethod": "POST",
"description": "Uploads line items in CSV format.", "description": "Uploads line items in CSV format. TrueView line items are not supported.",
"request": { "request": {
"$ref": "UploadLineItemsRequest" "$ref": "UploadLineItemsRequest"
}, },

16
etc/api/doubleclicksearch/v2/doubleclicksearch-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/T2vdXek6tIY1HgjGsdCsPe9_CT0\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/qKrjReh8gPfLEBqPkP4nP05MFxo\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "doubleclicksearch:v2", "id": "doubleclicksearch:v2",
"name": "doubleclicksearch", "name": "doubleclicksearch",
"version": "v2", "version": "v2",
"revision": "20171116", "revision": "20181010",
"title": "DoubleClick Search API", "title": "DoubleClick Search API",
"description": "Reports and modifies your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions).", "description": "Reports and modifies your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions).",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -474,7 +474,7 @@
"properties": { "properties": {
"columns": { "columns": {
"type": "array", "type": "array",
"description": "The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.", "description": "The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.\nThe maximum number of columns per request is 300.",
"items": { "items": {
"$ref": "ReportApiColumnSpec" "$ref": "ReportApiColumnSpec"
} }
@@ -490,7 +490,7 @@
}, },
"filters": { "filters": {
"type": "array", "type": "array",
"description": "A list of filters to be applied to the report.", "description": "A list of filters to be applied to the report.\nThe maximum number of filters per request is 300.",
"items": { "items": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -504,7 +504,7 @@
}, },
"values": { "values": {
"type": "array", "type": "array",
"description": "A list of values to filter the column value against.", "description": "A list of values to filter the column value against.\nThe maximum number of filter values per request is 300.",
"items": { "items": {
"type": "any" "type": "any"
} }
@@ -536,7 +536,7 @@
}, },
"orderBy": { "orderBy": {
"type": "array", "type": "array",
"description": "Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.", "description": "Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.\nThe maximum number of orderings per request is 300.",
"items": { "items": {
"type": "object", "type": "object",
"properties": { "properties": {

174
etc/api/drive/v2/drive-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/3l4zAM4QjtKUvpGW4oeKgzw0f5o\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/6CEwLTtnGFlh6TEMLAxgmRoDkCs\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "drive:v2", "id": "drive:v2",
"name": "drive", "name": "drive",
"version": "v2", "version": "v2",
"revision": "20171201", "revision": "20181004",
"title": "Drive API", "title": "Drive API",
"description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -138,6 +138,10 @@
} }
} }
}, },
"canCreateTeamDrives": {
"type": "boolean",
"description": "Whether the user can create Team Drives."
},
"domainSharingPolicy": { "domainSharingPolicy": {
"type": "string", "type": "string",
"description": "The domain sharing policy for the current user. Possible values are: \n- allowed \n- allowedWithWarning \n- incomingOnly \n- disallowed" "description": "The domain sharing policy for the current user. Possible values are: \n- allowed \n- allowedWithWarning \n- incomingOnly \n- disallowed"
@@ -739,6 +743,7 @@
"annotations": { "annotations": {
"required": [ "required": [
"drive.comments.insert", "drive.comments.insert",
"drive.comments.patch",
"drive.comments.update" "drive.comments.update"
] ]
} }
@@ -850,6 +855,7 @@
"description": "The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).", "description": "The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).",
"annotations": { "annotations": {
"required": [ "required": [
"drive.replies.patch",
"drive.replies.update" "drive.replies.update"
] ]
} }
@@ -947,9 +953,13 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can add children to this folder. This is always false when the item is not a folder." "description": "Whether the current user can add children to this folder. This is always false when the item is not a folder."
}, },
"canChangeCopyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file."
},
"canChangeRestrictedDownload": { "canChangeRestrictedDownload": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can change the restricted download label of this file." "description": "Deprecated"
}, },
"canComment": { "canComment": {
"type": "boolean", "type": "boolean",
@@ -963,6 +973,10 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can delete this file." "description": "Whether the current user can delete this file."
}, },
"canDeleteChildren": {
"type": "boolean",
"description": "Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for Team Drive items."
},
"canDownload": { "canDownload": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can download this file." "description": "Whether the current user can download this file."
@@ -975,13 +989,29 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can list the children of this folder. This is always false when the item is not a folder." "description": "Whether the current user can list the children of this folder. This is always false when the item is not a folder."
}, },
"canMoveChildrenOutOfTeamDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder outside of the Team Drive. This is false when the item is not a folder. Only populated for Team Drive items."
},
"canMoveChildrenWithinTeamDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder within the Team Drive. This is false when the item is not a folder. Only populated for Team Drive items."
},
"canMoveItemIntoTeamDrive": { "canMoveItemIntoTeamDrive": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem." "description": "Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem."
}, },
"canMoveItemOutOfTeamDrive": {
"type": "boolean",
"description": "Whether the current user can move this Team Drive item outside of this Team Drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for Team Drive items."
},
"canMoveItemWithinTeamDrive": {
"type": "boolean",
"description": "Whether the current user can move this Team Drive item within this Team Drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for Team Drive items."
},
"canMoveTeamDriveItem": { "canMoveTeamDriveItem": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files." "description": "Deprecated - use canMoveItemWithinTeamDrive or canMoveItemOutOfTeamDrive instead."
}, },
"canReadRevisions": { "canReadRevisions": {
"type": "boolean", "type": "boolean",
@@ -993,7 +1023,7 @@
}, },
"canRemoveChildren": { "canRemoveChildren": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can remove children from this folder. This is always false when the item is not a folder." "description": "Whether the current user can remove children from this folder. This is always false when the item is not a folder. For Team Drive items, use canDeleteChildren or canTrashChildren instead."
}, },
"canRename": { "canRename": {
"type": "boolean", "type": "boolean",
@@ -1007,12 +1037,20 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can move this file to trash." "description": "Whether the current user can move this file to trash."
}, },
"canTrashChildren": {
"type": "boolean",
"description": "Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for Team Drive items."
},
"canUntrash": { "canUntrash": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can restore this file from trash." "description": "Whether the current user can restore this file from trash."
} }
} }
}, },
"copyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters."
},
"copyable": { "copyable": {
"type": "boolean", "type": "boolean",
"description": "Deprecated: use capabilities/canCopy." "description": "Deprecated: use capabilities/canCopy."
@@ -1244,7 +1282,7 @@
}, },
"restricted": { "restricted": {
"type": "boolean", "type": "boolean",
"description": "Whether viewers and commenters are prevented from downloading, printing, and copying this file." "description": "Deprecated - use copyRequiresWriterPermission instead."
}, },
"starred": { "starred": {
"type": "boolean", "type": "boolean",
@@ -1327,7 +1365,7 @@
}, },
"parents": { "parents": {
"type": "array", "type": "array",
"description": "Collection of parent folders which contain this file.\nSetting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.", "description": "Collection of parent folders which contain this file.\nIf not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.",
"items": { "items": {
"$ref": "ParentReference" "$ref": "ParentReference"
} }
@@ -1627,7 +1665,7 @@
}, },
"expirationDate": { "expirationDate": {
"type": "string", "type": "string",
"description": "The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: \n- They can only be set on user and group permissions \n- The date must be in the future \n- The date cannot be more than a year in the future \n- The date can only be set on drive.permissions.update requests", "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: \n- They can only be set on user and group permissions \n- The date must be in the future \n- The date cannot be more than a year in the future \n- The date can only be set on drive.permissions.update or drive.permissions.patch requests",
"format": "date-time" "format": "date-time"
}, },
"id": { "id": {
@@ -1649,7 +1687,7 @@
}, },
"role": { "role": {
"type": "string", "type": "string",
"description": "The primary role for this user. While new values may be supported in the future, the following are currently allowed: \n- organizer \n- owner \n- reader \n- writer", "description": "The primary role for this user. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- reader",
"annotations": { "annotations": {
"required": [ "required": [
"drive.permissions.insert" "drive.permissions.insert"
@@ -1683,7 +1721,7 @@
}, },
"role": { "role": {
"type": "string", "type": "string",
"description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- reader \n- writer" "description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- fileOrganizer \n- writer \n- reader"
}, },
"teamDrivePermissionType": { "teamDrivePermissionType": {
"type": "string", "type": "string",
@@ -1769,7 +1807,12 @@
}, },
"key": { "key": {
"type": "string", "type": "string",
"description": "The key of this property." "description": "The key of this property.",
"annotations": {
"required": [
"drive.properties.insert"
]
}
}, },
"kind": { "kind": {
"type": "string", "type": "string",
@@ -1786,7 +1829,7 @@
}, },
"visibility": { "visibility": {
"type": "string", "type": "string",
"description": "The visibility of this property." "description": "The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)"
} }
} }
}, },
@@ -1991,10 +2034,22 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can add children to folders in this Team Drive." "description": "Whether the current user can add children to folders in this Team Drive."
}, },
"canChangeCopyRequiresWriterPermissionRestriction": {
"type": "boolean",
"description": "Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive."
},
"canChangeDomainUsersOnlyRestriction": {
"type": "boolean",
"description": "Whether the current user can change the domainUsersOnly restriction of this Team Drive."
},
"canChangeTeamDriveBackground": { "canChangeTeamDriveBackground": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can change the background of this Team Drive." "description": "Whether the current user can change the background of this Team Drive."
}, },
"canChangeTeamMembersOnlyRestriction": {
"type": "boolean",
"description": "Whether the current user can change the teamMembersOnly restriction of this Team Drive."
},
"canComment": { "canComment": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can comment on files in this Team Drive." "description": "Whether the current user can comment on files in this Team Drive."
@@ -2003,6 +2058,10 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can copy files in this Team Drive." "description": "Whether the current user can copy files in this Team Drive."
}, },
"canDeleteChildren": {
"type": "boolean",
"description": "Whether the current user can delete children from folders in this Team Drive."
},
"canDeleteTeamDrive": { "canDeleteTeamDrive": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive." "description": "Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive."
@@ -2029,7 +2088,7 @@
}, },
"canRemoveChildren": { "canRemoveChildren": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can remove children from folders in this Team Drive." "description": "Deprecated - use canDeleteChildren or canTrashChildren instead."
}, },
"canRename": { "canRename": {
"type": "boolean", "type": "boolean",
@@ -2042,6 +2101,10 @@
"canShare": { "canShare": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can share files or folders in this Team Drive." "description": "Whether the current user can share files or folders in this Team Drive."
},
"canTrashChildren": {
"type": "boolean",
"description": "Whether the current user can trash children from folders in this Team Drive."
} }
} }
}, },
@@ -2056,7 +2119,7 @@
}, },
"id": { "id": {
"type": "string", "type": "string",
"description": "The ID of this Team Drive which is also the ID of the top level folder for this Team Drive." "description": "The ID of this Team Drive which is also the ID of the top level folder of this Team Drive."
}, },
"kind": { "kind": {
"type": "string", "type": "string",
@@ -2065,7 +2128,34 @@
}, },
"name": { "name": {
"type": "string", "type": "string",
"description": "The name of this Team Drive." "description": "The name of this Team Drive.",
"annotations": {
"required": [
"drive.teamdrives.insert"
]
}
},
"restrictions": {
"type": "object",
"description": "A set of restrictions that apply to this Team Drive or items inside this Team Drive.",
"properties": {
"adminManagedRestrictions": {
"type": "boolean",
"description": "Whether administrative privileges on this Team Drive are required to modify restrictions."
},
"copyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive."
},
"domainUsersOnly": {
"type": "boolean",
"description": "Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive."
},
"teamMembersOnly": {
"type": "boolean",
"description": "Whether access to items inside this Team Drive is restricted to members of this Team Drive."
}
}
}, },
"themeId": { "themeId": {
"type": "string", "type": "string",
@@ -2146,7 +2236,7 @@
"parameters": { "parameters": {
"includeSubscribed": { "includeSubscribed": {
"type": "boolean", "type": "boolean",
"description": "When calculating the number of remaining change IDs, whether to include public files the user has opened and shared files. When set to false, this counts only change IDs for owned files and any shared or public files that the user has explicitly added to a folder they own.", "description": "Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the maxChangeIdCount.",
"default": "true", "default": "true",
"location": "query" "location": "query"
}, },
@@ -2249,7 +2339,7 @@
"id": "drive.changes.get", "id": "drive.changes.get",
"path": "changes/{changeId}", "path": "changes/{changeId}",
"httpMethod": "GET", "httpMethod": "GET",
"description": "Gets a specific change.", "description": "Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes.",
"parameters": { "parameters": {
"changeId": { "changeId": {
"type": "string", "type": "string",
@@ -2338,7 +2428,7 @@
}, },
"includeSubscribed": { "includeSubscribed": {
"type": "boolean", "type": "boolean",
"description": "Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.", "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.",
"default": "true", "default": "true",
"location": "query" "location": "query"
}, },
@@ -2368,7 +2458,7 @@
}, },
"startChangeId": { "startChangeId": {
"type": "string", "type": "string",
"description": "Change ID to start listing changes from.", "description": "Deprecated - use pageToken instead.",
"format": "int64", "format": "int64",
"location": "query" "location": "query"
}, },
@@ -2419,7 +2509,7 @@
}, },
"includeSubscribed": { "includeSubscribed": {
"type": "boolean", "type": "boolean",
"description": "Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.", "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.",
"default": "true", "default": "true",
"location": "query" "location": "query"
}, },
@@ -2449,7 +2539,7 @@
}, },
"startChangeId": { "startChangeId": {
"type": "string", "type": "string",
"description": "Change ID to start listing changes from.", "description": "Deprecated - use pageToken instead.",
"format": "int64", "format": "int64",
"location": "query" "location": "query"
}, },
@@ -3398,7 +3488,7 @@
}, },
"setModifiedDate": { "setModifiedDate": {
"type": "boolean", "type": "boolean",
"description": "Whether to set the modified date with the supplied modified date.", "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.",
"default": "false", "default": "false",
"location": "query" "location": "query"
}, },
@@ -3486,7 +3576,7 @@
"id": "drive.files.trash", "id": "drive.files.trash",
"path": "files/{fileId}/trash", "path": "files/{fileId}/trash",
"httpMethod": "POST", "httpMethod": "POST",
"description": "Moves a file to the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files.", "description": "Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for Team Drive files.",
"parameters": { "parameters": {
"fileId": { "fileId": {
"type": "string", "type": "string",
@@ -3620,7 +3710,7 @@
}, },
"setModifiedDate": { "setModifiedDate": {
"type": "boolean", "type": "boolean",
"description": "Whether to set the modified date with the supplied modified date.", "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.",
"default": "false", "default": "false",
"location": "query" "location": "query"
}, },
@@ -3921,7 +4011,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -3961,7 +4051,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -4020,7 +4110,7 @@
"parameters": { "parameters": {
"emailMessage": { "emailMessage": {
"type": "string", "type": "string",
"description": "A custom message to include in notification emails.", "description": "A plain text custom message to include in notification emails.",
"location": "query" "location": "query"
}, },
"fileId": { "fileId": {
@@ -4043,7 +4133,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -4095,7 +4185,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -4153,7 +4243,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -4211,7 +4301,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -4375,7 +4465,7 @@
"id": "drive.properties.patch", "id": "drive.properties.patch",
"path": "files/{fileId}/properties/{propertyKey}", "path": "files/{fileId}/properties/{propertyKey}",
"httpMethod": "PATCH", "httpMethod": "PATCH",
"description": "Updates a property, or adds it if it doesn't exist. This method supports patch semantics.", "description": "Updates a property.",
"parameters": { "parameters": {
"fileId": { "fileId": {
"type": "string", "type": "string",
@@ -4391,7 +4481,7 @@
}, },
"visibility": { "visibility": {
"type": "string", "type": "string",
"description": "The visibility of the property.", "description": "The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)",
"default": "private", "default": "private",
"location": "query" "location": "query"
} }
@@ -4417,7 +4507,7 @@
"id": "drive.properties.update", "id": "drive.properties.update",
"path": "files/{fileId}/properties/{propertyKey}", "path": "files/{fileId}/properties/{propertyKey}",
"httpMethod": "PUT", "httpMethod": "PUT",
"description": "Updates a property, or adds it if it doesn't exist.", "description": "Updates a property.",
"parameters": { "parameters": {
"fileId": { "fileId": {
"type": "string", "type": "string",
@@ -4433,7 +4523,7 @@
}, },
"visibility": { "visibility": {
"type": "string", "type": "string",
"description": "The visibility of the property.", "description": "The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)",
"default": "private", "default": "private",
"location": "query" "location": "query"
} }
@@ -5004,7 +5094,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -5073,7 +5163,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.", "description": "Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -5097,6 +5187,12 @@
"description": "The ID of the Team Drive", "description": "The ID of the Team Drive",
"required": true, "required": true,
"location": "path" "location": "path"
},
"useDomainAdminAccess": {
"type": "boolean",
"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.",
"default": "false",
"location": "query"
} }
}, },
"parameterOrder": [ "parameterOrder": [

126
etc/api/drive/v3/drive-api.json
View File

@@ -1,11 +1,11 @@
{ {
"kind": "discovery#restDescription", "kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/dokL7JnoHyUOqrzu7Ur837tSd0s\"", "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/jcb0-MLN_pBue1FrS8xKoAlTq7w\"",
"discoveryVersion": "v1", "discoveryVersion": "v1",
"id": "drive:v3", "id": "drive:v3",
"name": "drive", "name": "drive",
"version": "v3", "version": "v3",
"revision": "20171201", "revision": "20181004",
"title": "Drive API", "title": "Drive API",
"description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.",
"ownerDomain": "google.com", "ownerDomain": "google.com",
@@ -57,12 +57,12 @@
}, },
"quotaUser": { "quotaUser": {
"type": "string", "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.", "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query" "location": "query"
}, },
"userIp": { "userIp": {
"type": "string", "type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", "description": "Deprecated. Please use quotaUser instead.",
"location": "query" "location": "query"
} }
}, },
@@ -106,6 +106,10 @@
"type": "boolean", "type": "boolean",
"description": "Whether the user has installed the requesting app." "description": "Whether the user has installed the requesting app."
}, },
"canCreateTeamDrives": {
"type": "boolean",
"description": "Whether the user can create Team Drives."
},
"exportFormats": { "exportFormats": {
"type": "object", "type": "object",
"description": "A map of source MIME type to possible targets for all supported exports.", "description": "A map of source MIME type to possible targets for all supported exports.",
@@ -445,9 +449,13 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can add children to this folder. This is always false when the item is not a folder." "description": "Whether the current user can add children to this folder. This is always false when the item is not a folder."
}, },
"canChangeCopyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file."
},
"canChangeViewersCanCopyContent": { "canChangeViewersCanCopyContent": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can change whether viewers can copy the contents of this file." "description": "Deprecated"
}, },
"canComment": { "canComment": {
"type": "boolean", "type": "boolean",
@@ -461,6 +469,10 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can delete this file." "description": "Whether the current user can delete this file."
}, },
"canDeleteChildren": {
"type": "boolean",
"description": "Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for Team Drive items."
},
"canDownload": { "canDownload": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can download this file." "description": "Whether the current user can download this file."
@@ -473,13 +485,29 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can list the children of this folder. This is always false when the item is not a folder." "description": "Whether the current user can list the children of this folder. This is always false when the item is not a folder."
}, },
"canMoveChildrenOutOfTeamDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder outside of the Team Drive. This is false when the item is not a folder. Only populated for Team Drive items."
},
"canMoveChildrenWithinTeamDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder within the Team Drive. This is false when the item is not a folder. Only populated for Team Drive items."
},
"canMoveItemIntoTeamDrive": { "canMoveItemIntoTeamDrive": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem." "description": "Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem."
}, },
"canMoveItemOutOfTeamDrive": {
"type": "boolean",
"description": "Whether the current user can move this Team Drive item outside of this Team Drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for Team Drive items."
},
"canMoveItemWithinTeamDrive": {
"type": "boolean",
"description": "Whether the current user can move this Team Drive item within this Team Drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for Team Drive items."
},
"canMoveTeamDriveItem": { "canMoveTeamDriveItem": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files." "description": "Deprecated - use canMoveItemWithinTeamDrive or canMoveItemOutOfTeamDrive instead."
}, },
"canReadRevisions": { "canReadRevisions": {
"type": "boolean", "type": "boolean",
@@ -491,7 +519,7 @@
}, },
"canRemoveChildren": { "canRemoveChildren": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can remove children from this folder. This is always false when the item is not a folder." "description": "Whether the current user can remove children from this folder. This is always false when the item is not a folder. For Team Drive items, use canDeleteChildren or canTrashChildren instead."
}, },
"canRename": { "canRename": {
"type": "boolean", "type": "boolean",
@@ -505,6 +533,10 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can move this file to trash." "description": "Whether the current user can move this file to trash."
}, },
"canTrashChildren": {
"type": "boolean",
"description": "Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for Team Drive items."
},
"canUntrash": { "canUntrash": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can restore this file from trash." "description": "Whether the current user can restore this file from trash."
@@ -536,6 +568,10 @@
} }
} }
}, },
"copyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters."
},
"createdTime": { "createdTime": {
"type": "string", "type": "string",
"description": "The time at which the file was created (RFC 3339 date-time).", "description": "The time at which the file was created (RFC 3339 date-time).",
@@ -754,7 +790,7 @@
}, },
"parents": { "parents": {
"type": "array", "type": "array",
"description": "The IDs of the parent folders which contain the file.\nIf not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.", "description": "The IDs of the parent folders which contain the file.\nIf not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.",
"items": { "items": {
"type": "string" "type": "string"
} }
@@ -877,7 +913,7 @@
}, },
"viewersCanCopyContent": { "viewersCanCopyContent": {
"type": "boolean", "type": "boolean",
"description": "Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations." "description": "Deprecated - use copyRequiresWriterPermission instead."
}, },
"webContentLink": { "webContentLink": {
"type": "string", "type": "string",
@@ -988,7 +1024,7 @@
}, },
"role": { "role": {
"type": "string", "type": "string",
"description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- organizer \n- owner \n- writer \n- commenter \n- reader", "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader",
"annotations": { "annotations": {
"required": [ "required": [
"drive.permissions.create" "drive.permissions.create"
@@ -1011,7 +1047,7 @@
}, },
"role": { "role": {
"type": "string", "type": "string",
"description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- writer \n- commenter \n- reader" "description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader"
}, },
"teamDrivePermissionType": { "teamDrivePermissionType": {
"type": "string", "type": "string",
@@ -1266,10 +1302,22 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can add children to folders in this Team Drive." "description": "Whether the current user can add children to folders in this Team Drive."
}, },
"canChangeCopyRequiresWriterPermissionRestriction": {
"type": "boolean",
"description": "Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive."
},
"canChangeDomainUsersOnlyRestriction": {
"type": "boolean",
"description": "Whether the current user can change the domainUsersOnly restriction of this Team Drive."
},
"canChangeTeamDriveBackground": { "canChangeTeamDriveBackground": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can change the background of this Team Drive." "description": "Whether the current user can change the background of this Team Drive."
}, },
"canChangeTeamMembersOnlyRestriction": {
"type": "boolean",
"description": "Whether the current user can change the teamMembersOnly restriction of this Team Drive."
},
"canComment": { "canComment": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can comment on files in this Team Drive." "description": "Whether the current user can comment on files in this Team Drive."
@@ -1278,6 +1326,10 @@
"type": "boolean", "type": "boolean",
"description": "Whether the current user can copy files in this Team Drive." "description": "Whether the current user can copy files in this Team Drive."
}, },
"canDeleteChildren": {
"type": "boolean",
"description": "Whether the current user can delete children from folders in this Team Drive."
},
"canDeleteTeamDrive": { "canDeleteTeamDrive": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive." "description": "Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive."
@@ -1304,7 +1356,7 @@
}, },
"canRemoveChildren": { "canRemoveChildren": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can remove children from folders in this Team Drive." "description": "Deprecated - use canDeleteChildren or canTrashChildren instead."
}, },
"canRename": { "canRename": {
"type": "boolean", "type": "boolean",
@@ -1317,6 +1369,10 @@
"canShare": { "canShare": {
"type": "boolean", "type": "boolean",
"description": "Whether the current user can share files or folders in this Team Drive." "description": "Whether the current user can share files or folders in this Team Drive."
},
"canTrashChildren": {
"type": "boolean",
"description": "Whether the current user can trash children from folders in this Team Drive."
} }
} }
}, },
@@ -1331,7 +1387,7 @@
}, },
"id": { "id": {
"type": "string", "type": "string",
"description": "The ID of this Team Drive which is also the ID of the top level folder for this Team Drive." "description": "The ID of this Team Drive which is also the ID of the top level folder of this Team Drive."
}, },
"kind": { "kind": {
"type": "string", "type": "string",
@@ -1342,6 +1398,28 @@
"type": "string", "type": "string",
"description": "The name of this Team Drive." "description": "The name of this Team Drive."
}, },
"restrictions": {
"type": "object",
"description": "A set of restrictions that apply to this Team Drive or items inside this Team Drive.",
"properties": {
"adminManagedRestrictions": {
"type": "boolean",
"description": "Whether administrative privileges on this Team Drive are required to modify restrictions."
},
"copyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive."
},
"domainUsersOnly": {
"type": "boolean",
"description": "Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive."
},
"teamMembersOnly": {
"type": "boolean",
"description": "Whether access to items inside this Team Drive is restricted to members of this Team Drive."
}
}
},
"themeId": { "themeId": {
"type": "string", "type": "string",
"description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile." "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile."
@@ -2317,7 +2395,7 @@
"parameters": { "parameters": {
"emailMessage": { "emailMessage": {
"type": "string", "type": "string",
"description": "A custom message to include in the notification email.", "description": "A plain text custom message to include in the notification email.",
"location": "query" "location": "query"
}, },
"fileId": { "fileId": {
@@ -2345,7 +2423,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -2390,7 +2468,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -2430,7 +2508,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -2484,7 +2562,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -2542,7 +2620,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -2992,7 +3070,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.", "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -3035,7 +3113,7 @@
}, },
"useDomainAdminAccess": { "useDomainAdminAccess": {
"type": "boolean", "type": "boolean",
"description": "Whether the request should be treated as if it was issued by a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.", "description": "Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.",
"default": "false", "default": "false",
"location": "query" "location": "query"
} }
@@ -3059,6 +3137,12 @@
"description": "The ID of the Team Drive", "description": "The ID of the Team Drive",
"required": true, "required": true,
"location": "path" "location": "path"
},
"useDomainAdminAccess": {
"type": "boolean",
"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.",
"default": "false",
"location": "query"
} }
}, },
"parameterOrder": [ "parameterOrder": [

824
etc/api/file/v1beta1/file-api.json Normal file
View File

@@ -0,0 +1,824 @@
{
"canonicalName": "Cloud Filestore",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://file.googleapis.com/",
"ownerDomain": "google.com",
"name": "file",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Cloud Filestore API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"list": {
"response": {
"$ref": "ListLocationsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"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": {
"location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$"
},
"pageToken": {
"location": "query",
"description": "The standard list page token.",
"type": "string"
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations",
"path": "v1beta1/{+name}/locations",
"id": "file.projects.locations.list",
"description": "Lists information about the supported locations for this service."
},
"get": {
"id": "file.projects.locations.get",
"path": "v1beta1/{+name}",
"description": "Gets information about a location.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Location"
},
"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"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}"
}
},
"resources": {
"instances": {
"methods": {
"delete": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"location": "path",
"description": "The instance resource name, in the format\nprojects/{project_id}/locations/{location}/instances/{instance_id}",
"required": true,
"type": "string"
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"path": "v1beta1/{+name}",
"id": "file.projects.locations.instances.delete",
"description": "Deletes an instance."
},
"list": {
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances",
"path": "v1beta1/{+parent}/instances",
"id": "file.projects.locations.instances.list",
"description": "Lists all instances in a project for either a specified location\nor for all locations.",
"response": {
"$ref": "ListInstancesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"location": "query",
"description": "The next_page_token value to use if there are additional\nresults to retrieve for this list request.",
"type": "string"
},
"orderBy": {
"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"description": "The maximum number of items to return.",
"format": "int32",
"type": "integer"
},
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"description": "The project and location for which to retrieve instance information,\nin the format projects/{project_id}/locations/{location}. In Cloud\nFilestore, locations map to GCP zones, for example **us-west1-b**. To\nretrieve instance information for all locations, use \"-\" for the {location}\nvalue.",
"required": true,
"type": "string"
},
"filter": {
"description": "List filter.",
"type": "string",
"location": "query"
}
}
},
"get": {
"response": {
"$ref": "Instance"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "The instance resource name, in the format\nprojects/{project_id}/locations/{location}/instances/{instance_id}.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"location": "path"
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"path": "v1beta1/{+name}",
"id": "file.projects.locations.instances.get",
"description": "Gets the details of a specific instance."
},
"patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"description": "Output only.\nThe resource name of the instance, in the format\nprojects/{project_id}/locations/{location_id}/instances/{instance_id}.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"location": "path"
},
"updateMask": {
"description": "Mask of fields to update. At least one path must be supplied in this\nfield. The elements of the repeated paths field may only include these\nfields:\n\"description\"",
"format": "google-fieldmask",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"id": "file.projects.locations.instances.patch",
"path": "v1beta1/{+name}",
"description": "Updates the settings of a specific instance.",
"request": {
"$ref": "Instance"
}
},
"create": {
"description": "Creates an instance.",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"location": "path",
"description": "The instance's project and location, in the format\nprojects/{project_id}/locations/{location}. In Cloud Filestore,\nlocations map to GCP zones, for example **us-west1-b**.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+$"
},
"instanceId": {
"location": "query",
"description": "The name of the instance to create.\nThe name must be unique for the specified project and location.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances",
"path": "v1beta1/{+parent}/instances",
"id": "file.projects.locations.instances.create"
}
}
},
"operations": {
"methods": {
"list": {
"id": "file.projects.locations.operations.list",
"path": "v1beta1/{+name}/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.",
"httpMethod": "GET",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [
"name"
],
"parameters": {
"pageSize": {
"location": "query",
"description": "The standard list page size.",
"format": "int32",
"type": "integer"
},
"filter": {
"location": "query",
"description": "The standard list filter.",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
},
"pageToken": {
"location": "query",
"description": "The standard list page token.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations"
},
"get": {
"id": "file.projects.locations.operations.get",
"path": "v1beta1/{+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",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}"
},
"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`.",
"request": {
"$ref": "CancelOperationRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"id": "file.projects.locations.operations.cancel",
"path": "v1beta1/{+name}:cancel"
},
"delete": {
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/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": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"id": "file.projects.locations.operations.delete",
"path": "v1beta1/{+name}",
"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`."
}
}
}
}
}
}
}
},
"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"
},
"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"
},
"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"
]
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"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"
},
"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": "v1beta1",
"baseUrl": "https://file.googleapis.com/",
"servicePath": "",
"description": "The Cloud Filestore API is used for creating and managing cloud file servers.",
"kind": "discovery#restDescription",
"basePath": "",
"documentationLink": "https://cloud.google.com/filestore/",
"id": "file:v1beta1",
"revision": "20180925",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"NetworkConfig": {
"properties": {
"modes": {
"description": "Internet protocol versions for which the instance has IP addresses\nassigned. For this version, only MODE_IPV4 is supported.",
"type": "array",
"items": {
"enum": [
"ADDRESS_MODE_UNSPECIFIED",
"MODE_IPV4"
],
"type": "string"
},
"enumDescriptions": [
"Internet protocol not set.",
"Use the IPv4 internet protocol."
]
},
"reservedIpRange": {
"description": "A /29 CIDR block in one of the\n[internal IP address ranges](https://www.arin.net/knowledge/address_filters.html)\nthat identifies the range of IP addresses reserved for this\ninstance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify\ncan't overlap with either existing subnets or assigned IP address ranges\nfor other Cloud Filestore instances in the selected VPC network.",
"type": "string"
},
"ipAddresses": {
"description": "Output only.\nIPv4 addresses in the format\n{octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format\n{block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.",
"type": "array",
"items": {
"type": "string"
}
},
"network": {
"description": "The name of the Google Compute Engine\n[VPC network](/compute/docs/networks-and-firewalls#networks) to which the\ninstance is connected.",
"type": "string"
}
},
"id": "NetworkConfig",
"description": "Network configuration for the instance.",
"type": "object"
},
"Instance": {
"description": "A Cloud Filestore instance.",
"type": "object",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Resource labels to represent user provided metadata.",
"type": "object"
},
"createTime": {
"description": "Output only.\nThe time when the instance was created.",
"format": "google-datetime",
"type": "string"
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"READY",
"REPAIRING",
"DELETING",
"ERROR"
],
"description": "Output only.\nThe instance state.",
"type": "string",
"enumDescriptions": [
"State not set.",
"The instance is being created.",
"The instance is available for use.",
"Work is being done on the instance. You can get further details from the\n`statusMessage` field of the `Instance` resource.",
"The instance is shutting down.",
"The instance is experiencing an issue and might be unusable. You can get\nfurther details from the `statusMessage` field of the `Instance`\nresource."
]
},
"statusMessage": {
"description": "Output only.\nAdditional information about the instance state, if available.",
"type": "string"
},
"name": {
"description": "Output only.\nThe resource name of the instance, in the format\nprojects/{project_id}/locations/{location_id}/instances/{instance_id}.",
"type": "string"
},
"networks": {
"description": "VPC networks to which the instance is connected.\nFor this version, only a single network is supported.",
"type": "array",
"items": {
"$ref": "NetworkConfig"
}
},
"fileShares": {
"description": "File system shares on the instance.\nFor this version, only a single file share is supported.",
"type": "array",
"items": {
"$ref": "FileShareConfig"
}
},
"tier": {
"enum": [
"TIER_UNSPECIFIED",
"STANDARD",
"PREMIUM"
],
"description": "The service tier of the instance.",
"type": "string",
"enumDescriptions": [
"Not set.",
"STANDARD tier.",
"PREMIUM tier."
]
},
"description": {
"description": "Optional. A description of the instance (2048 characters or less).",
"type": "string"
},
"etag": {
"description": "Server-specified ETag for the instance resource to prevent simultaneous\nupdates from overwriting each other.",
"type": "string"
}
},
"id": "Instance"
},
"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": {
"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"
},
"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"
},
"displayName": {
"description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".",
"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"
},
"FileShareConfig": {
"description": "File share configuration for the instance.",
"type": "object",
"properties": {
"name": {
"description": "The name of the file share (must be 16 characters or less).",
"type": "string"
},
"capacityGb": {
"description": "File share capacity in gigabytes (GB).\nCloud Filestore defines 1 GB as 1024^3 bytes.",
"format": "int64",
"type": "string"
}
},
"id": "FileShareConfig"
},
"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"
},
"OperationMetadata": {
"properties": {
"createTime": {
"description": "[Output only] The time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"statusDetail": {
"description": "[Output only] Human-readable status of the operation, if any.",
"type": "string"
},
"apiVersion": {
"description": "[Output only] API version used to start the operation.",
"type": "string"
},
"target": {
"description": "[Output only] Server-defined resource path for the target of the operation.",
"type": "string"
},
"endTime": {
"description": "[Output only] The time the operation finished running.",
"format": "google-datetime",
"type": "string"
},
"cancelRequested": {
"description": "[Output only] Identifies whether the user has requested cancellation\nof the operation. Operations that have successfully been cancelled\nhave Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
"type": "boolean"
},
"verb": {
"description": "[Output only] Name of the verb executed by the operation.",
"type": "string"
}
},
"id": "OperationMetadata",
"description": "Represents the metadata of the long-running operation.",
"type": "object"
},
"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"
},
"ListInstancesResponse": {
"properties": {
"nextPageToken": {
"description": "The token you can use to retrieve the next page of results. Not returned\nif there are no more results in the list.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"type": "array",
"items": {
"type": "string"
}
},
"instances": {
"description": "A list of instances in the project for the specified location.\n\nIf the {location} value in the request is \"-\", the response contains a list\nof instances from all locations. If any location is unreachable, the\nresponse will only return instances in reachable locations and the\n\"unreachable\" field will be populated with a list of unreachable locations.",
"type": "array",
"items": {
"$ref": "Instance"
}
}
},
"id": "ListInstancesResponse",
"description": "ListInstancesResponse is the result of ListInstancesRequest.",
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"type": "object",
"properties": {},
"id": "CancelOperationRequest"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"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"
},
"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"
},
"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"
}
},
"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"
}
}

1000
etc/api/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
View File

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More