diff --git a/etc/api/adexchangebuyer/v1.2/adexchangebuyer-api.json b/etc/api/adexchangebuyer/v1.2/adexchangebuyer-api.json index e4ecbebe1f..0f50b4bf95 100644 --- a/etc/api/adexchangebuyer/v1.2/adexchangebuyer-api.json +++ b/etc/api/adexchangebuyer/v1.2/adexchangebuyer-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/zqZsvSATKuDoq4Vo_kVWZ4Fg79c\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/2MOB7UocvnNx2RsEkZnyXaWuXHI\"", "discoveryVersion": "v1", "id": "adexchangebuyer:v1.2", "name": "adexchangebuyer", "canonicalName": "Ad Exchange Buyer", "version": "v1.2", - "revision": "20160118", + "revision": "20160222", "title": "Ad Exchange Buyer API", "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "ownerDomain": "google.com", diff --git a/etc/api/adexchangebuyer/v1.3/adexchangebuyer-api.json b/etc/api/adexchangebuyer/v1.3/adexchangebuyer-api.json index a45cb144b4..070bcabcab 100644 --- a/etc/api/adexchangebuyer/v1.3/adexchangebuyer-api.json +++ b/etc/api/adexchangebuyer/v1.3/adexchangebuyer-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/rEz2HiDx2Fu1wTpH2EJgUXCR4Qk\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/VXepic53Yi7a5nl5bTfBrOL42qg\"", "discoveryVersion": "v1", "id": "adexchangebuyer:v1.3", "name": "adexchangebuyer", "canonicalName": "Ad Exchange Buyer", "version": "v1.3", - "revision": "20160118", + "revision": "20160222", "title": "Ad Exchange Buyer API", "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "ownerDomain": "google.com", @@ -88,6 +88,10 @@ "items": { "type": "object", "properties": { + "bidProtocol": { + "type": "string", + "description": "The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right now. Allowed values: \n- PROTOCOL_ADX \n- PROTOCOL_OPENRTB_2_2 \n- PROTOCOL_OPENRTB_2_3 \n- PROTOCOL_OPENRTB_PROTOBUF" + }, "maximumQps": { "type": "integer", "description": "The maximum queries per second the Ad Exchange will send.", @@ -596,6 +600,10 @@ "type": "string", "description": "The name of the advertiser this deal is for." }, + "allowsAlcohol": { + "type": "boolean", + "description": "Whether the publisher for this deal is eligible for alcohol ads." + }, "currencyCode": { "type": "string", "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD." diff --git a/etc/api/adexchangebuyer/v1.4/adexchangebuyer-api.json b/etc/api/adexchangebuyer/v1.4/adexchangebuyer-api.json index 0e6621c26c..a6134553a6 100644 --- a/etc/api/adexchangebuyer/v1.4/adexchangebuyer-api.json +++ b/etc/api/adexchangebuyer/v1.4/adexchangebuyer-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/EdmLlIWDPOXUaIR9PyM0JrTn9Ls\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/URFS8nFLzISc5jlgQq2A7Yy8-38\"", "discoveryVersion": "v1", "id": "adexchangebuyer:v1.4", "name": "adexchangebuyer", "canonicalName": "Ad Exchange Buyer", "version": "v1.4", - "revision": "20160118", + "revision": "20160222", "title": "Ad Exchange Buyer API", "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "ownerDomain": "google.com", @@ -88,6 +88,10 @@ "items": { "type": "object", "properties": { + "bidProtocol": { + "type": "string", + "description": "The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right now. Allowed values: \n- PROTOCOL_ADX \n- PROTOCOL_OPENRTB_2_2 \n- PROTOCOL_OPENRTB_2_3 \n- PROTOCOL_OPENRTB_PROTOBUF" + }, "maximumQps": { "type": "integer", "description": "The maximum queries per second the Ad Exchange will send.", @@ -752,6 +756,29 @@ } } }, + "DealServingMetadata": { + "id": "DealServingMetadata", + "type": "object", + "properties": { + "dealPauseStatus": { + "$ref": "DealServingMetadataDealPauseStatus", + "description": "Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)" + } + } + }, + "DealServingMetadataDealPauseStatus": { + "id": "DealServingMetadataDealPauseStatus", + "type": "object", + "description": "Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused.", + "properties": { + "hasBuyerPaused": { + "type": "boolean" + }, + "hasSellerPaused": { + "type": "boolean" + } + } + }, "DealTerms": { "id": "DealTerms", "type": "object", @@ -814,9 +841,9 @@ "id": "DealTermsNonGuaranteedAuctionTerms", "type": "object", "properties": { - "privateAuctionId": { - "type": "string", - "description": "Id of the corresponding private auction." + "autoOptimizePrivateAuction": { + "type": "boolean", + "description": "True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly)." }, "reservePricePerBuyers": { "type": "array", @@ -950,6 +977,11 @@ "items": { "$ref": "MarketplaceDeal" } + }, + "orderRevisionNumber": { + "type": "string", + "description": "The latest revision number after the update has been applied.", + "format": "int64" } } }, @@ -1005,6 +1037,19 @@ } } }, + "GetPublisherProfilesByAccountIdResponse": { + "id": "GetPublisherProfilesByAccountIdResponse", + "type": "object", + "properties": { + "profiles": { + "type": "array", + "description": "Profiles for the requested publisher", + "items": { + "$ref": "PublisherProfileApiProto" + } + } + } + }, "MarketplaceDeal": { "id": "MarketplaceDeal", "type": "object", @@ -1023,10 +1068,18 @@ "type": "string", "description": "Specifies the creative pre-approval policy (buyer-readonly)" }, + "creativeSafeFrameCompatibility": { + "type": "string", + "description": "Specifies whether the creative is safeFrame compatible (buyer-readonly)" + }, "dealId": { "type": "string", "description": "A unique deal=id for the deal (readonly)." }, + "dealServingMetadata": { + "$ref": "DealServingMetadata", + "description": "Metadata about the serving status of this deal (readonly, writes via custom actions)" + }, "deliveryControl": { "$ref": "DeliveryControl", "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension." @@ -1072,6 +1125,10 @@ "description": "The revision number of the product that the deal was created from (readonly, except on create)", "format": "int64" }, + "programmaticCreativeSource": { + "type": "string", + "description": "Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)" + }, "proposalId": { "type": "string" }, @@ -1084,7 +1141,7 @@ }, "sharedTargetings": { "type": "array", - "description": "The shared targeting visible to buyers and sellers. (updatable)", + "description": "The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)", "items": { "$ref": "SharedTargeting" } @@ -1628,6 +1685,10 @@ "$ref": "ContactInformation" } }, + "deliveryControl": { + "$ref": "DeliveryControl", + "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension." + }, "flightEndTimeMs": { "type": "string", "description": "The proposed end time for the deal (ms since epoch) (buyer-readonly)", @@ -1663,10 +1724,18 @@ "description": "Time of last update in ms. since epoch (readonly)", "format": "int64" }, + "legacyOfferId": { + "type": "string", + "description": "Optional legacy offer id if this offer is a preferred deal offer." + }, "name": { "type": "string", "description": "The name for this product as set by the seller. (buyer-readonly)" }, + "privateAuctionId": { + "type": "string", + "description": "Optional private auction id if this offer is a private auction offer." + }, "productId": { "type": "string", "description": "The unique id for the product (readonly)" @@ -1746,7 +1815,7 @@ }, "isSetupComplete": { "type": "boolean", - "description": "True, if the buyside inventory setup is complete for this proposal. (readonly)" + "description": "True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)" }, "kind": { "type": "string", @@ -1771,10 +1840,18 @@ "type": "string", "description": "The name for the proposal (updatable)" }, + "negotiationId": { + "type": "string", + "description": "Optional negotiation id if this proposal is a preferred deal proposal." + }, "originatorRole": { "type": "string", "description": "Indicates whether the buyer/seller created the proposal.(readonly)" }, + "privateAuctionId": { + "type": "string", + "description": "Optional private auction id if this proposal is a private auction proposal." + }, "proposalId": { "type": "string", "description": "The unique id of the proposal. (readonly)." @@ -1806,6 +1883,71 @@ } } }, + "PublisherProfileApiProto": { + "id": "PublisherProfileApiProto", + "type": "object", + "properties": { + "buyerPitchStatement": { + "type": "string", + "description": "A pitch statement for the buyer" + }, + "googlePlusLink": { + "type": "string", + "description": "Link to publisher's Google+ page." + }, + "isParent": { + "type": "boolean", + "description": "True, if this is the parent profile, which represents all domains owned by the publisher." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#publisherProfileApiProto\".", + "default": "adexchangebuyer#publisherProfileApiProto" + }, + "logoUrl": { + "type": "string", + "description": "The url to the logo for the publisher." + }, + "mediaKitLink": { + "type": "string", + "description": "The url for additional marketing and sales materials." + }, + "name": { + "type": "string" + }, + "overview": { + "type": "string", + "description": "Publisher provided overview." + }, + "profileId": { + "type": "integer", + "description": "Unique id for the publisher profile", + "format": "int32" + }, + "publisherDomains": { + "type": "array", + "description": "The list of domains represented in this publisher profile. Empty if this is a parent profile.", + "items": { + "type": "string" + } + }, + "rateCardInfoLink": { + "type": "string", + "description": "Link to publisher rate card" + }, + "samplePageLink": { + "type": "string", + "description": "Link for a sample content page." + }, + "topHeadlines": { + "type": "array", + "description": "Publisher provided key metrics and rankings.", + "items": { + "type": "string" + } + } + } + }, "Seller": { "id": "Seller", "type": "object", @@ -1826,14 +1968,14 @@ "properties": { "exclusions": { "type": "array", - "description": "The list of values to exclude from targeting.", + "description": "The list of values to exclude from targeting. Each value is AND'd together.", "items": { "$ref": "TargetingValue" } }, "inclusions": { "type": "array", - "description": "The list of value to include as part of the targeting.", + "description": "The list of value to include as part of the targeting. Each value is OR'd together.", "items": { "$ref": "TargetingValue" } @@ -2941,6 +3083,26 @@ "https://www.googleapis.com/auth/adexchange.buyer" ] }, + "setupcomplete": { + "id": "adexchangebuyer.proposals.setupcomplete", + "path": "proposals/{proposalId}/setupcomplete", + "httpMethod": "POST", + "description": "Update the given proposal to indicate that setup has been completed.", + "parameters": { + "proposalId": { + "type": "string", + "description": "The proposal id for which the setup is complete", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "proposalId" + ], + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ] + }, "update": { "id": "adexchangebuyer.proposals.update", "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}", @@ -2997,6 +3159,34 @@ ] } } + }, + "pubprofiles": { + "methods": { + "list": { + "id": "adexchangebuyer.pubprofiles.list", + "path": "publisher/{accountId}/profiles", + "httpMethod": "GET", + "description": "Gets the requested publisher profile(s) by publisher accountId.", + "parameters": { + "accountId": { + "type": "integer", + "description": "The accountId of the publisher to get profiles for.", + "required": true, + "format": "int32", + "location": "path" + } + }, + "parameterOrder": [ + "accountId" + ], + "response": { + "$ref": "GetPublisherProfilesByAccountIdResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ] + } + } } } } diff --git a/etc/api/classroom/v1beta1/classroom-api.json b/etc/api/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json similarity index 100% rename from etc/api/classroom/v1beta1/classroom-api.json rename to etc/api/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json diff --git a/etc/api/adexchangeseller/v1.1/adexchangeseller-api.json b/etc/api/adexchangeseller/v1.1/adexchangeseller-api.json index 6e48f8477c..2aafbb1ded 100644 --- a/etc/api/adexchangeseller/v1.1/adexchangeseller-api.json +++ b/etc/api/adexchangeseller/v1.1/adexchangeseller-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/_L8pHrTWBfD1EYMPU_k0cR-dVDI\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/yGVcPLwiZSQ-IqA-VzRt5HRabDM\"", "discoveryVersion": "v1", "id": "adexchangeseller:v1.1", "name": "adexchangeseller", diff --git a/etc/api/adexchangeseller/v1/adexchangeseller-api.json b/etc/api/adexchangeseller/v1/adexchangeseller-api.json index 193f6ba1f3..92a960f6bc 100644 --- a/etc/api/adexchangeseller/v1/adexchangeseller-api.json +++ b/etc/api/adexchangeseller/v1/adexchangeseller-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/VcpcMk7pUwJMbfxc4BYcr-YTNAg\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/GTUyFqTp03AxvtXGSPwa14CBOeE\"", "discoveryVersion": "v1", "id": "adexchangeseller:v1", "name": "adexchangeseller", diff --git a/etc/api/adexchangeseller/v2.0/adexchangeseller-api.json b/etc/api/adexchangeseller/v2.0/adexchangeseller-api.json index 5dc4174584..e90671af4b 100644 --- a/etc/api/adexchangeseller/v2.0/adexchangeseller-api.json +++ b/etc/api/adexchangeseller/v2.0/adexchangeseller-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/BAaOLHhMqQCA6Kcn_BDPak1RSQQ\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/rTQPwJ9q2nhaUPuYhDxmQRI6s5g\"", "discoveryVersion": "v1", "id": "adexchangeseller:v2.0", "name": "adexchangeseller", diff --git a/etc/api/admin/datatransfer_v1/admin-api.json b/etc/api/admin/datatransfer_v1/admin-api.json index c140d610f0..f76cc2feaf 100644 --- a/etc/api/admin/datatransfer_v1/admin-api.json +++ b/etc/api/admin/datatransfer_v1/admin-api.json @@ -1,14 +1,14 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/kTLBRgj0_CSR6L-Vtk7U0tv9JLw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/YLr8KxlFkw8ar-xZYzcCGhmF9B0\"", "discoveryVersion": "v1", "id": "admin:datatransfer_v1", "name": "admin", "canonicalName": "DataTransfer", "version": "datatransfer_v1", - "revision": "20151124", + "revision": "20160223", "title": "Admin Data Transfer API", - "description": "Admin Data Transfer API lets you transfer user data from one user to another.", + "description": "Transfers user data from one user to another.", "ownerDomain": "google.com", "ownerName": "Google", "packagePath": "admin", diff --git a/etc/api/admin/directory_v1/admin-api.json b/etc/api/admin/directory_v1/admin-api.json index b56eedd655..04d54393c4 100644 --- a/etc/api/admin/directory_v1/admin-api.json +++ b/etc/api/admin/directory_v1/admin-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/De-lbD45bqBY_dNAx8GzhjIlRyA\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/xS4037BUKAt0D_L9mKpD-MebHg4\"", "discoveryVersion": "v1", "id": "admin:directory_v1", "name": "admin", diff --git a/etc/api/admin/email_migration_v2/admin-api.json b/etc/api/admin/email_migration_v2/admin-api.json deleted file mode 100644 index a52012ca90..0000000000 --- a/etc/api/admin/email_migration_v2/admin-api.json +++ /dev/null @@ -1,173 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/_VRzIG5q4_x1FzCCxocLHIuiUhw\"", - "discoveryVersion": "v1", - "id": "admin:email_migration_v2", - "name": "admin", - "version": "email_migration_v2", - "revision": "20150303", - "title": "Email Migration API v2", - "description": "Email Migration API lets you migrate emails of users to Google backends.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "https://www.google.com/images/icons/product/googlemail-16.png", - "x32": "https://www.google.com/images/icons/product/googlemail-32.png" - }, - "documentationLink": "https://developers.google.com/admin-sdk/email-migration/v2/", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/email/v2/users/", - "basePath": "/email/v2/users/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "email/v2/users/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/email.migration": { - "description": "Manage email messages of users on your domain" - } - } - } - }, - "schemas": { - "MailItem": { - "id": "MailItem", - "type": "object", - "description": "JSON template for MailItem object in Email Migration API.", - "properties": { - "isDeleted": { - "type": "boolean", - "description": "Boolean indicating if the mail is deleted (used in Vault)" - }, - "isDraft": { - "type": "boolean", - "description": "Boolean indicating if the mail is draft" - }, - "isInbox": { - "type": "boolean", - "description": "Boolean indicating if the mail is in inbox" - }, - "isSent": { - "type": "boolean", - "description": "Boolean indicating if the mail is in 'sent mails'" - }, - "isStarred": { - "type": "boolean", - "description": "Boolean indicating if the mail is starred" - }, - "isTrash": { - "type": "boolean", - "description": "Boolean indicating if the mail is in trash" - }, - "isUnread": { - "type": "boolean", - "description": "Boolean indicating if the mail is unread" - }, - "kind": { - "type": "string", - "description": "Kind of resource this is.", - "default": "mailItem" - }, - "labels": { - "type": "array", - "description": "List of labels (strings)", - "items": { - "type": "string" - } - } - } - } - }, - "resources": { - "mail": { - "methods": { - "insert": { - "id": "emailMigration.mail.insert", - "path": "{userKey}/mail", - "httpMethod": "POST", - "description": "Insert Mail into Google's Gmail backends", - "parameters": { - "userKey": { - "type": "string", - "description": "The email or immutable id of the user", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "userKey" - ], - "request": { - "$ref": "MailItem" - }, - "scopes": [ - "https://www.googleapis.com/auth/email.migration" - ], - "supportsMediaUpload": true, - "mediaUpload": { - "accept": [ - "message/rfc822" - ], - "maxSize": "35MB", - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/email/v2/users/{userKey}/mail" - }, - "resumable": { - "multipart": true, - "path": "/resumable/upload/email/v2/users/{userKey}/mail" - } - } - } - } - } - } - } -} diff --git a/etc/api/admin/reports_v1/admin-api.json b/etc/api/admin/reports_v1/admin-api.json index e71f0cab64..44b74b30a5 100644 --- a/etc/api/admin/reports_v1/admin-api.json +++ b/etc/api/admin/reports_v1/admin-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/A4vYPOWVYZiuMn6FfA3WIi7I_H4\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/byz5VJzn0qUbAiSmE6GjI4kojVg\"", "discoveryVersion": "v1", "id": "admin:reports_v1", "name": "admin", diff --git a/etc/api/adsense/v1.2/adsense-api.json b/etc/api/adsense/v1.2/adsense-api.json index 0f6be48002..16ac9dd897 100644 --- a/etc/api/adsense/v1.2/adsense-api.json +++ b/etc/api/adsense/v1.2/adsense-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ttTjeFwp7BPMgbJr27EOmBncEqo\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Mut-plOrR6DSpBJ9WCFiUmkHDwE\"", "discoveryVersion": "v1", "id": "adsense:v1.2", "name": "adsense", "canonicalName": "AdSense", "version": "v1.2", - "revision": "20160127", + "revision": "20160223", "title": "AdSense Management API", "description": "Gives AdSense publishers access to their inventory and the ability to generate reports", "ownerDomain": "google.com", diff --git a/etc/api/adsense/v1.3/adsense-api.json b/etc/api/adsense/v1.3/adsense-api.json index 8e1e1d4a2f..3c221e84c2 100644 --- a/etc/api/adsense/v1.3/adsense-api.json +++ b/etc/api/adsense/v1.3/adsense-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Fd7krNddtkTfjloqHK8muzvSh3w\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Bo70Gu875eIJ0r6fszypcRcE6IQ\"", "discoveryVersion": "v1", "id": "adsense:v1.3", "name": "adsense", "canonicalName": "AdSense", "version": "v1.3", - "revision": "20160127", + "revision": "20160223", "title": "AdSense Management API", "description": "Gives AdSense publishers access to their inventory and the ability to generate reports", "ownerDomain": "google.com", diff --git a/etc/api/adsense/v1.4/adsense-api.json b/etc/api/adsense/v1.4/adsense-api.json index 037dc040d3..659eca1ac5 100644 --- a/etc/api/adsense/v1.4/adsense-api.json +++ b/etc/api/adsense/v1.4/adsense-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/yTXIRiKTgAsrnL4fOEOUAV3bDbY\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Nx2iomi3ve-zx6tBzpFu3QAueM4\"", "discoveryVersion": "v1", "id": "adsense:v1.4", "name": "adsense", "canonicalName": "AdSense", "version": "v1.4", - "revision": "20160127", + "revision": "20160223", "title": "AdSense Management API", "description": "Gives AdSense publishers access to their inventory and the ability to generate reports", "ownerDomain": "google.com", @@ -154,10 +154,6 @@ "type": "boolean", "description": "Whether this ad client is opted in to ARC." }, - "arcReviewMode": { - "type": "string", - "description": "ARC review mode this ad client is in. Empty if the client is not opted in to ARC. Possible values: POST_REVIEW, AUTOMATIC_PRE_REVIEW." - }, "id": { "type": "string", "description": "Unique identifier of this ad client." diff --git a/etc/api/adsensehost/v4.1/adsensehost-api.json b/etc/api/adsensehost/v4.1/adsensehost-api.json index be3da9555a..6d51622f79 100644 --- a/etc/api/adsensehost/v4.1/adsensehost-api.json +++ b/etc/api/adsensehost/v4.1/adsensehost-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/FWvOzkk0xhVUakvwkVWWrRazM7U\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/pnrwWFIfZQX6ZdAsQY5fnMughCs\"", "discoveryVersion": "v1", "id": "adsensehost:v4.1", "name": "adsensehost", "canonicalName": "AdSense Host", "version": "v4.1", - "revision": "20160127", + "revision": "20160223", "title": "AdSense Host API", "description": "Gives AdSense Hosts access to report generation, ad code generation, and publisher management capabilities.", "ownerDomain": "google.com", diff --git a/etc/api/analytics/v2.4/analytics-api.json b/etc/api/analytics/v2.4/analytics-api.json index 7323946c0c..75ca8f936a 100644 --- a/etc/api/analytics/v2.4/analytics-api.json +++ b/etc/api/analytics/v2.4/analytics-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/lHNAwypdAUhY4WpPN2HmEBAFuZs\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/HnBbx1CzQq18EMBMTrvfA_7KYrA\"", "discoveryVersion": "v1", "id": "analytics:v2.4", "name": "analytics", "version": "v2.4", - "revision": "20151215", + "revision": "20160223", "title": "Google Analytics API", "description": "View and manage your Google Analytics data", "ownerDomain": "google.com", diff --git a/etc/api/analytics/v3/analytics-api.json b/etc/api/analytics/v3/analytics-api.json index 289b921781..be7249e161 100644 --- a/etc/api/analytics/v3/analytics-api.json +++ b/etc/api/analytics/v3/analytics-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/yipUxJ3MQM_fDvErB1j4hLbOCkw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/lcxvn8OaVzfbxI4Y934R1xQ9Q74\"", "discoveryVersion": "v1", "id": "analytics:v3", "name": "analytics", "version": "v3", - "revision": "20151215", + "revision": "20160223", "title": "Google Analytics API", "description": "View and manage your Google Analytics data", "ownerDomain": "google.com", @@ -5492,21 +5492,21 @@ "parameters": { "accountId": { "type": "string", - "description": "Account ID to retrieve the goal for.", + "description": "Account ID to retrieve the view (profile) for.", "required": true, "pattern": "[0-9]+", "location": "path" }, "profileId": { "type": "string", - "description": "View (Profile) ID to retrieve the goal for.", + "description": "View (Profile) ID to retrieve the view (profile) for.", "required": true, "pattern": "[0-9]+", "location": "path" }, "webPropertyId": { "type": "string", - "description": "Web property ID to retrieve the goal for.", + "description": "Web property ID to retrieve the view (profile) for.", "required": true, "pattern": "UA-[0-9]+-[0-9]+", "location": "path" diff --git a/etc/api/androidenterprise/v1/androidenterprise-api.json b/etc/api/androidenterprise/v1/androidenterprise-api.json index 1bbe88a541..053c9b045f 100644 --- a/etc/api/androidenterprise/v1/androidenterprise-api.json +++ b/etc/api/androidenterprise/v1/androidenterprise-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/4xdfCsFKqY63nj0AgziCWDL1CtA\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Dx0G8SPg6yJp2LDFLDUMMNNCJBA\"", "discoveryVersion": "v1", "id": "androidenterprise:v1", "name": "androidenterprise", "canonicalName": "Android Enterprise", "version": "v1", - "revision": "20160106", + "revision": "20160212", "title": "Google Play EMM API", "description": "Allows MDMs/EMMs and enterprises to manage the deployment of apps to Android for Work users.", "ownerDomain": "google.com", @@ -284,7 +284,7 @@ "Device": { "id": "Device", "type": "object", - "description": "A device resource represents a mobile device managed by the MDM and belonging to a specific enterprise user.\n\nThis collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.", + "description": "A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.\n\nThis collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.", "properties": { "androidId": { "type": "string", @@ -297,7 +297,7 @@ }, "managementType": { "type": "string", - "description": "The mechanism by which this device is managed by the MDM. \"managedDevice\" means that the MDM's app is a device owner. \"managedProfile\" means that the MDM's app is the profile owner (and there is a separate personal profile which is not managed). \"containerApp\" means that the MDM's app is managing the Android for Work container app on the device." + "description": "The mechanism by which this device is managed by the EMM. \"managedDevice\" means that the EMM's app is a device owner. \"managedProfile\" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). \"containerApp\" means that the EMM's app is managing the Android for Work container app on the device." } } }, @@ -339,7 +339,7 @@ "Enterprise": { "id": "Enterprise", "type": "object", - "description": "An enterprise resource represents a binding between an organisation and their MDM.\n\nTo create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.\n\nAfter calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).\n\nThe MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.\n\nThe ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.", + "description": "An enterprise resource represents a binding between an organisation and their EMM.\n\nTo create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise.\n\nAfter calling enroll the EMM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).\n\nThe EMM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the EMM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.\n\nThe ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.", "properties": { "id": { "type": "string", @@ -417,7 +417,7 @@ "Entitlement": { "id": "Entitlement", "type": "object", - "description": "The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.\n\nIt should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.\n\nNote that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.\n\nThe API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.\n\nEntitlements for paid apps that are due to purchases by the user on a non-managed profile will have \"userPurchase\" as entitlement reason; those entitlements cannot be removed via the API.", + "description": "The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.\n\nIt should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.\n\nNote that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.\n\nThe API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.\n\nEntitlements for paid apps that are due to purchases by the user on a non-managed profile will have \"userPurchase\" as entitlement reason; those entitlements cannot be removed via the API.", "properties": { "kind": { "type": "string", @@ -587,7 +587,7 @@ "Permission": { "id": "Permission", "type": "object", - "description": "A permission represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created.\n\nThe permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise.", + "description": "A permission represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created.\n\nThe permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the EMM user interface when obtaining consent from the enterprise.", "properties": { "description": { "type": "string", @@ -611,7 +611,7 @@ "Product": { "id": "Product", "type": "object", - "description": "A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)\n\nThe information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an MDM user interface.", + "description": "A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)\n\nThe information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.", "properties": { "appVersion": { "type": "array", @@ -866,7 +866,7 @@ "User": { "id": "User", "type": "object", - "description": "A user resource represents an individual user within the enterprise's domain.\n\nNote that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.\n\nThe ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.", + "description": "A user resource represents an individual user within the enterprise's domain.\n\nNote that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.\n\nThe ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.", "properties": { "id": { "type": "string", @@ -886,7 +886,7 @@ "UserToken": { "id": "UserToken", "type": "object", - "description": "A UserToken is used by a user when setting up a managed device or profile with their work account on a device. When the user enters their email address and token (activation code) the appropriate MDM app can be automatically downloaded.", + "description": "A UserToken is used by a user when setting up a managed device or profile with their work account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded.", "properties": { "kind": { "type": "string", @@ -1439,7 +1439,7 @@ "id": "androidenterprise.enterprises.delete", "path": "enterprises/{enterpriseId}", "httpMethod": "DELETE", - "description": "Deletes the binding between the MDM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.", + "description": "Deletes the binding between the EMM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.", "parameters": { "enterpriseId": { "type": "string", @@ -1459,11 +1459,11 @@ "id": "androidenterprise.enterprises.enroll", "path": "enterprises/enroll", "httpMethod": "POST", - "description": "Enrolls an enterprise with the calling MDM.", + "description": "Enrolls an enterprise with the calling EMM.", "parameters": { "token": { "type": "string", - "description": "The token provided by the enterprise to register the MDM.", + "description": "The token provided by the enterprise to register the EMM.", "required": true, "location": "query" } @@ -1531,11 +1531,11 @@ "id": "androidenterprise.enterprises.insert", "path": "enterprises", "httpMethod": "POST", - "description": "Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.", + "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 MDM.", + "description": "The token provided by the enterprise to register the EMM.", "required": true, "location": "query" } @@ -1580,7 +1580,7 @@ "id": "androidenterprise.enterprises.sendTestPushNotification", "path": "enterprises/{enterpriseId}/sendTestPushNotification", "httpMethod": "POST", - "description": "Sends a test push notification to validate the MDM integration with the Google Cloud Pub/Sub service for this enterprise.", + "description": "Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.", "parameters": { "enterpriseId": { "type": "string", @@ -1655,7 +1655,7 @@ "id": "androidenterprise.enterprises.unenroll", "path": "enterprises/{enterpriseId}/unenroll", "httpMethod": "POST", - "description": "Unenrolls an enterprise from the calling MDM.", + "description": "Unenrolls an enterprise from the calling EMM.", "parameters": { "enterpriseId": { "type": "string", @@ -2382,7 +2382,7 @@ "id": "androidenterprise.products.updatePermissions", "path": "enterprises/{enterpriseId}/products/{productId}/permissions", "httpMethod": "PUT", - "description": "Updates the set of Android app permissions for this app that have been accepted by the enterprise.", + "description": "This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the generateApprovalUrl and approve methods of the Products resource. For more information, see the Play EMM API usage requirements.\n\nThe updatePermissions method (deprecated) updates the set of Android app permissions for this app that have been accepted by the enterprise.", "parameters": { "enterpriseId": { "type": "string", @@ -2813,7 +2813,7 @@ "id": "androidenterprise.users.generateToken", "path": "enterprises/{enterpriseId}/users/{userId}/token", "httpMethod": "POST", - "description": "Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.", + "description": "Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.\n\nThis call only works with Google managed accounts.", "parameters": { "enterpriseId": { "type": "string", @@ -2903,7 +2903,7 @@ "id": "androidenterprise.users.list", "path": "enterprises/{enterpriseId}/users", "httpMethod": "GET", - "description": "Looks up a user by email address. This only works for Google managed users.", + "description": "Looks up a user by their primary email address.", "parameters": { "email": { "type": "string", diff --git a/etc/api/androidpublisher/v1.1/androidpublisher-api.json b/etc/api/androidpublisher/v1.1/androidpublisher-api.json index 10ef1db59c..8c5f8388a5 100644 --- a/etc/api/androidpublisher/v1.1/androidpublisher-api.json +++ b/etc/api/androidpublisher/v1.1/androidpublisher-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7iAmRYwoDYWOcDyml409arPbF3w\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/f_Ih5rlctQLoYjA79HJRwD_1140\"", "discoveryVersion": "v1", "id": "androidpublisher:v1.1", "name": "androidpublisher", "canonicalName": "Android Publisher", "version": "v1.1", - "revision": "20160111", + "revision": "20160221", "title": "Google Play Developer API", "description": "Lets Android application developers access their Google Play accounts.", "ownerDomain": "google.com", diff --git a/etc/api/androidpublisher/v1/androidpublisher-api.json b/etc/api/androidpublisher/v1/androidpublisher-api.json index b992c2551c..8a66febf23 100644 --- a/etc/api/androidpublisher/v1/androidpublisher-api.json +++ b/etc/api/androidpublisher/v1/androidpublisher-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/YckzLnvUj6xmkI3kLWrnZAiz4Zs\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/FYzvitHkIO0WHnHI9t6qknKNpQ0\"", "discoveryVersion": "v1", "id": "androidpublisher:v1", "name": "androidpublisher", "canonicalName": "Android Publisher", "version": "v1", - "revision": "20160111", + "revision": "20160221", "title": "Google Play Developer API", "description": "Lets Android application developers access their Google Play accounts.", "ownerDomain": "google.com", diff --git a/etc/api/androidpublisher/v2/androidpublisher-api.json b/etc/api/androidpublisher/v2/androidpublisher-api.json index 9eb07b3c97..a03ea1b343 100644 --- a/etc/api/androidpublisher/v2/androidpublisher-api.json +++ b/etc/api/androidpublisher/v2/androidpublisher-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/cxP0mtBkWIA4ZdoBuvl7SgC3-Gc\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/mQrWIJVnZ-o4oNXFGrclXicilbM\"", "discoveryVersion": "v1", "id": "androidpublisher:v2", "name": "androidpublisher", "canonicalName": "Android Publisher", "version": "v2", - "revision": "20160111", + "revision": "20160221", "title": "Google Play Developer API", "description": "Lets Android application developers access their Google Play accounts.", "ownerDomain": "google.com", diff --git a/etc/api/api-list.yaml b/etc/api/api-list.yaml index 81e4c9945c..59f92be0f1 100644 --- a/etc/api/api-list.yaml +++ b/etc/api/api-list.yaml @@ -10,7 +10,6 @@ api: - v2.0 admin: - directory_v1 - - email_migration_v2 - reports_v1 adsense: - v1.4 @@ -29,8 +28,6 @@ api: - v1 appstate: - v1 - audit: - - v1 autoscaler: - v1beta2 bigquery: @@ -54,6 +51,7 @@ api: cloudmonitoring: - v2beta2 cloudresourcemanager: + - v1 - v1beta1 cloudsearch: - v1 @@ -65,7 +63,6 @@ api: - v1 container: - v1 - - v1beta1 content: - v2 - v2sandbox @@ -86,6 +83,7 @@ api: - v2.1 - v2.2 - v2.3 + - v2.4 discovery: - v1 dns: @@ -101,7 +99,6 @@ api: - v1 freebase: - v1 - - v1sandbox fusiontables: - v2 games: @@ -129,12 +126,9 @@ api: licensing: - v1 logging: - - v1beta3 - v2beta1 manager: - v1beta2 - mapsengine: - - v1 mirror: - v1 oauth2: @@ -143,6 +137,8 @@ api: - v2 partners: - v2 + people: + - v1 playmoviespartner: - v1 plus: @@ -166,6 +162,8 @@ api: - v1sandbox resourceviews: - v1beta2 + script: + - v1 serviceregistry: - alpha siteverification: diff --git a/etc/api/appengine/v1beta4/appengine-api.json b/etc/api/appengine/v1beta4/appengine-api.json index 34076c4468..3a4e1fc7f2 100644 --- a/etc/api/appengine/v1beta4/appengine-api.json +++ b/etc/api/appengine/v1beta4/appengine-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/q1k107w8H1_Vpbv_soyd95U2Uhs\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/sOTtGIhBrGRLc0_FlU9VkPbZAm0\"", "discoveryVersion": "v1", "id": "appengine:v1beta4", "name": "appengine", "version": "v1beta4", - "revision": "20160121", + "revision": "20160223", "title": "Google App Engine Admin API", "description": "The Google App Engine Admin API enables developers to provision and manage their App Engine applications.", "ownerDomain": "google.com", @@ -121,7 +121,7 @@ }, "id": { "type": "string", - "description": "The relative name/path of the application. Example: \"myapp\". @OutputOnly" + "description": "The relative name/path of the application. Example: \"myapp\"." }, "dispatchRules": { "type": "array", @@ -130,6 +130,10 @@ "$ref": "UrlDispatchRule" } }, + "authDomain": { + "type": "string", + "description": "If set, only users from the specified Google Apps authentication domain may access the application. If not set, any Google Account may access the application." + }, "location": { "type": "string", "description": "The location from which the application will be run. Choices are \"us-central\" for United States and \"europe-west\" for European Union. Application instances will run out of data centers in the chosen location and all of the application's End User Content will be stored at rest in the chosen location. The default is \"us-central\"." @@ -138,6 +142,14 @@ "type": "string", "description": "A Google Cloud Storage bucket which can be used for storing files associated with an application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly" }, + "defaultCookieExpiration": { + "type": "string", + "description": "Determines the cookie expiration policy for the application." + }, + "defaultHostname": { + "type": "string", + "description": "The hostname used to reach the application, as resolved by App Engine. @OutputOnly" + }, "defaultBucket": { "type": "string", "description": "A Google Cloud Storage bucket which can be used by the application to store content. @OutputOnly" @@ -1453,6 +1465,51 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "id": "appengine.apps.modules.versions.patch", + "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", + "httpMethod": "PATCH", + "description": "Updates an existing version. Note: UNIMPLEMENTED.", + "parameters": { + "appsId": { + "type": "string", + "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/modules/default/versions/1\".", + "required": true, + "location": "path" + }, + "modulesId": { + "type": "string", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "location": "path" + }, + "versionsId": { + "type": "string", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "location": "path" + }, + "mask": { + "type": "string", + "description": "Standard field mask for the set of fields to be updated.", + "location": "query" + } + }, + "parameterOrder": [ + "appsId", + "modulesId", + "versionsId" + ], + "request": { + "$ref": "Version" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } diff --git a/etc/api/appengine/v1beta5/appengine-api.json b/etc/api/appengine/v1beta5/appengine-api.json index a860d32b65..a52338852e 100644 --- a/etc/api/appengine/v1beta5/appengine-api.json +++ b/etc/api/appengine/v1beta5/appengine-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/zAfXnU96F6G6dh1E_ZlK9dswqE4\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/tL7xNjyj_kg_Ll9deL7DxZKPLUI\"", "discoveryVersion": "v1", "id": "appengine:v1beta5", "name": "appengine", "version": "v1beta5", - "revision": "20160121", + "revision": "20160223", "title": "Google App Engine Admin API", "description": "The Google App Engine Admin API enables developers to provision and manage their App Engine applications.", "ownerDomain": "google.com", @@ -201,7 +201,7 @@ }, "id": { "type": "string", - "description": "The relative name/path of the application. Example: \"myapp\". @OutputOnly" + "description": "The relative name/path of the application. Example: \"myapp\"." }, "dispatchRules": { "type": "array", @@ -210,6 +210,10 @@ "$ref": "UrlDispatchRule" } }, + "authDomain": { + "type": "string", + "description": "If set, only users from the specified Google Apps authentication domain may access the application. If not set, any Google Account may access the application." + }, "location": { "type": "string", "description": "The location from which the application will be run. Choices are \"us\" for United States and \"eu\" for European Union. Application instances will run out of data centers in the chosen location and all of the application's End User Content will be stored at rest in the chosen location. The default is \"us\"." @@ -218,6 +222,14 @@ "type": "string", "description": "A Google Cloud Storage bucket which can be used for storing files associated with an application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly" }, + "defaultCookieExpiration": { + "type": "string", + "description": "Determines the cookie expiration policy for the application." + }, + "defaultHostname": { + "type": "string", + "description": "The hostname used to reach the application, as resolved by App Engine. @OutputOnly" + }, "defaultBucket": { "type": "string", "description": "A Google Cloud Storage bucket which can be used by the application to store content. @OutputOnly" @@ -1493,6 +1505,51 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "id": "appengine.apps.services.versions.patch", + "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}", + "httpMethod": "PATCH", + "description": "Updates an existing version. Note: UNIMPLEMENTED.", + "parameters": { + "appsId": { + "type": "string", + "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default/versions/1\".", + "required": true, + "location": "path" + }, + "servicesId": { + "type": "string", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "location": "path" + }, + "versionsId": { + "type": "string", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "location": "path" + }, + "mask": { + "type": "string", + "description": "Standard field mask for the set of fields to be updated.", + "location": "query" + } + }, + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId" + ], + "request": { + "$ref": "Version" + }, + "response": { + "$ref": "Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } diff --git a/etc/api/appsactivity/v1/appsactivity-api.json b/etc/api/appsactivity/v1/appsactivity-api.json index 8982d82873..44e2297bb3 100644 --- a/etc/api/appsactivity/v1/appsactivity-api.json +++ b/etc/api/appsactivity/v1/appsactivity-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/5AQpW1lJHfcDZmUKJzrzEbI6GXM\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/lSwCOA9I8RqRLs7NT_M6K7rXf1o\"", "discoveryVersion": "v1", "id": "appsactivity:v1", "name": "appsactivity", diff --git a/etc/api/appstate/v1/appstate-api.json b/etc/api/appstate/v1/appstate-api.json index 42da40dd94..ab2da411a9 100644 --- a/etc/api/appstate/v1/appstate-api.json +++ b/etc/api/appstate/v1/appstate-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/C08r27fmT3w3bKePOUTeTljlo0w\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/FfUlPqFpPCwvkVzt3a4SxWWpKoc\"", "discoveryVersion": "v1", "id": "appstate:v1", "name": "appstate", "canonicalName": "App State", "version": "v1", - "revision": "20160125", + "revision": "20160224", "title": "Google App State API", "description": "The Google App State API.", "ownerDomain": "google.com", diff --git a/etc/api/audit/v1/audit-api.json b/etc/api/audit/v1/audit-api.json deleted file mode 100644 index 2dffc82c12..0000000000 --- a/etc/api/audit/v1/audit-api.json +++ /dev/null @@ -1,288 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/qDki177mae-tdDHfIJUXH1TuTZo\"", - "discoveryVersion": "v1", - "id": "audit:v1", - "name": "audit", - "version": "v1", - "revision": "20150419", - "title": "Enterprise Audit API", - "description": "Lets you access user activities in your enterprise made through various applications.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "https://developers.google.com/google-apps/admin-audit/get_started", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/apps/reporting/audit/v1/", - "basePath": "/apps/reporting/audit/v1/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "apps/reporting/audit/v1/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "atom", - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/atom+xml", - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "schemas": { - "Activities": { - "id": "Activities", - "type": "object", - "properties": { - "items": { - "type": "array", - "description": "Each record in read response.", - "items": { - "$ref": "Activity" - } - }, - "kind": { - "type": "string", - "description": "Kind of list response this is.", - "default": "audit#activities" - }, - "next": { - "type": "string", - "description": "Next page URL." - } - } - }, - "Activity": { - "id": "Activity", - "type": "object", - "properties": { - "actor": { - "type": "object", - "description": "User doing the action.", - "properties": { - "applicationId": { - "type": "string", - "description": "ID of application which interacted on behalf of the user.", - "format": "int64" - }, - "callerType": { - "type": "string", - "description": "User or OAuth 2LO request." - }, - "email": { - "type": "string", - "description": "Email address of the user." - }, - "key": { - "type": "string", - "description": "For OAuth 2LO API requests, consumer_key of the requestor." - } - } - }, - "events": { - "type": "array", - "description": "Activity events.", - "items": { - "type": "object", - "properties": { - "eventType": { - "type": "string", - "description": "Type of event." - }, - "name": { - "type": "string", - "description": "Name of event." - }, - "parameters": { - "type": "array", - "description": "Event parameters.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the parameter." - }, - "value": { - "type": "string", - "description": "Value of the parameter." - } - } - } - } - } - } - }, - "id": { - "type": "object", - "description": "Unique identifier for each activity record.", - "properties": { - "applicationId": { - "type": "string", - "description": "Application ID of the source application.", - "format": "int64" - }, - "customerId": { - "type": "string", - "description": "Obfuscated customer ID of the source customer." - }, - "time": { - "type": "string", - "description": "Time of occurrence of the activity.", - "format": "date-time" - }, - "uniqQualifier": { - "type": "string", - "description": "Unique qualifier if multiple events have the same time.", - "format": "int64" - } - } - }, - "ipAddress": { - "type": "string", - "description": "IP Address of the user doing the action." - }, - "kind": { - "type": "string", - "description": "Kind of resource this is.", - "default": "audit#activity" - }, - "ownerDomain": { - "type": "string", - "description": "Domain of source customer." - } - } - } - }, - "resources": { - "activities": { - "methods": { - "list": { - "id": "audit.activities.list", - "path": "{customerId}/{applicationId}", - "httpMethod": "GET", - "description": "Retrieves a list of activities for a specific customer and application.", - "parameters": { - "actorApplicationId": { - "type": "string", - "description": "Application ID of the application which interacted on behalf of the user while performing the event.", - "format": "int64", - "location": "query" - }, - "actorEmail": { - "type": "string", - "description": "Email address of the user who performed the action.", - "location": "query" - }, - "actorIpAddress": { - "type": "string", - "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.", - "location": "query" - }, - "applicationId": { - "type": "string", - "description": "Application ID of the application on which the event was performed.", - "required": true, - "format": "int64", - "location": "path" - }, - "caller": { - "type": "string", - "description": "Type of the caller.", - "enum": [ - "application_owner", - "customer" - ], - "enumDescriptions": [ - "Caller is an application owner.", - "Caller is a customer." - ], - "location": "query" - }, - "continuationToken": { - "type": "string", - "description": "Next page URL.", - "location": "query" - }, - "customerId": { - "type": "string", - "description": "Represents the customer who is the owner of target object on which action was performed.", - "required": true, - "pattern": "C.+", - "location": "path" - }, - "endTime": { - "type": "string", - "description": "Return events which occured at or before this time.", - "location": "query" - }, - "eventName": { - "type": "string", - "description": "Name of the event being queried.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "Number of activity records to be shown in each page.", - "format": "int32", - "minimum": "1", - "maximum": "1000", - "location": "query" - }, - "startTime": { - "type": "string", - "description": "Return events which occured at or after this time.", - "location": "query" - } - }, - "parameterOrder": [ - "customerId", - "applicationId" - ], - "response": { - "$ref": "Activities" - } - } - } - } - } -} diff --git a/etc/api/autoscaler/v1beta2/autoscaler-api.json b/etc/api/autoscaler/v1beta2/autoscaler-api.json index 6ca3525c68..68ca9bab0a 100644 --- a/etc/api/autoscaler/v1beta2/autoscaler-api.json +++ b/etc/api/autoscaler/v1beta2/autoscaler-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/jlD4rieW9SE6mlSqZWY6ITBumQQ\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/_ZR2rPUVlAfmKDqeLvaYVY_Ov9g\"", "discoveryVersion": "v1", "id": "autoscaler:v1beta2", "name": "autoscaler", diff --git a/etc/api/bigquery/v2/bigquery-api.json b/etc/api/bigquery/v2/bigquery-api.json index 6438dabf34..77319a4350 100644 --- a/etc/api/bigquery/v2/bigquery-api.json +++ b/etc/api/bigquery/v2/bigquery-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/KhBY9BAZ9f1xpe68E42latOsq24\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/yOlQD0XV-M95o1thz-ymKpLxG7I\"", "discoveryVersion": "v1", "id": "bigquery:v2", "name": "bigquery", "version": "v2", - "revision": "20160127", + "revision": "20160222", "title": "BigQuery API", "description": "A data platform for customers to create, manage, share and query data.", "ownerDomain": "google.com", @@ -400,9 +400,13 @@ "id": "ExternalDataConfiguration", "type": "object", "properties": { + "autodetect": { + "type": "boolean", + "description": "[Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored." + }, "compression": { "type": "string", - "description": "[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Datastore backups." + "description": "[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Datastore backups and Avro." }, "csvOptions": { "$ref": "CsvOptions", @@ -410,20 +414,20 @@ }, "ignoreUnknownValues": { "type": "boolean", - "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Datastore backups: This setting is ignored." + "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored." }, "maxBadRecords": { "type": "integer", - "description": "[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Datastore backups.", + "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 Datastore backups and Avro.", "format": "int32" }, "schema": { "$ref": "TableSchema", - "description": "[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups." + "description": "[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups and Avro." }, "sourceFormat": { "type": "string", - "description": "[Required] The data format. For CSV files, specify \"CSV\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Google Cloud Datastore backups, specify \"DATASTORE_BACKUP\"." + "description": "[Required] The data format. For CSV files, specify \"CSV\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Google Cloud Datastore backups, specify \"DATASTORE_BACKUP\". For Avro files, specify \"AVRO\"." }, "sourceUris": { "type": "array", @@ -749,6 +753,10 @@ "$ref": "ExternalDataConfiguration" } }, + "useLegacySql": { + "type": "boolean", + "description": "[Experimental] 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 updated SQL dialect with improved standards compliance. When using BigQuery's updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false." + }, "useQueryCache": { "type": "boolean", "description": "[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.", @@ -943,6 +951,13 @@ "$ref": "ExplainQueryStage" } }, + "referencedTables": { + "type": "array", + "description": "[Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.", + "items": { + "$ref": "TableReference" + } + }, "totalBytesBilled": { "type": "string", "description": "[Output-only] Total bytes billed for the job.", @@ -1133,6 +1148,10 @@ "description": "[Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).", "format": "uint32" }, + "useLegacySql": { + "type": "boolean", + "description": "[Experimental] 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 updated SQL dialect with improved standards compliance. When using BigQuery's updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false." + }, "useQueryCache": { "type": "boolean", "description": "[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.", @@ -1345,7 +1364,7 @@ }, "templateSuffix": { "type": "string", - "description": "[Optional] If specified, treats the destination table as a base template, and inserts the rows into an instance table named \"{destination}{templateSuffix}\". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables." + "description": "[Experimental] If specified, treats the destination table as a base template, and inserts the rows into an instance table named \"{destination}{templateSuffix}\". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables." } } }, diff --git a/etc/api/blogger/v2/blogger-api.json b/etc/api/blogger/v2/blogger-api.json index c0c0a18689..20e5b269e6 100644 --- a/etc/api/blogger/v2/blogger-api.json +++ b/etc/api/blogger/v2/blogger-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/JWycgFMuWMaxJ4QnDA4iy4OznOI\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Mm4a0u3lPNBqEzKCYhfhIpC2Mw4\"", "discoveryVersion": "v1", "id": "blogger:v2", "name": "blogger", diff --git a/etc/api/blogger/v3/blogger-api.json b/etc/api/blogger/v3/blogger-api.json index 435c0ab931..2f8d2ec264 100644 --- a/etc/api/blogger/v3/blogger-api.json +++ b/etc/api/blogger/v3/blogger-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/J0W_74OKtqTk9D0dwUl_TZLYMoc\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Goh5bsNuqq7lTY-yMf_QcKSL760\"", "discoveryVersion": "v1", "id": "blogger:v3", "name": "blogger", diff --git a/etc/api/books/v1/books-api.json b/etc/api/books/v1/books-api.json index da7ffafec6..8bf6954d13 100644 --- a/etc/api/books/v1/books-api.json +++ b/etc/api/books/v1/books-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/vRAufP6uKRoBM4DQ7BpgqL4krnY\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/2Ar_hXPHmnxe2mV6uxVVcPSU_1Y\"", "discoveryVersion": "v1", "id": "books:v1", "name": "books", "version": "v1", - "revision": "20151218", + "revision": "20160113", "title": "Books API", "description": "Lets you search for books and manage your Google Books library.", "ownerDomain": "google.com", @@ -3661,13 +3661,6 @@ "type": "string", "description": "String to identify the originator of this request.", "location": "query" - }, - "targetIds": { - "type": "string", - "description": "List of target ids used for experiments or user segments", - "format": "int64", - "repeated": true, - "location": "query" } }, "parameterOrder": [ @@ -3784,13 +3777,6 @@ "type": "string", "description": "String to identify the originator of this request.", "location": "query" - }, - "targetIds": { - "type": "string", - "description": "List of target ids used for experiments or user segments", - "format": "int64", - "repeated": true, - "location": "query" } }, "response": { @@ -4398,13 +4384,6 @@ "type": "string", "description": "String to identify the originator of this request.", "location": "query" - }, - "targetIds": { - "type": "string", - "description": "List of target ids used for experiments or user segments", - "format": "int64", - "repeated": true, - "location": "query" } }, "response": { diff --git a/etc/api/calendar/v3/calendar-api.json b/etc/api/calendar/v3/calendar-api.json index 8813fc71cb..bfdf7ef9da 100644 --- a/etc/api/calendar/v3/calendar-api.json +++ b/etc/api/calendar/v3/calendar-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/pc6b-08E-ViUuIdQ73xY_pzKtKo\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/WeMLh_6p2zlMBJbL5SsqQ7fFLj4\"", "discoveryVersion": "v1", "id": "calendar:v3", "name": "calendar", "version": "v3", - "revision": "20160110", + "revision": "20160221", "title": "Calendar API", "description": "Lets you manipulate events and other calendar data.", "ownerDomain": "google.com", diff --git a/etc/api/civicinfo/us_v1/civicinfo-api.json b/etc/api/civicinfo/us_v1/civicinfo-api.json deleted file mode 100644 index 944505879c..0000000000 --- a/etc/api/civicinfo/us_v1/civicinfo-api.json +++ /dev/null @@ -1,874 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"l66ggWbucbkBw9Lpos72oziyefE/ixlTlCZ6lprJQCHG1SmuBjDXiaM\"", - "discoveryVersion": "v1", - "id": "civicinfo:us_v1", - "name": "civicinfo", - "canonicalName": "Civic Info", - "version": "us_v1", - "revision": "20141023", - "title": "Google Civic Information API", - "description": "An API for accessing civic information.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "https://developers.google.com/civic-information", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/civicinfo/us_v1/", - "basePath": "/civicinfo/us_v1/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "civicinfo/us_v1/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "schemas": { - "AdministrationRegion": { - "id": "AdministrationRegion", - "type": "object", - "description": "Describes information about a regional election administrative area.", - "properties": { - "electionAdministrationBody": { - "$ref": "AdministrativeBody", - "description": "The election administration body for this area." - }, - "id": { - "type": "string", - "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page." - }, - "local_jurisdiction": { - "$ref": "AdministrationRegion", - "description": "The city or county that provides election information for this voter. This object can have the same elements as state." - }, - "name": { - "type": "string", - "description": "The name of the jurisdiction." - }, - "sources": { - "type": "array", - "description": "A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.", - "items": { - "$ref": "Source" - } - } - } - }, - "AdministrativeBody": { - "id": "AdministrativeBody", - "type": "object", - "description": "Information about an election administrative body (e.g. County Board of Elections).", - "properties": { - "absenteeVotingInfoUrl": { - "type": "string", - "description": "A URL provided by this administrative body for information on absentee voting." - }, - "ballotInfoUrl": { - "type": "string", - "description": "A URL provided by this administrative body to give contest information to the voter." - }, - "correspondenceAddress": { - "$ref": "SimpleAddressType", - "description": "The mailing address of this administrative body." - }, - "electionInfoUrl": { - "type": "string", - "description": "A URL provided by this administrative body for looking up general election information." - }, - "electionOfficials": { - "type": "array", - "description": "The election officials for this election administrative body.", - "items": { - "$ref": "ElectionOfficial" - } - }, - "electionRegistrationConfirmationUrl": { - "type": "string", - "description": "A URL provided by this administrative body for confirming that the voter is registered to vote." - }, - "electionRegistrationUrl": { - "type": "string", - "description": "A URL provided by this administrative body for looking up how to register to vote." - }, - "electionRulesUrl": { - "type": "string", - "description": "A URL provided by this administrative body describing election rules to the voter." - }, - "hoursOfOperation": { - "type": "string", - "description": "A description of the hours of operation for this administrative body." - }, - "name": { - "type": "string", - "description": "The name of this election administrative body." - }, - "physicalAddress": { - "$ref": "SimpleAddressType", - "description": "The physical address of this administrative body." - }, - "voter_services": { - "type": "array", - "description": "A description of the services this administrative body may provide.", - "items": { - "type": "string" - } - }, - "votingLocationFinderUrl": { - "type": "string", - "description": "A URL provided by this administrative body for looking up where to vote." - } - } - }, - "Candidate": { - "id": "Candidate", - "type": "object", - "description": "Information about a candidate running for elected office.", - "properties": { - "candidateUrl": { - "type": "string", - "description": "The URL for the candidate's campaign web site." - }, - "channels": { - "type": "array", - "description": "A list of known (social) media channels for this candidate.", - "items": { - "$ref": "Channel" - } - }, - "email": { - "type": "string", - "description": "The email address for the candidate's campaign." - }, - "name": { - "type": "string", - "description": "The candidate's name." - }, - "orderOnBallot": { - "type": "string", - "description": "The order the candidate appears on the ballot for this contest.", - "format": "int64" - }, - "party": { - "type": "string", - "description": "The full name of the party the candidate is a member of." - }, - "phone": { - "type": "string", - "description": "The voice phone number for the candidate's campaign office." - }, - "photoUrl": { - "type": "string", - "description": "A URL for a photo of the candidate." - } - } - }, - "Channel": { - "id": "Channel", - "type": "object", - "description": "A social media or web channel for a candidate.", - "properties": { - "id": { - "type": "string", - "description": "The unique public identifier for the candidate's channel." - }, - "type": { - "type": "string", - "description": "The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter" - } - } - }, - "Contest": { - "id": "Contest", - "type": "object", - "description": "Information about a contest that appears on a voter's ballot.", - "properties": { - "ballotPlacement": { - "type": "string", - "description": "A number specifying the position of this contest on the voter's ballot.", - "format": "int64" - }, - "candidates": { - "type": "array", - "description": "The candidate choices for this contest.", - "items": { - "$ref": "Candidate" - } - }, - "district": { - "$ref": "ElectoralDistrict", - "description": "Information about the electoral district that this contest is in." - }, - "electorateSpecifications": { - "type": "string", - "description": "A description of any additional eligibility requirements for voting in this contest." - }, - "id": { - "type": "string", - "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page." - }, - "level": { - "type": "string", - "description": "The level of office for this contest. One of: federal, state, county, city, other" - }, - "numberElected": { - "type": "string", - "description": "The number of candidates that will be elected to office in this contest.", - "format": "int64" - }, - "numberVotingFor": { - "type": "string", - "description": "The number of candidates that a voter may vote for in this contest.", - "format": "int64" - }, - "office": { - "type": "string", - "description": "The name of the office for this contest." - }, - "primaryParty": { - "type": "string", - "description": "If this is a partisan election, the name of the party it is for." - }, - "referendumSubtitle": { - "type": "string", - "description": "A brief description of the referendum. This field is only populated for contests of type 'Referendum'." - }, - "referendumTitle": { - "type": "string", - "description": "The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'." - }, - "referendumUrl": { - "type": "string", - "description": "A link to the referendum. This field is only populated for contests of type 'Referendum'." - }, - "sources": { - "type": "array", - "description": "A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.", - "items": { - "$ref": "Source" - } - }, - "special": { - "type": "string", - "description": "\"Yes\" or \"No\" depending on whether this a contest being held outside the normal election cycle." - }, - "type": { - "type": "string", - "description": "The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'." - } - } - }, - "DivisionSearchResponse": { - "id": "DivisionSearchResponse", - "type": "object", - "description": "The result of a division search query.", - "properties": { - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#divisionSearchResponse\".", - "default": "civicinfo#divisionSearchResponse" - }, - "results": { - "type": "array", - "items": { - "$ref": "DivisionSearchResult" - } - }, - "status": { - "type": "string", - "description": "The result of the request. One of: success, addressUnparseable, noAddressParameter, internalLookupFailure" - } - } - }, - "DivisionSearchResult": { - "id": "DivisionSearchResult", - "type": "object", - "description": "Represents a political geographic division that matches the requested query.", - "properties": { - "aliases": { - "type": "array", - "description": "Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The name of the division." - }, - "ocdId": { - "type": "string", - "description": "The unique Open Civic Data identifier for this division." - } - } - }, - "Election": { - "id": "Election", - "type": "object", - "description": "Information about the election that was queried.", - "properties": { - "electionDay": { - "type": "string", - "description": "Day of the election in YYYY-MM-DD format." - }, - "id": { - "type": "string", - "description": "The unique ID of this election.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "A displayable name for the election." - } - } - }, - "ElectionOfficial": { - "id": "ElectionOfficial", - "type": "object", - "description": "Information about individual election officials.", - "properties": { - "emailAddress": { - "type": "string", - "description": "The email address of the election official." - }, - "faxNumber": { - "type": "string", - "description": "The fax number of the election official." - }, - "name": { - "type": "string", - "description": "The full name of the election official." - }, - "officePhoneNumber": { - "type": "string", - "description": "The office phone number of the election official." - }, - "title": { - "type": "string", - "description": "The title of the election official." - } - } - }, - "ElectionsQueryResponse": { - "id": "ElectionsQueryResponse", - "type": "object", - "description": "The list of elections available for this version of the API.", - "properties": { - "elections": { - "type": "array", - "description": "A list of available elections", - "items": { - "$ref": "Election" - } - }, - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#electionsQueryResponse\".", - "default": "civicinfo#electionsQueryResponse" - } - } - }, - "ElectoralDistrict": { - "id": "ElectoralDistrict", - "type": "object", - "description": "Describes the geographic scope of a contest.", - "properties": { - "id": { - "type": "string", - "description": "An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id \"34\" and a scope of stateUpper." - }, - "name": { - "type": "string", - "description": "The name of the district." - }, - "scope": { - "type": "string", - "description": "The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special" - } - } - }, - "GeographicDivision": { - "id": "GeographicDivision", - "type": "object", - "description": "Describes a political geography.", - "properties": { - "alsoKnownAs": { - "type": "array", - "description": "Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The name of the division." - }, - "officeIds": { - "type": "array", - "description": "List of keys in the offices object, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.", - "items": { - "type": "string" - } - }, - "scope": { - "type": "string", - "description": "The geographic scope of the division. If unspecified, the division's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special" - } - } - }, - "Office": { - "id": "Office", - "type": "object", - "description": "Information about an Office held by one or more Officials.", - "properties": { - "divisionId": { - "type": "string", - "description": "The OCD ID of the division with which this office is associated." - }, - "level": { - "type": "string", - "description": "The level of this elected office. One of: federal, state, county, city, other" - }, - "name": { - "type": "string", - "description": "The human-readable name of the office." - }, - "officialIds": { - "type": "array", - "description": "List of keys in the officials object of people who presently hold this office.", - "items": { - "type": "string" - } - }, - "sources": { - "type": "array", - "description": "A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.", - "items": { - "$ref": "Source" - } - } - } - }, - "Official": { - "id": "Official", - "type": "object", - "description": "Information about a person holding an elected office.", - "properties": { - "address": { - "type": "array", - "description": "Addresses at which to contact the official.", - "items": { - "$ref": "SimpleAddressType" - } - }, - "channels": { - "type": "array", - "description": "A list of known (social) media channels for this official.", - "items": { - "$ref": "Channel" - } - }, - "emails": { - "type": "array", - "description": "The direct email addresses for the official.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The official's name." - }, - "party": { - "type": "string", - "description": "The full name of the party the official belongs to." - }, - "phones": { - "type": "array", - "description": "The official's public contact phone numbers.", - "items": { - "type": "string" - } - }, - "photoUrl": { - "type": "string", - "description": "A URL for a photo of the official." - }, - "urls": { - "type": "array", - "description": "The official's public website URLs.", - "items": { - "type": "string" - } - } - } - }, - "PollingLocation": { - "id": "PollingLocation", - "type": "object", - "description": "A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.", - "properties": { - "address": { - "$ref": "SimpleAddressType", - "description": "The address of the location." - }, - "endDate": { - "type": "string", - "description": "The last date that this early vote site or drop off location may be used. This field is not populated for polling locations." - }, - "id": { - "type": "string", - "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page." - }, - "name": { - "type": "string", - "description": "The name of the early vote site or drop off location. This field is not populated for polling locations." - }, - "notes": { - "type": "string", - "description": "Notes about this location (e.g. accessibility ramp or entrance to use)." - }, - "pollingHours": { - "type": "string", - "description": "A description of when this location is open." - }, - "sources": { - "type": "array", - "description": "A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.", - "items": { - "$ref": "Source" - } - }, - "startDate": { - "type": "string", - "description": "The first date that this early vote site or drop off location may be used. This field is not populated for polling locations." - }, - "voterServices": { - "type": "string", - "description": "The services provided by this early vote site or drop off location. This field is not populated for polling locations." - } - } - }, - "RepresentativeInfoRequest": { - "id": "RepresentativeInfoRequest", - "type": "object", - "description": "A request for political geography and representative information for an address.", - "properties": { - "address": { - "type": "string", - "description": "The address to look up. May only be specified if the field ocdId is not given in the URL." - } - } - }, - "RepresentativeInfoResponse": { - "id": "RepresentativeInfoResponse", - "type": "object", - "description": "The result of a representative info lookup query.", - "properties": { - "divisions": { - "type": "object", - "description": "Political geographic divisions that contain the requested address.", - "additionalProperties": { - "$ref": "GeographicDivision", - "description": "The unique Open Civic Data identifier for this division." - } - }, - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#representativeInfoResponse\".", - "default": "civicinfo#representativeInfoResponse" - }, - "normalizedInput": { - "$ref": "SimpleAddressType", - "description": "The normalized version of the requested address" - }, - "offices": { - "type": "object", - "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.", - "additionalProperties": { - "$ref": "Office", - "description": "A unique identifier for this office, within the context of this request. Identifiers are *not* long-lived: the same office may get different IDs on different requests." - } - }, - "officials": { - "type": "object", - "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.", - "additionalProperties": { - "$ref": "Official", - "description": "A unique identifier for this official, within the context of this request. Identifiers are *not* long-lived: the same official may get different IDs on different requests." - } - }, - "status": { - "type": "string", - "description": "The result of the request. One of: success, noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegmentsFound, electionOver, electionUnknown, internalLookupFailure, RequestedBothAddressAndOcdId" - } - } - }, - "SimpleAddressType": { - "id": "SimpleAddressType", - "type": "object", - "description": "A simple representation of an address.", - "properties": { - "city": { - "type": "string", - "description": "The city or town for the address." - }, - "line1": { - "type": "string", - "description": "The street name and number of this address." - }, - "line2": { - "type": "string", - "description": "The second line the address, if needed." - }, - "line3": { - "type": "string", - "description": "The third line of the address, if needed." - }, - "locationName": { - "type": "string", - "description": "The name of the location." - }, - "state": { - "type": "string", - "description": "The US two letter state abbreviation of the address." - }, - "zip": { - "type": "string", - "description": "The US Postal Zip Code of the address." - } - } - }, - "Source": { - "id": "Source", - "type": "object", - "description": "Contains information about the data source for the element containing it.", - "properties": { - "name": { - "type": "string", - "description": "The name of the data source." - }, - "official": { - "type": "boolean", - "description": "Whether this data comes from an official government source." - } - } - }, - "VoterInfoRequest": { - "id": "VoterInfoRequest", - "type": "object", - "description": "A request for information about a voter.", - "properties": { - "address": { - "type": "string", - "description": "The registered address of the voter to look up." - } - } - }, - "VoterInfoResponse": { - "id": "VoterInfoResponse", - "type": "object", - "description": "The result of a voter info lookup query.", - "properties": { - "contests": { - "type": "array", - "description": "Contests that will appear on the voter's ballot.", - "items": { - "$ref": "Contest" - } - }, - "dropOffLocations": { - "type": "array", - "description": "Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.", - "items": { - "$ref": "PollingLocation" - } - }, - "earlyVoteSites": { - "type": "array", - "description": "Locations where the voter is eligible to vote early, prior to election day.", - "items": { - "$ref": "PollingLocation" - } - }, - "election": { - "$ref": "Election", - "description": "The election that was queried." - }, - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#voterInfoResponse\".", - "default": "civicinfo#voterInfoResponse" - }, - "normalizedInput": { - "$ref": "SimpleAddressType", - "description": "The normalized version of the requested address" - }, - "pollingLocations": { - "type": "array", - "description": "Locations where the voter is eligible to vote on election day.", - "items": { - "$ref": "PollingLocation" - } - }, - "precinctId": { - "type": "string" - }, - "state": { - "type": "array", - "description": "Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.", - "items": { - "$ref": "AdministrationRegion" - } - }, - "status": { - "type": "string", - "description": "The result of the request. One of: success, noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegmentsFound, electionOver, electionUnknown, internalLookupFailure" - } - } - } - }, - "resources": { - "divisions": { - "methods": { - "search": { - "id": "civicinfo.divisions.search", - "path": "representatives/division_search", - "httpMethod": "GET", - "description": "Searches for political divisions by their natural name or OCD ID.", - "parameters": { - "query": { - "type": "string", - "description": "The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html", - "location": "query" - } - }, - "response": { - "$ref": "DivisionSearchResponse" - } - } - } - }, - "elections": { - "methods": { - "electionQuery": { - "id": "civicinfo.elections.electionQuery", - "path": "elections", - "httpMethod": "GET", - "description": "List of available elections to query.", - "response": { - "$ref": "ElectionsQueryResponse" - } - }, - "voterInfoQuery": { - "id": "civicinfo.elections.voterInfoQuery", - "path": "voterinfo/{electionId}/lookup", - "httpMethod": "POST", - "description": "Looks up information relevant to a voter based on the voter's registered address.", - "parameters": { - "electionId": { - "type": "string", - "description": "The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections", - "required": true, - "format": "int64", - "location": "path" - }, - "officialOnly": { - "type": "boolean", - "description": "If set to true, only data from official state sources will be returned.", - "default": "false", - "location": "query" - } - }, - "parameterOrder": [ - "electionId" - ], - "request": { - "$ref": "VoterInfoRequest" - }, - "response": { - "$ref": "VoterInfoResponse" - } - } - } - }, - "representatives": { - "methods": { - "representativeInfoQuery": { - "id": "civicinfo.representatives.representativeInfoQuery", - "path": "representatives/lookup", - "httpMethod": "POST", - "description": "Looks up political geography and representative information based on an address or Open Civic Data division identifier.", - "parameters": { - "includeOffices": { - "type": "boolean", - "description": "Whether to return information about offices and officials. If false, only the top-level district information will be returned.", - "default": "true", - "location": "query" - }, - "ocdId": { - "type": "string", - "description": "The division to look up. May only be specified if the address field is not given in the request body.", - "location": "query" - }, - "recursive": { - "type": "boolean", - "description": "When ocd_id is supplied, return all divisions which are hierarchically nested within the queried division. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.", - "default": "false", - "location": "query" - } - }, - "request": { - "$ref": "RepresentativeInfoRequest" - }, - "response": { - "$ref": "RepresentativeInfoResponse" - } - } - } - } - } -} diff --git a/etc/api/civicinfo/v1/civicinfo-api.json b/etc/api/civicinfo/v1/civicinfo-api.json deleted file mode 100644 index 078ecfc915..0000000000 --- a/etc/api/civicinfo/v1/civicinfo-api.json +++ /dev/null @@ -1,874 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"l66ggWbucbkBw9Lpos72oziyefE/m-jfWpr9P6EusWc0QHxRJ5ZUj0Y\"", - "discoveryVersion": "v1", - "id": "civicinfo:v1", - "name": "civicinfo", - "canonicalName": "Civic Info", - "version": "v1", - "revision": "20141023", - "title": "Google Civic Information API", - "description": "An API for accessing civic information.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "https://developers.google.com/civic-information", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/civicinfo/v1/", - "basePath": "/civicinfo/v1/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "civicinfo/v1/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "schemas": { - "AdministrationRegion": { - "id": "AdministrationRegion", - "type": "object", - "description": "Describes information about a regional election administrative area.", - "properties": { - "electionAdministrationBody": { - "$ref": "AdministrativeBody", - "description": "The election administration body for this area." - }, - "id": { - "type": "string", - "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page." - }, - "local_jurisdiction": { - "$ref": "AdministrationRegion", - "description": "The city or county that provides election information for this voter. This object can have the same elements as state." - }, - "name": { - "type": "string", - "description": "The name of the jurisdiction." - }, - "sources": { - "type": "array", - "description": "A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.", - "items": { - "$ref": "Source" - } - } - } - }, - "AdministrativeBody": { - "id": "AdministrativeBody", - "type": "object", - "description": "Information about an election administrative body (e.g. County Board of Elections).", - "properties": { - "absenteeVotingInfoUrl": { - "type": "string", - "description": "A URL provided by this administrative body for information on absentee voting." - }, - "ballotInfoUrl": { - "type": "string", - "description": "A URL provided by this administrative body to give contest information to the voter." - }, - "correspondenceAddress": { - "$ref": "SimpleAddressType", - "description": "The mailing address of this administrative body." - }, - "electionInfoUrl": { - "type": "string", - "description": "A URL provided by this administrative body for looking up general election information." - }, - "electionOfficials": { - "type": "array", - "description": "The election officials for this election administrative body.", - "items": { - "$ref": "ElectionOfficial" - } - }, - "electionRegistrationConfirmationUrl": { - "type": "string", - "description": "A URL provided by this administrative body for confirming that the voter is registered to vote." - }, - "electionRegistrationUrl": { - "type": "string", - "description": "A URL provided by this administrative body for looking up how to register to vote." - }, - "electionRulesUrl": { - "type": "string", - "description": "A URL provided by this administrative body describing election rules to the voter." - }, - "hoursOfOperation": { - "type": "string", - "description": "A description of the hours of operation for this administrative body." - }, - "name": { - "type": "string", - "description": "The name of this election administrative body." - }, - "physicalAddress": { - "$ref": "SimpleAddressType", - "description": "The physical address of this administrative body." - }, - "voter_services": { - "type": "array", - "description": "A description of the services this administrative body may provide.", - "items": { - "type": "string" - } - }, - "votingLocationFinderUrl": { - "type": "string", - "description": "A URL provided by this administrative body for looking up where to vote." - } - } - }, - "Candidate": { - "id": "Candidate", - "type": "object", - "description": "Information about a candidate running for elected office.", - "properties": { - "candidateUrl": { - "type": "string", - "description": "The URL for the candidate's campaign web site." - }, - "channels": { - "type": "array", - "description": "A list of known (social) media channels for this candidate.", - "items": { - "$ref": "Channel" - } - }, - "email": { - "type": "string", - "description": "The email address for the candidate's campaign." - }, - "name": { - "type": "string", - "description": "The candidate's name." - }, - "orderOnBallot": { - "type": "string", - "description": "The order the candidate appears on the ballot for this contest.", - "format": "int64" - }, - "party": { - "type": "string", - "description": "The full name of the party the candidate is a member of." - }, - "phone": { - "type": "string", - "description": "The voice phone number for the candidate's campaign office." - }, - "photoUrl": { - "type": "string", - "description": "A URL for a photo of the candidate." - } - } - }, - "Channel": { - "id": "Channel", - "type": "object", - "description": "A social media or web channel for a candidate.", - "properties": { - "id": { - "type": "string", - "description": "The unique public identifier for the candidate's channel." - }, - "type": { - "type": "string", - "description": "The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter" - } - } - }, - "Contest": { - "id": "Contest", - "type": "object", - "description": "Information about a contest that appears on a voter's ballot.", - "properties": { - "ballotPlacement": { - "type": "string", - "description": "A number specifying the position of this contest on the voter's ballot.", - "format": "int64" - }, - "candidates": { - "type": "array", - "description": "The candidate choices for this contest.", - "items": { - "$ref": "Candidate" - } - }, - "district": { - "$ref": "ElectoralDistrict", - "description": "Information about the electoral district that this contest is in." - }, - "electorateSpecifications": { - "type": "string", - "description": "A description of any additional eligibility requirements for voting in this contest." - }, - "id": { - "type": "string", - "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page." - }, - "level": { - "type": "string", - "description": "The level of office for this contest. One of: federal, state, county, city, other" - }, - "numberElected": { - "type": "string", - "description": "The number of candidates that will be elected to office in this contest.", - "format": "int64" - }, - "numberVotingFor": { - "type": "string", - "description": "The number of candidates that a voter may vote for in this contest.", - "format": "int64" - }, - "office": { - "type": "string", - "description": "The name of the office for this contest." - }, - "primaryParty": { - "type": "string", - "description": "If this is a partisan election, the name of the party it is for." - }, - "referendumSubtitle": { - "type": "string", - "description": "A brief description of the referendum. This field is only populated for contests of type 'Referendum'." - }, - "referendumTitle": { - "type": "string", - "description": "The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'." - }, - "referendumUrl": { - "type": "string", - "description": "A link to the referendum. This field is only populated for contests of type 'Referendum'." - }, - "sources": { - "type": "array", - "description": "A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.", - "items": { - "$ref": "Source" - } - }, - "special": { - "type": "string", - "description": "\"Yes\" or \"No\" depending on whether this a contest being held outside the normal election cycle." - }, - "type": { - "type": "string", - "description": "The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'." - } - } - }, - "DivisionSearchResponse": { - "id": "DivisionSearchResponse", - "type": "object", - "description": "The result of a division search query.", - "properties": { - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#divisionSearchResponse\".", - "default": "civicinfo#divisionSearchResponse" - }, - "results": { - "type": "array", - "items": { - "$ref": "DivisionSearchResult" - } - }, - "status": { - "type": "string", - "description": "The result of the request. One of: success, addressUnparseable, noAddressParameter, internalLookupFailure" - } - } - }, - "DivisionSearchResult": { - "id": "DivisionSearchResult", - "type": "object", - "description": "Represents a political geographic division that matches the requested query.", - "properties": { - "aliases": { - "type": "array", - "description": "Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The name of the division." - }, - "ocdId": { - "type": "string", - "description": "The unique Open Civic Data identifier for this division." - } - } - }, - "Election": { - "id": "Election", - "type": "object", - "description": "Information about the election that was queried.", - "properties": { - "electionDay": { - "type": "string", - "description": "Day of the election in YYYY-MM-DD format." - }, - "id": { - "type": "string", - "description": "The unique ID of this election.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "A displayable name for the election." - } - } - }, - "ElectionOfficial": { - "id": "ElectionOfficial", - "type": "object", - "description": "Information about individual election officials.", - "properties": { - "emailAddress": { - "type": "string", - "description": "The email address of the election official." - }, - "faxNumber": { - "type": "string", - "description": "The fax number of the election official." - }, - "name": { - "type": "string", - "description": "The full name of the election official." - }, - "officePhoneNumber": { - "type": "string", - "description": "The office phone number of the election official." - }, - "title": { - "type": "string", - "description": "The title of the election official." - } - } - }, - "ElectionsQueryResponse": { - "id": "ElectionsQueryResponse", - "type": "object", - "description": "The list of elections available for this version of the API.", - "properties": { - "elections": { - "type": "array", - "description": "A list of available elections", - "items": { - "$ref": "Election" - } - }, - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#electionsQueryResponse\".", - "default": "civicinfo#electionsQueryResponse" - } - } - }, - "ElectoralDistrict": { - "id": "ElectoralDistrict", - "type": "object", - "description": "Describes the geographic scope of a contest.", - "properties": { - "id": { - "type": "string", - "description": "An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id \"34\" and a scope of stateUpper." - }, - "name": { - "type": "string", - "description": "The name of the district." - }, - "scope": { - "type": "string", - "description": "The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special" - } - } - }, - "GeographicDivision": { - "id": "GeographicDivision", - "type": "object", - "description": "Describes a political geography.", - "properties": { - "alsoKnownAs": { - "type": "array", - "description": "Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The name of the division." - }, - "officeIds": { - "type": "array", - "description": "List of keys in the offices object, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.", - "items": { - "type": "string" - } - }, - "scope": { - "type": "string", - "description": "The geographic scope of the division. If unspecified, the division's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special" - } - } - }, - "Office": { - "id": "Office", - "type": "object", - "description": "Information about an Office held by one or more Officials.", - "properties": { - "divisionId": { - "type": "string", - "description": "The OCD ID of the division with which this office is associated." - }, - "level": { - "type": "string", - "description": "The level of this elected office. One of: federal, state, county, city, other" - }, - "name": { - "type": "string", - "description": "The human-readable name of the office." - }, - "officialIds": { - "type": "array", - "description": "List of keys in the officials object of people who presently hold this office.", - "items": { - "type": "string" - } - }, - "sources": { - "type": "array", - "description": "A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.", - "items": { - "$ref": "Source" - } - } - } - }, - "Official": { - "id": "Official", - "type": "object", - "description": "Information about a person holding an elected office.", - "properties": { - "address": { - "type": "array", - "description": "Addresses at which to contact the official.", - "items": { - "$ref": "SimpleAddressType" - } - }, - "channels": { - "type": "array", - "description": "A list of known (social) media channels for this official.", - "items": { - "$ref": "Channel" - } - }, - "emails": { - "type": "array", - "description": "The direct email addresses for the official.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The official's name." - }, - "party": { - "type": "string", - "description": "The full name of the party the official belongs to." - }, - "phones": { - "type": "array", - "description": "The official's public contact phone numbers.", - "items": { - "type": "string" - } - }, - "photoUrl": { - "type": "string", - "description": "A URL for a photo of the official." - }, - "urls": { - "type": "array", - "description": "The official's public website URLs.", - "items": { - "type": "string" - } - } - } - }, - "PollingLocation": { - "id": "PollingLocation", - "type": "object", - "description": "A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.", - "properties": { - "address": { - "$ref": "SimpleAddressType", - "description": "The address of the location." - }, - "endDate": { - "type": "string", - "description": "The last date that this early vote site or drop off location may be used. This field is not populated for polling locations." - }, - "id": { - "type": "string", - "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page." - }, - "name": { - "type": "string", - "description": "The name of the early vote site or drop off location. This field is not populated for polling locations." - }, - "notes": { - "type": "string", - "description": "Notes about this location (e.g. accessibility ramp or entrance to use)." - }, - "pollingHours": { - "type": "string", - "description": "A description of when this location is open." - }, - "sources": { - "type": "array", - "description": "A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.", - "items": { - "$ref": "Source" - } - }, - "startDate": { - "type": "string", - "description": "The first date that this early vote site or drop off location may be used. This field is not populated for polling locations." - }, - "voterServices": { - "type": "string", - "description": "The services provided by this early vote site or drop off location. This field is not populated for polling locations." - } - } - }, - "RepresentativeInfoRequest": { - "id": "RepresentativeInfoRequest", - "type": "object", - "description": "A request for political geography and representative information for an address.", - "properties": { - "address": { - "type": "string", - "description": "The address to look up. May only be specified if the field ocdId is not given in the URL." - } - } - }, - "RepresentativeInfoResponse": { - "id": "RepresentativeInfoResponse", - "type": "object", - "description": "The result of a representative info lookup query.", - "properties": { - "divisions": { - "type": "object", - "description": "Political geographic divisions that contain the requested address.", - "additionalProperties": { - "$ref": "GeographicDivision", - "description": "The unique Open Civic Data identifier for this division." - } - }, - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#representativeInfoResponse\".", - "default": "civicinfo#representativeInfoResponse" - }, - "normalizedInput": { - "$ref": "SimpleAddressType", - "description": "The normalized version of the requested address" - }, - "offices": { - "type": "object", - "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.", - "additionalProperties": { - "$ref": "Office", - "description": "A unique identifier for this office, within the context of this request. Identifiers are *not* long-lived: the same office may get different IDs on different requests." - } - }, - "officials": { - "type": "object", - "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.", - "additionalProperties": { - "$ref": "Official", - "description": "A unique identifier for this official, within the context of this request. Identifiers are *not* long-lived: the same official may get different IDs on different requests." - } - }, - "status": { - "type": "string", - "description": "The result of the request. One of: success, noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegmentsFound, electionOver, electionUnknown, internalLookupFailure, RequestedBothAddressAndOcdId" - } - } - }, - "SimpleAddressType": { - "id": "SimpleAddressType", - "type": "object", - "description": "A simple representation of an address.", - "properties": { - "city": { - "type": "string", - "description": "The city or town for the address." - }, - "line1": { - "type": "string", - "description": "The street name and number of this address." - }, - "line2": { - "type": "string", - "description": "The second line the address, if needed." - }, - "line3": { - "type": "string", - "description": "The third line of the address, if needed." - }, - "locationName": { - "type": "string", - "description": "The name of the location." - }, - "state": { - "type": "string", - "description": "The US two letter state abbreviation of the address." - }, - "zip": { - "type": "string", - "description": "The US Postal Zip Code of the address." - } - } - }, - "Source": { - "id": "Source", - "type": "object", - "description": "Contains information about the data source for the element containing it.", - "properties": { - "name": { - "type": "string", - "description": "The name of the data source." - }, - "official": { - "type": "boolean", - "description": "Whether this data comes from an official government source." - } - } - }, - "VoterInfoRequest": { - "id": "VoterInfoRequest", - "type": "object", - "description": "A request for information about a voter.", - "properties": { - "address": { - "type": "string", - "description": "The registered address of the voter to look up." - } - } - }, - "VoterInfoResponse": { - "id": "VoterInfoResponse", - "type": "object", - "description": "The result of a voter info lookup query.", - "properties": { - "contests": { - "type": "array", - "description": "Contests that will appear on the voter's ballot.", - "items": { - "$ref": "Contest" - } - }, - "dropOffLocations": { - "type": "array", - "description": "Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.", - "items": { - "$ref": "PollingLocation" - } - }, - "earlyVoteSites": { - "type": "array", - "description": "Locations where the voter is eligible to vote early, prior to election day.", - "items": { - "$ref": "PollingLocation" - } - }, - "election": { - "$ref": "Election", - "description": "The election that was queried." - }, - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#voterInfoResponse\".", - "default": "civicinfo#voterInfoResponse" - }, - "normalizedInput": { - "$ref": "SimpleAddressType", - "description": "The normalized version of the requested address" - }, - "pollingLocations": { - "type": "array", - "description": "Locations where the voter is eligible to vote on election day.", - "items": { - "$ref": "PollingLocation" - } - }, - "precinctId": { - "type": "string" - }, - "state": { - "type": "array", - "description": "Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.", - "items": { - "$ref": "AdministrationRegion" - } - }, - "status": { - "type": "string", - "description": "The result of the request. One of: success, noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegmentsFound, electionOver, electionUnknown, internalLookupFailure" - } - } - } - }, - "resources": { - "divisions": { - "methods": { - "search": { - "id": "civicinfo.divisions.search", - "path": "representatives/division_search", - "httpMethod": "GET", - "description": "Searches for political divisions by their natural name or OCD ID.", - "parameters": { - "query": { - "type": "string", - "description": "The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html", - "location": "query" - } - }, - "response": { - "$ref": "DivisionSearchResponse" - } - } - } - }, - "elections": { - "methods": { - "electionQuery": { - "id": "civicinfo.elections.electionQuery", - "path": "elections", - "httpMethod": "GET", - "description": "List of available elections to query.", - "response": { - "$ref": "ElectionsQueryResponse" - } - }, - "voterInfoQuery": { - "id": "civicinfo.elections.voterInfoQuery", - "path": "voterinfo/{electionId}/lookup", - "httpMethod": "POST", - "description": "Looks up information relevant to a voter based on the voter's registered address.", - "parameters": { - "electionId": { - "type": "string", - "description": "The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections", - "required": true, - "format": "int64", - "location": "path" - }, - "officialOnly": { - "type": "boolean", - "description": "If set to true, only data from official state sources will be returned.", - "default": "false", - "location": "query" - } - }, - "parameterOrder": [ - "electionId" - ], - "request": { - "$ref": "VoterInfoRequest" - }, - "response": { - "$ref": "VoterInfoResponse" - } - } - } - }, - "representatives": { - "methods": { - "representativeInfoQuery": { - "id": "civicinfo.representatives.representativeInfoQuery", - "path": "representatives/lookup", - "httpMethod": "POST", - "description": "Looks up political geography and representative information based on an address or Open Civic Data division identifier.", - "parameters": { - "includeOffices": { - "type": "boolean", - "description": "Whether to return information about offices and officials. If false, only the top-level district information will be returned.", - "default": "true", - "location": "query" - }, - "ocdId": { - "type": "string", - "description": "The division to look up. May only be specified if the address field is not given in the request body.", - "location": "query" - }, - "recursive": { - "type": "boolean", - "description": "When ocd_id is supplied, return all divisions which are hierarchically nested within the queried division. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.", - "default": "false", - "location": "query" - } - }, - "request": { - "$ref": "RepresentativeInfoRequest" - }, - "response": { - "$ref": "RepresentativeInfoResponse" - } - } - } - } - } -} diff --git a/etc/api/civicinfo/v2/civicinfo-api.json b/etc/api/civicinfo/v2/civicinfo-api.json index bb45ff4144..ce585066bb 100644 --- a/etc/api/civicinfo/v2/civicinfo-api.json +++ b/etc/api/civicinfo/v2/civicinfo-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/dzDAw-a-wr29Bfv6g2UuVo82dys\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/m2jEe7hMRh3PEVg32yoWNGLPJKw\"", "discoveryVersion": "v1", "id": "civicinfo:v2", "name": "civicinfo", diff --git a/etc/api/cloudlatencytest/v2/cloudlatencytest-api.json b/etc/api/cloudlatencytest/v2/cloudlatencytest-api.json index 8ead9c1b74..583addb6a8 100644 --- a/etc/api/cloudlatencytest/v2/cloudlatencytest-api.json +++ b/etc/api/cloudlatencytest/v2/cloudlatencytest-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/PW6HfcHDC5AsDXJubg0JwdKPyYo\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/DOqQD0ztw6kTeWEwsos73hXv2PI\"", "discoveryVersion": "v1", "id": "cloudlatencytest:v2", "name": "cloudlatencytest", diff --git a/etc/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json b/etc/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json index 735f45a449..245d664196 100644 --- a/etc/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json +++ b/etc/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Dk6TwAngsiH9i6P5F-3AwO5eWBw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Ly32PDFAiHCxV9MTTuQr-IdOpS0\"", "discoveryVersion": "v1", "id": "cloudmonitoring:v2beta2", "name": "cloudmonitoring", "canonicalName": "Cloud Monitoring", "version": "v2beta2", - "revision": "20160124", + "revision": "20160221", "title": "Cloud Monitoring API", "description": "API for accessing Google Cloud and API monitoring data.", "ownerDomain": "google.com", diff --git a/etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json b/etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json new file mode 100644 index 0000000000..4961a4ba63 --- /dev/null +++ b/etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json @@ -0,0 +1,507 @@ +{ + "kind": "discovery#restDescription", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/8EOgQpr1bAhvZ8Ay5woGZcfT03Y\"", + "discoveryVersion": "v1", + "id": "cloudresourcemanager:v1", + "name": "cloudresourcemanager", + "version": "v1", + "revision": "20160225", + "title": "Google Cloud Resource Manager API", + "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.", + "ownerDomain": "google.com", + "ownerName": "Google", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "documentationLink": "https://cloud.google.com/resource-manager", + "protocol": "rest", + "baseUrl": "https://cloudresourcemanager.googleapis.com/", + "basePath": "", + "rootUrl": "https://cloudresourcemanager.googleapis.com/", + "servicePath": "", + "batchPath": "batch", + "parameters": { + "access_token": { + "type": "string", + "description": "OAuth access token.", + "location": "query" + }, + "alt": { + "type": "string", + "description": "Data format for response.", + "default": "json", + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query" + }, + "bearer_token": { + "type": "string", + "description": "OAuth bearer token.", + "location": "query" + }, + "callback": { + "type": "string", + "description": "JSONP", + "location": "query" + }, + "fields": { + "type": "string", + "description": "Selector specifying which fields to include in a partial response.", + "location": "query" + }, + "key": { + "type": "string", + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query" + }, + "oauth_token": { + "type": "string", + "description": "OAuth 2.0 token for the current user.", + "location": "query" + }, + "pp": { + "type": "boolean", + "description": "Pretty-print response.", + "default": "true", + "location": "query" + }, + "prettyPrint": { + "type": "boolean", + "description": "Returns response with indentations and line breaks.", + "default": "true", + "location": "query" + }, + "quotaUser": { + "type": "string", + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query" + }, + "upload_protocol": { + "type": "string", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query" + }, + "uploadType": { + "type": "string", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query" + }, + "$.xgafv": { + "type": "string", + "description": "V1 error format.", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + } + }, + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + } + } + } + }, + "schemas": { + "Project": { + "id": "Project", + "type": "object", + "description": "A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.", + "properties": { + "projectNumber": { + "type": "string", + "description": "The number uniquely identifying the project. Example: 415104041262 Read-only.", + "format": "int64" + }, + "projectId": { + "type": "string", + "description": "The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation." + }, + "lifecycleState": { + "type": "string", + "description": "The Project lifecycle state. Read-only.", + "enum": [ + "LIFECYCLE_STATE_UNSPECIFIED", + "ACTIVE", + "DELETE_REQUESTED", + "DELETE_IN_PROGRESS" + ] + }, + "name": { + "type": "string", + "description": "The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write." + }, + "createTime": { + "type": "string", + "description": "Creation time. Read-only." + }, + "labels": { + "type": "object", + "description": "The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: \"environment\" : \"dev\" Read-write.", + "additionalProperties": { + "type": "string" + } + }, + "parent": { + "$ref": "ResourceId", + "description": "An optional reference to a parent Resource. The only supported parent type is \"organization\". Once set, the parent cannot be modified. Read-write." + } + } + }, + "ResourceId": { + "id": "ResourceId", + "type": "object", + "description": "A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on.", + "properties": { + "type": { + "type": "string", + "description": "Required field representing the resource type this id is for. At present, the only valid type is \"organization\"." + }, + "id": { + "type": "string", + "description": "Required field for the type-specific id. This should correspond to the id used in the type-specific API's." + } + } + }, + "ListProjectsResponse": { + "id": "ListProjectsResponse", + "type": "object", + "description": "A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.", + "properties": { + "projects": { + "type": "array", + "description": "The list of Projects that matched the list filter. This list can be paginated.", + "items": { + "$ref": "Project" + } + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime." + } + } + }, + "Empty": { + "id": "Empty", + "type": "object", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`." + }, + "UndeleteProjectRequest": { + "id": "UndeleteProjectRequest", + "type": "object", + "description": "The request sent to the UndeleteProject method." + }, + "GetIamPolicyRequest": { + "id": "GetIamPolicyRequest", + "type": "object", + "description": "Request message for `GetIamPolicy` method." + }, + "Policy": { + "id": "Policy", + "type": "object", + "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).", + "properties": { + "version": { + "type": "integer", + "description": "Version of the `Policy`. The default version is 0.", + "format": "int32" + }, + "bindings": { + "type": "array", + "description": "Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.", + "items": { + "$ref": "Binding" + } + }, + "etag": { + "type": "string", + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.", + "format": "byte" + } + } + }, + "Binding": { + "id": "Binding", + "type": "object", + "description": "Associates `members` with a `role`.", + "properties": { + "role": { + "type": "string", + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required" + }, + "members": { + "type": "array", + "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.", + "items": { + "type": "string" + } + } + } + }, + "SetIamPolicyRequest": { + "id": "SetIamPolicyRequest", + "type": "object", + "description": "Request message for `SetIamPolicy` method.", + "properties": { + "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 a valid policy but certain Cloud Platform services (such as Projects) might reject them." + } + } + }, + "TestIamPermissionsRequest": { + "id": "TestIamPermissionsRequest", + "type": "object", + "description": "Request message for `TestIamPermissions` method.", + "properties": { + "permissions": { + "type": "array", + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.", + "items": { + "type": "string" + } + } + } + }, + "TestIamPermissionsResponse": { + "id": "TestIamPermissionsResponse", + "type": "object", + "description": "Response message for `TestIamPermissions` method.", + "properties": { + "permissions": { + "type": "array", + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + } + } + } + } + }, + "resources": { + "projects": { + "methods": { + "get": { + "id": "cloudresourcemanager.projects.get", + "path": "v1/projects/{projectId}", + "httpMethod": "GET", + "description": "Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.", + "parameters": { + "projectId": { + "type": "string", + "description": "The Project ID (for example, `my-project-123`). Required.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "Project" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "id": "cloudresourcemanager.projects.list", + "path": "v1/projects", + "httpMethod": "GET", + "description": "Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.", + "parameters": { + "pageToken": { + "type": "string", + "description": "A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional.", + "location": "query" + }, + "pageSize": { + "type": "integer", + "description": "The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional.", + "format": "int32", + "location": "query" + }, + "filter": { + "type": "string", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + labels.key where *key* is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:*|The project has a name.| |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label `color`.| |labels.color:red|The project's label `color` has the value `red`.| |labels.color:red label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.", + "location": "query" + } + }, + "response": { + "$ref": "ListProjectsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "update": { + "id": "cloudresourcemanager.projects.update", + "path": "v1/projects/{projectId}", + "httpMethod": "PUT", + "description": "Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.", + "parameters": { + "projectId": { + "type": "string", + "description": "The project ID (for example, `my-project-123`). Required.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId" + ], + "request": { + "$ref": "Project" + }, + "response": { + "$ref": "Project" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "id": "cloudresourcemanager.projects.delete", + "path": "v1/projects/{projectId}", + "httpMethod": "DELETE", + "description": "Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the lifecycle state changes to DELETE_IN_PROGRESS. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.", + "parameters": { + "projectId": { + "type": "string", + "description": "The Project ID (for example, `foo-bar-123`). Required.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "undelete": { + "id": "cloudresourcemanager.projects.undelete", + "path": "v1/projects/{projectId}:undelete", + "httpMethod": "POST", + "description": "Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, as indicated by a lifecycle state of DELETE_IN_PROGRESS, the Project cannot be restored. The caller must have modify permissions for this Project.", + "parameters": { + "projectId": { + "type": "string", + "description": "The project ID (for example, `foo-bar-123`). Required.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId" + ], + "request": { + "$ref": "UndeleteProjectRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "id": "cloudresourcemanager.projects.getIamPolicy", + "path": "v1/projects/{resource}:getIamPolicy", + "httpMethod": "POST", + "description": "Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.", + "parameters": { + "resource": { + "type": "string", + "description": "REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "resource" + ], + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "setIamPolicy": { + "id": "cloudresourcemanager.projects.setIamPolicy", + "path": "v1/projects/{resource}:setIamPolicy", + "httpMethod": "POST", + "description": "Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project currently supports only `user:{emailid}` and `serviceAccount:{emailid}` members in a `Binding` of a `Policy`. + To be added as an `owner`, a user must be invited via Cloud Platform console and must accept the invitation. + Members cannot be added to more than one role in the same policy. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.", + "parameters": { + "resource": { + "type": "string", + "description": "REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "resource" + ], + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "id": "cloudresourcemanager.projects.testIamPermissions", + "path": "v1/projects/{resource}:testIamPermissions", + "httpMethod": "POST", + "description": "Returns permissions that a caller has on the specified Project.", + "parameters": { + "resource": { + "type": "string", + "description": "REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "resource" + ], + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } +} diff --git a/etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json index 64e499750d..7ffbe8d5d1 100644 --- a/etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json +++ b/etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/64r0Ra9DOl7BV1-32e4gD2NffS8\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/TrvaAIwiWgzGMcf4IeAhPh7OpkA\"", "discoveryVersion": "v1", "id": "cloudresourcemanager:v1beta1", "name": "cloudresourcemanager", "version": "v1beta1", - "revision": "20160112", + "revision": "20160225", "title": "Google Cloud Resource Manager API", "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.", "ownerDomain": "google.com", @@ -196,6 +196,11 @@ "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`." }, + "UndeleteProjectRequest": { + "id": "UndeleteProjectRequest", + "type": "object", + "description": "The request sent to the UndeleteProject method." + }, "GetIamPolicyRequest": { "id": "GetIamPolicyRequest", "type": "object", @@ -204,7 +209,7 @@ "Policy": { "id": "Policy", "type": "object", - "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).", + "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).", "properties": { "version": { "type": "integer", @@ -473,6 +478,9 @@ "parameterOrder": [ "projectId" ], + "request": { + "$ref": "UndeleteProjectRequest" + }, "response": { "$ref": "Empty" }, diff --git a/etc/api/cloudsearch/v1/cloudsearch-api.json b/etc/api/cloudsearch/v1/cloudsearch-api.json deleted file mode 100644 index 81b5583187..0000000000 --- a/etc/api/cloudsearch/v1/cloudsearch-api.json +++ /dev/null @@ -1,93 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/zg78C4sqdSofxjEUeedn97IFYfM\"", - "discoveryVersion": "v1", - "id": "cloudsearch:v1", - "name": "cloudsearch", - "version": "v1", - "revision": "20150416", - "title": "Google Cloud Search API", - "description": "The Google Cloud Search API defines an application interface to index documents that contain structured data and to search those indexes. It supports full text search.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "", - "protocol": "rest", - "baseUrl": "https://cloudsearch.googleapis.com/", - "basePath": "", - "rootUrl": "https://cloudsearch.googleapis.com/", - "servicePath": "", - "batchPath": "batch", - "parameters": { - "access_token": { - "type": "string", - "description": "OAuth access token.", - "location": "query" - }, - "alt": { - "type": "string", - "description": "Data format for response.", - "default": "json", - "enumDescriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ], - "location": "query" - }, - "bearer_token": { - "type": "string", - "description": "OAuth bearer token.", - "location": "query" - }, - "callback": { - "type": "string", - "description": "JSONP", - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "pp": { - "type": "boolean", - "description": "Pretty-print response.", - "default": "true", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", - "location": "query" - }, - "$.xgafv": { - "type": "string", - "description": "V1 error format.", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - } - } -} diff --git a/etc/api/clouduseraccounts/alpha/clouduseraccounts-api.json b/etc/api/clouduseraccounts/alpha/clouduseraccounts-api.json index b1372c0ed2..c4aa58ec15 100644 --- a/etc/api/clouduseraccounts/alpha/clouduseraccounts-api.json +++ b/etc/api/clouduseraccounts/alpha/clouduseraccounts-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/vRMv8xyCdMdgcOt35MZF2cJ5KT8\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ppUUXohfxuRfcvaKvPBvhvlWEhk\"", "discoveryVersion": "v1", "id": "clouduseraccounts:alpha", "name": "clouduseraccounts", diff --git a/etc/api/clouduseraccounts/beta/clouduseraccounts-api.json b/etc/api/clouduseraccounts/beta/clouduseraccounts-api.json index 4f5a6a5493..469c76bd4d 100644 --- a/etc/api/clouduseraccounts/beta/clouduseraccounts-api.json +++ b/etc/api/clouduseraccounts/beta/clouduseraccounts-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/DPLw2T3kPt3Bo--G1FdqA_FfDM4\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/P3UYPKTEgal1uNkI02OYlUoya-A\"", "discoveryVersion": "v1", "id": "clouduseraccounts:beta", "name": "clouduseraccounts", diff --git a/etc/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json b/etc/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json index e974be1fe6..129644618f 100644 --- a/etc/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json +++ b/etc/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/dsj-5t6cQWtEI3OqAnAnB9yeOCY\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/8QLRZ5jNksoRAKNza-2WDCbR984\"", "discoveryVersion": "v1", "id": "clouduseraccounts:vm_alpha", "name": "clouduseraccounts", diff --git a/etc/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json b/etc/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json index 3923deb794..32faf500f2 100644 --- a/etc/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json +++ b/etc/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/D6BiqZRDfPgZK4O17ekltegAwtY\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/_YEtikt1V6jQ8uvyDFq2SnsqFzY\"", "discoveryVersion": "v1", "id": "clouduseraccounts:vm_beta", "name": "clouduseraccounts", diff --git a/etc/api/compute/beta/compute-api.json b/etc/api/compute/beta/compute-api.json index 76b236d748..fd1f030544 100644 --- a/etc/api/compute/beta/compute-api.json +++ b/etc/api/compute/beta/compute-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/4d2gO2u2XoUkLnhU3hGWJa3ZXEk\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/pVbZZeEvcu3mq1f_gCZmNGrmIYU\"", "discoveryVersion": "v1", "id": "compute:beta", "name": "compute", "version": "beta", - "revision": "20160120", + "revision": "20160224", "title": "Compute Engine API", "description": "API for the Google Compute Engine service.", "ownerDomain": "google.com", @@ -151,7 +151,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -222,7 +222,7 @@ "AddressList": { "id": "AddressList", "type": "object", - "description": "Contains a list of address resources.", + "description": "Contains a list of addresses.", "properties": { "id": { "type": "string", @@ -230,7 +230,7 @@ }, "items": { "type": "array", - "description": "[Output Only] A list of Address resources.", + "description": "[Output Only] A list of addresses.", "items": { "$ref": "Address" } @@ -269,6 +269,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -298,6 +299,7 @@ "", "", "", + "", "" ] }, @@ -309,7 +311,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -358,7 +360,7 @@ }, "interface": { "type": "string", - "description": "Specifies the disk interface to use for attaching this disk, either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.", + "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.", "enum": [ "NVME", "SCSI" @@ -431,7 +433,7 @@ }, "diskStorageType": { "type": "string", - "description": "Storage type of the disk.", + "description": "[Deprecated] Storage type of the disk.", "enum": [ "HDD", "SSD" @@ -458,10 +460,11 @@ "Autoscaler": { "id": "Autoscaler", "type": "object", + "description": "Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.", "properties": { "autoscalingPolicy": { "$ref": "AutoscalingPolicy", - "description": "Autoscaling configuration." + "description": "The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.\n\nIf none of these are specified, the default will be to autoscale based on cpuUtilization to 0.8 or 80%." }, "creationTimestamp": { "type": "string", @@ -478,7 +481,7 @@ }, "kind": { "type": "string", - "description": "Type of the resource.", + "description": "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.", "default": "compute#autoscaler" }, "name": { @@ -497,7 +500,7 @@ }, "target": { "type": "string", - "description": "URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler." + "description": "URL of the managed instance group that this autoscaler will scale." }, "zone": { "type": "string", @@ -518,12 +521,12 @@ "description": "A map of scoped autoscaler lists.", "additionalProperties": { "$ref": "AutoscalersScopedList", - "description": "Name of the scope containing this set of autoscalers." + "description": "[Output Only] Name of the scope containing this set of autoscalers." } }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.", "default": "compute#autoscalerAggregatedList" }, "nextPageToken": { @@ -539,7 +542,7 @@ "AutoscalerList": { "id": "AutoscalerList", "type": "object", - "description": "Contains a list of persistent autoscaler resources.", + "description": "Contains a list of Autoscaler resources.", "properties": { "id": { "type": "string", @@ -554,7 +557,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.", "default": "compute#autoscalerList" }, "nextPageToken": { @@ -573,19 +576,20 @@ "properties": { "autoscalers": { "type": "array", - "description": "List of autoscalers contained in this scope.", + "description": "[Output Only] List of autoscalers contained in this scope.", "items": { "$ref": "Autoscaler" } }, "warning": { "type": "object", - "description": "Informational warning which replaces the list of autoscalers when the list is empty.", + "description": "[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.", "properties": { "code": { "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -615,6 +619,7 @@ "", "", "", + "", "" ] }, @@ -626,7 +631,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -650,16 +655,16 @@ "properties": { "coolDownPeriodSec": { "type": "integer", - "description": "The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.", + "description": "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.", "format": "int32" }, "cpuUtilization": { "$ref": "AutoscalingPolicyCpuUtilization", - "description": "TODO(jbartosik): Add support for scaling based on muliple utilization metrics (take max recommendation). Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy." + "description": "Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group." }, "customMetricUtilizations": { "type": "array", - "description": "Configuration parameters of autoscaling based on custom metric.", + "description": "Configuration parameters of autoscaling based on a custom metric.", "items": { "$ref": "AutoscalingPolicyCustomMetricUtilization" } @@ -670,12 +675,12 @@ }, "maxNumReplicas": { "type": "integer", - "description": "The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend.", + "description": "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.", "format": "int32" }, "minNumReplicas": { "type": "integer", - "description": "The minimum number of replicas that the Autoscaler can scale down to. Can't be less than 0. If not provided Autoscaler will choose default value depending on maximal number of replicas.", + "description": "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.", "format": "int32" } } @@ -687,7 +692,7 @@ "properties": { "utilizationTarget": { "type": "number", - "description": "The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.", + "description": "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.8.\n\nIf the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.", "format": "double" } } @@ -699,16 +704,16 @@ "properties": { "metric": { "type": "string", - "description": "Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count." + "description": "The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.\n\nFor example, the following is a valid metric:\ncompute.googleapis.com/instance/network/received_bytes_count\n\n\nThe following is not a valid metric because it does not increase or decrease based on usage:\ncompute.googleapis.com/instance/cpu/reserved_cores" }, "utilizationTarget": { "type": "number", - "description": "Target value of the metric which Autoscaler should maintain. Must be a positive value.", + "description": "Target value of the metric which autoscaler should maintain. Must be a positive value.", "format": "double" }, "utilizationTargetType": { "type": "string", - "description": "Defines type in which utilization_target is expressed.", + "description": "Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.", "enum": [ "DELTA_PER_MINUTE", "DELTA_PER_SECOND", @@ -725,11 +730,11 @@ "AutoscalingPolicyLoadBalancingUtilization": { "id": "AutoscalingPolicyLoadBalancingUtilization", "type": "object", - "description": "Load balancing utilization policy.", + "description": "Configuration parameters of autoscaling based on load balancing.", "properties": { "utilizationTarget": { "type": "number", - "description": "Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.", + "description": "Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.", "format": "double" } } @@ -741,7 +746,7 @@ "properties": { "balancingMode": { "type": "string", - "description": "Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.", + "description": "Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.", "enum": [ "RATE", "UTILIZATION" @@ -766,12 +771,12 @@ }, "maxRate": { "type": "integer", - "description": "The max requests per second (RPS) of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.", + "description": "The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.", "format": "int32" }, "maxRatePerInstance": { "type": "number", - "description": "The max requests per second (RPS) that a single backed instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.", + "description": "The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.", "format": "float" }, "maxUtilization": { @@ -801,6 +806,10 @@ "type": "string", "description": "An optional description of this resource. Provide this property when you create the resource." }, + "enableCDN": { + "type": "boolean", + "description": "If true, enable Cloud CDN for this BackendService." + }, "fingerprint": { "type": "string", "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.", @@ -835,10 +844,11 @@ }, "portName": { "type": "string", - "description": "Name of backend port. The same name should appear in the resource views referenced by this service. Required." + "description": "Name of backend port. The same name should appear in the instance groups referenced by this service. Required." }, "protocol": { "type": "string", + "description": "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, HTTP2, TCP and SSL.", "enum": [ "HTTP", "HTTPS" @@ -854,7 +864,7 @@ }, "timeoutSec": { "type": "integer", - "description": "How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].", + "description": "How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.", "format": "int32" } } @@ -907,6 +917,15 @@ } } }, + "CacheInvalidationRule": { + "id": "CacheInvalidationRule", + "type": "object", + "properties": { + "path": { + "type": "string" + } + } + }, "CustomerEncryptionKey": { "id": "CustomerEncryptionKey", "type": "object", @@ -990,6 +1009,18 @@ "description": "[Output Only] Type of the resource. Always compute#disk for disks.", "default": "compute#disk" }, + "labelFingerprint": { + "type": "string", + "description": "A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make get() request to the disk.", + "format": "byte" + }, + "labels": { + "type": "object", + "description": "Labels to apply to this disk. These can be later modified by the setLabels method. Each label key & value must comply with RFC1035. Label values may be empty.", + "additionalProperties": { + "type": "string" + } + }, "lastAttachTimestamp": { "type": "string", "description": "[Output Only] Last attach timestamp in RFC3339 text format." @@ -1000,14 +1031,14 @@ }, "licenses": { "type": "array", - "description": "Any applicable publicly visible licenses.", + "description": "[Output Only] Any applicable publicly visible licenses.", "items": { "type": "string" } }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -1030,7 +1061,7 @@ }, "sourceImage": { "type": "string", - "description": "The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.\n\nWhen creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:\n\nglobal/images/my-private-image \n\nOr you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD \n\nwhere vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases." + "description": "The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.\n\nWhen creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:\n\nglobal/images/my-private-image \n\nOr you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD \n\nwhere vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.\n\nYou can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example:\n\nglobal/images/family/my-private-family \n\nOr you can specify an image family from a publicly-available project. For example, to use the latest Debian 7 from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/family/debian-7" }, "sourceImageEncryptionKey": { "$ref": "CustomerEncryptionKey", @@ -1038,7 +1069,7 @@ }, "sourceImageId": { "type": "string", - "description": "The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used." + "description": "[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used." }, "sourceSnapshot": { "type": "string", @@ -1082,11 +1113,11 @@ }, "type": { "type": "string", - "description": "URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created." + "description": "URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk." }, "users": { "type": "array", - "description": "Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance", + "description": "[Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance", "items": { "type": "string" } @@ -1162,7 +1193,7 @@ "DiskType": { "id": "DiskType", "type": "object", - "description": "A disk type resource.", + "description": "A DiskType resource.", "properties": { "creationTimestamp": { "type": "string", @@ -1244,7 +1275,7 @@ "DiskTypeList": { "id": "DiskTypeList", "type": "object", - "description": "Contains a list of disk type resources.", + "description": "Contains a list of disk types.", "properties": { "id": { "type": "string", @@ -1291,6 +1322,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -1320,6 +1352,7 @@ "", "", "", + "", "" ] }, @@ -1331,7 +1364,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -1378,6 +1411,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -1407,6 +1441,7 @@ "", "", "", + "", "" ] }, @@ -1418,7 +1453,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -1438,7 +1473,7 @@ "Firewall": { "id": "Firewall", "type": "object", - "description": "A Firewall resource.", + "description": "Represents a Firewall resource.", "properties": { "allowed": { "type": "array", @@ -1448,7 +1483,7 @@ "properties": { "IPProtocol": { "type": "string", - "description": "The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number." + "description": "The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number." }, "ports": { "type": "array", @@ -1523,7 +1558,7 @@ "FirewallList": { "id": "FirewallList", "type": "object", - "description": "Contains a list of Firewall resources.", + "description": "Contains a list of firewalls.", "properties": { "id": { "type": "string", @@ -1637,7 +1672,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.", "default": "compute#forwardingRuleAggregatedList" }, "nextPageToken": { @@ -1700,6 +1735,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -1729,6 +1765,7 @@ "", "", "", + "", "" ] }, @@ -1740,7 +1777,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -1760,6 +1797,7 @@ "HealthCheckReference": { "id": "HealthCheckReference", "type": "object", + "description": "A full or valid partial URL to a health check. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check \n- projects/project-id/global/httpHealthChecks/health-check \n- global/httpHealthChecks/health-check", "properties": { "healthCheck": { "type": "string" @@ -1853,7 +1891,7 @@ }, "kind": { "type": "string", - "description": "Type of the resource.", + "description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", "default": "compute#httpHealthCheck" }, "name": { @@ -1868,7 +1906,7 @@ }, "requestPath": { "type": "string", - "description": "The request path of the HTTP health check request. The default value is \"/\"." + "description": "The request path of the HTTP health check request. The default value is /." }, "selfLink": { "type": "string", @@ -2042,6 +2080,10 @@ "description": "Size of the image when restored onto a persistent disk (in GB).", "format": "int64" }, + "family": { + "type": "string", + "description": "Image family for the resource; provided by the client when the resource is created." + }, "id": { "type": "string", "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", @@ -2056,6 +2098,18 @@ "description": "[Output Only] Type of the resource. Always compute#image for images.", "default": "compute#image" }, + "labelFingerprint": { + "type": "string", + "description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make get() request to retrieve the image.", + "format": "byte" + }, + "labels": { + "type": "object", + "description": "Labels to apply to this image. These can be later modified by the setLabels method. Each label key & value must comply with RFC1035. Label values may be empty.", + "additionalProperties": { + "type": "string" + } + }, "licenses": { "type": "array", "description": "Any applicable publicly visible licenses.", @@ -2149,7 +2203,7 @@ "ImageList": { "id": "ImageList", "type": "object", - "description": "Contains a list of Image resources.", + "description": "Contains a list of images.", "properties": { "id": { "type": "string", @@ -2229,7 +2283,7 @@ }, "machineType": { "type": "string", - "description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/ machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:\n\nzones/us-central1-f/machineTypes/n1-standard-1 \n\nTo create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY \n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120 \n\nFor a full list of restrictions, read the Specifications for custom machine types.", + "description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:\n\nzones/us-central1-f/machineTypes/n1-standard-1 \n\nTo create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY \n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120 \n\nFor a full list of restrictions, read the Specifications for custom machine types.", "annotations": { "required": [ "compute.instances.insert" @@ -2296,7 +2350,7 @@ }, "tags": { "$ref": "Tags", - "description": "A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035." + "description": "A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035." }, "zone": { "type": "string", @@ -2317,7 +2371,7 @@ "description": "[Output Only] A map of scoped instance lists.", "additionalProperties": { "$ref": "InstancesScopedList", - "description": "Name of the scope containing this set of instances." + "description": "[Output Only] Name of the scope containing this set of instances." } }, "kind": { @@ -2381,7 +2435,7 @@ }, "network": { "type": "string", - "description": "[Output Only] The URL of the network to which all instances in the instance group belong." + "description": "The URL of the network to which all instances in the instance group belong." }, "selfLink": { "type": "string", @@ -2394,7 +2448,7 @@ }, "subnetwork": { "type": "string", - "description": "[Output Only] The URL of the subnetwork to which all instances in the instance group belong." + "description": "The URL of the subnetwork to which all instances in the instance group belong." }, "zone": { "type": "string", @@ -2467,7 +2521,6 @@ "InstanceGroupManager": { "id": "InstanceGroupManager", "type": "object", - "description": "InstanceGroupManagers\n\nNext available tag: 20", "properties": { "autoHealingPolicies": { "type": "array", @@ -2759,6 +2812,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -2788,6 +2842,7 @@ "", "", "", + "", "" ] }, @@ -2799,7 +2854,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -2949,6 +3004,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -2978,6 +3034,7 @@ "", "", "", + "", "" ] }, @@ -2989,7 +3046,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -3027,7 +3084,7 @@ "InstanceList": { "id": "InstanceList", "type": "object", - "description": "Contains a list of instance resources.", + "description": "Contains a list of instances.", "properties": { "id": { "type": "string", @@ -3035,7 +3092,7 @@ }, "items": { "type": "array", - "description": "[Output Only] A list of Instance resources.", + "description": "[Output Only] A list of instances.", "items": { "$ref": "Instance" } @@ -3256,6 +3313,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -3285,6 +3343,7 @@ "", "", "", + "", "" ] }, @@ -3296,7 +3355,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -3467,7 +3526,7 @@ "MachineTypeList": { "id": "MachineTypeList", "type": "object", - "description": "Contains a list of Machine Type resources.", + "description": "Contains a list of machine types.", "properties": { "id": { "type": "string", @@ -3514,6 +3573,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -3543,6 +3603,7 @@ "", "", "", + "", "" ] }, @@ -3554,7 +3615,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -3656,7 +3717,7 @@ }, "location": { "type": "string", - "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional." + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional." }, "message": { "type": "string", @@ -3735,7 +3796,7 @@ "Network": { "id": "Network", "type": "object", - "description": "A network resource.", + "description": "Represents a Network resource. Read Networks and Firewalls for more information.", "properties": { "IPv4Range": { "type": "string", @@ -3830,7 +3891,7 @@ "NetworkList": { "id": "NetworkList", "type": "object", - "description": "Contains a list of Network resources.", + "description": "Contains a list of networks.", "properties": { "id": { "type": "string", @@ -3865,7 +3926,7 @@ "properties": { "clientOperationId": { "type": "string", - "description": "[Output Only] A unique client ID generated by the server." + "description": "[Output Only] Reserved for future use." }, "creationTimestamp": { "type": "string", @@ -3895,7 +3956,7 @@ }, "location": { "type": "string", - "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional." + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional." }, "message": { "type": "string", @@ -3926,7 +3987,7 @@ }, "kind": { "type": "string", - "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.", + "description": "[Output Only] Type of the resource. Always compute#operation for operation resources.", "default": "compute#operation" }, "name": { @@ -3935,7 +3996,7 @@ }, "operationType": { "type": "string", - "description": "[Output Only] The type of operation, which can be insert, update, or delete." + "description": "[Output Only] The type of operation, such as insert, update, or delete, and so on." }, "progress": { "type": "integer", @@ -3944,7 +4005,7 @@ }, "region": { "type": "string", - "description": "[Output Only] 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." }, "selfLink": { "type": "string", @@ -3979,7 +4040,7 @@ }, "targetLink": { "type": "string", - "description": "[Output Only] The URL of the resource that the operation is modifying." + "description": "[Output Only] The URL of the resource that the operation modifies." }, "user": { "type": "string", @@ -3995,6 +4056,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -4024,6 +4086,7 @@ "", "", "", + "", "" ] }, @@ -4035,7 +4098,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -4053,7 +4116,7 @@ }, "zone": { "type": "string", - "description": "[Output Only] 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." } } }, @@ -4099,7 +4162,7 @@ }, "items": { "type": "array", - "description": "[Output Only] The Operation resources.", + "description": "[Output Only] A list of Operation resources.", "items": { "$ref": "Operation" } @@ -4138,6 +4201,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -4167,6 +4231,7 @@ "", "", "", + "", "" ] }, @@ -4178,7 +4243,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -4242,7 +4307,7 @@ "Project": { "id": "Project", "type": "object", - "description": "A Project resource. Projects can only be created in the Google Developers Console. Unless marked otherwise, values can only be modified in the console.", + "description": "A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.", "properties": { "commonInstanceMetadata": { "$ref": "Metadata", @@ -4323,6 +4388,7 @@ "IN_USE_ADDRESSES", "LOCAL_SSD_TOTAL_GB", "NETWORKS", + "ROUTERS", "ROUTES", "SNAPSHOTS", "SSD_TOTAL_GB", @@ -4365,6 +4431,7 @@ "", "", "", + "", "" ] }, @@ -4482,7 +4549,7 @@ "Route": { "id": "Route", "type": "object", - "description": "The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tags and the set of Routes for a particular instance is called its routing table. For each packet leaving a instance, the system searches that instance's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning Route -- either to another instance destination, a instance gateway or a Google Compute Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.", + "description": "Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.\n\nFor each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.\n\nPackets that do not match any route in the sending instance's routing table are dropped.", "properties": { "creationTimestamp": { "type": "string", @@ -4513,7 +4580,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -4586,6 +4653,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -4615,6 +4683,7 @@ "", "", "", + "", "" ] }, @@ -4626,7 +4695,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -4647,7 +4716,7 @@ "RouteList": { "id": "RouteList", "type": "object", - "description": "Contains a list of route resources.", + "description": "Contains a list of Route resources.", "properties": { "id": { "type": "string", @@ -4675,6 +4744,376 @@ } } }, + "Router": { + "id": "Router", + "type": "object", + "description": "Router resource.", + "properties": { + "bgp": { + "$ref": "RouterBgp" + }, + "bgpPeers": { + "type": "array", + "items": { + "$ref": "RouterBgpPeer" + } + }, + "creationTimestamp": { + "type": "string", + "description": "[Output Only] Creation timestamp in RFC3339 text format." + }, + "description": { + "type": "string", + "description": "An optional description of this resource. Provide this property when you create the resource." + }, + "id": { + "type": "string", + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64" + }, + "interfaces": { + "type": "array", + "items": { + "$ref": "RouterInterface" + } + }, + "kind": { + "type": "string", + "description": "[Output Only] Type of resource. Always compute#router for routers.", + "default": "compute#router" + }, + "name": { + "type": "string", + "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.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "annotations": { + "required": [ + "compute.routers.insert" + ] + } + }, + "network": { + "type": "string", + "description": "URI of the network to which this router belongs.", + "annotations": { + "required": [ + "compute.routers.insert" + ] + } + }, + "region": { + "type": "string", + "description": "[Output Only] URI of the region where the router resides." + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for the resource." + } + } + }, + "RouterAggregatedList": { + "id": "RouterAggregatedList", + "type": "object", + "description": "Contains a list of routers.", + "properties": { + "id": { + "type": "string", + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." + }, + "items": { + "type": "object", + "description": "A map of scoped router lists.", + "additionalProperties": { + "$ref": "RoutersScopedList", + "description": "Name of the scope containing this set of routers." + } + }, + "kind": { + "type": "string", + "description": "Type of resource.", + "default": "compute#routerAggregatedList" + }, + "nextPageToken": { + "type": "string", + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results." + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." + } + } + }, + "RouterBgp": { + "id": "RouterBgp", + "type": "object", + "properties": { + "asn": { + "type": "integer", + "description": "Local BGP Autonomous System Number (ASN). Can be a constant public ASN value for Google, or a customer-specified private ASN. In either case, the value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.", + "format": "uint32" + } + } + }, + "RouterBgpPeer": { + "id": "RouterBgpPeer", + "type": "object", + "description": "BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Reference: https://tools.ietf.org/html/rfc4273", + "properties": { + "advertisedRoutePriority": { + "type": "integer", + "description": "The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.", + "format": "uint32" + }, + "interfaceName": { + "type": "string", + "description": "Name of the interface the BGP peer is associated with." + }, + "ipAddress": { + "type": "string", + "description": "IP address of the interface inside Google Cloud Platform." + }, + "name": { + "type": "string", + "description": "Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + }, + "peerAsn": { + "type": "integer", + "description": "Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.", + "format": "uint32" + }, + "peerIpAddress": { + "type": "string", + "description": "IP address of the BGP interface outside Google cloud." + } + } + }, + "RouterInterface": { + "id": "RouterInterface", + "type": "object", + "description": "Router interfaces. Each interface requires either one linked resource (e.g. linked_vpn_tunnel) or IP address + range (specified in ip_range).", + "properties": { + "ipRange": { + "type": "string", + "description": "IP address and range of the interface. The value should be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do NOT truncate address, as it represents IP address of interface." + }, + "linkedVpnTunnel": { + "type": "string", + "description": "URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource." + }, + "name": { + "type": "string", + "description": "Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" + } + } + }, + "RouterList": { + "id": "RouterList", + "type": "object", + "description": "Contains a list of Router resources.", + "properties": { + "id": { + "type": "string", + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server." + }, + "items": { + "type": "array", + "description": "A list of Router resources.", + "items": { + "$ref": "Router" + } + }, + "kind": { + "type": "string", + "description": "[Output Only] Type of resource. Always compute#router for routers.", + "default": "compute#routerList" + }, + "nextPageToken": { + "type": "string", + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results." + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for the resource." + } + } + }, + "RouterStatus": { + "id": "RouterStatus", + "type": "object", + "properties": { + "bestRoutes": { + "type": "array", + "description": "Best routes for this router.", + "items": { + "$ref": "Route" + } + }, + "bgpPeerStatus": { + "type": "array", + "items": { + "$ref": "RouterStatusBgpPeerStatus" + } + }, + "network": { + "type": "string", + "description": "URI of the network to which this router belongs." + } + } + }, + "RouterStatusBgpPeerStatus": { + "id": "RouterStatusBgpPeerStatus", + "type": "object", + "properties": { + "advertisedRoutes": { + "type": "array", + "description": "Routes that were advertised to the remote BGP peer", + "items": { + "$ref": "Route" + } + }, + "ipAddress": { + "type": "string", + "description": "IP address of the local BGP interface." + }, + "linkedVpnTunnel": { + "type": "string", + "description": "URL of the VPN tunnel that this BGP peer controls." + }, + "name": { + "type": "string", + "description": "Name of this BGP peer. Unique within the routes resource." + }, + "numLearnedRoutes": { + "type": "integer", + "description": "Number of routes learned from the remote BGP Peer.", + "format": "uint32" + }, + "peerIpAddress": { + "type": "string", + "description": "IP address of the remote BGP interface." + }, + "state": { + "type": "string", + "description": "BGP state as specified in RFC1771." + }, + "status": { + "type": "string", + "description": "Status of the BGP peer: {UP, DOWN}", + "enum": [ + "DOWN", + "UNKNOWN", + "UP" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "uptime": { + "type": "string", + "description": "Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds" + }, + "uptimeSeconds": { + "type": "string", + "description": "Time this session has been up, in seconds. Format: 145" + } + } + }, + "RouterStatusResponse": { + "id": "RouterStatusResponse", + "type": "object", + "properties": { + "kind": { + "type": "string", + "description": "Type of resource.", + "default": "compute#routerStatusResponse" + }, + "result": { + "$ref": "RouterStatus" + } + } + }, + "RoutersScopedList": { + "id": "RoutersScopedList", + "type": "object", + "properties": { + "routers": { + "type": "array", + "description": "List of routers contained in this scope.", + "items": { + "$ref": "Router" + } + }, + "warning": { + "type": "object", + "description": "Informational warning which replaces the list of routers when the list is empty.", + "properties": { + "code": { + "type": "string", + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "INJECTED_KERNELS_DEPRECATED", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_NOT_DELETED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNREACHABLE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "data": { + "type": "array", + "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + }, + "value": { + "type": "string", + "description": "[Output Only] A warning data value corresponding to the key." + } + } + } + }, + "message": { + "type": "string", + "description": "[Output Only] A human-readable description of the warning code." + } + } + } + } + }, "Scheduling": { "id": "Scheduling", "type": "object", @@ -4686,7 +5125,7 @@ }, "onHostMaintenance": { "type": "string", - "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior.", + "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.", "enum": [ "MIGRATE", "TERMINATE" @@ -4716,9 +5155,19 @@ "description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.", "default": "compute#serialPortOutput" }, + "next": { + "type": "string", + "description": "[Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.", + "format": "int64" + }, "selfLink": { "type": "string", "description": "[Output Only] Server-defined URL for the resource." + }, + "start": { + "type": "string", + "description": "[Output Only] The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.", + "format": "int64" } } }, @@ -4768,9 +5217,21 @@ "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.", "default": "compute#snapshot" }, + "labelFingerprint": { + "type": "string", + "description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make get() request to the snapshot.", + "format": "byte" + }, + "labels": { + "type": "object", + "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key & value must comply with RFC1035. Label values may be empty.", + "additionalProperties": { + "type": "string" + } + }, "licenses": { "type": "array", - "description": "Public visible licenses.", + "description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).", "items": { "type": "string" } @@ -4802,7 +5263,7 @@ }, "status": { "type": "string", - "description": "[Output Only] The status of the snapshot.", + "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.", "enum": [ "CREATING", "DELETING", @@ -4825,7 +5286,7 @@ }, "storageBytesStatus": { "type": "string", - "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation.", + "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", "enum": [ "UPDATING", "UP_TO_DATE" @@ -5072,6 +5533,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -5101,6 +5563,7 @@ "", "", "", + "", "" ] }, @@ -5112,7 +5575,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -5173,7 +5636,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" }, "selfLink": { @@ -5204,7 +5667,7 @@ }, "kind": { "type": "string", - "description": "Type of resource. Always compute#targetHttpProxyList for lists of Target HTTP proxies.", + "description": "Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.", "default": "compute#targetHttpProxyList" }, "nextPageToken": { @@ -5223,7 +5686,7 @@ "properties": { "sslCertificates": { "type": "array", - "description": "New set of URLs to SslCertificate resources to associate with this TargetHttpProxy. Currently exactly one ssl certificate must be specified.", + "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.", "items": { "type": "string" } @@ -5250,7 +5713,7 @@ }, "kind": { "type": "string", - "description": "[Output Only] Type of the resource. Always compute#targetHttpsProxy for target HTTPS proxies.", + "description": "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.", "default": "compute#targetHttpsProxy" }, "name": { @@ -5264,14 +5727,14 @@ }, "sslCertificates": { "type": "array", - "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently exactly one SSL certificate must be specified.", + "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.", "items": { "type": "string" } }, "urlMap": { "type": "string", - "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService." + "description": "A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: \n- https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map \n- projects/project/global/urlMaps/url-map \n- global/urlMaps/url-map" } } }, @@ -5293,7 +5756,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.", "default": "compute#targetHttpsProxyList" }, "nextPageToken": { @@ -5326,7 +5789,7 @@ }, "instance": { "type": "string", - "description": "The URL to the instance that terminates the relevant traffic." + "description": "A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance \n- zones/zone/instances/instance" }, "kind": { "type": "string", @@ -5439,6 +5902,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -5468,6 +5932,7 @@ "", "", "", + "", "" ] }, @@ -5479,7 +5944,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -5499,7 +5964,7 @@ "TargetPool": { "id": "TargetPool", "type": "object", - "description": "A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.", + "description": "A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.", "properties": { "backupPool": { "type": "string", @@ -5532,7 +5997,7 @@ }, "instances": { "type": "array", - "description": "A list of resource URLs to the member virtual machines serving this pool. They must live in zones contained in the same region as this pool.", + "description": "A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.", "items": { "type": "string" } @@ -5581,7 +6046,7 @@ }, "items": { "type": "object", - "description": "A map of scoped target pool lists.", + "description": "[Output Only] A map of scoped target pool lists.", "additionalProperties": { "$ref": "TargetPoolsScopedList", "description": "Name of the scope containing this set of target pools." @@ -5589,7 +6054,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.", "default": "compute#targetPoolAggregatedList" }, "nextPageToken": { @@ -5614,7 +6079,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.", "default": "compute#targetPoolInstanceHealth" } } @@ -5637,7 +6102,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.", "default": "compute#targetPoolList" }, "nextPageToken": { @@ -5656,7 +6121,7 @@ "properties": { "healthChecks": { "type": "array", - "description": "Health check URLs to be added to targetPool.", + "description": "A list of HttpHealthCheck resources to add to the target pool.", "items": { "$ref": "HealthCheckReference" } @@ -5669,7 +6134,7 @@ "properties": { "instances": { "type": "array", - "description": "URLs of the instances to be added to targetPool.", + "description": "A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name \n- projects/project-id/zones/zone/instances/instance-name \n- zones/zone/instances/instance-name", "items": { "$ref": "InstanceReference" } @@ -5682,7 +6147,7 @@ "properties": { "healthChecks": { "type": "array", - "description": "Health check URLs to be removed from targetPool.", + "description": "Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check \n- projects/project/global/httpHealthChecks/health-check \n- global/httpHealthChecks/health-check", "items": { "$ref": "HealthCheckReference" } @@ -5695,7 +6160,7 @@ "properties": { "instances": { "type": "array", - "description": "URLs of the instances to be removed from targetPool.", + "description": "URLs of the instances to be removed from target pool.", "items": { "$ref": "InstanceReference" } @@ -5721,6 +6186,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -5750,6 +6216,7 @@ "", "", "", + "", "" ] }, @@ -5761,7 +6228,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -5790,6 +6257,7 @@ "TargetVpnGateway": { "id": "TargetVpnGateway", "type": "object", + "description": "Represents a Target VPN gateway resource.", "properties": { "creationTimestamp": { "type": "string", @@ -5818,7 +6286,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -5861,7 +6329,7 @@ }, "tunnels": { "type": "array", - "description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.", + "description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.", "items": { "type": "string" } @@ -5881,7 +6349,7 @@ "description": "A map of scoped target vpn gateway lists.", "additionalProperties": { "$ref": "TargetVpnGatewaysScopedList", - "description": "[Output Only] Name of the scope containing this set of target vpn gateways." + "description": "[Output Only] Name of the scope containing this set of target VPN gateways." } }, "kind": { @@ -5949,6 +6417,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -5978,6 +6447,7 @@ "", "", "", + "", "" ] }, @@ -5989,7 +6459,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -6252,7 +6722,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -6268,6 +6738,10 @@ "type": "string", "description": "[Output Only] URL of the region where the VPN tunnel resides." }, + "router": { + "type": "string", + "description": "URL of router resource to be used for dynamic routing." + }, "selfLink": { "type": "string", "description": "[Output Only] Server-defined URL for the resource." @@ -6284,6 +6758,7 @@ "type": "string", "description": "[Output Only] The status of the VPN tunnel.", "enum": [ + "ALLOCATING_RESOURCES", "AUTHORIZATION_ERROR", "DEPROVISIONING", "ESTABLISHED", @@ -6307,12 +6782,13 @@ "", "", "", + "", "" ] }, "targetVpnGateway": { "type": "string", - "description": "URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.", + "description": "URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.", "annotations": { "required": [ "compute.vpnTunnels.insert" @@ -6402,6 +6878,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -6431,6 +6908,7 @@ "", "", "", + "", "" ] }, @@ -6442,7 +6920,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -6580,12 +7058,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -6644,7 +7122,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6685,7 +7163,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6720,7 +7198,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6745,16 +7223,16 @@ "id": "compute.addresses.list", "path": "{project}/regions/{region}/addresses", "httpMethod": "GET", - "description": "Retrieves a list of address resources contained within the specified region.", + "description": "Retrieves a list of addresses contained within the specified region.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -6780,7 +7258,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6811,12 +7289,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -6857,11 +7335,11 @@ "id": "compute.autoscalers.delete", "path": "{project}/zones/{zone}/autoscalers/{autoscaler}", "httpMethod": "DELETE", - "description": "Deletes the specified autoscaler resource.", + "description": "Deletes the specified autoscaler.", "parameters": { "autoscaler": { "type": "string", - "description": "Name of the persistent autoscaler resource to delete.", + "description": "Name of the autoscaler to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6875,7 +7353,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6898,11 +7376,11 @@ "id": "compute.autoscalers.get", "path": "{project}/zones/{zone}/autoscalers/{autoscaler}", "httpMethod": "GET", - "description": "Returns the specified autoscaler resource.", + "description": "Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.", "parameters": { "autoscaler": { "type": "string", - "description": "Name of the persistent autoscaler resource to return.", + "description": "Name of the autoscaler to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6916,7 +7394,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6940,7 +7418,7 @@ "id": "compute.autoscalers.insert", "path": "{project}/zones/{zone}/autoscalers", "httpMethod": "POST", - "description": "Creates an autoscaler resource in the specified project using the data included in the request.", + "description": "Creates an autoscaler in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -6951,7 +7429,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6976,16 +7454,16 @@ "id": "compute.autoscalers.list", "path": "{project}/zones/{zone}/autoscalers", "httpMethod": "GET", - "description": "Retrieves a list of autoscaler resources contained within the specified zone.", + "description": "Retrieves a list of autoscalers contained within the specified zone.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7011,7 +7489,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7034,11 +7512,11 @@ "id": "compute.autoscalers.patch", "path": "{project}/zones/{zone}/autoscalers", "httpMethod": "PATCH", - "description": "Updates an autoscaler resource in the specified project using the data included in the request. This method supports patch semantics.", + "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.", "parameters": { "autoscaler": { "type": "string", - "description": "Name of the autoscaler resource to update.", + "description": "Name of the autoscaler to update.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "query" @@ -7052,7 +7530,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7078,11 +7556,11 @@ "id": "compute.autoscalers.update", "path": "{project}/zones/{zone}/autoscalers", "httpMethod": "PUT", - "description": "Updates an autoscaler resource in the specified project using the data included in the request.", + "description": "Updates an autoscaler in the specified project using the data included in the request.", "parameters": { "autoscaler": { "type": "string", - "description": "Name of the autoscaler resource to update.", + "description": "Name of the autoscaler to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "query" }, @@ -7095,7 +7573,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7157,7 +7635,7 @@ "id": "compute.backendServices.get", "path": "{project}/global/backendServices/{backendService}", "httpMethod": "GET", - "description": "Returns the specified BackendService resource.", + "description": "Returns the specified BackendService resource. Get a list of available backend services by making a list() request.", "parameters": { "backendService": { "type": "string", @@ -7259,12 +7737,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7381,16 +7859,16 @@ "id": "compute.diskTypes.aggregatedList", "path": "{project}/aggregated/diskTypes", "httpMethod": "GET", - "description": "Retrieves an aggregated list of disk type resources.", + "description": "Retrieves an aggregated list of disk types.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7431,11 +7909,11 @@ "id": "compute.diskTypes.get", "path": "{project}/zones/{zone}/diskTypes/{diskType}", "httpMethod": "GET", - "description": "Returns the specified disk type resource.", + "description": "Returns the specified disk type. Get a list of available disk types by making a list() request.", "parameters": { "diskType": { "type": "string", - "description": "Name of the disk type resource to return.", + "description": "Name of the disk type to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7473,16 +7951,16 @@ "id": "compute.diskTypes.list", "path": "{project}/zones/{zone}/diskTypes", "httpMethod": "GET", - "description": "Retrieves a list of disk type resources available to the specified project.", + "description": "Retrieves a list of disk types available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7539,12 +8017,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7670,7 +8148,7 @@ "id": "compute.disks.get", "path": "{project}/zones/{zone}/disks/{disk}", "httpMethod": "GET", - "description": "Returns a specified persistent disk.", + "description": "Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.", "parameters": { "disk": { "type": "string", @@ -7712,7 +8190,7 @@ "id": "compute.disks.insert", "path": "{project}/zones/{zone}/disks", "httpMethod": "POST", - "description": "Creates a persistent disk in the specified project using the data included in the request.", + "description": "Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 200 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.", "parameters": { "project": { "type": "string", @@ -7757,12 +8235,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7859,11 +8337,11 @@ "id": "compute.firewalls.delete", "path": "{project}/global/firewalls/{firewall}", "httpMethod": "DELETE", - "description": "Deletes the specified firewall resource.", + "description": "Deletes the specified firewall.", "parameters": { "firewall": { "type": "string", - "description": "Name of the firewall resource to delete.", + "description": "Name of the firewall rule to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7892,11 +8370,11 @@ "id": "compute.firewalls.get", "path": "{project}/global/firewalls/{firewall}", "httpMethod": "GET", - "description": "Returns the specified firewall resource.", + "description": "Returns the specified firewall.", "parameters": { "firewall": { "type": "string", - "description": "Name of the firewall resource to return.", + "description": "Name of the firewall rule to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7926,7 +8404,7 @@ "id": "compute.firewalls.insert", "path": "{project}/global/firewalls", "httpMethod": "POST", - "description": "Creates a firewall resource in the specified project using the data included in the request.", + "description": "Creates a firewall rule in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -7954,16 +8432,16 @@ "id": "compute.firewalls.list", "path": "{project}/global/firewalls", "httpMethod": "GET", - "description": "Retrieves the list of firewall resources available to the specified project.", + "description": "Retrieves the list of firewall rules available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8004,11 +8482,11 @@ "id": "compute.firewalls.patch", "path": "{project}/global/firewalls/{firewall}", "httpMethod": "PATCH", - "description": "Updates the specified firewall resource with the data included in the request. This method supports patch semantics.", + "description": "Updates the specified firewall rule with the data included in the request. This method supports patch semantics.", "parameters": { "firewall": { "type": "string", - "description": "Name of the firewall resource to update.", + "description": "Name of the firewall rule to update.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -8040,11 +8518,11 @@ "id": "compute.firewalls.update", "path": "{project}/global/firewalls/{firewall}", "httpMethod": "PUT", - "description": "Updates the specified firewall resource with the data included in the request.", + "description": "Updates the specified firewall rule with the data included in the request.", "parameters": { "firewall": { "type": "string", - "description": "Name of the firewall resource to update.", + "description": "Name of the firewall rule to update.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -8084,12 +8562,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8253,12 +8731,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8388,7 +8866,7 @@ "id": "compute.globalAddresses.get", "path": "{project}/global/addresses/{address}", "httpMethod": "GET", - "description": "Returns the specified address resource.", + "description": "Returns the specified address resource. Get a list of available addresses by making a list() request.", "parameters": { "address": { "type": "string", @@ -8450,16 +8928,16 @@ "id": "compute.globalAddresses.list", "path": "{project}/global/addresses", "httpMethod": "GET", - "description": "Retrieves a list of global address resources.", + "description": "Retrieves a list of global addresses.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8537,7 +9015,7 @@ "id": "compute.globalForwardingRules.get", "path": "{project}/global/forwardingRules/{forwardingRule}", "httpMethod": "GET", - "description": "Returns the specified ForwardingRule resource.", + "description": "Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.", "parameters": { "forwardingRule": { "type": "string", @@ -8603,12 +9081,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8693,12 +9171,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8769,7 +9247,7 @@ "id": "compute.globalOperations.get", "path": "{project}/global/operations/{operation}", "httpMethod": "GET", - "description": "Retrieves the specified Operations resource.", + "description": "Retrieves the specified Operations resource. Get a list of operations by making a list() request.", "parameters": { "operation": { "type": "string", @@ -8807,12 +9285,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8890,7 +9368,7 @@ "id": "compute.httpHealthChecks.get", "path": "{project}/global/httpHealthChecks/{httpHealthCheck}", "httpMethod": "GET", - "description": "Returns the specified HttpHealthCheck resource.", + "description": "Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.", "parameters": { "httpHealthCheck": { "type": "string", @@ -8956,12 +9434,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9111,7 +9589,7 @@ "id": "compute.httpsHealthChecks.get", "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}", "httpMethod": "GET", - "description": "Returns the specified HttpsHealthCheck resource.", + "description": "Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.", "parameters": { "httpsHealthCheck": { "type": "string", @@ -9177,12 +9655,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9299,7 +9777,7 @@ "id": "compute.images.delete", "path": "{project}/global/images/{image}", "httpMethod": "DELETE", - "description": "Deletes the specified image resource.", + "description": "Deletes the specified image.", "parameters": { "image": { "type": "string", @@ -9368,7 +9846,7 @@ "id": "compute.images.get", "path": "{project}/global/images/{image}", "httpMethod": "GET", - "description": "Returns the specified image resource.", + "description": "Returns the specified image. Get a list of available images by making a list() request.", "parameters": { "image": { "type": "string", @@ -9398,11 +9876,45 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getFromFamily": { + "id": "compute.images.getFromFamily", + "path": "{project}/global/images/family/{family}", + "httpMethod": "GET", + "description": "Returns the latest undeprecated image for an image family.", + "parameters": { + "family": { + "type": "string", + "description": "Name of the image resource to return.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + }, + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "family" + ], + "response": { + "$ref": "Image" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "insert": { "id": "compute.images.insert", "path": "{project}/global/images", "httpMethod": "POST", - "description": "Creates an image resource in the specified project using the data included in the request.", + "description": "Creates an image in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -9437,12 +9949,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9533,12 +10045,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9660,7 +10172,7 @@ "id": "compute.instanceGroupManagers.get", "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "httpMethod": "GET", - "description": "Returns all of the details about the specified managed instance group.", + "description": "Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.", "parameters": { "instanceGroupManager": { "type": "string", @@ -9739,12 +10251,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9938,7 +10450,7 @@ }, "zone": { "type": "string", - "description": "The URL of the zone where the managed instance group is located.", + "description": "The name of the zone where the managed instance group is located.", "required": true, "location": "path" } @@ -10051,7 +10563,7 @@ "id": "compute.instanceGroups.addInstances", "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances", "httpMethod": "POST", - "description": "Adds a list of instances to the specified instance group. Read Adding instances for more information.", + "description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.", "parameters": { "instanceGroup": { "type": "string", @@ -10097,12 +10609,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -10182,7 +10694,7 @@ "id": "compute.instanceGroups.get", "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}", "httpMethod": "GET", - "description": "Returns the specified instance group resource.", + "description": "Returns the specified instance group. Get a list of available instance groups by making a list() request.", "parameters": { "instanceGroup": { "type": "string", @@ -10261,12 +10773,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -10318,7 +10830,7 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "instanceGroup": { @@ -10329,7 +10841,7 @@ }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -10469,7 +10981,7 @@ "id": "compute.instanceTemplates.delete", "path": "{project}/global/instanceTemplates/{instanceTemplate}", "httpMethod": "DELETE", - "description": "Deletes the specified instance template.", + "description": "Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.", "parameters": { "instanceTemplate": { "type": "string", @@ -10502,7 +11014,7 @@ "id": "compute.instanceTemplates.get", "path": "{project}/global/instanceTemplates/{instanceTemplate}", "httpMethod": "GET", - "description": "Returns the specified instance template resource.", + "description": "Returns the specified instance template. Get a list of available instance templates by making a list() request.", "parameters": { "instanceTemplate": { "type": "string", @@ -10568,12 +11080,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -10669,16 +11181,16 @@ "id": "compute.instances.aggregatedList", "path": "{project}/aggregated/instances", "httpMethod": "GET", - "description": "Retrieves aggregated list of instance resources.", + "description": "Retrieves aggregated list of instances.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -10723,7 +11235,7 @@ "parameters": { "instance": { "type": "string", - "description": "Instance name.", + "description": "The instance name for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -10908,7 +11420,7 @@ "id": "compute.instances.get", "path": "{project}/zones/{zone}/instances/{instance}", "httpMethod": "GET", - "description": "Returns the specified instance resource.", + "description": "Returns the specified Instance resource. Get a list of available instances by making a list() request.", "parameters": { "instance": { "type": "string", @@ -10975,6 +11487,12 @@ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" }, + "start": { + "type": "string", + "description": "For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value that was returned in the previous call.", + "format": "int64", + "location": "query" + }, "zone": { "type": "string", "description": "The name of the zone for this request.", @@ -11037,16 +11555,16 @@ "id": "compute.instances.list", "path": "{project}/zones/{zone}/instances", "httpMethod": "GET", - "description": "Retrieves the list of instance resources contained within the specified zone.", + "description": "Retrieves the list of instances contained within the specified zone.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11498,11 +12016,11 @@ "id": "compute.licenses.get", "path": "{project}/global/licenses/{license}", "httpMethod": "GET", - "description": "Returns the specified license resource.", + "description": "Returns the specified License resource. Get a list of available licenses by making a list() request.", "parameters": { "license": { "type": "string", - "description": "Name of the license resource to return.", + "description": "Name of the License resource to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11536,16 +12054,16 @@ "id": "compute.machineTypes.aggregatedList", "path": "{project}/aggregated/machineTypes", "httpMethod": "GET", - "description": "Retrieves an aggregated list of machine type resources.", + "description": "Retrieves an aggregated list of machine types.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11586,11 +12104,11 @@ "id": "compute.machineTypes.get", "path": "{project}/zones/{zone}/machineTypes/{machineType}", "httpMethod": "GET", - "description": "Returns the specified machine type resource.", + "description": "Returns the specified machine type. Get a list of available machine types by making a list() request.", "parameters": { "machineType": { "type": "string", - "description": "Name of the machine type resource to return.", + "description": "Name of the machine type to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11628,16 +12146,16 @@ "id": "compute.machineTypes.list", "path": "{project}/zones/{zone}/machineTypes", "httpMethod": "GET", - "description": "Retrieves a list of machine type resources available to the specified project.", + "description": "Retrieves a list of machine types available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11690,11 +12208,11 @@ "id": "compute.networks.delete", "path": "{project}/global/networks/{network}", "httpMethod": "DELETE", - "description": "Deletes the specified network resource.", + "description": "Deletes the specified network.", "parameters": { "network": { "type": "string", - "description": "Name of the network resource to delete.", + "description": "Name of the network to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11723,11 +12241,11 @@ "id": "compute.networks.get", "path": "{project}/global/networks/{network}", "httpMethod": "GET", - "description": "Returns the specified network resource.", + "description": "Returns the specified network. Get a list of available networks by making a list() request.", "parameters": { "network": { "type": "string", - "description": "Name of the network resource to return.", + "description": "Name of the network to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11757,7 +12275,7 @@ "id": "compute.networks.insert", "path": "{project}/global/networks", "httpMethod": "POST", - "description": "Creates a network resource in the specified project using the data included in the request.", + "description": "Creates a network in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -11785,16 +12303,16 @@ "id": "compute.networks.list", "path": "{project}/global/networks", "httpMethod": "GET", - "description": "Retrieves the list of network resources available to the specified project.", + "description": "Retrieves the list of networks available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11839,7 +12357,7 @@ "id": "compute.projects.get", "path": "{project}", "httpMethod": "GET", - "description": "Returns the specified project resource.", + "description": "Returns the specified Project resource.", "parameters": { "project": { "type": "string", @@ -11946,7 +12464,7 @@ }, "region": { "type": "string", - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11984,7 +12502,7 @@ }, "region": { "type": "string", - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -12012,12 +12530,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12043,7 +12561,7 @@ }, "region": { "type": "string", - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -12070,7 +12588,7 @@ "id": "compute.regions.get", "path": "{project}/regions/{region}", "httpMethod": "GET", - "description": "Returns the specified region resource.", + "description": "Returns the specified Region resource. Get a list of available regions by making a list() request.", "parameters": { "project": { "type": "string", @@ -12108,12 +12626,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12152,13 +12670,374 @@ } } }, + "routers": { + "methods": { + "aggregatedList": { + "id": "compute.routers.aggregatedList", + "path": "{project}/aggregated/routers", + "httpMethod": "GET", + "description": "Retrieves an aggregated list of routers.", + "parameters": { + "filter": { + "type": "string", + "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "default": "500", + "format": "uint32", + "minimum": "0", + "maximum": "500", + "location": "query" + }, + "orderBy": { + "type": "string", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.", + "location": "query" + }, + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + } + }, + "parameterOrder": [ + "project" + ], + "response": { + "$ref": "RouterAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "id": "compute.routers.delete", + "path": "{project}/regions/{region}/routers/{router}", + "httpMethod": "DELETE", + "description": "Deletes the specified Router resource.", + "parameters": { + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + }, + "router": { + "type": "string", + "description": "Name of the Router resource to delete.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region", + "router" + ], + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "id": "compute.routers.get", + "path": "{project}/regions/{region}/routers/{router}", + "httpMethod": "GET", + "description": "Returns the specified Router resource. Get a list of available routers by making a list() request.", + "parameters": { + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + }, + "router": { + "type": "string", + "description": "Name of the Router resource to return.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region", + "router" + ], + "response": { + "$ref": "Router" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getRouterStatus": { + "id": "compute.routers.getRouterStatus", + "path": "{project}/regions/{region}/routers/{router}/getRouterStatus", + "httpMethod": "GET", + "description": "Retrieves runtime information of the specified router.", + "parameters": { + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + }, + "router": { + "type": "string", + "description": "Name of the Router resource to query.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region", + "router" + ], + "response": { + "$ref": "RouterStatusResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "id": "compute.routers.insert", + "path": "{project}/regions/{region}/routers", + "httpMethod": "POST", + "description": "Creates a Router resource in the specified project and region using the data included in the request.", + "parameters": { + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region" + ], + "request": { + "$ref": "Router" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "id": "compute.routers.list", + "path": "{project}/regions/{region}/routers", + "httpMethod": "GET", + "description": "Retrieves a list of Router resources available to the specified project.", + "parameters": { + "filter": { + "type": "string", + "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "default": "500", + "format": "uint32", + "minimum": "0", + "maximum": "500", + "location": "query" + }, + "orderBy": { + "type": "string", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.", + "location": "query" + }, + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region" + ], + "response": { + "$ref": "RouterList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "id": "compute.routers.patch", + "path": "{project}/regions/{region}/routers/{router}", + "httpMethod": "PATCH", + "description": "Updates the entire content of the Router resource. This method supports patch semantics.", + "parameters": { + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + }, + "router": { + "type": "string", + "description": "Name of the Router resource to update.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region", + "router" + ], + "request": { + "$ref": "Router" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "update": { + "id": "compute.routers.update", + "path": "{project}/regions/{region}/routers/{router}", + "httpMethod": "PUT", + "description": "Updates the entire content of the Router resource.", + "parameters": { + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + }, + "router": { + "type": "string", + "description": "Name of the Router resource to update.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region", + "router" + ], + "request": { + "$ref": "Router" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "routes": { "methods": { "delete": { "id": "compute.routes.delete", "path": "{project}/global/routes/{route}", "httpMethod": "DELETE", - "description": "Deletes the specified route resource.", + "description": "Deletes the specified Route resource.", "parameters": { "project": { "type": "string", @@ -12169,7 +13048,7 @@ }, "route": { "type": "string", - "description": "Name of the route resource to delete.", + "description": "Name of the Route resource to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -12191,7 +13070,7 @@ "id": "compute.routes.get", "path": "{project}/global/routes/{route}", "httpMethod": "GET", - "description": "Returns the specified route resource.", + "description": "Returns the specified Route resource. Get a list of available routes by making a list() request.", "parameters": { "project": { "type": "string", @@ -12202,7 +13081,7 @@ }, "route": { "type": "string", - "description": "Name of the route resource to return.", + "description": "Name of the Route resource to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -12225,7 +13104,7 @@ "id": "compute.routes.insert", "path": "{project}/global/routes", "httpMethod": "POST", - "description": "Creates a route resource in the specified project using the data included in the request.", + "description": "Creates a Route resource in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -12253,16 +13132,16 @@ "id": "compute.routes.list", "path": "{project}/global/routes", "httpMethod": "GET", - "description": "Retrieves the list of route resources available to the specified project.", + "description": "Retrieves the list of Route resources available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12340,7 +13219,7 @@ "id": "compute.snapshots.get", "path": "{project}/global/snapshots/{snapshot}", "httpMethod": "GET", - "description": "Returns the specified Snapshot resource.", + "description": "Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.", "parameters": { "project": { "type": "string", @@ -12378,12 +13257,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12461,7 +13340,7 @@ "id": "compute.sslCertificates.get", "path": "{project}/global/sslCertificates/{sslCertificate}", "httpMethod": "GET", - "description": "Returns the specified SslCertificate resource.", + "description": "Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.", "parameters": { "project": { "type": "string", @@ -12527,12 +13406,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12581,12 +13460,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12668,7 +13547,7 @@ "id": "compute.subnetworks.get", "path": "{project}/regions/{region}/subnetworks/{subnetwork}", "httpMethod": "GET", - "description": "Returns the specified subnetwork.", + "description": "Returns the specified subnetwork. Get a list of available subnetworks by making a list() request.", "parameters": { "project": { "type": "string", @@ -12750,12 +13629,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12841,7 +13720,7 @@ "id": "compute.targetHttpProxies.get", "path": "{project}/global/targetHttpProxies/{targetHttpProxy}", "httpMethod": "GET", - "description": "Returns the specified TargetHttpProxy resource.", + "description": "Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.", "parameters": { "project": { "type": "string", @@ -12907,12 +13786,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12964,7 +13843,7 @@ }, "targetHttpProxy": { "type": "string", - "description": "Name of the TargetHttpProxy resource whose URL map is to be set.", + "description": "Name of the TargetHttpProxy to set a URL map for.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13026,7 +13905,7 @@ "id": "compute.targetHttpsProxies.get", "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "GET", - "description": "Returns the specified TargetHttpsProxy resource.", + "description": "Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.", "parameters": { "project": { "type": "string", @@ -13092,12 +13971,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13149,7 +14028,7 @@ }, "targetHttpsProxy": { "type": "string", - "description": "Name of the TargetHttpsProxy resource whose SSLCertificate is to be set.", + "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13218,12 +14097,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13305,7 +14184,7 @@ "id": "compute.targetInstances.get", "path": "{project}/zones/{zone}/targetInstances/{targetInstance}", "httpMethod": "GET", - "description": "Returns the specified TargetInstance resource.", + "description": "Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.", "parameters": { "project": { "type": "string", @@ -13387,12 +14266,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13445,10 +14324,11 @@ "id": "compute.targetPools.addHealthCheck", "path": "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", "httpMethod": "POST", - "description": "Adds health check URL to targetPool.", + "description": "Adds health check URLs to a target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" @@ -13462,7 +14342,7 @@ }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource to which health_check_url is to be added.", + "description": "Name of the target pool to add a health check to.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13488,10 +14368,11 @@ "id": "compute.targetPools.addInstance", "path": "{project}/regions/{region}/targetPools/{targetPool}/addInstance", "httpMethod": "POST", - "description": "Adds instance URL to targetPool.", + "description": "Adds an instance to a target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" @@ -13505,7 +14386,7 @@ }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource to which instance_url is to be added.", + "description": "Name of the TargetPool resource to add instances to.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13535,12 +14416,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13581,7 +14462,7 @@ "id": "compute.targetPools.delete", "path": "{project}/regions/{region}/targetPools/{targetPool}", "httpMethod": "DELETE", - "description": "Deletes the specified TargetPool resource.", + "description": "Deletes the specified target pool.", "parameters": { "project": { "type": "string", @@ -13622,7 +14503,7 @@ "id": "compute.targetPools.get", "path": "{project}/regions/{region}/targetPools/{targetPool}", "httpMethod": "GET", - "description": "Returns the specified TargetPool resource.", + "description": "Returns the specified target pool. Get a list of available target pools by making a list() request.", "parameters": { "project": { "type": "string", @@ -13664,10 +14545,11 @@ "id": "compute.targetPools.getHealth", "path": "{project}/regions/{region}/targetPools/{targetPool}/getHealth", "httpMethod": "POST", - "description": "Gets the most recent health check results for each IP for the given instance that is referenced by the given TargetPool.", + "description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" @@ -13708,7 +14590,7 @@ "id": "compute.targetPools.insert", "path": "{project}/regions/{region}/targetPools", "httpMethod": "POST", - "description": "Creates a TargetPool resource in the specified project and region using the data included in the request.", + "description": "Creates a target pool in the specified project and region using the data included in the request.", "parameters": { "project": { "type": "string", @@ -13744,16 +14626,16 @@ "id": "compute.targetPools.list", "path": "{project}/regions/{region}/targetPools", "httpMethod": "GET", - "description": "Retrieves a list of TargetPool resources available to the specified project and region.", + "description": "Retrieves a list of target pools available to the specified project and region.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13802,24 +14684,25 @@ "id": "compute.targetPools.removeHealthCheck", "path": "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", "httpMethod": "POST", - "description": "Removes health check URL from targetPool.", + "description": "Removes health check URL from a target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" }, "region": { "type": "string", - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource to which health_check_url is to be removed.", + "description": "Name of the target pool to remove health checks from.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13845,10 +14728,11 @@ "id": "compute.targetPools.removeInstance", "path": "{project}/regions/{region}/targetPools/{targetPool}/removeInstance", "httpMethod": "POST", - "description": "Removes instance URL from targetPool.", + "description": "Removes instance URL from a target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" @@ -13862,7 +14746,7 @@ }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource to which instance_url is to be removed.", + "description": "Name of the TargetPool resource to remove instances from.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13888,11 +14772,11 @@ "id": "compute.targetPools.setBackup", "path": "{project}/regions/{region}/targetPools/{targetPool}/setBackup", "httpMethod": "POST", - "description": "Changes backup pool configurations.", + "description": "Changes a backup target pool's configurations.", "parameters": { "failoverRatio": { "type": "number", - "description": "New failoverRatio value for the containing target pool.", + "description": "New failoverRatio value for the target pool.", "format": "float", "location": "query" }, @@ -13912,7 +14796,7 @@ }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource for which the backup is to be set.", + "description": "Name of the TargetPool resource to set a backup pool for.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13942,16 +14826,16 @@ "id": "compute.targetVpnGateways.aggregatedList", "path": "{project}/aggregated/targetVpnGateways", "httpMethod": "GET", - "description": "Retrieves an aggregated list of target VPN gateways .", + "description": "Retrieves an aggregated list of target VPN gateways.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13992,7 +14876,7 @@ "id": "compute.targetVpnGateways.delete", "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "httpMethod": "DELETE", - "description": "Deletes the specified TargetVpnGateway resource.", + "description": "Deletes the specified target VPN gateway.", "parameters": { "project": { "type": "string", @@ -14003,14 +14887,14 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" }, "targetVpnGateway": { "type": "string", - "description": "Name of the TargetVpnGateway resource to delete.", + "description": "Name of the target VPN gateway to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14033,7 +14917,7 @@ "id": "compute.targetVpnGateways.get", "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "httpMethod": "GET", - "description": "Returns the specified TargetVpnGateway resource.", + "description": "Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.", "parameters": { "project": { "type": "string", @@ -14044,14 +14928,14 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" }, "targetVpnGateway": { "type": "string", - "description": "Name of the TargetVpnGateway resource to return.", + "description": "Name of the target VPN gateway to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14075,7 +14959,7 @@ "id": "compute.targetVpnGateways.insert", "path": "{project}/regions/{region}/targetVpnGateways", "httpMethod": "POST", - "description": "Creates a TargetVpnGateway resource in the specified project and region using the data included in the request.", + "description": "Creates a target VPN gateway in the specified project and region using the data included in the request.", "parameters": { "project": { "type": "string", @@ -14086,7 +14970,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14111,16 +14995,16 @@ "id": "compute.targetVpnGateways.list", "path": "{project}/regions/{region}/targetVpnGateways", "httpMethod": "GET", - "description": "Retrieves a list of TargetVpnGateway resources available to the specified project and region.", + "description": "Retrieves a list of target VPN gateways available to the specified project and region.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -14146,7 +15030,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14206,7 +15090,7 @@ "id": "compute.urlMaps.get", "path": "{project}/global/urlMaps/{urlMap}", "httpMethod": "GET", - "description": "Returns the specified UrlMap resource.", + "description": "Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.", "parameters": { "project": { "type": "string", @@ -14264,6 +15148,42 @@ "https://www.googleapis.com/auth/compute" ] }, + "invalidateCache": { + "id": "compute.urlMaps.invalidateCache", + "path": "{project}/global/urlMaps/{urlMap}/invalidateCache", + "httpMethod": "POST", + "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.", + "parameters": { + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "urlMap": { + "type": "string", + "description": "Name of the UrlMap scoping this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "urlMap" + ], + "request": { + "$ref": "CacheInvalidationRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "list": { "id": "compute.urlMaps.list", "path": "{project}/global/urlMaps", @@ -14272,12 +15192,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -14434,12 +15354,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -14491,7 +15411,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14521,7 +15441,7 @@ "id": "compute.vpnTunnels.get", "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}", "httpMethod": "GET", - "description": "Returns the specified VpnTunnel resource.", + "description": "Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.", "parameters": { "project": { "type": "string", @@ -14532,7 +15452,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14574,7 +15494,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14603,12 +15523,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -14634,7 +15554,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14679,7 +15599,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14717,7 +15637,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14745,12 +15665,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -14776,7 +15696,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14803,7 +15723,7 @@ "id": "compute.zones.get", "path": "{project}/zones/{zone}", "httpMethod": "GET", - "description": "Returns the specified zone resource.", + "description": "Returns the specified Zone resource. Get a list of available zones by making a list() request.", "parameters": { "project": { "type": "string", @@ -14837,16 +15757,16 @@ "id": "compute.zones.list", "path": "{project}/zones", "httpMethod": "GET", - "description": "Retrieves the list of zone resources available to the specified project.", + "description": "Retrieves the list of Zone resources available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", diff --git a/etc/api/compute/v1/compute-api.json b/etc/api/compute/v1/compute-api.json index 8d5db80031..3553a72c23 100644 --- a/etc/api/compute/v1/compute-api.json +++ b/etc/api/compute/v1/compute-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/c55dTQvv4NWDkglZO3_PlmckRzg\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/20Z2B4pctNFb7ZLU4UgN3SvWELA\"", "discoveryVersion": "v1", "id": "compute:v1", "name": "compute", "version": "v1", - "revision": "20160120", + "revision": "20160224", "title": "Compute Engine API", "description": "API for the Google Compute Engine service.", "ownerDomain": "google.com", @@ -151,7 +151,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -222,7 +222,7 @@ "AddressList": { "id": "AddressList", "type": "object", - "description": "Contains a list of address resources.", + "description": "Contains a list of addresses.", "properties": { "id": { "type": "string", @@ -230,7 +230,7 @@ }, "items": { "type": "array", - "description": "[Output Only] A list of Address resources.", + "description": "[Output Only] A list of addresses.", "items": { "$ref": "Address" } @@ -269,6 +269,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -298,6 +299,7 @@ "", "", "", + "", "" ] }, @@ -309,7 +311,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -354,7 +356,7 @@ }, "interface": { "type": "string", - "description": "Specifies the disk interface to use for attaching this disk, either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.", + "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.", "enum": [ "NVME", "SCSI" @@ -438,10 +440,11 @@ "Autoscaler": { "id": "Autoscaler", "type": "object", + "description": "Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.", "properties": { "autoscalingPolicy": { "$ref": "AutoscalingPolicy", - "description": "Autoscaling configuration." + "description": "The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.\n\nIf none of these are specified, the default will be to autoscale based on cpuUtilization to 0.8 or 80%." }, "creationTimestamp": { "type": "string", @@ -458,7 +461,7 @@ }, "kind": { "type": "string", - "description": "Type of the resource.", + "description": "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.", "default": "compute#autoscaler" }, "name": { @@ -477,7 +480,7 @@ }, "target": { "type": "string", - "description": "URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler." + "description": "URL of the managed instance group that this autoscaler will scale." }, "zone": { "type": "string", @@ -498,12 +501,12 @@ "description": "A map of scoped autoscaler lists.", "additionalProperties": { "$ref": "AutoscalersScopedList", - "description": "Name of the scope containing this set of autoscalers." + "description": "[Output Only] Name of the scope containing this set of autoscalers." } }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.", "default": "compute#autoscalerAggregatedList" }, "nextPageToken": { @@ -519,7 +522,7 @@ "AutoscalerList": { "id": "AutoscalerList", "type": "object", - "description": "Contains a list of persistent autoscaler resources.", + "description": "Contains a list of Autoscaler resources.", "properties": { "id": { "type": "string", @@ -534,7 +537,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.", "default": "compute#autoscalerList" }, "nextPageToken": { @@ -553,19 +556,20 @@ "properties": { "autoscalers": { "type": "array", - "description": "List of autoscalers contained in this scope.", + "description": "[Output Only] List of autoscalers contained in this scope.", "items": { "$ref": "Autoscaler" } }, "warning": { "type": "object", - "description": "Informational warning which replaces the list of autoscalers when the list is empty.", + "description": "[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.", "properties": { "code": { "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -595,6 +599,7 @@ "", "", "", + "", "" ] }, @@ -606,7 +611,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -630,16 +635,16 @@ "properties": { "coolDownPeriodSec": { "type": "integer", - "description": "The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.", + "description": "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.", "format": "int32" }, "cpuUtilization": { "$ref": "AutoscalingPolicyCpuUtilization", - "description": "TODO(jbartosik): Add support for scaling based on muliple utilization metrics (take max recommendation). Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy." + "description": "Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group." }, "customMetricUtilizations": { "type": "array", - "description": "Configuration parameters of autoscaling based on custom metric.", + "description": "Configuration parameters of autoscaling based on a custom metric.", "items": { "$ref": "AutoscalingPolicyCustomMetricUtilization" } @@ -650,12 +655,12 @@ }, "maxNumReplicas": { "type": "integer", - "description": "The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend.", + "description": "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.", "format": "int32" }, "minNumReplicas": { "type": "integer", - "description": "The minimum number of replicas that the Autoscaler can scale down to. Can't be less than 0. If not provided Autoscaler will choose default value depending on maximal number of replicas.", + "description": "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.", "format": "int32" } } @@ -667,7 +672,7 @@ "properties": { "utilizationTarget": { "type": "number", - "description": "The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.", + "description": "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.8.\n\nIf the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.", "format": "double" } } @@ -679,16 +684,16 @@ "properties": { "metric": { "type": "string", - "description": "Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count." + "description": "The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.\n\nFor example, the following is a valid metric:\ncompute.googleapis.com/instance/network/received_bytes_count\n\n\nThe following is not a valid metric because it does not increase or decrease based on usage:\ncompute.googleapis.com/instance/cpu/reserved_cores" }, "utilizationTarget": { "type": "number", - "description": "Target value of the metric which Autoscaler should maintain. Must be a positive value.", + "description": "Target value of the metric which autoscaler should maintain. Must be a positive value.", "format": "double" }, "utilizationTargetType": { "type": "string", - "description": "Defines type in which utilization_target is expressed.", + "description": "Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.", "enum": [ "DELTA_PER_MINUTE", "DELTA_PER_SECOND", @@ -705,11 +710,11 @@ "AutoscalingPolicyLoadBalancingUtilization": { "id": "AutoscalingPolicyLoadBalancingUtilization", "type": "object", - "description": "Load balancing utilization policy.", + "description": "Configuration parameters of autoscaling based on load balancing.", "properties": { "utilizationTarget": { "type": "number", - "description": "Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.", + "description": "Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.", "format": "double" } } @@ -721,7 +726,7 @@ "properties": { "balancingMode": { "type": "string", - "description": "Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.", + "description": "Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.", "enum": [ "RATE", "UTILIZATION" @@ -746,12 +751,12 @@ }, "maxRate": { "type": "integer", - "description": "The max requests per second (RPS) of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.", + "description": "The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.", "format": "int32" }, "maxRatePerInstance": { "type": "number", - "description": "The max requests per second (RPS) that a single backed instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.", + "description": "The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.", "format": "float" }, "maxUtilization": { @@ -815,10 +820,11 @@ }, "portName": { "type": "string", - "description": "Name of backend port. The same name should appear in the resource views referenced by this service. Required." + "description": "Name of backend port. The same name should appear in the instance groups referenced by this service. Required." }, "protocol": { "type": "string", + "description": "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, HTTP2, TCP and SSL.", "enum": [ "HTTP", "HTTPS" @@ -834,7 +840,7 @@ }, "timeoutSec": { "type": "integer", - "description": "How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].", + "description": "How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.", "format": "int32" } } @@ -957,14 +963,14 @@ }, "licenses": { "type": "array", - "description": "Any applicable publicly visible licenses.", + "description": "[Output Only] Any applicable publicly visible licenses.", "items": { "type": "string" } }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -987,11 +993,11 @@ }, "sourceImage": { "type": "string", - "description": "The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.\n\nWhen creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:\n\nglobal/images/my-private-image \n\nOr you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD \n\nwhere vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases." + "description": "The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.\n\nWhen creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:\n\nglobal/images/my-private-image \n\nOr you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD \n\nwhere vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.\n\nYou can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example:\n\nglobal/images/family/my-private-family \n\nOr you can specify an image family from a publicly-available project. For example, to use the latest Debian 7 from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/family/debian-7" }, "sourceImageId": { "type": "string", - "description": "The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used." + "description": "[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used." }, "sourceSnapshot": { "type": "string", @@ -1019,11 +1025,11 @@ }, "type": { "type": "string", - "description": "URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created." + "description": "URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk." }, "users": { "type": "array", - "description": "Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance", + "description": "[Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance", "items": { "type": "string" } @@ -1102,7 +1108,7 @@ "properties": { "destinationZone": { "type": "string", - "description": "The URL of the destination zone to move the disk to. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone" + "description": "The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone" }, "targetDisk": { "type": "string", @@ -1113,7 +1119,7 @@ "DiskType": { "id": "DiskType", "type": "object", - "description": "A disk type resource.", + "description": "A DiskType resource.", "properties": { "creationTimestamp": { "type": "string", @@ -1195,7 +1201,7 @@ "DiskTypeList": { "id": "DiskTypeList", "type": "object", - "description": "Contains a list of disk type resources.", + "description": "Contains a list of disk types.", "properties": { "id": { "type": "string", @@ -1242,6 +1248,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -1271,6 +1278,7 @@ "", "", "", + "", "" ] }, @@ -1282,7 +1290,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -1318,6 +1326,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -1347,6 +1356,7 @@ "", "", "", + "", "" ] }, @@ -1358,7 +1368,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -1378,7 +1388,7 @@ "Firewall": { "id": "Firewall", "type": "object", - "description": "A Firewall resource.", + "description": "Represents a Firewall resource.", "properties": { "allowed": { "type": "array", @@ -1388,7 +1398,7 @@ "properties": { "IPProtocol": { "type": "string", - "description": "The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number." + "description": "The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number." }, "ports": { "type": "array", @@ -1463,7 +1473,7 @@ "FirewallList": { "id": "FirewallList", "type": "object", - "description": "Contains a list of Firewall resources.", + "description": "Contains a list of firewalls.", "properties": { "id": { "type": "string", @@ -1577,7 +1587,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.", "default": "compute#forwardingRuleAggregatedList" }, "nextPageToken": { @@ -1640,6 +1650,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -1669,6 +1680,7 @@ "", "", "", + "", "" ] }, @@ -1680,7 +1692,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -1700,6 +1712,7 @@ "HealthCheckReference": { "id": "HealthCheckReference", "type": "object", + "description": "A full or valid partial URL to a health check. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check \n- projects/project-id/global/httpHealthChecks/health-check \n- global/httpHealthChecks/health-check", "properties": { "healthCheck": { "type": "string" @@ -1793,7 +1806,7 @@ }, "kind": { "type": "string", - "description": "Type of the resource.", + "description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", "default": "compute#httpHealthCheck" }, "name": { @@ -1808,7 +1821,7 @@ }, "requestPath": { "type": "string", - "description": "The request path of the HTTP health check request. The default value is \"/\"." + "description": "The request path of the HTTP health check request. The default value is /." }, "selfLink": { "type": "string", @@ -2081,7 +2094,7 @@ "ImageList": { "id": "ImageList", "type": "object", - "description": "Contains a list of Image resources.", + "description": "Contains a list of images.", "properties": { "id": { "type": "string", @@ -2149,7 +2162,7 @@ }, "machineType": { "type": "string", - "description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/ machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:\n\nzones/us-central1-f/machineTypes/n1-standard-1 \n\nTo create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY \n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120 \n\nFor a full list of restrictions, read the Specifications for custom machine types.", + "description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:\n\nzones/us-central1-f/machineTypes/n1-standard-1 \n\nTo create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY \n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120 \n\nFor a full list of restrictions, read the Specifications for custom machine types.", "annotations": { "required": [ "compute.instances.insert" @@ -2216,7 +2229,7 @@ }, "tags": { "$ref": "Tags", - "description": "A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035." + "description": "A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035." }, "zone": { "type": "string", @@ -2237,7 +2250,7 @@ "description": "[Output Only] A map of scoped instance lists.", "additionalProperties": { "$ref": "InstancesScopedList", - "description": "Name of the scope containing this set of instances." + "description": "[Output Only] Name of the scope containing this set of instances." } }, "kind": { @@ -2301,7 +2314,7 @@ }, "network": { "type": "string", - "description": "[Output Only] The URL of the network to which all instances in the instance group belong." + "description": "The URL of the network to which all instances in the instance group belong." }, "selfLink": { "type": "string", @@ -2314,7 +2327,7 @@ }, "subnetwork": { "type": "string", - "description": "[Output Only] The URL of the subnetwork to which all instances in the instance group belong." + "description": "The URL of the subnetwork to which all instances in the instance group belong." }, "zone": { "type": "string", @@ -2387,7 +2400,6 @@ "InstanceGroupManager": { "id": "InstanceGroupManager", "type": "object", - "description": "InstanceGroupManagers\n\nNext available tag: 20", "properties": { "baseInstanceName": { "type": "string", @@ -2657,6 +2669,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -2686,6 +2699,7 @@ "", "", "", + "", "" ] }, @@ -2697,7 +2711,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -2835,6 +2849,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -2864,6 +2879,7 @@ "", "", "", + "", "" ] }, @@ -2875,7 +2891,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -2913,7 +2929,7 @@ "InstanceList": { "id": "InstanceList", "type": "object", - "description": "Contains a list of instance resources.", + "description": "Contains a list of instances.", "properties": { "id": { "type": "string", @@ -2921,7 +2937,7 @@ }, "items": { "type": "array", - "description": "[Output Only] A list of Instance resources.", + "description": "[Output Only] A list of instances.", "items": { "$ref": "Instance" } @@ -2947,7 +2963,7 @@ "properties": { "destinationZone": { "type": "string", - "description": "The URL of the destination zone to move the instance to. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone" + "description": "The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone" }, "targetInstance": { "type": "string", @@ -3156,6 +3172,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -3185,6 +3202,7 @@ "", "", "", + "", "" ] }, @@ -3196,7 +3214,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -3368,7 +3386,7 @@ "MachineTypeList": { "id": "MachineTypeList", "type": "object", - "description": "Contains a list of Machine Type resources.", + "description": "Contains a list of machine types.", "properties": { "id": { "type": "string", @@ -3415,6 +3433,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -3444,6 +3463,7 @@ "", "", "", + "", "" ] }, @@ -3455,7 +3475,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -3557,7 +3577,7 @@ }, "location": { "type": "string", - "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional." + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional." }, "message": { "type": "string", @@ -3636,7 +3656,7 @@ "Network": { "id": "Network", "type": "object", - "description": "A network resource.", + "description": "Represents a Network resource. Read Networks and Firewalls for more information.", "properties": { "IPv4Range": { "type": "string", @@ -3731,7 +3751,7 @@ "NetworkList": { "id": "NetworkList", "type": "object", - "description": "Contains a list of Network resources.", + "description": "Contains a list of networks.", "properties": { "id": { "type": "string", @@ -3766,7 +3786,7 @@ "properties": { "clientOperationId": { "type": "string", - "description": "[Output Only] A unique client ID generated by the server." + "description": "[Output Only] Reserved for future use." }, "creationTimestamp": { "type": "string", @@ -3796,7 +3816,7 @@ }, "location": { "type": "string", - "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional." + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional." }, "message": { "type": "string", @@ -3827,7 +3847,7 @@ }, "kind": { "type": "string", - "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.", + "description": "[Output Only] Type of the resource. Always compute#operation for operation resources.", "default": "compute#operation" }, "name": { @@ -3836,7 +3856,7 @@ }, "operationType": { "type": "string", - "description": "[Output Only] The type of operation, which can be insert, update, or delete." + "description": "[Output Only] The type of operation, such as insert, update, or delete, and so on." }, "progress": { "type": "integer", @@ -3845,7 +3865,7 @@ }, "region": { "type": "string", - "description": "[Output Only] 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." }, "selfLink": { "type": "string", @@ -3880,7 +3900,7 @@ }, "targetLink": { "type": "string", - "description": "[Output Only] The URL of the resource that the operation is modifying." + "description": "[Output Only] The URL of the resource that the operation modifies." }, "user": { "type": "string", @@ -3896,6 +3916,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -3925,6 +3946,7 @@ "", "", "", + "", "" ] }, @@ -3936,7 +3958,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -3954,7 +3976,7 @@ }, "zone": { "type": "string", - "description": "[Output Only] 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." } } }, @@ -4000,7 +4022,7 @@ }, "items": { "type": "array", - "description": "[Output Only] The Operation resources.", + "description": "[Output Only] A list of Operation resources.", "items": { "$ref": "Operation" } @@ -4039,6 +4061,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -4068,6 +4091,7 @@ "", "", "", + "", "" ] }, @@ -4079,7 +4103,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -4143,7 +4167,7 @@ "Project": { "id": "Project", "type": "object", - "description": "A Project resource. Projects can only be created in the Google Developers Console. Unless marked otherwise, values can only be modified in the console.", + "description": "A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.", "properties": { "commonInstanceMetadata": { "$ref": "Metadata", @@ -4383,7 +4407,7 @@ "Route": { "id": "Route", "type": "object", - "description": "The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tags and the set of Routes for a particular instance is called its routing table. For each packet leaving a instance, the system searches that instance's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning Route -- either to another instance destination, a instance gateway or a Google Compute Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.", + "description": "Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.\n\nFor each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.\n\nPackets that do not match any route in the sending instance's routing table are dropped.", "properties": { "creationTimestamp": { "type": "string", @@ -4414,7 +4438,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -4487,6 +4511,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -4516,6 +4541,7 @@ "", "", "", + "", "" ] }, @@ -4527,7 +4553,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -4548,7 +4574,7 @@ "RouteList": { "id": "RouteList", "type": "object", - "description": "Contains a list of route resources.", + "description": "Contains a list of Route resources.", "properties": { "id": { "type": "string", @@ -4587,7 +4613,7 @@ }, "onHostMaintenance": { "type": "string", - "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior.", + "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.", "enum": [ "MIGRATE", "TERMINATE" @@ -4671,7 +4697,7 @@ }, "licenses": { "type": "array", - "description": "Public visible licenses.", + "description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).", "items": { "type": "string" } @@ -4695,7 +4721,7 @@ }, "status": { "type": "string", - "description": "[Output Only] The status of the snapshot.", + "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.", "enum": [ "CREATING", "DELETING", @@ -4718,7 +4744,7 @@ }, "storageBytesStatus": { "type": "string", - "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation.", + "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", "enum": [ "UPDATING", "UP_TO_DATE" @@ -4965,6 +4991,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -4994,6 +5021,7 @@ "", "", "", + "", "" ] }, @@ -5005,7 +5033,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -5066,7 +5094,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?" }, "selfLink": { @@ -5097,7 +5125,7 @@ }, "kind": { "type": "string", - "description": "Type of resource. Always compute#targetHttpProxyList for lists of Target HTTP proxies.", + "description": "Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.", "default": "compute#targetHttpProxyList" }, "nextPageToken": { @@ -5116,7 +5144,7 @@ "properties": { "sslCertificates": { "type": "array", - "description": "New set of URLs to SslCertificate resources to associate with this TargetHttpProxy. Currently exactly one ssl certificate must be specified.", + "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.", "items": { "type": "string" } @@ -5143,7 +5171,7 @@ }, "kind": { "type": "string", - "description": "[Output Only] Type of the resource. Always compute#targetHttpsProxy for target HTTPS proxies.", + "description": "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.", "default": "compute#targetHttpsProxy" }, "name": { @@ -5157,14 +5185,14 @@ }, "sslCertificates": { "type": "array", - "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently exactly one SSL certificate must be specified.", + "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.", "items": { "type": "string" } }, "urlMap": { "type": "string", - "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService." + "description": "A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: \n- https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map \n- projects/project/global/urlMaps/url-map \n- global/urlMaps/url-map" } } }, @@ -5186,7 +5214,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.", "default": "compute#targetHttpsProxyList" }, "nextPageToken": { @@ -5219,7 +5247,7 @@ }, "instance": { "type": "string", - "description": "The URL to the instance that terminates the relevant traffic." + "description": "A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance \n- zones/zone/instances/instance" }, "kind": { "type": "string", @@ -5332,6 +5360,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -5361,6 +5390,7 @@ "", "", "", + "", "" ] }, @@ -5372,7 +5402,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -5392,7 +5422,7 @@ "TargetPool": { "id": "TargetPool", "type": "object", - "description": "A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.", + "description": "A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.", "properties": { "backupPool": { "type": "string", @@ -5425,7 +5455,7 @@ }, "instances": { "type": "array", - "description": "A list of resource URLs to the member virtual machines serving this pool. They must live in zones contained in the same region as this pool.", + "description": "A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.", "items": { "type": "string" } @@ -5474,7 +5504,7 @@ }, "items": { "type": "object", - "description": "A map of scoped target pool lists.", + "description": "[Output Only] A map of scoped target pool lists.", "additionalProperties": { "$ref": "TargetPoolsScopedList", "description": "Name of the scope containing this set of target pools." @@ -5482,7 +5512,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.", "default": "compute#targetPoolAggregatedList" }, "nextPageToken": { @@ -5507,7 +5537,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.", "default": "compute#targetPoolInstanceHealth" } } @@ -5530,7 +5560,7 @@ }, "kind": { "type": "string", - "description": "Type of resource.", + "description": "[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.", "default": "compute#targetPoolList" }, "nextPageToken": { @@ -5549,7 +5579,7 @@ "properties": { "healthChecks": { "type": "array", - "description": "Health check URLs to be added to targetPool.", + "description": "A list of HttpHealthCheck resources to add to the target pool.", "items": { "$ref": "HealthCheckReference" } @@ -5562,7 +5592,7 @@ "properties": { "instances": { "type": "array", - "description": "URLs of the instances to be added to targetPool.", + "description": "A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name \n- projects/project-id/zones/zone/instances/instance-name \n- zones/zone/instances/instance-name", "items": { "$ref": "InstanceReference" } @@ -5575,7 +5605,7 @@ "properties": { "healthChecks": { "type": "array", - "description": "Health check URLs to be removed from targetPool.", + "description": "Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check \n- projects/project/global/httpHealthChecks/health-check \n- global/httpHealthChecks/health-check", "items": { "$ref": "HealthCheckReference" } @@ -5588,7 +5618,7 @@ "properties": { "instances": { "type": "array", - "description": "URLs of the instances to be removed from targetPool.", + "description": "URLs of the instances to be removed from target pool.", "items": { "$ref": "InstanceReference" } @@ -5614,6 +5644,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -5643,6 +5674,7 @@ "", "", "", + "", "" ] }, @@ -5654,7 +5686,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -5683,6 +5715,7 @@ "TargetVpnGateway": { "id": "TargetVpnGateway", "type": "object", + "description": "Represents a Target VPN gateway resource.", "properties": { "creationTimestamp": { "type": "string", @@ -5711,7 +5744,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -5754,7 +5787,7 @@ }, "tunnels": { "type": "array", - "description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.", + "description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.", "items": { "type": "string" } @@ -5774,7 +5807,7 @@ "description": "A map of scoped target vpn gateway lists.", "additionalProperties": { "$ref": "TargetVpnGatewaysScopedList", - "description": "[Output Only] Name of the scope containing this set of target vpn gateways." + "description": "[Output Only] Name of the scope containing this set of target VPN gateways." } }, "kind": { @@ -5842,6 +5875,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -5871,6 +5905,7 @@ "", "", "", + "", "" ] }, @@ -5882,7 +5917,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -6145,7 +6180,7 @@ }, "name": { "type": "string", - "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.", + "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ @@ -6177,6 +6212,7 @@ "type": "string", "description": "[Output Only] The status of the VPN tunnel.", "enum": [ + "ALLOCATING_RESOURCES", "AUTHORIZATION_ERROR", "DEPROVISIONING", "ESTABLISHED", @@ -6200,12 +6236,13 @@ "", "", "", + "", "" ] }, "targetVpnGateway": { "type": "string", - "description": "URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.", + "description": "URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.", "annotations": { "required": [ "compute.vpnTunnels.insert" @@ -6295,6 +6332,7 @@ "type": "string", "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ + "CLEANUP_FAILED", "DEPRECATED_RESOURCE_USED", "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", "INJECTED_KERNELS_DEPRECATED", @@ -6324,6 +6362,7 @@ "", "", "", + "", "" ] }, @@ -6335,7 +6374,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -6473,12 +6512,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -6532,7 +6571,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6573,7 +6612,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6608,7 +6647,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6633,16 +6672,16 @@ "id": "compute.addresses.list", "path": "{project}/regions/{region}/addresses", "httpMethod": "GET", - "description": "Retrieves a list of address resources contained within the specified region.", + "description": "Retrieves a list of addresses contained within the specified region.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -6663,7 +6702,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6694,12 +6733,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -6735,11 +6774,11 @@ "id": "compute.autoscalers.delete", "path": "{project}/zones/{zone}/autoscalers/{autoscaler}", "httpMethod": "DELETE", - "description": "Deletes the specified autoscaler resource.", + "description": "Deletes the specified autoscaler.", "parameters": { "autoscaler": { "type": "string", - "description": "Name of the persistent autoscaler resource to delete.", + "description": "Name of the autoscaler to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6753,7 +6792,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6776,11 +6815,11 @@ "id": "compute.autoscalers.get", "path": "{project}/zones/{zone}/autoscalers/{autoscaler}", "httpMethod": "GET", - "description": "Returns the specified autoscaler resource.", + "description": "Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.", "parameters": { "autoscaler": { "type": "string", - "description": "Name of the persistent autoscaler resource to return.", + "description": "Name of the autoscaler to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6794,7 +6833,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6818,7 +6857,7 @@ "id": "compute.autoscalers.insert", "path": "{project}/zones/{zone}/autoscalers", "httpMethod": "POST", - "description": "Creates an autoscaler resource in the specified project using the data included in the request.", + "description": "Creates an autoscaler in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -6829,7 +6868,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6854,16 +6893,16 @@ "id": "compute.autoscalers.list", "path": "{project}/zones/{zone}/autoscalers", "httpMethod": "GET", - "description": "Retrieves a list of autoscaler resources contained within the specified zone.", + "description": "Retrieves a list of autoscalers contained within the specified zone.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -6884,7 +6923,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6907,11 +6946,11 @@ "id": "compute.autoscalers.patch", "path": "{project}/zones/{zone}/autoscalers", "httpMethod": "PATCH", - "description": "Updates an autoscaler resource in the specified project using the data included in the request. This method supports patch semantics.", + "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.", "parameters": { "autoscaler": { "type": "string", - "description": "Name of the autoscaler resource to update.", + "description": "Name of the autoscaler to update.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "query" @@ -6925,7 +6964,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -6951,11 +6990,11 @@ "id": "compute.autoscalers.update", "path": "{project}/zones/{zone}/autoscalers", "httpMethod": "PUT", - "description": "Updates an autoscaler resource in the specified project using the data included in the request.", + "description": "Updates an autoscaler in the specified project using the data included in the request.", "parameters": { "autoscaler": { "type": "string", - "description": "Name of the autoscaler resource to update.", + "description": "Name of the autoscaler to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "query" }, @@ -6968,7 +7007,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7030,7 +7069,7 @@ "id": "compute.backendServices.get", "path": "{project}/global/backendServices/{backendService}", "httpMethod": "GET", - "description": "Returns the specified BackendService resource.", + "description": "Returns the specified BackendService resource. Get a list of available backend services by making a list() request.", "parameters": { "backendService": { "type": "string", @@ -7132,12 +7171,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7249,16 +7288,16 @@ "id": "compute.diskTypes.aggregatedList", "path": "{project}/aggregated/diskTypes", "httpMethod": "GET", - "description": "Retrieves an aggregated list of disk type resources.", + "description": "Retrieves an aggregated list of disk types.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7294,11 +7333,11 @@ "id": "compute.diskTypes.get", "path": "{project}/zones/{zone}/diskTypes/{diskType}", "httpMethod": "GET", - "description": "Returns the specified disk type resource.", + "description": "Returns the specified disk type. Get a list of available disk types by making a list() request.", "parameters": { "diskType": { "type": "string", - "description": "Name of the disk type resource to return.", + "description": "Name of the disk type to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7336,16 +7375,16 @@ "id": "compute.diskTypes.list", "path": "{project}/zones/{zone}/diskTypes", "httpMethod": "GET", - "description": "Retrieves a list of disk type resources available to the specified project.", + "description": "Retrieves a list of disk types available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7397,12 +7436,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7523,7 +7562,7 @@ "id": "compute.disks.get", "path": "{project}/zones/{zone}/disks/{disk}", "httpMethod": "GET", - "description": "Returns a specified persistent disk.", + "description": "Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.", "parameters": { "disk": { "type": "string", @@ -7565,7 +7604,7 @@ "id": "compute.disks.insert", "path": "{project}/zones/{zone}/disks", "httpMethod": "POST", - "description": "Creates a persistent disk in the specified project using the data included in the request.", + "description": "Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 200 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.", "parameters": { "project": { "type": "string", @@ -7610,12 +7649,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7663,11 +7702,11 @@ "id": "compute.firewalls.delete", "path": "{project}/global/firewalls/{firewall}", "httpMethod": "DELETE", - "description": "Deletes the specified firewall resource.", + "description": "Deletes the specified firewall.", "parameters": { "firewall": { "type": "string", - "description": "Name of the firewall resource to delete.", + "description": "Name of the firewall rule to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7696,11 +7735,11 @@ "id": "compute.firewalls.get", "path": "{project}/global/firewalls/{firewall}", "httpMethod": "GET", - "description": "Returns the specified firewall resource.", + "description": "Returns the specified firewall.", "parameters": { "firewall": { "type": "string", - "description": "Name of the firewall resource to return.", + "description": "Name of the firewall rule to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7730,7 +7769,7 @@ "id": "compute.firewalls.insert", "path": "{project}/global/firewalls", "httpMethod": "POST", - "description": "Creates a firewall resource in the specified project using the data included in the request.", + "description": "Creates a firewall rule in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -7758,16 +7797,16 @@ "id": "compute.firewalls.list", "path": "{project}/global/firewalls", "httpMethod": "GET", - "description": "Retrieves the list of firewall resources available to the specified project.", + "description": "Retrieves the list of firewall rules available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -7803,11 +7842,11 @@ "id": "compute.firewalls.patch", "path": "{project}/global/firewalls/{firewall}", "httpMethod": "PATCH", - "description": "Updates the specified firewall resource with the data included in the request. This method supports patch semantics.", + "description": "Updates the specified firewall rule with the data included in the request. This method supports patch semantics.", "parameters": { "firewall": { "type": "string", - "description": "Name of the firewall resource to update.", + "description": "Name of the firewall rule to update.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7839,11 +7878,11 @@ "id": "compute.firewalls.update", "path": "{project}/global/firewalls/{firewall}", "httpMethod": "PUT", - "description": "Updates the specified firewall resource with the data included in the request.", + "description": "Updates the specified firewall rule with the data included in the request.", "parameters": { "firewall": { "type": "string", - "description": "Name of the firewall resource to update.", + "description": "Name of the firewall rule to update.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -7883,12 +7922,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8047,12 +8086,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8177,7 +8216,7 @@ "id": "compute.globalAddresses.get", "path": "{project}/global/addresses/{address}", "httpMethod": "GET", - "description": "Returns the specified address resource.", + "description": "Returns the specified address resource. Get a list of available addresses by making a list() request.", "parameters": { "address": { "type": "string", @@ -8239,16 +8278,16 @@ "id": "compute.globalAddresses.list", "path": "{project}/global/addresses", "httpMethod": "GET", - "description": "Retrieves a list of global address resources.", + "description": "Retrieves a list of global addresses.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8321,7 +8360,7 @@ "id": "compute.globalForwardingRules.get", "path": "{project}/global/forwardingRules/{forwardingRule}", "httpMethod": "GET", - "description": "Returns the specified ForwardingRule resource.", + "description": "Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.", "parameters": { "forwardingRule": { "type": "string", @@ -8387,12 +8426,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8472,12 +8511,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8543,7 +8582,7 @@ "id": "compute.globalOperations.get", "path": "{project}/global/operations/{operation}", "httpMethod": "GET", - "description": "Retrieves the specified Operations resource.", + "description": "Retrieves the specified Operations resource. Get a list of operations by making a list() request.", "parameters": { "operation": { "type": "string", @@ -8581,12 +8620,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8659,7 +8698,7 @@ "id": "compute.httpHealthChecks.get", "path": "{project}/global/httpHealthChecks/{httpHealthCheck}", "httpMethod": "GET", - "description": "Returns the specified HttpHealthCheck resource.", + "description": "Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.", "parameters": { "httpHealthCheck": { "type": "string", @@ -8725,12 +8764,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -8875,7 +8914,7 @@ "id": "compute.httpsHealthChecks.get", "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}", "httpMethod": "GET", - "description": "Returns the specified HttpsHealthCheck resource.", + "description": "Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.", "parameters": { "httpsHealthCheck": { "type": "string", @@ -8941,12 +8980,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9058,7 +9097,7 @@ "id": "compute.images.delete", "path": "{project}/global/images/{image}", "httpMethod": "DELETE", - "description": "Deletes the specified image resource.", + "description": "Deletes the specified image.", "parameters": { "image": { "type": "string", @@ -9127,7 +9166,7 @@ "id": "compute.images.get", "path": "{project}/global/images/{image}", "httpMethod": "GET", - "description": "Returns the specified image resource.", + "description": "Returns the specified image. Get a list of available images by making a list() request.", "parameters": { "image": { "type": "string", @@ -9161,7 +9200,7 @@ "id": "compute.images.insert", "path": "{project}/global/images", "httpMethod": "POST", - "description": "Creates an image resource in the specified project using the data included in the request.", + "description": "Creates an image in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -9196,12 +9235,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9287,12 +9326,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9409,7 +9448,7 @@ "id": "compute.instanceGroupManagers.get", "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "httpMethod": "GET", - "description": "Returns all of the details about the specified managed instance group.", + "description": "Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.", "parameters": { "instanceGroupManager": { "type": "string", @@ -9488,12 +9527,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9753,7 +9792,7 @@ "id": "compute.instanceGroups.addInstances", "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances", "httpMethod": "POST", - "description": "Adds a list of instances to the specified instance group. Read Adding instances for more information.", + "description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.", "parameters": { "instanceGroup": { "type": "string", @@ -9799,12 +9838,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -9879,7 +9918,7 @@ "id": "compute.instanceGroups.get", "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}", "httpMethod": "GET", - "description": "Returns the specified instance group resource.", + "description": "Returns the specified instance group. Get a list of available instance groups by making a list() request.", "parameters": { "instanceGroup": { "type": "string", @@ -9958,12 +9997,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -10010,7 +10049,7 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "instanceGroup": { @@ -10021,7 +10060,7 @@ }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -10156,7 +10195,7 @@ "id": "compute.instanceTemplates.delete", "path": "{project}/global/instanceTemplates/{instanceTemplate}", "httpMethod": "DELETE", - "description": "Deletes the specified instance template.", + "description": "Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.", "parameters": { "instanceTemplate": { "type": "string", @@ -10189,7 +10228,7 @@ "id": "compute.instanceTemplates.get", "path": "{project}/global/instanceTemplates/{instanceTemplate}", "httpMethod": "GET", - "description": "Returns the specified instance template resource.", + "description": "Returns the specified instance template. Get a list of available instance templates by making a list() request.", "parameters": { "instanceTemplate": { "type": "string", @@ -10255,12 +10294,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -10351,16 +10390,16 @@ "id": "compute.instances.aggregatedList", "path": "{project}/aggregated/instances", "httpMethod": "GET", - "description": "Retrieves aggregated list of instance resources.", + "description": "Retrieves aggregated list of instances.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -10400,7 +10439,7 @@ "parameters": { "instance": { "type": "string", - "description": "Instance name.", + "description": "The instance name for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -10585,7 +10624,7 @@ "id": "compute.instances.get", "path": "{project}/zones/{zone}/instances/{instance}", "httpMethod": "GET", - "description": "Returns the specified instance resource.", + "description": "Returns the specified Instance resource. Get a list of available instances by making a list() request.", "parameters": { "instance": { "type": "string", @@ -10714,16 +10753,16 @@ "id": "compute.instances.list", "path": "{project}/zones/{zone}/instances", "httpMethod": "GET", - "description": "Retrieves the list of instance resources contained within the specified zone.", + "description": "Retrieves the list of instances contained within the specified zone.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11126,11 +11165,11 @@ "id": "compute.licenses.get", "path": "{project}/global/licenses/{license}", "httpMethod": "GET", - "description": "Returns the specified license resource.", + "description": "Returns the specified License resource. Get a list of available licenses by making a list() request.", "parameters": { "license": { "type": "string", - "description": "Name of the license resource to return.", + "description": "Name of the License resource to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11164,16 +11203,16 @@ "id": "compute.machineTypes.aggregatedList", "path": "{project}/aggregated/machineTypes", "httpMethod": "GET", - "description": "Retrieves an aggregated list of machine type resources.", + "description": "Retrieves an aggregated list of machine types.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11209,11 +11248,11 @@ "id": "compute.machineTypes.get", "path": "{project}/zones/{zone}/machineTypes/{machineType}", "httpMethod": "GET", - "description": "Returns the specified machine type resource.", + "description": "Returns the specified machine type. Get a list of available machine types by making a list() request.", "parameters": { "machineType": { "type": "string", - "description": "Name of the machine type resource to return.", + "description": "Name of the machine type to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11251,16 +11290,16 @@ "id": "compute.machineTypes.list", "path": "{project}/zones/{zone}/machineTypes", "httpMethod": "GET", - "description": "Retrieves a list of machine type resources available to the specified project.", + "description": "Retrieves a list of machine types available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11308,11 +11347,11 @@ "id": "compute.networks.delete", "path": "{project}/global/networks/{network}", "httpMethod": "DELETE", - "description": "Deletes the specified network resource.", + "description": "Deletes the specified network.", "parameters": { "network": { "type": "string", - "description": "Name of the network resource to delete.", + "description": "Name of the network to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11341,11 +11380,11 @@ "id": "compute.networks.get", "path": "{project}/global/networks/{network}", "httpMethod": "GET", - "description": "Returns the specified network resource.", + "description": "Returns the specified network. Get a list of available networks by making a list() request.", "parameters": { "network": { "type": "string", - "description": "Name of the network resource to return.", + "description": "Name of the network to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11375,7 +11414,7 @@ "id": "compute.networks.insert", "path": "{project}/global/networks", "httpMethod": "POST", - "description": "Creates a network resource in the specified project using the data included in the request.", + "description": "Creates a network in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -11403,16 +11442,16 @@ "id": "compute.networks.list", "path": "{project}/global/networks", "httpMethod": "GET", - "description": "Retrieves the list of network resources available to the specified project.", + "description": "Retrieves the list of networks available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11452,7 +11491,7 @@ "id": "compute.projects.get", "path": "{project}", "httpMethod": "GET", - "description": "Returns the specified project resource.", + "description": "Returns the specified Project resource.", "parameters": { "project": { "type": "string", @@ -11615,7 +11654,7 @@ }, "region": { "type": "string", - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11653,7 +11692,7 @@ }, "region": { "type": "string", - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11681,12 +11720,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11707,7 +11746,7 @@ }, "region": { "type": "string", - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11734,7 +11773,7 @@ "id": "compute.regions.get", "path": "{project}/regions/{region}", "httpMethod": "GET", - "description": "Returns the specified region resource.", + "description": "Returns the specified Region resource. Get a list of available regions by making a list() request.", "parameters": { "project": { "type": "string", @@ -11772,12 +11811,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11817,7 +11856,7 @@ "id": "compute.routes.delete", "path": "{project}/global/routes/{route}", "httpMethod": "DELETE", - "description": "Deletes the specified route resource.", + "description": "Deletes the specified Route resource.", "parameters": { "project": { "type": "string", @@ -11828,7 +11867,7 @@ }, "route": { "type": "string", - "description": "Name of the route resource to delete.", + "description": "Name of the Route resource to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11850,7 +11889,7 @@ "id": "compute.routes.get", "path": "{project}/global/routes/{route}", "httpMethod": "GET", - "description": "Returns the specified route resource.", + "description": "Returns the specified Route resource. Get a list of available routes by making a list() request.", "parameters": { "project": { "type": "string", @@ -11861,7 +11900,7 @@ }, "route": { "type": "string", - "description": "Name of the route resource to return.", + "description": "Name of the Route resource to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -11884,7 +11923,7 @@ "id": "compute.routes.insert", "path": "{project}/global/routes", "httpMethod": "POST", - "description": "Creates a route resource in the specified project using the data included in the request.", + "description": "Creates a Route resource in the specified project using the data included in the request.", "parameters": { "project": { "type": "string", @@ -11912,16 +11951,16 @@ "id": "compute.routes.list", "path": "{project}/global/routes", "httpMethod": "GET", - "description": "Retrieves the list of route resources available to the specified project.", + "description": "Retrieves the list of Route resources available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -11994,7 +12033,7 @@ "id": "compute.snapshots.get", "path": "{project}/global/snapshots/{snapshot}", "httpMethod": "GET", - "description": "Returns the specified Snapshot resource.", + "description": "Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.", "parameters": { "project": { "type": "string", @@ -12032,12 +12071,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12110,7 +12149,7 @@ "id": "compute.sslCertificates.get", "path": "{project}/global/sslCertificates/{sslCertificate}", "httpMethod": "GET", - "description": "Returns the specified SslCertificate resource.", + "description": "Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.", "parameters": { "project": { "type": "string", @@ -12176,12 +12215,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12225,12 +12264,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12307,7 +12346,7 @@ "id": "compute.subnetworks.get", "path": "{project}/regions/{region}/subnetworks/{subnetwork}", "httpMethod": "GET", - "description": "Returns the specified subnetwork.", + "description": "Returns the specified subnetwork. Get a list of available subnetworks by making a list() request.", "parameters": { "project": { "type": "string", @@ -12389,12 +12428,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12475,7 +12514,7 @@ "id": "compute.targetHttpProxies.get", "path": "{project}/global/targetHttpProxies/{targetHttpProxy}", "httpMethod": "GET", - "description": "Returns the specified TargetHttpProxy resource.", + "description": "Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.", "parameters": { "project": { "type": "string", @@ -12541,12 +12580,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12593,7 +12632,7 @@ }, "targetHttpProxy": { "type": "string", - "description": "Name of the TargetHttpProxy resource whose URL map is to be set.", + "description": "Name of the TargetHttpProxy to set a URL map for.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -12655,7 +12694,7 @@ "id": "compute.targetHttpsProxies.get", "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "GET", - "description": "Returns the specified TargetHttpsProxy resource.", + "description": "Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.", "parameters": { "project": { "type": "string", @@ -12721,12 +12760,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12773,7 +12812,7 @@ }, "targetHttpsProxy": { "type": "string", - "description": "Name of the TargetHttpsProxy resource whose SSLCertificate is to be set.", + "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -12842,12 +12881,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -12924,7 +12963,7 @@ "id": "compute.targetInstances.get", "path": "{project}/zones/{zone}/targetInstances/{targetInstance}", "httpMethod": "GET", - "description": "Returns the specified TargetInstance resource.", + "description": "Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.", "parameters": { "project": { "type": "string", @@ -13006,12 +13045,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13059,10 +13098,11 @@ "id": "compute.targetPools.addHealthCheck", "path": "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", "httpMethod": "POST", - "description": "Adds health check URL to targetPool.", + "description": "Adds health check URLs to a target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" @@ -13076,7 +13116,7 @@ }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource to which health_check_url is to be added.", + "description": "Name of the target pool to add a health check to.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13102,10 +13142,11 @@ "id": "compute.targetPools.addInstance", "path": "{project}/regions/{region}/targetPools/{targetPool}/addInstance", "httpMethod": "POST", - "description": "Adds instance URL to targetPool.", + "description": "Adds an instance to a target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" @@ -13119,7 +13160,7 @@ }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource to which instance_url is to be added.", + "description": "Name of the TargetPool resource to add instances to.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13149,12 +13190,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13190,7 +13231,7 @@ "id": "compute.targetPools.delete", "path": "{project}/regions/{region}/targetPools/{targetPool}", "httpMethod": "DELETE", - "description": "Deletes the specified TargetPool resource.", + "description": "Deletes the specified target pool.", "parameters": { "project": { "type": "string", @@ -13231,7 +13272,7 @@ "id": "compute.targetPools.get", "path": "{project}/regions/{region}/targetPools/{targetPool}", "httpMethod": "GET", - "description": "Returns the specified TargetPool resource.", + "description": "Returns the specified target pool. Get a list of available target pools by making a list() request.", "parameters": { "project": { "type": "string", @@ -13273,10 +13314,11 @@ "id": "compute.targetPools.getHealth", "path": "{project}/regions/{region}/targetPools/{targetPool}/getHealth", "httpMethod": "POST", - "description": "Gets the most recent health check results for each IP for the given instance that is referenced by the given TargetPool.", + "description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" @@ -13317,7 +13359,7 @@ "id": "compute.targetPools.insert", "path": "{project}/regions/{region}/targetPools", "httpMethod": "POST", - "description": "Creates a TargetPool resource in the specified project and region using the data included in the request.", + "description": "Creates a target pool in the specified project and region using the data included in the request.", "parameters": { "project": { "type": "string", @@ -13353,16 +13395,16 @@ "id": "compute.targetPools.list", "path": "{project}/regions/{region}/targetPools", "httpMethod": "GET", - "description": "Retrieves a list of TargetPool resources available to the specified project and region.", + "description": "Retrieves a list of target pools available to the specified project and region.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13406,24 +13448,25 @@ "id": "compute.targetPools.removeHealthCheck", "path": "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", "httpMethod": "POST", - "description": "Removes health check URL from targetPool.", + "description": "Removes health check URL from a target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" }, "region": { "type": "string", - "description": "Name of the region scoping this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource to which health_check_url is to be removed.", + "description": "Name of the target pool to remove health checks from.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13449,10 +13492,11 @@ "id": "compute.targetPools.removeInstance", "path": "{project}/regions/{region}/targetPools/{targetPool}/removeInstance", "httpMethod": "POST", - "description": "Removes instance URL from targetPool.", + "description": "Removes instance URL from a target pool.", "parameters": { "project": { "type": "string", + "description": "Project ID for this request.", "required": true, "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path" @@ -13466,7 +13510,7 @@ }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource to which instance_url is to be removed.", + "description": "Name of the TargetPool resource to remove instances from.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13492,11 +13536,11 @@ "id": "compute.targetPools.setBackup", "path": "{project}/regions/{region}/targetPools/{targetPool}/setBackup", "httpMethod": "POST", - "description": "Changes backup pool configurations.", + "description": "Changes a backup target pool's configurations.", "parameters": { "failoverRatio": { "type": "number", - "description": "New failoverRatio value for the containing target pool.", + "description": "New failoverRatio value for the target pool.", "format": "float", "location": "query" }, @@ -13516,7 +13560,7 @@ }, "targetPool": { "type": "string", - "description": "Name of the TargetPool resource for which the backup is to be set.", + "description": "Name of the TargetPool resource to set a backup pool for.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13546,16 +13590,16 @@ "id": "compute.targetVpnGateways.aggregatedList", "path": "{project}/aggregated/targetVpnGateways", "httpMethod": "GET", - "description": "Retrieves an aggregated list of target VPN gateways .", + "description": "Retrieves an aggregated list of target VPN gateways.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13591,7 +13635,7 @@ "id": "compute.targetVpnGateways.delete", "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "httpMethod": "DELETE", - "description": "Deletes the specified TargetVpnGateway resource.", + "description": "Deletes the specified target VPN gateway.", "parameters": { "project": { "type": "string", @@ -13602,14 +13646,14 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" }, "targetVpnGateway": { "type": "string", - "description": "Name of the TargetVpnGateway resource to delete.", + "description": "Name of the target VPN gateway to delete.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13632,7 +13676,7 @@ "id": "compute.targetVpnGateways.get", "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "httpMethod": "GET", - "description": "Returns the specified TargetVpnGateway resource.", + "description": "Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.", "parameters": { "project": { "type": "string", @@ -13643,14 +13687,14 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" }, "targetVpnGateway": { "type": "string", - "description": "Name of the TargetVpnGateway resource to return.", + "description": "Name of the target VPN gateway to return.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13674,7 +13718,7 @@ "id": "compute.targetVpnGateways.insert", "path": "{project}/regions/{region}/targetVpnGateways", "httpMethod": "POST", - "description": "Creates a TargetVpnGateway resource in the specified project and region using the data included in the request.", + "description": "Creates a target VPN gateway in the specified project and region using the data included in the request.", "parameters": { "project": { "type": "string", @@ -13685,7 +13729,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13710,16 +13754,16 @@ "id": "compute.targetVpnGateways.list", "path": "{project}/regions/{region}/targetVpnGateways", "httpMethod": "GET", - "description": "Retrieves a list of TargetVpnGateway resources available to the specified project and region.", + "description": "Retrieves a list of target VPN gateways available to the specified project and region.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -13740,7 +13784,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -13800,7 +13844,7 @@ "id": "compute.urlMaps.get", "path": "{project}/global/urlMaps/{urlMap}", "httpMethod": "GET", - "description": "Returns the specified UrlMap resource.", + "description": "Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.", "parameters": { "project": { "type": "string", @@ -13866,12 +13910,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -14023,12 +14067,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -14075,7 +14119,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14105,7 +14149,7 @@ "id": "compute.vpnTunnels.get", "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}", "httpMethod": "GET", - "description": "Returns the specified VpnTunnel resource.", + "description": "Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.", "parameters": { "project": { "type": "string", @@ -14116,7 +14160,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14158,7 +14202,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14187,12 +14231,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -14213,7 +14257,7 @@ }, "region": { "type": "string", - "description": "The name of the region for this request.", + "description": "Name of the region for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14258,7 +14302,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14296,7 +14340,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for this request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14324,12 +14368,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -14350,7 +14394,7 @@ }, "zone": { "type": "string", - "description": "Name of the zone scoping this request.", + "description": "Name of the zone for request.", "required": true, "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path" @@ -14377,7 +14421,7 @@ "id": "compute.zones.get", "path": "{project}/zones/{zone}", "httpMethod": "GET", - "description": "Returns the specified zone resource.", + "description": "Returns the specified Zone resource. Get a list of available zones by making a list() request.", "parameters": { "project": { "type": "string", @@ -14411,16 +14455,16 @@ "id": "compute.zones.list", "path": "{project}/zones", "httpMethod": "GET", - "description": "Retrieves the list of zone resources available to the specified project.", + "description": "Retrieves the list of Zone resources available to the specified project.", "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", diff --git a/etc/api/container/v1beta1/container-api.json b/etc/api/container/v1beta1/container-api.json deleted file mode 100644 index 3ee4d2e009..0000000000 --- a/etc/api/container/v1beta1/container-api.json +++ /dev/null @@ -1,652 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/MMM1eku07yBWMoyhM-gsRmxhXoM\"", - "discoveryVersion": "v1", - "id": "container:v1beta1", - "name": "container", - "version": "v1beta1", - "revision": "20151005", - "title": "Google Container Engine API", - "description": "The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "https://cloud.google.com/container-engine/docs/v1beta1/", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/container/v1beta1/projects/", - "basePath": "/container/v1beta1/projects/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "container/v1beta1/projects/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "schemas": { - "Cluster": { - "id": "Cluster", - "type": "object", - "properties": { - "clusterApiVersion": { - "type": "string", - "description": "The API version of the Kubernetes master and kubelets running in this cluster. Leave blank to pick up the latest stable release, or specify a version of the form \"x.y.z\". The Google Container Engine release notes lists the currently supported versions. If an incorrect version is specified, the server returns an error listing the currently supported versions." - }, - "containerIpv4Cidr": { - "type": "string", - "description": "The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8." - }, - "creationTimestamp": { - "type": "string", - "description": "[Output only] The time the cluster was created, in RFC3339 text format." - }, - "description": { - "type": "string", - "description": "An optional description of this cluster." - }, - "enableCloudLogging": { - "type": "boolean", - "description": "Whether logs from the cluster should be made available via the Google Cloud Logging service. This includes both logs from your applications running in the cluster as well as logs from the Kubernetes components themselves." - }, - "enableCloudMonitoring": { - "type": "boolean", - "description": "Whether metrics from the cluster should be made available via the Google Cloud Monitoring service." - }, - "endpoint": { - "type": "string", - "description": "[Output only] The IP address of this cluster's Kubernetes master. The endpoint can be accessed from the internet at https://username:password@endpoint/.\n\nSee the masterAuth property of this resource for username and password information." - }, - "instanceGroupUrls": { - "type": "array", - "description": "[Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.", - "items": { - "type": "string" - } - }, - "masterAuth": { - "$ref": "MasterAuth", - "description": "The authentication information for accessing the master." - }, - "name": { - "type": "string", - "description": "The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: \n- Lowercase letters, numbers, and hyphens only.\n- Must start with a letter.\n- Must end with a number or a letter." - }, - "network": { - "type": "string", - "description": "The name of the Google Compute Engine network to which the cluster is connected." - }, - "nodeConfig": { - "$ref": "NodeConfig", - "description": "The machine type and image to use for all nodes in this cluster. See the descriptions of the child properties of nodeConfig." - }, - "nodeRoutingPrefixSize": { - "type": "integer", - "description": "[Output only] The size of the address space on each node for hosting containers.", - "format": "int32" - }, - "numNodes": { - "type": "integer", - "description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances plus one (to include the master). You must also have available firewall and routes quota.", - "format": "int32" - }, - "selfLink": { - "type": "string", - "description": "[Output only] Server-defined URL for the resource." - }, - "servicesIpv4Cidr": { - "type": "string", - "description": "[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR." - }, - "status": { - "type": "string", - "description": "[Output only] The current status of this cluster.", - "enum": [ - "error", - "provisioning", - "running", - "stopping" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ] - }, - "statusMessage": { - "type": "string", - "description": "[Output only] Additional information about the current status of this cluster, if available." - }, - "zone": { - "type": "string", - "description": "[Output only] The name of the Google Compute Engine zone in which the cluster resides." - } - } - }, - "CreateClusterRequest": { - "id": "CreateClusterRequest", - "type": "object", - "properties": { - "cluster": { - "$ref": "Cluster", - "description": "A cluster resource." - } - } - }, - "ListAggregatedClustersResponse": { - "id": "ListAggregatedClustersResponse", - "type": "object", - "properties": { - "clusters": { - "type": "array", - "description": "A list of clusters in the project, across all zones.", - "items": { - "$ref": "Cluster" - } - } - } - }, - "ListAggregatedOperationsResponse": { - "id": "ListAggregatedOperationsResponse", - "type": "object", - "properties": { - "operations": { - "type": "array", - "description": "A list of operations in the project, across all zones.", - "items": { - "$ref": "Operation" - } - } - } - }, - "ListClustersResponse": { - "id": "ListClustersResponse", - "type": "object", - "properties": { - "clusters": { - "type": "array", - "description": "A list of clusters in the project in the specified zone.", - "items": { - "$ref": "Cluster" - } - } - } - }, - "ListOperationsResponse": { - "id": "ListOperationsResponse", - "type": "object", - "properties": { - "operations": { - "type": "array", - "description": "A list of operations in the project in the specified zone.", - "items": { - "$ref": "Operation" - } - } - } - }, - "MasterAuth": { - "id": "MasterAuth", - "type": "object", - "description": "The authentication information for accessing the master. Authentication is either done using HTTP basic authentication or using a bearer token.", - "properties": { - "bearerToken": { - "type": "string", - "description": "The token used to authenticate API requests to the master. The token is to be included in an HTTP Authorization Header in all requests to the master endpoint. The format of the header is: \"Authorization: Bearer \"." - }, - "clientCertificate": { - "type": "string", - "description": "[Output only] Base64 encoded public certificate used by clients to authenticate to the cluster endpoint." - }, - "clientKey": { - "type": "string", - "description": "[Output only] Base64 encoded private key used by clients to authenticate to the cluster endpoint." - }, - "clusterCaCertificate": { - "type": "string", - "description": "[Output only] Base64 encoded public certificate that is the root of trust for the cluster." - }, - "password": { - "type": "string", - "description": "The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint. Because the master endpoint is open to the internet, you should create a strong password." - }, - "user": { - "type": "string", - "description": "The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint." - } - } - }, - "NodeConfig": { - "id": "NodeConfig", - "type": "object", - "properties": { - "machineType": { - "type": "string", - "description": "The name of a Google Compute Engine machine type (e.g. n1-standard-1).\n\nIf unspecified, the default machine type is n1-standard-1." - }, - "serviceAccounts": { - "type": "array", - "description": "The optional list of ServiceAccounts, each with their specified scopes, to be made available on all of the node VMs. In addition to the service accounts and scopes specified, the \"default\" account will always be created with the following scopes to ensure the correct functioning of the cluster: \n- https://www.googleapis.com/auth/compute,\n- https://www.googleapis.com/auth/devstorage.read_only", - "items": { - "$ref": "ServiceAccount" - } - }, - "sourceImage": { - "type": "string", - "description": "The fully-specified name of a Google Compute Engine image. For example: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/backports-debian-7-wheezy-vYYYYMMDD (where YYYMMDD is the version date).\n\nIf specifying an image, you are responsible for ensuring its compatibility with the Debian 7 backports image. We recommend leaving this field blank to accept the default backports-debian-7-wheezy value." - } - } - }, - "Operation": { - "id": "Operation", - "type": "object", - "description": "Defines the operation resource. All fields are output only.", - "properties": { - "errorMessage": { - "type": "string", - "description": "If an error has occurred, a textual description of the error." - }, - "name": { - "type": "string", - "description": "The server-assigned ID for the operation." - }, - "operationType": { - "type": "string", - "description": "The operation type.", - "enum": [ - "createCluster", - "deleteCluster", - "repairCluster", - "updateCluster", - "upgradeMaster", - "upgradeNodes" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" - ] - }, - "selfLink": { - "type": "string", - "description": "Server-defined URL for the resource." - }, - "status": { - "type": "string", - "description": "The current status of the operation.", - "enum": [ - "done", - "pending", - "running" - ], - "enumDescriptions": [ - "", - "", - "" - ] - }, - "target": { - "type": "string", - "description": "[Optional] The URL of the cluster resource that this operation is associated with." - }, - "targetLink": { - "type": "string", - "description": "Server-defined URL for the target of the operation." - }, - "zone": { - "type": "string", - "description": "The name of the Google Compute Engine zone in which the operation is taking place." - } - } - }, - "ServiceAccount": { - "id": "ServiceAccount", - "type": "object", - "description": "A Compute Engine service account.", - "properties": { - "email": { - "type": "string", - "description": "Email address of the service account." - }, - "scopes": { - "type": "array", - "description": "The list of scopes to be made available for this service account.", - "items": { - "type": "string" - } - } - } - } - }, - "resources": { - "projects": { - "resources": { - "clusters": { - "methods": { - "list": { - "id": "container.projects.clusters.list", - "path": "{projectId}/clusters", - "httpMethod": "GET", - "description": "Lists all clusters owned by a project across all zones.", - "parameters": { - "projectId": { - "type": "string", - "description": "The Google Developers Console project ID or project number.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "ListAggregatedClustersResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "operations": { - "methods": { - "list": { - "id": "container.projects.operations.list", - "path": "{projectId}/operations", - "httpMethod": "GET", - "description": "Lists all operations in a project, across all zones.", - "parameters": { - "projectId": { - "type": "string", - "description": "The Google Developers Console project ID or project number.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "ListAggregatedOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "zones": { - "resources": { - "clusters": { - "methods": { - "create": { - "id": "container.projects.zones.clusters.create", - "path": "{projectId}/zones/{zoneId}/clusters", - "httpMethod": "POST", - "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master instance.\n\nThe cluster is created in the project's default network.\n\nA firewall is added that allows traffic into port 443 on the master, which enables HTTPS. A firewall and a route is added for each node to allow the containers on that node to communicate with all other instances in the cluster.\n\nFinally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.", - "parameters": { - "projectId": { - "type": "string", - "description": "The Google Developers Console project ID or project number.", - "required": true, - "location": "path" - }, - "zoneId": { - "type": "string", - "description": "The name of the Google Compute Engine zone in which the cluster resides.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "zoneId" - ], - "request": { - "$ref": "CreateClusterRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "id": "container.projects.zones.clusters.delete", - "path": "{projectId}/zones/{zoneId}/clusters/{clusterId}", - "httpMethod": "DELETE", - "description": "Deletes the cluster, including the Kubernetes master and all worker nodes.\n\nFirewalls and routes that were configured at cluster creation are also deleted.", - "parameters": { - "clusterId": { - "type": "string", - "description": "The name of the cluster to delete.", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "description": "The Google Developers Console project ID or project number.", - "required": true, - "location": "path" - }, - "zoneId": { - "type": "string", - "description": "The name of the Google Compute Engine zone in which the cluster resides.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "zoneId", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "id": "container.projects.zones.clusters.get", - "path": "{projectId}/zones/{zoneId}/clusters/{clusterId}", - "httpMethod": "GET", - "description": "Gets a specific cluster.", - "parameters": { - "clusterId": { - "type": "string", - "description": "The name of the cluster to retrieve.", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "description": "The Google Developers Console project ID or project number.", - "required": true, - "location": "path" - }, - "zoneId": { - "type": "string", - "description": "The name of the Google Compute Engine zone in which the cluster resides.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "zoneId", - "clusterId" - ], - "response": { - "$ref": "Cluster" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "id": "container.projects.zones.clusters.list", - "path": "{projectId}/zones/{zoneId}/clusters", - "httpMethod": "GET", - "description": "Lists all clusters owned by a project in the specified zone.", - "parameters": { - "projectId": { - "type": "string", - "description": "The Google Developers Console project ID or project number.", - "required": true, - "location": "path" - }, - "zoneId": { - "type": "string", - "description": "The name of the Google Compute Engine zone in which the cluster resides.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "zoneId" - ], - "response": { - "$ref": "ListClustersResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "operations": { - "methods": { - "get": { - "id": "container.projects.zones.operations.get", - "path": "{projectId}/zones/{zoneId}/operations/{operationId}", - "httpMethod": "GET", - "description": "Gets the specified operation.", - "parameters": { - "operationId": { - "type": "string", - "description": "The server-assigned name of the operation.", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "description": "The Google Developers Console project ID or project number.", - "required": true, - "location": "path" - }, - "zoneId": { - "type": "string", - "description": "The name of the Google Compute Engine zone in which the operation resides. This is always the same zone as the cluster with which the operation is associated.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "zoneId", - "operationId" - ], - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "id": "container.projects.zones.operations.list", - "path": "{projectId}/zones/{zoneId}/operations", - "httpMethod": "GET", - "description": "Lists all operations in a project in a specific zone.", - "parameters": { - "projectId": { - "type": "string", - "description": "The Google Developers Console project ID or project number.", - "required": true, - "location": "path" - }, - "zoneId": { - "type": "string", - "description": "The name of the Google Compute Engine zone to return operations for.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "zoneId" - ], - "response": { - "$ref": "ListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - } - } -} diff --git a/etc/api/content/v2/content-api.json b/etc/api/content/v2/content-api.json index 37e4dd9d0e..201cf8ece9 100644 --- a/etc/api/content/v2/content-api.json +++ b/etc/api/content/v2/content-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/WzxFI4GBYGkZGJCfKJi51ODdQOI\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1_ZSJu77tRD1CDhwJUBK_00tAPU\"", "discoveryVersion": "v1", "id": "content:v2", "name": "content", "canonicalName": "Shopping Content", "version": "v2", - "revision": "20160115", + "revision": "20160204", "title": "Content API for Shopping", "description": "Manage product items, inventory, and Merchant Center accounts for Google Shopping.", "ownerDomain": "google.com", @@ -1874,6 +1874,13 @@ "type": "string", "description": "The date when the order was placed, in ISO 8601 format." }, + "promotions": { + "type": "array", + "description": "The details of the merchant provided promotions applied to the order. More details about the program are here.", + "items": { + "$ref": "OrderPromotion" + } + }, "refunds": { "type": "array", "description": "Refunds for the order.", @@ -2304,6 +2311,71 @@ } } }, + "OrderPromotion": { + "id": "OrderPromotion", + "type": "object", + "properties": { + "benefits": { + "type": "array", + "items": { + "$ref": "OrderPromotionBenefit" + } + }, + "effectiveDates": { + "type": "string", + "description": "The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.\nStart date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format." + }, + "genericRedemptionCode": { + "type": "string", + "description": "Optional. The text code that corresponds to the promotion when applied on the retailer?s website." + }, + "id": { + "type": "string", + "description": "The unique ID of the promotion." + }, + "longTitle": { + "type": "string", + "description": "The full title of the promotion." + }, + "productApplicability": { + "type": "string", + "description": "Whether the promotion is applicable to all products or only specific products." + }, + "redemptionChannel": { + "type": "string", + "description": "Indicates that the promotion is valid online." + } + } + }, + "OrderPromotionBenefit": { + "id": "OrderPromotionBenefit", + "type": "object", + "properties": { + "discount": { + "$ref": "Price", + "description": "The discount in the order price when the promotion is applied." + }, + "offerIds": { + "type": "array", + "description": "The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.", + "items": { + "type": "string" + } + }, + "subType": { + "type": "string", + "description": "Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types." + }, + "taxImpact": { + "$ref": "Price", + "description": "The impact on tax when the promotion is applied." + }, + "type": { + "type": "string", + "description": "Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping)." + } + } + }, "OrderRefund": { "id": "OrderRefund", "type": "object", @@ -3303,6 +3375,13 @@ "type": "string", "description": "Your category of the item (formatted as in product feeds specification)." }, + "promotionIds": { + "type": "array", + "description": "The unique ID of a promotion.", + "items": { + "type": "string" + } + }, "salePrice": { "$ref": "Price", "description": "Advertised sale price of the item." @@ -3955,6 +4034,13 @@ ] } }, + "promotions": { + "type": "array", + "description": "The details of the merchant provided promotions applied to the order. More details about the program are here.", + "items": { + "$ref": "OrderPromotion" + } + }, "shippingCost": { "$ref": "Price", "description": "The total cost of shipping for all items.", @@ -5538,9 +5624,13 @@ "required": true, "enum": [ "template1", + "template1a", + "template1b", "template2" ], "enumDescriptions": [ + "", + "", "", "" ], diff --git a/etc/api/content/v2sandbox/content-api.json b/etc/api/content/v2sandbox/content-api.json index e87cd82fdc..b108b8d59f 100644 --- a/etc/api/content/v2sandbox/content-api.json +++ b/etc/api/content/v2sandbox/content-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/xxKiVUHXdi7496Ms-R75deYhuZo\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/E9Q3WkKQIctkqTCGftuDi6_-ikQ\"", "discoveryVersion": "v1", "id": "content:v2sandbox", "name": "content", "canonicalName": "Shopping Content", "version": "v2sandbox", - "revision": "20160115", + "revision": "20160204", "title": "Content API for Shopping", "description": "Manage product items, inventory, and Merchant Center accounts for Google Shopping.", "ownerDomain": "google.com", @@ -175,6 +175,13 @@ "type": "string", "description": "The date when the order was placed, in ISO 8601 format." }, + "promotions": { + "type": "array", + "description": "The details of the merchant provided promotions applied to the order. More details about the program are here.", + "items": { + "$ref": "OrderPromotion" + } + }, "refunds": { "type": "array", "description": "Refunds for the order.", @@ -605,6 +612,71 @@ } } }, + "OrderPromotion": { + "id": "OrderPromotion", + "type": "object", + "properties": { + "benefits": { + "type": "array", + "items": { + "$ref": "OrderPromotionBenefit" + } + }, + "effectiveDates": { + "type": "string", + "description": "The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.\nStart date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format." + }, + "genericRedemptionCode": { + "type": "string", + "description": "Optional. The text code that corresponds to the promotion when applied on the retailer?s website." + }, + "id": { + "type": "string", + "description": "The unique ID of the promotion." + }, + "longTitle": { + "type": "string", + "description": "The full title of the promotion." + }, + "productApplicability": { + "type": "string", + "description": "Whether the promotion is applicable to all products or only specific products." + }, + "redemptionChannel": { + "type": "string", + "description": "Indicates that the promotion is valid online." + } + } + }, + "OrderPromotionBenefit": { + "id": "OrderPromotionBenefit", + "type": "object", + "properties": { + "discount": { + "$ref": "Price", + "description": "The discount in the order price when the promotion is applied." + }, + "offerIds": { + "type": "array", + "description": "The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.", + "items": { + "type": "string" + } + }, + "subType": { + "type": "string", + "description": "Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types." + }, + "taxImpact": { + "$ref": "Price", + "description": "The impact on tax when the promotion is applied." + }, + "type": { + "type": "string", + "description": "Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping)." + } + } + }, "OrderRefund": { "id": "OrderRefund", "type": "object", @@ -1399,6 +1471,13 @@ ] } }, + "promotions": { + "type": "array", + "description": "The details of the merchant provided promotions applied to the order. More details about the program are here.", + "items": { + "$ref": "OrderPromotion" + } + }, "shippingCost": { "$ref": "Price", "description": "The total cost of shipping for all items.", @@ -1892,9 +1971,13 @@ "required": true, "enum": [ "template1", + "template1a", + "template1b", "template2" ], "enumDescriptions": [ + "", + "", "", "" ], diff --git a/etc/api/coordinate/v1/coordinate-api.json b/etc/api/coordinate/v1/coordinate-api.json index 0f18f4353f..1982ba690e 100644 --- a/etc/api/coordinate/v1/coordinate-api.json +++ b/etc/api/coordinate/v1/coordinate-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/LAdZ2nGpn3ijcxPMLSPWr-ojB-4\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/MnvBWhcZU7xS2iIEoZ2wSIQNHiQ\"", "discoveryVersion": "v1", "id": "coordinate:v1", "name": "coordinate", diff --git a/etc/api/customsearch/v1/customsearch-api.json b/etc/api/customsearch/v1/customsearch-api.json index b42296a62c..c6bd1f23cf 100644 --- a/etc/api/customsearch/v1/customsearch-api.json +++ b/etc/api/customsearch/v1/customsearch-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/HbdYnih5X_STX1k-JZ6vFWYzrig\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/XzGRxEeySE6tqu0KMmAajCfq0UU\"", "discoveryVersion": "v1", "id": "customsearch:v1", "name": "customsearch", diff --git a/etc/api/dataflow/v1b3/dataflow-api.json b/etc/api/dataflow/v1b3/dataflow-api.json index 1d236b78b1..df8929f631 100644 --- a/etc/api/dataflow/v1b3/dataflow-api.json +++ b/etc/api/dataflow/v1b3/dataflow-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/z_qEBVG4geak7DrKYhi9NJcxQa4\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/2T7pRfqHiALUVY6zFk7GoMXgWV4\"", "discoveryVersion": "v1", "id": "dataflow:v1b3", "name": "dataflow", "version": "v1b3", - "revision": "20160123", + "revision": "20160225", "title": "Google Dataflow API", "description": "Google Dataflow API.", "ownerDomain": "google.com", @@ -384,6 +384,10 @@ "network": { "type": "string", "description": "Network to which VMs will be assigned. If empty or unspecified, the service will use the network \"default\"." + }, + "workerHarnessContainerImage": { + "type": "string", + "description": "Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required." } } }, @@ -1730,6 +1734,10 @@ "streamingComputationTopology": { "$ref": "TopologyConfig", "description": "The global topology of the streaming Dataflow job." + }, + "drain": { + "type": "boolean", + "description": "The user has requested drain." } } }, diff --git a/etc/api/dataflow/v1b4/dataflow-api.json b/etc/api/dataflow/v1b4/dataflow-api.json deleted file mode 100644 index cf3b80843d..0000000000 --- a/etc/api/dataflow/v1b4/dataflow-api.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/P_vr2FB2gO6U8edv6zuM317lno4\"", - "discoveryVersion": "v1", - "id": "dataflow:v1b4", - "name": "dataflow", - "version": "v1b4", - "revision": "20150401", - "title": "Google Dataflow API", - "description": "Google Dataflow API.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "", - "protocol": "rest", - "baseUrl": "https://dataflow.googleapis.com/", - "basePath": "/", - "rootUrl": "https://dataflow.googleapis.com/", - "servicePath": "", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - } -} diff --git a/etc/api/dataflow/v1beta3/dataflow-api.json b/etc/api/dataflow/v1beta3/dataflow-api.json deleted file mode 100644 index b7edb63b99..0000000000 --- a/etc/api/dataflow/v1beta3/dataflow-api.json +++ /dev/null @@ -1,1973 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/FPRgkYm-RZQh1gGnAPYf9mcPy44\"", - "discoveryVersion": "v1", - "id": "dataflow:v1beta3", - "name": "dataflow", - "version": "v1beta3", - "revision": "20150322", - "title": "Google Dataflow API", - "description": "Google Dataflow API.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/dataflow/v1b3/projects/", - "basePath": "/dataflow/v1b3/projects/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "dataflow/v1b3/projects/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/userinfo.email": { - "description": "View your email address" - } - } - } - }, - "schemas": { - "ApproximateProgress": { - "id": "ApproximateProgress", - "type": "object", - "properties": { - "percentComplete": { - "type": "number", - "format": "float" - }, - "position": { - "$ref": "Position" - }, - "remainingTime": { - "type": "string" - } - } - }, - "AutoscalingSettings": { - "id": "AutoscalingSettings", - "type": "object", - "properties": { - "algorithm": { - "type": "string", - "enum": [ - "AUTOSCALING_ALGORITHM_BASIC", - "AUTOSCALING_ALGORITHM_NONE", - "AUTOSCALING_ALGORITHM_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "" - ] - }, - "maxNumWorkers": { - "type": "integer", - "format": "int32" - } - } - }, - "ComputationTopology": { - "id": "ComputationTopology", - "type": "object", - "properties": { - "computationId": { - "type": "string" - }, - "inputs": { - "type": "array", - "items": { - "$ref": "StreamLocation" - } - }, - "keyRanges": { - "type": "array", - "items": { - "$ref": "KeyRangeLocation" - } - }, - "outputs": { - "type": "array", - "items": { - "$ref": "StreamLocation" - } - } - } - }, - "DataDiskAssignment": { - "id": "DataDiskAssignment", - "type": "object", - "properties": { - "dataDisks": { - "type": "array", - "items": { - "type": "string" - } - }, - "vmInstance": { - "type": "string" - } - } - }, - "DerivedSource": { - "id": "DerivedSource", - "type": "object", - "properties": { - "derivationMode": { - "type": "string", - "enum": [ - "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", - "SOURCE_DERIVATION_MODE_INDEPENDENT", - "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT", - "SOURCE_DERIVATION_MODE_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ] - }, - "source": { - "$ref": "Source" - } - } - }, - "Disk": { - "id": "Disk", - "type": "object", - "properties": { - "diskType": { - "type": "string" - }, - "mountPoint": { - "type": "string" - }, - "sizeGb": { - "type": "integer", - "format": "int32" - } - } - }, - "DynamicSourceSplit": { - "id": "DynamicSourceSplit", - "type": "object", - "properties": { - "primary": { - "$ref": "DerivedSource" - }, - "residual": { - "$ref": "DerivedSource" - } - } - }, - "Environment": { - "id": "Environment", - "type": "object", - "properties": { - "clusterManagerApiService": { - "type": "string" - }, - "dataset": { - "type": "string" - }, - "experiments": { - "type": "array", - "items": { - "type": "string" - } - }, - "sdkPipelineOptions": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "tempStoragePrefix": { - "type": "string" - }, - "userAgent": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "version": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "workerPools": { - "type": "array", - "items": { - "$ref": "WorkerPool" - } - } - } - }, - "FlattenInstruction": { - "id": "FlattenInstruction", - "type": "object", - "properties": { - "inputs": { - "type": "array", - "items": { - "$ref": "InstructionInput" - } - } - } - }, - "GoogleprotobufValue": { - "id": "GoogleprotobufValue", - "type": "any" - }, - "InstructionInput": { - "id": "InstructionInput", - "type": "object", - "properties": { - "outputNum": { - "type": "integer", - "format": "int32" - }, - "producerInstructionIndex": { - "type": "integer", - "format": "int32" - } - } - }, - "InstructionOutput": { - "id": "InstructionOutput", - "type": "object", - "properties": { - "codec": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "name": { - "type": "string" - } - } - }, - "Job": { - "id": "Job", - "type": "object", - "properties": { - "createTime": { - "type": "string" - }, - "currentState": { - "type": "string", - "enum": [ - "JOB_STATE_CANCELLED", - "JOB_STATE_DONE", - "JOB_STATE_FAILED", - "JOB_STATE_RUNNING", - "JOB_STATE_STOPPED", - "JOB_STATE_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" - ] - }, - "currentStateTime": { - "type": "string" - }, - "environment": { - "$ref": "Environment" - }, - "executionInfo": { - "$ref": "JobExecutionInfo" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "projectId": { - "type": "string" - }, - "requestedState": { - "type": "string", - "enum": [ - "JOB_STATE_CANCELLED", - "JOB_STATE_DONE", - "JOB_STATE_FAILED", - "JOB_STATE_RUNNING", - "JOB_STATE_STOPPED", - "JOB_STATE_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" - ] - }, - "steps": { - "type": "array", - "items": { - "$ref": "Step" - } - }, - "type": { - "type": "string", - "enum": [ - "JOB_TYPE_BATCH", - "JOB_TYPE_STREAMING", - "JOB_TYPE_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "" - ] - } - } - }, - "JobExecutionInfo": { - "id": "JobExecutionInfo", - "type": "object", - "properties": { - "stages": { - "type": "object", - "additionalProperties": { - "$ref": "JobExecutionStageInfo" - } - } - } - }, - "JobExecutionStageInfo": { - "id": "JobExecutionStageInfo", - "type": "object", - "properties": { - "stepName": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "JobMessage": { - "id": "JobMessage", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "messageImportance": { - "type": "string", - "enum": [ - "JOB_MESSAGE_DEBUG", - "JOB_MESSAGE_DETAILED", - "JOB_MESSAGE_ERROR", - "JOB_MESSAGE_IMPORTANCE_UNKNOWN", - "JOB_MESSAGE_WARNING" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "messageText": { - "type": "string" - }, - "time": { - "type": "string" - } - } - }, - "JobMetrics": { - "id": "JobMetrics", - "type": "object", - "properties": { - "metricTime": { - "type": "string" - }, - "metrics": { - "type": "array", - "items": { - "$ref": "MetricUpdate" - } - } - } - }, - "KeyRangeDataDiskAssignment": { - "id": "KeyRangeDataDiskAssignment", - "type": "object", - "properties": { - "dataDisk": { - "type": "string" - }, - "end": { - "type": "string" - }, - "start": { - "type": "string" - } - } - }, - "KeyRangeLocation": { - "id": "KeyRangeLocation", - "type": "object", - "properties": { - "dataDisk": { - "type": "string" - }, - "deliveryEndpoint": { - "type": "string" - }, - "end": { - "type": "string" - }, - "persistentDirectory": { - "type": "string" - }, - "start": { - "type": "string" - } - } - }, - "LeaseWorkItemRequest": { - "id": "LeaseWorkItemRequest", - "type": "object", - "properties": { - "currentWorkerTime": { - "type": "string" - }, - "requestedLeaseDuration": { - "type": "string" - }, - "workItemTypes": { - "type": "array", - "items": { - "type": "string" - } - }, - "workerCapabilities": { - "type": "array", - "items": { - "type": "string" - } - }, - "workerId": { - "type": "string" - } - } - }, - "LeaseWorkItemResponse": { - "id": "LeaseWorkItemResponse", - "type": "object", - "properties": { - "workItems": { - "type": "array", - "items": { - "$ref": "WorkItem" - } - } - } - }, - "ListJobMessagesResponse": { - "id": "ListJobMessagesResponse", - "type": "object", - "properties": { - "jobMessages": { - "type": "array", - "items": { - "$ref": "JobMessage" - } - }, - "nextPageToken": { - "type": "string" - } - } - }, - "ListJobsResponse": { - "id": "ListJobsResponse", - "type": "object", - "properties": { - "jobs": { - "type": "array", - "items": { - "$ref": "Job" - } - }, - "nextPageToken": { - "type": "string" - } - } - }, - "MapTask": { - "id": "MapTask", - "type": "object", - "properties": { - "instructions": { - "type": "array", - "items": { - "$ref": "ParallelInstruction" - } - }, - "stageName": { - "type": "string" - }, - "systemName": { - "type": "string" - } - } - }, - "MetricStructuredName": { - "id": "MetricStructuredName", - "type": "object", - "properties": { - "context": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "name": { - "type": "string" - }, - "origin": { - "type": "string" - } - } - }, - "MetricUpdate": { - "id": "MetricUpdate", - "type": "object", - "properties": { - "cumulative": { - "type": "boolean" - }, - "internal": { - "$ref": "GoogleprotobufValue" - }, - "kind": { - "type": "string" - }, - "meanCount": { - "$ref": "GoogleprotobufValue" - }, - "meanSum": { - "$ref": "GoogleprotobufValue" - }, - "name": { - "$ref": "MetricStructuredName" - }, - "scalar": { - "$ref": "GoogleprotobufValue" - }, - "set": { - "$ref": "GoogleprotobufValue" - }, - "updateTime": { - "type": "string" - } - } - }, - "MountedDataDisk": { - "id": "MountedDataDisk", - "type": "object", - "properties": { - "dataDisk": { - "type": "string" - } - } - }, - "MultiOutputInfo": { - "id": "MultiOutputInfo", - "type": "object", - "properties": { - "tag": { - "type": "string" - } - } - }, - "Package": { - "id": "Package", - "type": "object", - "properties": { - "location": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "ParDoInstruction": { - "id": "ParDoInstruction", - "type": "object", - "properties": { - "input": { - "$ref": "InstructionInput" - }, - "multiOutputInfos": { - "type": "array", - "items": { - "$ref": "MultiOutputInfo" - } - }, - "numOutputs": { - "type": "integer", - "format": "int32" - }, - "sideInputs": { - "type": "array", - "items": { - "$ref": "SideInputInfo" - } - }, - "userFn": { - "type": "object", - "additionalProperties": { - "type": "any" - } - } - } - }, - "ParallelInstruction": { - "id": "ParallelInstruction", - "type": "object", - "properties": { - "flatten": { - "$ref": "FlattenInstruction" - }, - "name": { - "type": "string" - }, - "outputs": { - "type": "array", - "items": { - "$ref": "InstructionOutput" - } - }, - "parDo": { - "$ref": "ParDoInstruction" - }, - "partialGroupByKey": { - "$ref": "PartialGroupByKeyInstruction" - }, - "read": { - "$ref": "ReadInstruction" - }, - "systemName": { - "type": "string" - }, - "write": { - "$ref": "WriteInstruction" - } - } - }, - "PartialGroupByKeyInstruction": { - "id": "PartialGroupByKeyInstruction", - "type": "object", - "properties": { - "input": { - "$ref": "InstructionInput" - }, - "inputElementCodec": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "valueCombiningFn": { - "type": "object", - "additionalProperties": { - "type": "any" - } - } - } - }, - "Position": { - "id": "Position", - "type": "object", - "properties": { - "byteOffset": { - "type": "string", - "format": "int64" - }, - "end": { - "type": "boolean" - }, - "key": { - "type": "string" - }, - "recordIndex": { - "type": "string", - "format": "int64" - }, - "shufflePosition": { - "type": "string" - } - } - }, - "PubsubLocation": { - "id": "PubsubLocation", - "type": "object", - "properties": { - "dropLateData": { - "type": "boolean" - }, - "idLabel": { - "type": "string" - }, - "subscription": { - "type": "string" - }, - "timestampLabel": { - "type": "string" - }, - "topic": { - "type": "string" - }, - "trackingSubscription": { - "type": "string" - } - } - }, - "ReadInstruction": { - "id": "ReadInstruction", - "type": "object", - "properties": { - "source": { - "$ref": "Source" - } - } - }, - "ReportWorkItemStatusRequest": { - "id": "ReportWorkItemStatusRequest", - "type": "object", - "properties": { - "currentWorkerTime": { - "type": "string" - }, - "workItemStatuses": { - "type": "array", - "items": { - "$ref": "WorkItemStatus" - } - }, - "workerId": { - "type": "string" - } - } - }, - "ReportWorkItemStatusResponse": { - "id": "ReportWorkItemStatusResponse", - "type": "object", - "properties": { - "workItemServiceStates": { - "type": "array", - "items": { - "$ref": "WorkItemServiceState" - } - } - } - }, - "SeqMapTask": { - "id": "SeqMapTask", - "type": "object", - "properties": { - "inputs": { - "type": "array", - "items": { - "$ref": "SideInputInfo" - } - }, - "name": { - "type": "string" - }, - "outputInfos": { - "type": "array", - "items": { - "$ref": "SeqMapTaskOutputInfo" - } - }, - "stageName": { - "type": "string" - }, - "systemName": { - "type": "string" - }, - "userFn": { - "type": "object", - "additionalProperties": { - "type": "any" - } - } - } - }, - "SeqMapTaskOutputInfo": { - "id": "SeqMapTaskOutputInfo", - "type": "object", - "properties": { - "sink": { - "$ref": "Sink" - }, - "tag": { - "type": "string" - } - } - }, - "ShellTask": { - "id": "ShellTask", - "type": "object", - "properties": { - "command": { - "type": "string" - }, - "exitCode": { - "type": "integer", - "format": "int32" - } - } - }, - "SideInputInfo": { - "id": "SideInputInfo", - "type": "object", - "properties": { - "kind": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "sources": { - "type": "array", - "items": { - "$ref": "Source" - } - }, - "tag": { - "type": "string" - } - } - }, - "Sink": { - "id": "Sink", - "type": "object", - "properties": { - "codec": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "spec": { - "type": "object", - "additionalProperties": { - "type": "any" - } - } - } - }, - "Source": { - "id": "Source", - "type": "object", - "properties": { - "baseSpecs": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "any" - } - } - }, - "codec": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "doesNotNeedSplitting": { - "type": "boolean" - }, - "metadata": { - "$ref": "SourceMetadata" - }, - "spec": { - "type": "object", - "additionalProperties": { - "type": "any" - } - } - } - }, - "SourceFork": { - "id": "SourceFork", - "type": "object", - "properties": { - "primary": { - "$ref": "SourceSplitShard" - }, - "primarySource": { - "$ref": "DerivedSource" - }, - "residual": { - "$ref": "SourceSplitShard" - }, - "residualSource": { - "$ref": "DerivedSource" - } - } - }, - "SourceGetMetadataRequest": { - "id": "SourceGetMetadataRequest", - "type": "object", - "properties": { - "source": { - "$ref": "Source" - } - } - }, - "SourceGetMetadataResponse": { - "id": "SourceGetMetadataResponse", - "type": "object", - "properties": { - "metadata": { - "$ref": "SourceMetadata" - } - } - }, - "SourceMetadata": { - "id": "SourceMetadata", - "type": "object", - "properties": { - "estimatedSizeBytes": { - "type": "string", - "format": "int64" - }, - "infinite": { - "type": "boolean" - }, - "producesSortedKeys": { - "type": "boolean" - } - } - }, - "SourceOperationRequest": { - "id": "SourceOperationRequest", - "type": "object", - "properties": { - "getMetadata": { - "$ref": "SourceGetMetadataRequest" - }, - "split": { - "$ref": "SourceSplitRequest" - } - } - }, - "SourceOperationResponse": { - "id": "SourceOperationResponse", - "type": "object", - "properties": { - "getMetadata": { - "$ref": "SourceGetMetadataResponse" - }, - "split": { - "$ref": "SourceSplitResponse" - } - } - }, - "SourceSplitOptions": { - "id": "SourceSplitOptions", - "type": "object", - "properties": { - "desiredBundleSizeBytes": { - "type": "string", - "format": "int64" - }, - "desiredShardSizeBytes": { - "type": "string", - "format": "int64" - } - } - }, - "SourceSplitRequest": { - "id": "SourceSplitRequest", - "type": "object", - "properties": { - "options": { - "$ref": "SourceSplitOptions" - }, - "source": { - "$ref": "Source" - } - } - }, - "SourceSplitResponse": { - "id": "SourceSplitResponse", - "type": "object", - "properties": { - "bundles": { - "type": "array", - "items": { - "$ref": "DerivedSource" - } - }, - "outcome": { - "type": "string", - "enum": [ - "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED", - "SOURCE_SPLIT_OUTCOME_UNKNOWN", - "SOURCE_SPLIT_OUTCOME_USE_CURRENT" - ], - "enumDescriptions": [ - "", - "", - "" - ] - }, - "shards": { - "type": "array", - "items": { - "$ref": "SourceSplitShard" - } - } - } - }, - "SourceSplitShard": { - "id": "SourceSplitShard", - "type": "object", - "properties": { - "derivationMode": { - "type": "string", - "enum": [ - "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", - "SOURCE_DERIVATION_MODE_INDEPENDENT", - "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT", - "SOURCE_DERIVATION_MODE_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ] - }, - "source": { - "$ref": "Source" - } - } - }, - "Status": { - "id": "Status", - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "any" - } - } - }, - "message": { - "type": "string" - } - } - }, - "Step": { - "id": "Step", - "type": "object", - "properties": { - "kind": { - "type": "string" - }, - "name": { - "type": "string" - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "any" - } - } - } - }, - "StreamLocation": { - "id": "StreamLocation", - "type": "object", - "properties": { - "pubsubLocation": { - "$ref": "PubsubLocation" - }, - "sideInputLocation": { - "$ref": "StreamingSideInputLocation" - }, - "streamingStageLocation": { - "$ref": "StreamingStageLocation" - } - } - }, - "StreamingComputationRanges": { - "id": "StreamingComputationRanges", - "type": "object", - "properties": { - "computationId": { - "type": "string" - }, - "rangeAssignments": { - "type": "array", - "items": { - "$ref": "KeyRangeDataDiskAssignment" - } - } - } - }, - "StreamingComputationTask": { - "id": "StreamingComputationTask", - "type": "object", - "properties": { - "computationRanges": { - "type": "array", - "items": { - "$ref": "StreamingComputationRanges" - } - }, - "dataDisks": { - "type": "array", - "items": { - "$ref": "MountedDataDisk" - } - }, - "taskType": { - "type": "string", - "enum": [ - "STREAMING_COMPUTATION_TASK_START", - "STREAMING_COMPUTATION_TASK_STOP", - "STREAMING_COMPUTATION_TASK_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "" - ] - } - } - }, - "StreamingSetupTask": { - "id": "StreamingSetupTask", - "type": "object", - "properties": { - "receiveWorkPort": { - "type": "integer", - "format": "int32" - }, - "streamingComputationTopology": { - "$ref": "TopologyConfig" - }, - "workerHarnessPort": { - "type": "integer", - "format": "int32" - } - } - }, - "StreamingSideInputLocation": { - "id": "StreamingSideInputLocation", - "type": "object", - "properties": { - "tag": { - "type": "string" - } - } - }, - "StreamingStageLocation": { - "id": "StreamingStageLocation", - "type": "object", - "properties": { - "streamId": { - "type": "string" - } - } - }, - "TaskRunnerSettings": { - "id": "TaskRunnerSettings", - "type": "object", - "properties": { - "alsologtostderr": { - "type": "boolean" - }, - "baseTaskDir": { - "type": "string" - }, - "baseUrl": { - "type": "string" - }, - "commandlinesFileName": { - "type": "string" - }, - "continueOnException": { - "type": "boolean" - }, - "dataflowApiVersion": { - "type": "string" - }, - "harnessCommand": { - "type": "string" - }, - "languageHint": { - "type": "string" - }, - "logDir": { - "type": "string" - }, - "logToSerialconsole": { - "type": "boolean" - }, - "logUploadLocation": { - "type": "string" - }, - "oauthScopes": { - "type": "array", - "items": { - "type": "string" - } - }, - "parallelWorkerSettings": { - "$ref": "WorkerSettings" - }, - "streamingWorkerMainClass": { - "type": "string" - }, - "taskGroup": { - "type": "string" - }, - "taskUser": { - "type": "string" - }, - "tempStoragePrefix": { - "type": "string" - }, - "vmId": { - "type": "string" - }, - "workflowFileName": { - "type": "string" - } - } - }, - "TopologyConfig": { - "id": "TopologyConfig", - "type": "object", - "properties": { - "computations": { - "type": "array", - "items": { - "$ref": "ComputationTopology" - } - }, - "dataDiskAssignments": { - "type": "array", - "items": { - "$ref": "DataDiskAssignment" - } - } - } - }, - "WorkItem": { - "id": "WorkItem", - "type": "object", - "properties": { - "configuration": { - "type": "string" - }, - "id": { - "type": "string", - "format": "int64" - }, - "initialReportIndex": { - "type": "string", - "format": "int64" - }, - "jobId": { - "type": "string" - }, - "leaseExpireTime": { - "type": "string" - }, - "mapTask": { - "$ref": "MapTask" - }, - "packages": { - "type": "array", - "items": { - "$ref": "Package" - } - }, - "projectId": { - "type": "string" - }, - "reportStatusInterval": { - "type": "string" - }, - "seqMapTask": { - "$ref": "SeqMapTask" - }, - "shellTask": { - "$ref": "ShellTask" - }, - "sourceOperationTask": { - "$ref": "SourceOperationRequest" - }, - "streamingComputationTask": { - "$ref": "StreamingComputationTask" - }, - "streamingSetupTask": { - "$ref": "StreamingSetupTask" - } - } - }, - "WorkItemServiceState": { - "id": "WorkItemServiceState", - "type": "object", - "properties": { - "harnessData": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "leaseExpireTime": { - "type": "string" - }, - "nextReportIndex": { - "type": "string", - "format": "int64" - }, - "reportStatusInterval": { - "type": "string" - }, - "suggestedStopPoint": { - "$ref": "ApproximateProgress" - }, - "suggestedStopPosition": { - "$ref": "Position" - } - } - }, - "WorkItemStatus": { - "id": "WorkItemStatus", - "type": "object", - "properties": { - "completed": { - "type": "boolean" - }, - "dynamicSourceSplit": { - "$ref": "DynamicSourceSplit" - }, - "errors": { - "type": "array", - "items": { - "$ref": "Status" - } - }, - "metricUpdates": { - "type": "array", - "items": { - "$ref": "MetricUpdate" - } - }, - "progress": { - "$ref": "ApproximateProgress" - }, - "reportIndex": { - "type": "string", - "format": "int64" - }, - "requestedLeaseDuration": { - "type": "string" - }, - "sourceFork": { - "$ref": "SourceFork" - }, - "sourceOperationResponse": { - "$ref": "SourceOperationResponse" - }, - "stopPosition": { - "$ref": "Position" - }, - "workItemId": { - "type": "string" - } - } - }, - "WorkerPool": { - "id": "WorkerPool", - "type": "object", - "properties": { - "autoscalingSettings": { - "$ref": "AutoscalingSettings" - }, - "dataDisks": { - "type": "array", - "items": { - "$ref": "Disk" - } - }, - "defaultPackageSet": { - "type": "string", - "enum": [ - "DEFAULT_PACKAGE_SET_JAVA", - "DEFAULT_PACKAGE_SET_NONE", - "DEFAULT_PACKAGE_SET_PYTHON", - "DEFAULT_PACKAGE_SET_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ] - }, - "diskSizeGb": { - "type": "integer", - "format": "int32" - }, - "diskSourceImage": { - "type": "string" - }, - "kind": { - "type": "string" - }, - "machineType": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "numWorkers": { - "type": "integer", - "format": "int32" - }, - "onHostMaintenance": { - "type": "string" - }, - "packages": { - "type": "array", - "items": { - "$ref": "Package" - } - }, - "poolArgs": { - "type": "object", - "additionalProperties": { - "type": "any" - } - }, - "taskrunnerSettings": { - "$ref": "TaskRunnerSettings" - }, - "teardownPolicy": { - "type": "string", - "enum": [ - "TEARDOWN_ALWAYS", - "TEARDOWN_NEVER", - "TEARDOWN_ON_SUCCESS", - "TEARDOWN_POLICY_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ] - }, - "zone": { - "type": "string" - } - } - }, - "WorkerSettings": { - "id": "WorkerSettings", - "type": "object", - "properties": { - "baseUrl": { - "type": "string" - }, - "reportingEnabled": { - "type": "boolean" - }, - "servicePath": { - "type": "string" - }, - "shuffleServicePath": { - "type": "string" - }, - "tempStoragePrefix": { - "type": "string" - }, - "workerId": { - "type": "string" - } - } - }, - "WriteInstruction": { - "id": "WriteInstruction", - "type": "object", - "properties": { - "input": { - "$ref": "InstructionInput" - }, - "sink": { - "$ref": "Sink" - } - } - } - }, - "resources": { - "v1b3": { - "resources": { - "projects": { - "resources": { - "jobs": { - "methods": { - "create": { - "id": "dataflow.v1b3.projects.jobs.create", - "path": "{projectId}/jobs", - "httpMethod": "POST", - "description": "Creates a dataflow job.", - "parameters": { - "projectId": { - "type": "string", - "required": true, - "location": "path" - }, - "view": { - "type": "string", - "enum": [ - "JOB_VIEW_ALL", - "JOB_VIEW_SUMMARY", - "JOB_VIEW_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "location": "query" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "Job" - }, - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "get": { - "id": "dataflow.v1b3.projects.jobs.get", - "path": "{projectId}/jobs/{jobId}", - "httpMethod": "GET", - "description": "Gets the state of the specified dataflow job.", - "parameters": { - "jobId": { - "type": "string", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "required": true, - "location": "path" - }, - "view": { - "type": "string", - "enum": [ - "JOB_VIEW_ALL", - "JOB_VIEW_SUMMARY", - "JOB_VIEW_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "location": "query" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "getMetrics": { - "id": "dataflow.v1b3.projects.jobs.getMetrics", - "path": "{projectId}/jobs/{jobId}/metrics", - "httpMethod": "GET", - "description": "Request the job status.", - "parameters": { - "jobId": { - "type": "string", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "required": true, - "location": "path" - }, - "startTime": { - "type": "string", - "location": "query" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "response": { - "$ref": "JobMetrics" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "list": { - "id": "dataflow.v1b3.projects.jobs.list", - "path": "{projectId}/jobs", - "httpMethod": "GET", - "description": "List the jobs of a project", - "parameters": { - "pageSize": { - "type": "integer", - "format": "int32", - "location": "query" - }, - "pageToken": { - "type": "string", - "location": "query" - }, - "projectId": { - "type": "string", - "required": true, - "location": "path" - }, - "view": { - "type": "string", - "enum": [ - "JOB_VIEW_ALL", - "JOB_VIEW_SUMMARY", - "JOB_VIEW_UNKNOWN" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "location": "query" - } - }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "ListJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "patch": { - "id": "dataflow.v1b3.projects.jobs.patch", - "path": "{projectId}/jobs/{jobId}", - "httpMethod": "PATCH", - "description": "Updates the state of an existing dataflow job. This method supports patch semantics.", - "parameters": { - "jobId": { - "type": "string", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "request": { - "$ref": "Job" - }, - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "update": { - "id": "dataflow.v1b3.projects.jobs.update", - "path": "{projectId}/jobs/{jobId}", - "httpMethod": "PUT", - "description": "Updates the state of an existing dataflow job.", - "parameters": { - "jobId": { - "type": "string", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "request": { - "$ref": "Job" - }, - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - } - }, - "resources": { - "messages": { - "methods": { - "list": { - "id": "dataflow.v1b3.projects.jobs.messages.list", - "path": "{projectId}/jobs/{jobId}/messages", - "httpMethod": "GET", - "description": "Request the job status.", - "parameters": { - "endTime": { - "type": "string", - "location": "query" - }, - "jobId": { - "type": "string", - "required": true, - "location": "path" - }, - "minimumImportance": { - "type": "string", - "enum": [ - "JOB_MESSAGE_DEBUG", - "JOB_MESSAGE_DETAILED", - "JOB_MESSAGE_ERROR", - "JOB_MESSAGE_IMPORTANCE_UNKNOWN", - "JOB_MESSAGE_WARNING" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ], - "location": "query" - }, - "pageSize": { - "type": "integer", - "format": "int32", - "location": "query" - }, - "pageToken": { - "type": "string", - "location": "query" - }, - "projectId": { - "type": "string", - "required": true, - "location": "path" - }, - "startTime": { - "type": "string", - "location": "query" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "response": { - "$ref": "ListJobMessagesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - } - } - }, - "workItems": { - "methods": { - "lease": { - "id": "dataflow.v1b3.projects.jobs.workItems.lease", - "path": "{projectId}/jobs/{jobId}/workItems:lease", - "httpMethod": "POST", - "description": "Leases a dataflow WorkItem to run.", - "parameters": { - "jobId": { - "type": "string", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "request": { - "$ref": "LeaseWorkItemRequest" - }, - "response": { - "$ref": "LeaseWorkItemResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "reportStatus": { - "id": "dataflow.v1b3.projects.jobs.workItems.reportStatus", - "path": "{projectId}/jobs/{jobId}/workItems:reportStatus", - "httpMethod": "POST", - "description": "Reports the status of dataflow WorkItems leased by a worker.", - "parameters": { - "jobId": { - "type": "string", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "request": { - "$ref": "ReportWorkItemStatusRequest" - }, - "response": { - "$ref": "ReportWorkItemStatusResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/userinfo.email" - ] - } - } - } - } - } - } - } - } - } - } -} diff --git a/etc/api/dataproc/v1/dataproc-api.json b/etc/api/dataproc/v1/dataproc-api.json index 10f330fba0..62954324b2 100644 --- a/etc/api/dataproc/v1/dataproc-api.json +++ b/etc/api/dataproc/v1/dataproc-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/SwbI7Wkwq3WInAaOPvGsFVm-5Tw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/SJDnrP-zMdgKOtIcX7eybyyfJxs\"", "discoveryVersion": "v1", "id": "dataproc:v1", "name": "dataproc", "version": "v1", - "revision": "20151209", + "revision": "20160219", "title": "Google Cloud Dataproc API", "description": "An API for managing Hadoop-based clusters and jobs on Google Cloud Platform.", "ownerDomain": "google.com", @@ -21,7 +21,6 @@ "rootUrl": "https://dataproc.googleapis.com/", "servicePath": "", "batchPath": "batch", - "version_module": true, "parameters": { "access_token": { "type": "string", @@ -131,6 +130,911 @@ } } }, + "Cluster": { + "id": "Cluster", + "type": "object", + "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.", + "properties": { + "projectId": { + "type": "string", + "description": "[Required] The Google Cloud Platform project ID that the cluster belongs to." + }, + "clusterName": { + "type": "string", + "description": "[Required] The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused." + }, + "config": { + "$ref": "ClusterConfig", + "description": "[Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated." + }, + "status": { + "$ref": "ClusterStatus", + "description": "[Output-only] Cluster status." + }, + "statusHistory": { + "type": "array", + "description": "[Output-only] The previous cluster status.", + "items": { + "$ref": "ClusterStatus" + } + }, + "clusterUuid": { + "type": "string", + "description": "[Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster." + } + } + }, + "ClusterConfig": { + "id": "ClusterConfig", + "type": "object", + "description": "The cluster config.", + "properties": { + "configBucket": { + "type": "string", + "description": "[Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you." + }, + "gceClusterConfig": { + "$ref": "GceClusterConfig", + "description": "[Optional] The shared Google Compute Engine config settings for all instances in a cluster." + }, + "masterConfig": { + "$ref": "InstanceGroupConfig", + "description": "[Optional] The Google Compute Engine config settings for the master instance in a cluster." + }, + "workerConfig": { + "$ref": "InstanceGroupConfig", + "description": "[Optional] The Google Compute Engine config settings for worker instances in a cluster." + }, + "secondaryWorkerConfig": { + "$ref": "InstanceGroupConfig", + "description": "[Optional] The Google Compute Engine config settings for additional worker instances in a cluster." + }, + "softwareConfig": { + "$ref": "SoftwareConfig", + "description": "[Optional] The config settings for software inside the cluster." + }, + "initializationActions": { + "type": "array", + "description": "[Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ \"${ROLE}\" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi", + "items": { + "$ref": "NodeInitializationAction" + } + } + } + }, + "GceClusterConfig": { + "id": "GceClusterConfig", + "type": "object", + "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.", + "properties": { + "zoneUri": { + "type": "string", + "description": "[Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`." + }, + "networkUri": { + "type": "string", + "description": "The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`." + }, + "subnetworkUri": { + "type": "string", + "description": "The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`." + }, + "serviceAccountScopes": { + "type": "array", + "description": "The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control", + "items": { + "type": "string" + } + }, + "tags": { + "type": "array", + "description": "The Google Compute Engine tags to add to all instances.", + "items": { + "type": "string" + } + }, + "metadata": { + "type": "object", + "description": "The Google Compute Engine metadata entries to add to all instances.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "InstanceGroupConfig": { + "id": "InstanceGroupConfig", + "type": "object", + "description": "The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.", + "properties": { + "numInstances": { + "type": "integer", + "description": "The number of VM instances in the instance group. For master instance groups, must be set to 1.", + "format": "int32" + }, + "instanceNames": { + "type": "array", + "description": "The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).", + "items": { + "type": "string" + } + }, + "imageUri": { + "type": "string", + "description": "[Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`." + }, + "machineTypeUri": { + "type": "string", + "description": "The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`." + }, + "diskConfig": { + "$ref": "DiskConfig", + "description": "Disk option config settings." + }, + "isPreemptible": { + "type": "boolean", + "description": "Specifies that this instance group contains Preemptible Instances." + }, + "managedGroupConfig": { + "$ref": "ManagedGroupConfig", + "description": "[Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups." + } + } + }, + "DiskConfig": { + "id": "DiskConfig", + "type": "object", + "description": "Specifies the config of disk options for a group of VM instances.", + "properties": { + "bootDiskSizeGb": { + "type": "integer", + "description": "[Optional] Size in GB of the boot disk (default is 500GB).", + "format": "int32" + }, + "numLocalSsds": { + "type": "integer", + "description": "[Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.", + "format": "int32" + } + } + }, + "ManagedGroupConfig": { + "id": "ManagedGroupConfig", + "type": "object", + "description": "Specifies the resources used to actively manage an instance group.", + "properties": { + "instanceTemplateName": { + "type": "string", + "description": "[Output-only] The name of the Instance Template used for the Managed Instance Group." + }, + "instanceGroupManagerName": { + "type": "string", + "description": "[Output-only] The name of the Instance Group Manager for this group." + } + } + }, + "SoftwareConfig": { + "id": "SoftwareConfig", + "type": "object", + "description": "Specifies the selection and config of software inside the cluster.", + "properties": { + "imageVersion": { + "type": "string", + "description": "[Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning))." + }, + "properties": { + "type": "object", + "description": "[Optional] The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NodeInitializationAction": { + "id": "NodeInitializationAction", + "type": "object", + "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.", + "properties": { + "executableFile": { + "type": "string", + "description": "[Required] Google Cloud Storage URI of executable file." + }, + "executionTimeout": { + "type": "string", + "description": "[Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period." + } + } + }, + "ClusterStatus": { + "id": "ClusterStatus", + "type": "object", + "description": "The status of a cluster and its instances.", + "properties": { + "state": { + "type": "string", + "description": "The cluster's state.", + "enum": [ + "UNKNOWN", + "CREATING", + "RUNNING", + "ERROR", + "DELETING", + "UPDATING" + ] + }, + "detail": { + "type": "string", + "description": "Optional details of cluster's state." + }, + "stateStartTime": { + "type": "string", + "description": "Time when this state was entered." + } + } + }, + "Operation": { + "id": "Operation", + "type": "object", + "description": "This resource represents a long-running operation that is the result of a network API call.", + "properties": { + "name": { + "type": "string", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`." + }, + "metadata": { + "type": "object", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "additionalProperties": { + "type": "any", + "description": "Properties of the object. Contains field @ype with type URL." + } + }, + "done": { + "type": "boolean", + "description": "If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available." + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure." + }, + "response": { + "type": "object", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "additionalProperties": { + "type": "any", + "description": "Properties of the object. Contains field @ype with type URL." + } + } + } + }, + "Status": { + "id": "Status", + "type": "object", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.", + "properties": { + "code": { + "type": "integer", + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32" + }, + "message": { + "type": "string", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." + }, + "details": { + "type": "array", + "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.", + "items": { + "type": "object", + "additionalProperties": { + "type": "any", + "description": "Properties of the object. Contains field @ype with type URL." + } + } + } + } + }, + "ListClustersResponse": { + "id": "ListClustersResponse", + "type": "object", + "description": "The list of all clusters in a project.", + "properties": { + "clusters": { + "type": "array", + "description": "[Output-only] The clusters in the project.", + "items": { + "$ref": "Cluster" + } + }, + "nextPageToken": { + "type": "string", + "description": "[Optional] This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the `page_token` in a subsequent ListClustersRequest." + } + } + }, + "DiagnoseClusterRequest": { + "id": "DiagnoseClusterRequest", + "type": "object", + "description": "A request to collect cluster diagnostic information." + }, + "SubmitJobRequest": { + "id": "SubmitJobRequest", + "type": "object", + "description": "A request to submit a job.", + "properties": { + "job": { + "$ref": "Job", + "description": "[Required] The job resource." + } + } + }, + "Job": { + "id": "Job", + "type": "object", + "description": "A Cloud Dataproc job resource.", + "properties": { + "reference": { + "$ref": "JobReference", + "description": "[Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id." + }, + "placement": { + "$ref": "JobPlacement", + "description": "[Required] Job information, including how, when, and where to run the job." + }, + "hadoopJob": { + "$ref": "HadoopJob", + "description": "Job is a Hadoop job." + }, + "sparkJob": { + "$ref": "SparkJob", + "description": "Job is a Spark job." + }, + "pysparkJob": { + "$ref": "PySparkJob", + "description": "Job is a Pyspark job." + }, + "hiveJob": { + "$ref": "HiveJob", + "description": "Job is a Hive job." + }, + "pigJob": { + "$ref": "PigJob", + "description": "Job is a Pig job." + }, + "sparkSqlJob": { + "$ref": "SparkSqlJob", + "description": "Job is a SparkSql job." + }, + "status": { + "$ref": "JobStatus", + "description": "[Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields." + }, + "statusHistory": { + "type": "array", + "description": "[Output-only] The previous job status.", + "items": { + "$ref": "JobStatus" + } + }, + "driverOutputResourceUri": { + "type": "string", + "description": "[Output-only] A URI pointing to the location of the stdout of the job's driver program." + }, + "driverControlFilesUri": { + "type": "string", + "description": "[Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`." + } + } + }, + "JobReference": { + "id": "JobReference", + "type": "object", + "description": "Encapsulates the full scoping used to reference a job.", + "properties": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to." + }, + "jobId": { + "type": "string", + "description": "[Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters." + } + } + }, + "JobPlacement": { + "id": "JobPlacement", + "type": "object", + "description": "Cloud Dataproc job config.", + "properties": { + "clusterName": { + "type": "string", + "description": "[Required] The name of the cluster where the job will be submitted." + }, + "clusterUuid": { + "type": "string", + "description": "[Output-only] A cluster UUID generated by the Cloud Dataproc service when the job is submitted." + } + } + }, + "HadoopJob": { + "id": "HadoopJob", + "type": "object", + "description": "A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN.", + "properties": { + "mainJarFileUri": { + "type": "string", + "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'" + }, + "mainClass": { + "type": "string", + "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`." + }, + "args": { + "type": "array", + "description": "[Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "items": { + "type": "string" + } + }, + "jarFileUris": { + "type": "array", + "description": "[Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.", + "items": { + "type": "string" + } + }, + "fileUris": { + "type": "array", + "description": "[Optional] HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.", + "items": { + "type": "string" + } + }, + "archiveUris": { + "type": "array", + "description": "[Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.", + "items": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "[Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.", + "additionalProperties": { + "type": "string" + } + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "[Optional] The runtime log config for job execution." + } + } + }, + "LoggingConfig": { + "id": "LoggingConfig", + "type": "object", + "description": "The runtime logging config of the job.", + "properties": { + "driverLogLevels": { + "type": "object", + "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'", + "additionalProperties": { + "type": "string", + "enum": [ + "LEVEL_UNSPECIFIED", + "ALL", + "TRACE", + "DEBUG", + "INFO", + "WARN", + "ERROR", + "FATAL", + "OFF" + ] + } + } + } + }, + "SparkJob": { + "id": "SparkJob", + "type": "object", + "description": "A Cloud Dataproc job for running Spark applications on YARN.", + "properties": { + "mainJarFileUri": { + "type": "string", + "description": "The HCFS URI of the jar file that contains the main class." + }, + "mainClass": { + "type": "string", + "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`." + }, + "args": { + "type": "array", + "description": "[Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "items": { + "type": "string" + } + }, + "jarFileUris": { + "type": "array", + "description": "[Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.", + "items": { + "type": "string" + } + }, + "fileUris": { + "type": "array", + "description": "[Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.", + "items": { + "type": "string" + } + }, + "archiveUris": { + "type": "array", + "description": "[Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", + "items": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "[Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", + "additionalProperties": { + "type": "string" + } + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "[Optional] The runtime log config for job execution." + } + } + }, + "PySparkJob": { + "id": "PySparkJob", + "type": "object", + "description": "A Cloud Dataproc job for running PySpark applications on YARN.", + "properties": { + "mainPythonFileUri": { + "type": "string", + "description": "[Required] The HCFS URI of the main Python file to use as the driver. Must be a .py file." + }, + "args": { + "type": "array", + "description": "[Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "items": { + "type": "string" + } + }, + "pythonFileUris": { + "type": "array", + "description": "[Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.", + "items": { + "type": "string" + } + }, + "jarFileUris": { + "type": "array", + "description": "[Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.", + "items": { + "type": "string" + } + }, + "fileUris": { + "type": "array", + "description": "[Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.", + "items": { + "type": "string" + } + }, + "archiveUris": { + "type": "array", + "description": "[Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.", + "items": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "[Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", + "additionalProperties": { + "type": "string" + } + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "[Optional] The runtime log config for job execution." + } + } + }, + "HiveJob": { + "id": "HiveJob", + "type": "object", + "description": "A Cloud Dataproc job for running Hive queries on YARN.", + "properties": { + "queryFileUri": { + "type": "string", + "description": "The HCFS URI of the script that contains Hive queries." + }, + "queryList": { + "$ref": "QueryList", + "description": "A list of queries." + }, + "continueOnFailure": { + "type": "boolean", + "description": "[Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries." + }, + "scriptVariables": { + "type": "object", + "description": "[Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name=\"value\";`).", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "[Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.", + "additionalProperties": { + "type": "string" + } + }, + "jarFileUris": { + "type": "array", + "description": "[Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.", + "items": { + "type": "string" + } + } + } + }, + "QueryList": { + "id": "QueryList", + "type": "object", + "description": "A list of queries to run on a cluster.", + "properties": { + "queries": { + "type": "array", + "description": "[Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: \"hiveJob\": { \"queryList\": { \"queries\": [ \"query1\", \"query2\", \"query3;query4\", ] } }", + "items": { + "type": "string" + } + } + } + }, + "PigJob": { + "id": "PigJob", + "type": "object", + "description": "A Cloud Dataproc job for running Pig queries on YARN.", + "properties": { + "queryFileUri": { + "type": "string", + "description": "The HCFS URI of the script that contains the Pig queries." + }, + "queryList": { + "$ref": "QueryList", + "description": "A list of queries." + }, + "continueOnFailure": { + "type": "boolean", + "description": "[Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries." + }, + "scriptVariables": { + "type": "object", + "description": "[Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "[Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", + "additionalProperties": { + "type": "string" + } + }, + "jarFileUris": { + "type": "array", + "description": "[Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.", + "items": { + "type": "string" + } + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "[Optional] The runtime log config for job execution." + } + } + }, + "SparkSqlJob": { + "id": "SparkSqlJob", + "type": "object", + "description": "A Cloud Dataproc job for running Spark SQL queries.", + "properties": { + "queryFileUri": { + "type": "string", + "description": "The HCFS URI of the script that contains SQL queries." + }, + "queryList": { + "$ref": "QueryList", + "description": "A list of queries." + }, + "scriptVariables": { + "type": "object", + "description": "[Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name=\"value\";`).", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "[Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.", + "additionalProperties": { + "type": "string" + } + }, + "jarFileUris": { + "type": "array", + "description": "[Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.", + "items": { + "type": "string" + } + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "[Optional] The runtime log config for job execution." + } + } + }, + "JobStatus": { + "id": "JobStatus", + "type": "object", + "description": "Cloud Dataproc job status.", + "properties": { + "state": { + "type": "string", + "description": "[Required] A state message specifying the overall job state.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "SETUP_DONE", + "RUNNING", + "CANCEL_PENDING", + "CANCEL_STARTED", + "CANCELLED", + "DONE", + "ERROR" + ] + }, + "details": { + "type": "string", + "description": "[Optional] Job state details, such as an error description if the state is ERROR." + }, + "stateStartTime": { + "type": "string", + "description": "[Output-only] The time when this state was entered." + } + } + }, + "ListJobsResponse": { + "id": "ListJobsResponse", + "type": "object", + "description": "A list of jobs in a project.", + "properties": { + "jobs": { + "type": "array", + "description": "[Output-only] Jobs list.", + "items": { + "$ref": "Job" + } + }, + "nextPageToken": { + "type": "string", + "description": "[Optional] This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the `page_token` in a subsequent ListJobsRequest." + } + } + }, + "CancelJobRequest": { + "id": "CancelJobRequest", + "type": "object", + "description": "A request to cancel a job." + }, + "Empty": { + "id": "Empty", + "type": "object", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`." + }, + "ListOperationsResponse": { + "id": "ListOperationsResponse", + "type": "object", + "description": "The response message for Operations.ListOperations.", + "properties": { + "operations": { + "type": "array", + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + } + }, + "nextPageToken": { + "type": "string", + "description": "The standard List next-page token." + } + } + }, + "DiagnoseClusterResults": { + "id": "DiagnoseClusterResults", + "type": "object", + "description": "The location of diagnostic output.", + "properties": { + "outputUri": { + "type": "string", + "description": "[Output-only] The Google Cloud Storage URI of the diagnostic output. This is a plain text file with a summary of collected diagnostics." + } + } + }, + "ClusterOperationMetadata": { + "id": "ClusterOperationMetadata", + "type": "object", + "description": "Metadata describing the operation.", + "properties": { + "clusterName": { + "type": "string", + "description": "Name of the cluster for the operation." + }, + "clusterUuid": { + "type": "string", + "description": "Cluster UUId for the operation." + }, + "status": { + "$ref": "ClusterOperationStatus", + "description": "[Output-only] Current operation status." + }, + "statusHistory": { + "type": "array", + "description": "[Output-only] The previous operation status.", + "items": { + "$ref": "ClusterOperationStatus" + } + }, + "operationType": { + "type": "string", + "description": "[Output-only] The operation type." + }, + "description": { + "type": "string", + "description": "[Output-only] Short description of operation." + } + } + }, + "ClusterOperationStatus": { + "id": "ClusterOperationStatus", + "type": "object", + "description": "The status of the operation.", + "properties": { + "state": { + "type": "string", + "description": "A message containing the operation state.", + "enum": [ + "UNKNOWN", + "PENDING", + "RUNNING", + "DONE" + ] + }, + "innerState": { + "type": "string", + "description": "A message containing the detailed operation state." + }, + "details": { + "type": "string", + "description": "A message containing any operation metadata details." + }, + "stateStartTime": { + "type": "string", + "description": "The time this state was entered." + } + } + }, "DiagnoseClusterOutputLocation": { "id": "DiagnoseClusterOutputLocation", "type": "object", @@ -195,6 +1099,14 @@ "items": { "$ref": "OperationStatus" } + }, + "operationType": { + "type": "string", + "description": "[Output-only] The operation type." + }, + "description": { + "type": "string", + "description": "[Output-only] Short description of operation." } } }, @@ -239,7 +1151,7 @@ "parameters": { "resourceName": { "type": "string", - "description": "Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name].", + "description": "Name of the media that is being downloaded. See ByteStream.ReadRequest.resource_name.", "required": true, "pattern": "^.*$", "location": "path" @@ -285,7 +1197,7 @@ "parameters": { "resourceName": { "type": "string", - "description": "Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name].", + "description": "Name of the media that is being downloaded. See ByteStream.ReadRequest.resource_name.", "required": true, "pattern": "^.*$", "location": "path" @@ -306,6 +1218,574 @@ "supportsMediaDownload": true } } + }, + "projects": { + "resources": { + "regions": { + "resources": { + "clusters": { + "methods": { + "create": { + "id": "dataproc.projects.regions.clusters.create", + "path": "v1/projects/{projectId}/regions/{region}/clusters", + "httpMethod": "POST", + "description": "Creates a cluster in a project.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region" + ], + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "id": "dataproc.projects.regions.clusters.patch", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "httpMethod": "PATCH", + "description": "Updates a cluster in a project.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project the cluster belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "clusterName": { + "type": "string", + "description": "[Required] The cluster name.", + "required": true, + "location": "path" + }, + "updateMask": { + "type": "string", + "description": "[Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the `PATCH` request body would specify the new value, as follows: { \"config\":{ \"workerConfig\":{ \"numInstances\":\"5\" } } } Note: Currently, config.worker_config.num_instances is the only field that can be updated.", + "location": "query" + } + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "id": "dataproc.projects.regions.clusters.delete", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "httpMethod": "DELETE", + "description": "Deletes a cluster in a project.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "clusterName": { + "type": "string", + "description": "[Required] The cluster name.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "id": "dataproc.projects.regions.clusters.get", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "httpMethod": "GET", + "description": "Gets the resource representation for a cluster in a project.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "clusterName": { + "type": "string", + "description": "[Required] The cluster name.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "response": { + "$ref": "Cluster" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "id": "dataproc.projects.regions.clusters.list", + "path": "v1/projects/{projectId}/regions/{region}/clusters", + "httpMethod": "GET", + "description": "Lists all regions/{region}/clusters in a project.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "pageSize": { + "type": "integer", + "description": "The standard List page size.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "The standard List page token.", + "location": "query" + } + }, + "parameterOrder": [ + "projectId", + "region" + ], + "response": { + "$ref": "ListClustersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "diagnose": { + "id": "dataproc.projects.regions.clusters.diagnose", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", + "httpMethod": "POST", + "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "clusterName": { + "type": "string", + "description": "[Required] The cluster name.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "request": { + "$ref": "DiagnoseClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "jobs": { + "methods": { + "submit": { + "id": "dataproc.projects.regions.jobs.submit", + "path": "v1/projects/{projectId}/regions/{region}/jobs:submit", + "httpMethod": "POST", + "description": "Submits a job to a cluster.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region" + ], + "request": { + "$ref": "SubmitJobRequest" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "id": "dataproc.projects.regions.jobs.get", + "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "httpMethod": "GET", + "description": "Gets the resource representation for a job in a project.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "jobId": { + "type": "string", + "description": "[Required] The job ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "id": "dataproc.projects.regions.jobs.list", + "path": "v1/projects/{projectId}/regions/{region}/jobs", + "httpMethod": "GET", + "description": "Lists regions/{region}/jobs in a project.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "pageSize": { + "type": "integer", + "description": "[Optional] The number of results to return in each response.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "[Optional] The page token, returned by a previous call, to request the next page of results.", + "location": "query" + }, + "clusterName": { + "type": "string", + "description": "[Optional] If set, the returned jobs list includes only jobs that were submitted to the named cluster.", + "location": "query" + }, + "jobStateMatcher": { + "type": "string", + "description": "[Optional] Specifies enumerated categories of jobs to list.", + "enum": [ + "ALL", + "ACTIVE", + "NON_ACTIVE" + ], + "location": "query" + } + }, + "parameterOrder": [ + "projectId", + "region" + ], + "response": { + "$ref": "ListJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cancel": { + "id": "dataproc.projects.regions.jobs.cancel", + "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", + "httpMethod": "POST", + "description": "Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/reference/rest/v1/projects.regions.jobs/list) or [regions/{region}/jobs.get](/dataproc/reference/rest/v1/projects.regions.jobs/get).", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "jobId": { + "type": "string", + "description": "[Required] The job ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "request": { + "$ref": "CancelJobRequest" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "id": "dataproc.projects.regions.jobs.delete", + "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "httpMethod": "DELETE", + "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Cloud Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "jobId": { + "type": "string", + "description": "[Required] The job ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "get": { + "id": "dataproc.projects.regions.operations.get", + "path": "v1/{+name}", + "httpMethod": "GET", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "parameters": { + "name": { + "type": "string", + "description": "The name of the operation resource.", + "required": true, + "pattern": "^projects/[^/]*/regions/[^/]*/operations/[^/]*$", + "location": "path" + } + }, + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "id": "dataproc.projects.regions.operations.list", + "path": "v1/{+name}", + "httpMethod": "GET", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.", + "parameters": { + "name": { + "type": "string", + "description": "The name of the operation collection.", + "required": true, + "pattern": "^projects/[^/]*/regions/[^/]*/operations$", + "location": "path" + }, + "filter": { + "type": "string", + "description": "The standard list filter.", + "location": "query" + }, + "pageSize": { + "type": "integer", + "description": "The standard list page size.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "The standard list page token.", + "location": "query" + } + }, + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cancel": { + "id": "dataproc.projects.regions.operations.cancel", + "path": "v1/{+name}:cancel", + "httpMethod": "POST", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.", + "parameters": { + "name": { + "type": "string", + "description": "The name of the operation resource to be cancelled.", + "required": true, + "pattern": "^projects/[^/]*/regions/[^/]*/operations/[^/]*$", + "location": "path" + } + }, + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "id": "dataproc.projects.regions.operations.delete", + "path": "v1/{+name}", + "httpMethod": "DELETE", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "parameters": { + "name": { + "type": "string", + "description": "The name of the operation resource to be deleted.", + "required": true, + "pattern": "^projects/[^/]*/regions/[^/]*/operations/[^/]*$", + "location": "path" + } + }, + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } } } } diff --git a/etc/api/dataproc/v1alpha1/dataproc-api.json b/etc/api/dataproc/v1alpha1/dataproc-api.json index 40594e469b..afc3216329 100644 --- a/etc/api/dataproc/v1alpha1/dataproc-api.json +++ b/etc/api/dataproc/v1alpha1/dataproc-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/jndj-e3v8fWTvNDjkWe-g8eW-mQ\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/yEGnz7qJE4H0ncVA8l2NAK4qges\"", "discoveryVersion": "v1", "id": "dataproc:v1alpha1", "name": "dataproc", "version": "v1alpha1", - "revision": "20151209", + "revision": "20160219", "title": "Google Cloud Dataproc API", "description": "An API for managing Hadoop-based clusters and jobs on Google Cloud Platform.", "ownerDomain": "google.com", @@ -105,73 +105,11 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/logging.admin": { - "description": "Administrate log data for your projects" - }, - "https://www.googleapis.com/auth/logging.read": { - "description": "View log data for your projects" - }, - "https://www.googleapis.com/auth/logging.write": { - "description": "Submit log data for your projects" } } } }, "schemas": { - "Agent": { - "id": "Agent", - "type": "object", - "description": "A record for a single agent within Dataproc.", - "properties": { - "agentId": { - "type": "string", - "description": "[Required] 64 characters matching the regular expression: [a-z0-9.-]{1,64} An agent chosen ID. This should typically be the hostname of the GCE virtual machine on which the agent is currently running." - }, - "lastAgentUpdateTime": { - "type": "string", - "description": "[Out] the last time this agent checked-in with Dataproc." - }, - "agentVersion": { - "type": "string", - "description": "The version of this agent in HTTP User-Agent Header value format (RFC 2616 section 14.43), e.g., \"Dataproc-Agent/1.2\"." - }, - "status": { - "type": "string", - "description": "Agent status.", - "enum": [ - "STATUS_UNKNOWN", - "INITIALIZING", - "PERFORMING_CUSTOM_INITIALIZATION_ACTIONS", - "RUNNING", - "SETUP_FAILED" - ] - } - } - }, - "ListAgentsResponse": { - "id": "ListAgentsResponse", - "type": "object", - "description": "Response to ListAgents", - "properties": { - "nextPageToken": { - "type": "string", - "description": "The token to send to ListAgents to acquire any following pages. Will be empty for last page." - }, - "agents": { - "type": "array", - "description": "A list of agents.", - "items": { - "$ref": "Agent" - } - } - } - }, - "Empty": { - "id": "Empty", - "type": "object", - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`." - }, "Cluster": { "id": "Cluster", "type": "object", @@ -334,7 +272,11 @@ }, "networkUri": { "type": "string", - "description": "The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example \"compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default\"." + "description": "The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`." + }, + "subnetworkUri": { + "type": "string", + "description": "The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`." }, "serviceAccountScopes": { "type": "array", @@ -342,6 +284,20 @@ "items": { "type": "string" } + }, + "tags": { + "type": "array", + "description": "The Google Compute Engine tags to add to all instances.", + "items": { + "type": "string" + } + }, + "metadata": { + "type": "object", + "description": "The Google Compute Engine metadata entries to add to all instances.", + "additionalProperties": { + "type": "string" + } } } }, @@ -407,6 +363,13 @@ "imageVersion": { "type": "string", "description": "[Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified it will default to latest version." + }, + "properties": { + "type": "object", + "description": "[Optional] The properties to set on daemon configuration files. Property keys are specified in \"prefix:property\" format, such as \"core:fs.defaultFS\". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf", + "additionalProperties": { + "type": "string" + } } } }, @@ -1134,439 +1097,82 @@ "type": "object", "description": "The request message for Operations.CancelOperation." }, - "LeaseTasksRequest": { - "id": "LeaseTasksRequest", + "Empty": { + "id": "Empty", "type": "object", - "description": "A request to lease tasks for execution by an agent.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`." + }, + "DiagnoseClusterResults": { + "id": "DiagnoseClusterResults", + "type": "object", + "description": "The location of diagnostic output.", "properties": { - "agentId": { + "outputUri": { "type": "string", - "description": "The agent's id." - }, - "requestedLeaseDuration": { - "type": "string", - "description": "The requested initial lease period." - }, - "currentAgentTime": { - "type": "string", - "description": "The current timestamp at the worker." + "description": "[Output-only] The Google Cloud Storage URI of the diagnostic output. This is a plain text file with a summary of collected diagnostics." } } }, - "LeaseTasksResponse": { - "id": "LeaseTasksResponse", + "ClusterOperationMetadata": { + "id": "ClusterOperationMetadata", "type": "object", - "description": "A Response for task leasing.", + "description": "Metadata describing the operation.", "properties": { - "tasks": { - "type": "array", - "description": "A list of tasks that have been leased.", - "items": { - "$ref": "Task" - } - }, - "leaseExpirationTime": { + "clusterName": { "type": "string", - "description": "The worker-local lease expiration time." + "description": "Name of the cluster for the operation." }, - "reportStatusInterval": { + "clusterUuid": { "type": "string", - "description": "The interval at which status should be reported." - } - } - }, - "Task": { - "id": "Task", - "type": "object", - "description": "A single Task for agent execution. A task in Cloud Dataproc is a unit of work originating with the Cloud Dataproc service and intended for execution on a Cloud Dataproc agent. The most straightforward example of a Task in Cloud Dataproc is one corresponding to an end-user originated Job. This task is then allocated to an available agent for execution. Other examples of Cloud Dataproc Tasks could include executing system-maintenance scripts, periodic agent upgrades, etc. Using the example of a Task corresponding to a Job, the flow through Cloud Dataproc will appear as: - The end-user submits a Job to Cloud Dataproc for execution. - The Cloud Dataproc service determines the best Cluster to execute the Job on and creates a Task for the job. - An agent polls Cloud Dataproc for outstanding Tasks via the LeaseTasks method and the Task created in step 2 is provided to the agent. - During execution of the Task, the agent updates the Task status via the ReportTaskStatus method. - Upon completion of a Task, the agent will finally ReportTaskStatus with a TaskStatus indicating the status of the driver application's exit status. - The Cloud Dataproc service updates the status of the user-submitted Job using the Task status reported by the agent.", - "properties": { - "taskId": { - "type": "string", - "description": "System defined task id." - }, - "configuration": { - "$ref": "TaskConfiguration", - "description": "Configuration for this task." + "description": "Cluster UUId for the operation." }, "status": { - "$ref": "TaskStatus", - "description": "The status of a task." + "$ref": "ClusterOperationStatus", + "description": "[Output-only] Current operation status." + }, + "statusHistory": { + "type": "array", + "description": "[Output-only] The previous operation status.", + "items": { + "$ref": "ClusterOperationStatus" + } + }, + "operationType": { + "type": "string", + "description": "[Output-only] The operation type." + }, + "description": { + "type": "string", + "description": "[Output-only] Short description of operation." } } }, - "TaskConfiguration": { - "id": "TaskConfiguration", + "ClusterOperationStatus": { + "id": "ClusterOperationStatus", "type": "object", - "description": "Configuration for a Dataproc Task.", - "properties": { - "jobConfiguration": { - "$ref": "TaskJobConfiguration", - "description": "Configuration of a Job-based task." - }, - "clusterConfiguration": { - "$ref": "TaskClusterConfiguration", - "description": "Cluster reconfiguration task." - }, - "maintenanceCommand": { - "$ref": "TaskMaintenanceCommand", - "description": "Execute cluster maintenance command." - } - } - }, - "TaskJobConfiguration": { - "id": "TaskJobConfiguration", - "type": "object", - "description": "A task corresponding to a single job execution request.", - "properties": { - "type": { - "type": "string", - "description": "The type of the job.", - "enum": [ - "TYPE_UNSPECIFIED", - "HADOOP", - "SPARK", - "PYSPARK", - "HIVE", - "PIG", - "SPARK_SQL" - ] - }, - "submittedBy": { - "type": "string", - "description": "The user that the job should be attributed to in Hadoop as a posix-style username. If the user is not a member of the system's user-database, the task will be started as a system account." - }, - "properties": { - "type": "object", - "description": "Properties for the submitted job.", - "additionalProperties": { - "type": "string" - } - }, - "jarFileUris": { - "type": "array", - "description": "JAR files that are required by the job.", - "items": { - "type": "string" - } - }, - "loggingConfiguration": { - "$ref": "TaskLoggingConfiguration", - "description": "Logging configuration for the job." - }, - "driverOutputUri": { - "type": "string", - "description": "Output URI for driver output." - }, - "driverInputUri": { - "type": "string", - "description": "[Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive." - }, - "driverControlFilesUri": { - "type": "string", - "description": "[Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri." - }, - "interactive": { - "type": "boolean", - "description": "[Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver." - }, - "args": { - "type": "array", - "description": "Arguments for the driver program. Used by Hadoop, Spark, and PySpark jobs.", - "items": { - "type": "string" - } - }, - "fileUris": { - "type": "array", - "description": "Required files for the driver program or distributed program. Used by Hadoop, Spark, and PySpark jobs.", - "items": { - "type": "string" - } - }, - "archiveUris": { - "type": "array", - "description": "Required archives for the driver program or distributed program. Used by Hadoop, Spark, and PySpark jobs.", - "items": { - "type": "string" - } - }, - "mainJarFileUri": { - "type": "string", - "description": "A JAR containing the main driver and containing a METADATA entry for a main class contained within the jar." - }, - "mainClass": { - "type": "string", - "description": "A class name that is contained either in core Hadoop or Spark libraries or within a JAR specified within jar_file_uris." - }, - "mainPythonFileUri": { - "type": "string", - "description": "The main Python file for a PySpark application." - }, - "pythonFileUris": { - "type": "array", - "description": "URIs of files required by the PySpark application", - "items": { - "type": "string" - } - }, - "queryFileUri": { - "type": "string", - "description": "A URI of a file containing queries" - }, - "queryList": { - "$ref": "TaskQueryList", - "description": "A list of queries specified within the API." - }, - "continueOnFailure": { - "type": "boolean", - "description": "True to continue processing pig or hive queries if an earlier query fails." - }, - "scriptVariables": { - "type": "object", - "description": "Variables to be substituted in Pig and Hive scripts.", - "additionalProperties": { - "type": "string" - } - } - } - }, - "TaskLoggingConfiguration": { - "id": "TaskLoggingConfiguration", - "type": "object", - "description": "Logging configuration for the task.", - "properties": { - "logLevels": { - "type": "object", - "description": "Map of logger name to log4j log level.", - "additionalProperties": { - "type": "string", - "enum": [ - "LEVEL_UNSPECIFIED", - "ALL", - "TRACE", - "DEBUG", - "INFO", - "WARN", - "ERROR", - "FATAL", - "OFF" - ] - } - } - } - }, - "TaskQueryList": { - "id": "TaskQueryList", - "type": "object", - "description": "A list of queries to execute as part of the task.", - "properties": { - "queries": { - "type": "array", - "description": "The queries to execute. The format of the queries is task-type dependent, but in each case each query should be executed within its own invocation of the interpreter for that task type.", - "items": { - "type": "string" - } - } - } - }, - "TaskClusterConfiguration": { - "id": "TaskClusterConfiguration", - "type": "object", - "description": "A system task corresponding to a request for Master node to update configuration based on provided values.", - "properties": { - "type": { - "type": "string", - "description": "Type of configuration change.", - "enum": [ - "TYPE_UNSPECIFIED", - "TYPE_CLUSTER_MEMBERSHIP_CHANGE" - ] - }, - "addMembers": { - "type": "array", - "description": "New nodes to register with cluster.", - "items": { - "type": "string" - } - }, - "removeMembers": { - "type": "array", - "description": "Existing nodes to decommission.", - "items": { - "type": "string" - } - } - } - }, - "TaskMaintenanceCommand": { - "id": "TaskMaintenanceCommand", - "type": "object", - "description": "A system task corresponding to a request to run a maintenance command on targeted agent.", - "properties": { - "gcsUri": { - "type": "string", - "description": "The executable is stored on GCS." - }, - "localPath": { - "type": "string", - "description": "The executable is a file on agent." - }, - "args": { - "type": "array", - "description": "Arguments to pass to the script.", - "items": { - "type": "string" - } - }, - "environment": { - "type": "object", - "description": "The environment variables.", - "additionalProperties": { - "type": "string" - } - }, - "scriptOutputUri": { - "type": "string", - "description": "The GCS URI where executable output will be stored." - } - } - }, - "TaskStatus": { - "id": "TaskStatus", - "type": "object", - "description": "Status for a single Task.", - "properties": { - "jobStatus": { - "$ref": "TaskJobStatus", - "description": "The status of the Job." - }, - "systemTaskStatus": { - "$ref": "SystemTaskStatus", - "description": "The status of the SystemTask." - } - } - }, - "TaskJobStatus": { - "id": "TaskJobStatus", - "type": "object", - "description": "Status of a single job-based task.", - "properties": { - "yarnApplications": { - "type": "array", - "description": "A list of YARN applications that have been launched for this task.", - "items": { - "$ref": "TaskYarnApplication" - } - }, - "driverExitCode": { - "type": "integer", - "description": "If the driver has exited, its exit code.", - "format": "int32" - }, - "driverState": { - "type": "string", - "description": "The state of the driver.", - "enum": [ - "DRIVER_STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "KILL_PENDING", - "KILLED", - "FINISHED", - "FAILED" - ] - } - } - }, - "TaskYarnApplication": { - "id": "TaskYarnApplication", - "type": "object", - "description": "YARN applications that have been associated with a task.", - "properties": { - "name": { - "type": "string", - "description": "YARN application name." - }, - "id": { - "type": "integer", - "description": "YARN application id.", - "format": "int32" - }, - "state": { - "type": "string", - "description": "The state of the YARN application.", - "enum": [ - "STATE_UNSPECIFIED", - "NEW", - "NEW_SAVING", - "SUBMITTED", - "ACCEPTED", - "RUNNING", - "FINISHED", - "FAILED", - "KILLED" - ] - }, - "progress": { - "type": "number", - "description": "The progress of the YARN application.", - "format": "float" - }, - "trackingUrl": { - "type": "string", - "description": "The tracking URL for the YARN application. This URL may or may not be accessible from outside the cluster." - } - } - }, - "SystemTaskStatus": { - "id": "SystemTaskStatus", - "type": "object", - "description": "Status of cluster configuration task.", + "description": "The status of the operation.", "properties": { "state": { "type": "string", - "description": "The outcome of reconfiguration.", + "description": "A message containing the operation state.", "enum": [ - "STATE_UNSPECIFIED", + "UNKNOWN", "PENDING", "RUNNING", - "FINISHED", - "FAILED" + "DONE" ] - } - } - }, - "ReportTaskStatusRequest": { - "id": "ReportTaskStatusRequest", - "type": "object", - "description": "A request to report task status, which may result in the corresponding lease being extended.", - "properties": { - "agentId": { - "type": "string", - "description": "The id of the agent reporting task status." }, - "currentWorkerTime": { + "innerState": { "type": "string", - "description": "The current timestamp at the worker." + "description": "A message containing the detailed operation state." }, - "status": { - "$ref": "TaskStatus", - "description": "Status for a single task." - } - } - }, - "ReportTaskStatusResponse": { - "id": "ReportTaskStatusResponse", - "type": "object", - "description": "A response to a task status report.", - "properties": { - "leaseExpirationTime": { + "details": { "type": "string", - "description": "New task lease expiration timestamp in worker-local time." + "description": "A message containing any operation metadata details." }, - "reportStatusInterval": { + "stateStartTime": { "type": "string", - "description": "The interval at which status should be reported." + "description": "The time this state was entered." } } }, @@ -1634,6 +1240,14 @@ "items": { "$ref": "OperationStatus" } + }, + "operationType": { + "type": "string", + "description": "[Output-only] The operation type." + }, + "description": { + "type": "string", + "description": "[Output-only] Short description of operation." } } }, @@ -1670,587 +1284,355 @@ "resources": { "projects": { "resources": { - "clusters": { - "methods": { - "create": { - "id": "dataproc.projects.clusters.create", - "path": "v1alpha1/projects/{projectId}/clusters", - "httpMethod": "POST", - "description": "Request to create a cluster in a project.", - "parameters": { - "projectId": { - "type": "string", - "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "Cluster" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "id": "dataproc.projects.clusters.patch", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterName}", - "httpMethod": "PATCH", - "description": "Request to update a cluster in a project.", - "parameters": { - "projectId": { - "type": "string", - "description": "[Required] The ID of the Google Cloud Platform project the cluster belongs to.", - "required": true, - "location": "path" - }, - "clusterName": { - "type": "string", - "description": "[Required] The cluster name.", - "required": true, - "location": "path" - }, - "updateMask": { - "type": "string", - "description": "[Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as \"configuration.worker_configuration.num_instances,\" and the PATCH request body would specify the new value, as follows: { \"configuration\":{ \"workerConfiguration\":{ \"numInstances\":\"5\" } } } Note: Currently, configuration.worker_configuration.num_instances is the only field that can be updated.", - "location": "query" - } - }, - "parameterOrder": [ - "projectId", - "clusterName" - ], - "request": { - "$ref": "Cluster" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "id": "dataproc.projects.clusters.delete", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterName}", - "httpMethod": "DELETE", - "description": "Request to delete a cluster in a project.", - "parameters": { - "projectId": { - "type": "string", - "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "location": "path" - }, - "clusterName": { - "type": "string", - "description": "[Required] The cluster name.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "clusterName" - ], - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "id": "dataproc.projects.clusters.get", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterName}", - "httpMethod": "GET", - "description": "Request to get the resource representation for a cluster in a project.", - "parameters": { - "projectId": { - "type": "string", - "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "location": "path" - }, - "clusterName": { - "type": "string", - "description": "[Required] The cluster name.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "clusterName" - ], - "response": { - "$ref": "Cluster" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "id": "dataproc.projects.clusters.list", - "path": "v1alpha1/projects/{projectId}/clusters", - "httpMethod": "GET", - "description": "Request a list of all clusters in a project.", - "parameters": { - "projectId": { - "type": "string", - "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "location": "path" - }, - "pageSize": { - "type": "integer", - "description": "The standard List page size.", - "format": "int32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The standard List page token.", - "location": "query" - } - }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "ListClustersResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, + "regions": { "resources": { - "agents": { + "clusters": { "methods": { "create": { - "id": "dataproc.projects.clusters.agents.create", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterUuid}/agents/{agentId}", - "httpMethod": "PUT", - "description": "Add a new agent to Dataproc's view of a cluster. This is the first Dataproc method that an agent should invoke after starting. If an agent has already been created with the given agent_id within the same cluster, this method will return a Conflict status code and the agent is expected to call GetAgent to retrieve the last registration and subsequently call UpdateAgent, if required.", + "id": "dataproc.projects.regions.clusters.create", + "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters", + "httpMethod": "POST", + "description": "Request to create a cluster in a project.", "parameters": { "projectId": { "type": "string", - "description": "Project ID that this agent is associated with", + "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", "required": true, "location": "path" }, - "clusterUuid": { + "region": { "type": "string", - "description": "Cluster that this agent is associated with", - "required": true, - "location": "path" - }, - "agentId": { - "type": "string", - "description": "[Required] Agent ID being registered.", + "description": "[Required] The Dataproc region in which to handle the request.", "required": true, "location": "path" } }, "parameterOrder": [ "projectId", - "clusterUuid", - "agentId" + "region" ], "request": { - "$ref": "Agent" + "$ref": "Cluster" }, "response": { - "$ref": "Agent" + "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read", - "https://www.googleapis.com/auth/logging.write" + "https://www.googleapis.com/auth/cloud-platform" ] }, - "update": { - "id": "dataproc.projects.clusters.agents.update", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterUuid}/agents/{agentId}", - "httpMethod": "PUT", - "description": "Update Dataproc's view of an agent. This is currently used to provide a is_healthy bit, but is expected to be extended to include daemon information and VM metrics for inclusion in cloud metrics.", + "patch": { + "id": "dataproc.projects.regions.clusters.patch", + "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "httpMethod": "PATCH", + "description": "Request to update a cluster in a project.", "parameters": { "projectId": { "type": "string", - "description": "The agent's project.", + "description": "[Required] The ID of the Google Cloud Platform project the cluster belongs to.", "required": true, "location": "path" }, - "clusterUuid": { + "region": { "type": "string", - "description": "The cluster on which the agent is running.", + "description": "[Required] The Dataproc region in which to handle the request.", "required": true, "location": "path" }, - "agentId": { + "clusterName": { "type": "string", - "description": "[Required] ID of agent sending the update.", + "description": "[Required] The cluster name.", + "required": true, + "location": "path" + }, + "updateMask": { + "type": "string", + "description": "[Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as \"configuration.worker_configuration.num_instances,\" and the PATCH request body would specify the new value, as follows: { \"configuration\":{ \"workerConfiguration\":{ \"numInstances\":\"5\" } } } Note: Currently, configuration.worker_configuration.num_instances is the only field that can be updated.", + "location": "query" + } + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "id": "dataproc.projects.regions.clusters.delete", + "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "httpMethod": "DELETE", + "description": "Request to delete a cluster in a project.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "clusterName": { + "type": "string", + "description": "[Required] The cluster name.", "required": true, "location": "path" } }, "parameterOrder": [ "projectId", - "clusterUuid", - "agentId" + "region", + "clusterName" ], - "request": { - "$ref": "Agent" - }, "response": { - "$ref": "Agent" + "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read", - "https://www.googleapis.com/auth/logging.write" + "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "id": "dataproc.projects.clusters.agents.get", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterUuid}/agents/{agentId}", + "id": "dataproc.projects.regions.clusters.get", + "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}", "httpMethod": "GET", - "description": "Retrieve an agent.", + "description": "Request to get the resource representation for a cluster in a project.", "parameters": { "projectId": { "type": "string", - "description": "The agent's project ID.", + "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", "required": true, "location": "path" }, - "clusterUuid": { + "region": { "type": "string", - "description": "The agent's cluster.", + "description": "[Required] The Dataproc region in which to handle the request.", "required": true, "location": "path" }, - "agentId": { + "clusterName": { "type": "string", - "description": "The agent's ID.", + "description": "[Required] The cluster name.", "required": true, "location": "path" } }, "parameterOrder": [ "projectId", - "clusterUuid", - "agentId" + "region", + "clusterName" ], "response": { - "$ref": "Agent" + "$ref": "Cluster" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read", - "https://www.googleapis.com/auth/logging.write" + "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "id": "dataproc.projects.clusters.agents.list", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterUuid}/agents", + "id": "dataproc.projects.regions.clusters.list", + "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters", "httpMethod": "GET", - "description": "List all agents Dataproc is aware of within a cluster.", + "description": "Request a list of all regions/{region}/clusters in a project.", "parameters": { "projectId": { "type": "string", - "description": "The project from which to list agents.", + "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", "required": true, "location": "path" }, - "clusterUuid": { + "region": { "type": "string", - "description": "The cluster from which to list agents.", + "description": "[Required] The Dataproc region in which to handle the request.", "required": true, "location": "path" }, "pageSize": { "type": "integer", - "description": "Requested page size for listing.", + "description": "The standard List page size.", "format": "int32", "location": "query" }, "pageToken": { "type": "string", - "description": "Page continuation token.", + "description": "The standard List page token.", "location": "query" } }, "parameterOrder": [ "projectId", - "clusterUuid" + "region" ], "response": { - "$ref": "ListAgentsResponse" + "$ref": "ListClustersResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read", - "https://www.googleapis.com/auth/logging.write" + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "jobs": { + "methods": { + "submit": { + "id": "dataproc.projects.regions.jobs.submit", + "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs:submit", + "httpMethod": "POST", + "description": "Submits a job to a cluster.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Dataproc region in which to handle the request.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region" + ], + "request": { + "$ref": "SubmitJobRequest" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "id": "dataproc.projects.regions.jobs.get", + "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "httpMethod": "GET", + "description": "Gets the resource representation for a job in a project.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "jobId": { + "type": "string", + "description": "[Required] The job ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cancel": { + "id": "dataproc.projects.regions.jobs.cancel", + "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", + "httpMethod": "POST", + "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get.", + "parameters": { + "projectId": { + "type": "string", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "location": "path" + }, + "region": { + "type": "string", + "description": "[Required] The Dataproc region in which to handle the request.", + "required": true, + "location": "path" + }, + "jobId": { + "type": "string", + "description": "[Required] The job ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "request": { + "$ref": "CancelJobRequest" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "id": "dataproc.projects.clusters.agents.delete", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterUuid}/agents/{agentId}", + "id": "dataproc.projects.regions.jobs.delete", + "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}", "httpMethod": "DELETE", - "description": "Delete an agent from Dataproc's view of a cluster. Deleting an agent is not required, but could be used in a shutdown sequence to indicate to Dataproc that the agent is to be considered dead and all agent-owned resources and tasks are free to be re-distributed.", + "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.", "parameters": { "projectId": { "type": "string", - "description": "The agent's project.", + "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", "required": true, "location": "path" }, - "clusterUuid": { + "region": { "type": "string", - "description": "The agent's cluster.", + "description": "[Required] The Dataproc region in which to handle the request.", "required": true, "location": "path" }, - "agentId": { + "jobId": { "type": "string", - "description": "The agent.", + "description": "[Required] The job ID.", "required": true, "location": "path" } }, "parameterOrder": [ "projectId", - "clusterUuid", - "agentId" + "region", + "jobId" ], "response": { - "$ref": "Empty" + "$ref": "Job" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read", - "https://www.googleapis.com/auth/logging.write" + "https://www.googleapis.com/auth/cloud-platform" ] } } - }, - "tasks": { - "methods": { - "lease": { - "id": "dataproc.projects.clusters.tasks.lease", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterUuid}/tasks:lease", - "httpMethod": "POST", - "description": "Obtain a lease on one or more tasks. Any given task may be in any state and each agent is expected to start any non-started tasks and to monitor any YarnApplications spawned by any already running tasks. It's expected that monitoring previously launched tasks will be more prevalent when drivers are run entirely within YARN containers. While there's a single lease expiration time, in the event of multiple tasks being leased to the agent in a single call, each task has a unique lease and status must be reported before the lease times out or the task can be considered orphaned. The service will determine how many tasks to lease to agents in a single call.", - "parameters": { - "projectId": { - "type": "string", - "description": "The project id of the agent.", - "required": true, - "location": "path" - }, - "clusterUuid": { - "type": "string", - "description": "The cluster id of the agent.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "clusterUuid" - ], - "request": { - "$ref": "LeaseTasksRequest" - }, - "response": { - "$ref": "LeaseTasksResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read", - "https://www.googleapis.com/auth/logging.write" - ] - }, - "report": { - "id": "dataproc.projects.clusters.tasks.report", - "path": "v1alpha1/projects/{projectId}/clusters/{clusterUuid}/tasks/{taskId}:report", - "httpMethod": "POST", - "description": "Report status for a task and extend the lease provided for the task.", - "parameters": { - "projectId": { - "type": "string", - "description": "The project id of the agent.", - "required": true, - "location": "path" - }, - "clusterUuid": { - "type": "string", - "description": "The cluster id of the agent.", - "required": true, - "location": "path" - }, - "taskId": { - "type": "string", - "description": "The task that is being reported on.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "clusterUuid", - "taskId" - ], - "request": { - "$ref": "ReportTaskStatusRequest" - }, - "response": { - "$ref": "ReportTaskStatusResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read", - "https://www.googleapis.com/auth/logging.write" - ] - } - } - } - } - }, - "jobs": { - "methods": { - "submit": { - "id": "dataproc.projects.jobs.submit", - "path": "v1alpha1/projects/{projectId}/jobs:submit", - "httpMethod": "POST", - "description": "Submits a job to a cluster.", - "parameters": { - "projectId": { - "type": "string", - "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "SubmitJobRequest" - }, - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "id": "dataproc.projects.jobs.get", - "path": "v1alpha1/projects/{projectId}/jobs/{jobId}", - "httpMethod": "GET", - "description": "Gets the resource representation for a job in a project.", - "parameters": { - "projectId": { - "type": "string", - "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "location": "path" - }, - "jobId": { - "type": "string", - "description": "[Required] The job ID.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "cancel": { - "id": "dataproc.projects.jobs.cancel", - "path": "v1alpha1/projects/{projectId}/jobs/{jobId}:cancel", - "httpMethod": "POST", - "description": "Starts a job cancellation request. To access the job resource after cancellation, call jobs:list or jobs:get.", - "parameters": { - "projectId": { - "type": "string", - "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "location": "path" - }, - "jobId": { - "type": "string", - "description": "[Required] The job ID.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "request": { - "$ref": "CancelJobRequest" - }, - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "id": "dataproc.projects.jobs.delete", - "path": "v1alpha1/projects/{projectId}/jobs/{jobId}", - "httpMethod": "DELETE", - "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.", - "parameters": { - "projectId": { - "type": "string", - "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "location": "path" - }, - "jobId": { - "type": "string", - "description": "[Required] The job ID.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } } diff --git a/etc/api/dataproc/v1beta1/dataproc-api.json b/etc/api/dataproc/v1beta1/dataproc-api.json index dfd8c8657b..5a3c5c648f 100644 --- a/etc/api/dataproc/v1beta1/dataproc-api.json +++ b/etc/api/dataproc/v1beta1/dataproc-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/J2wq1WcZfpjeQfZa1hSleFHi_7g\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/moJSD8ChiA3_GeWvn2rNFBXMhlQ\"", "discoveryVersion": "v1", "id": "dataproc:v1beta1", "name": "dataproc", "version": "v1beta1", - "revision": "20151209", + "revision": "20160219", "title": "Google Cloud Dataproc API", "description": "An API for managing Hadoop-based clusters and jobs on Google Cloud Platform.", "ownerDomain": "google.com", @@ -189,11 +189,15 @@ "properties": { "zoneUri": { "type": "string", - "description": "[Required] The zone where the Google Compute Engine cluster will be located. Example: `compute.googleapis.com/projects/[project_id]/zones/us-east1-a`." + "description": "[Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`." }, "networkUri": { "type": "string", - "description": "The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example: `compute.googleapis.com/projects/[project_id]/zones/us-east1-a/default`." + "description": "The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`." + }, + "subnetworkUri": { + "type": "string", + "description": "The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`." }, "serviceAccountScopes": { "type": "array", @@ -201,6 +205,20 @@ "items": { "type": "string" } + }, + "tags": { + "type": "array", + "description": "The Google Compute Engine tags to add to all instances.", + "items": { + "type": "string" + } + }, + "metadata": { + "type": "object", + "description": "The Google Compute Engine metadata entries to add to all instances.", + "additionalProperties": { + "type": "string" + } } } }, @@ -223,11 +241,11 @@ }, "imageUri": { "type": "string", - "description": "[Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`. Example: `compute.googleapis.com/projects/debian-cloud/global/images/backports-debian-7-wheezy-v20140904`." + "description": "[Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`." }, "machineTypeUri": { "type": "string", - "description": "The Google Compute Engine machine type used for cluster instances. Example: `compute.googleapis.com/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`." + "description": "The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`." }, "diskConfiguration": { "$ref": "DiskConfiguration", @@ -283,6 +301,13 @@ "imageVersion": { "type": "string", "description": "[Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning))." + }, + "properties": { + "type": "object", + "description": "[Optional] The properties to set on daemon configuration files. Property keys are specified in \"prefix:property\" format, such as \"core:fs.defaultFS\". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf", + "additionalProperties": { + "type": "string" + } } } }, @@ -335,7 +360,7 @@ "properties": { "name": { "type": "string", - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`." + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`." }, "metadata": { "type": "object", @@ -975,6 +1000,161 @@ "type": "object", "description": "The request message for Operations.CancelOperation." }, + "SetIamPolicyRequest": { + "id": "SetIamPolicyRequest", + "type": "object", + "description": "Request message for `SetIamPolicy` method.", + "properties": { + "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 a valid policy but certain Cloud Platform services (such as Projects) might reject them." + } + } + }, + "Policy": { + "id": "Policy", + "type": "object", + "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).", + "properties": { + "version": { + "type": "integer", + "description": "Version of the `Policy`. The default version is 0.", + "format": "int32" + }, + "bindings": { + "type": "array", + "description": "Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.", + "items": { + "$ref": "Binding" + } + }, + "etag": { + "type": "string", + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.", + "format": "byte" + } + } + }, + "Binding": { + "id": "Binding", + "type": "object", + "description": "Associates `members` with a `role`.", + "properties": { + "role": { + "type": "string", + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required" + }, + "members": { + "type": "array", + "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.", + "items": { + "type": "string" + } + } + } + }, + "TestIamPermissionsRequest": { + "id": "TestIamPermissionsRequest", + "type": "object", + "description": "Request message for `TestIamPermissions` method.", + "properties": { + "permissions": { + "type": "array", + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.", + "items": { + "type": "string" + } + } + } + }, + "TestIamPermissionsResponse": { + "id": "TestIamPermissionsResponse", + "type": "object", + "description": "Response message for `TestIamPermissions` method.", + "properties": { + "permissions": { + "type": "array", + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + } + } + } + }, + "DiagnoseClusterResults": { + "id": "DiagnoseClusterResults", + "type": "object", + "description": "The location of diagnostic output.", + "properties": { + "outputUri": { + "type": "string", + "description": "[Output-only] The Google Cloud Storage URI of the diagnostic output. This is a plain text file with a summary of collected diagnostics." + } + } + }, + "ClusterOperationMetadata": { + "id": "ClusterOperationMetadata", + "type": "object", + "description": "Metadata describing the operation.", + "properties": { + "clusterName": { + "type": "string", + "description": "Name of the cluster for the operation." + }, + "clusterUuid": { + "type": "string", + "description": "Cluster UUId for the operation." + }, + "status": { + "$ref": "ClusterOperationStatus", + "description": "[Output-only] Current operation status." + }, + "statusHistory": { + "type": "array", + "description": "[Output-only] The previous operation status.", + "items": { + "$ref": "ClusterOperationStatus" + } + }, + "operationType": { + "type": "string", + "description": "[Output-only] The operation type." + }, + "description": { + "type": "string", + "description": "[Output-only] Short description of operation." + } + } + }, + "ClusterOperationStatus": { + "id": "ClusterOperationStatus", + "type": "object", + "description": "The status of the operation.", + "properties": { + "state": { + "type": "string", + "description": "A message containing the operation state.", + "enum": [ + "UNKNOWN", + "PENDING", + "RUNNING", + "DONE" + ] + }, + "innerState": { + "type": "string", + "description": "A message containing the detailed operation state." + }, + "details": { + "type": "string", + "description": "A message containing any operation metadata details." + }, + "stateStartTime": { + "type": "string", + "description": "The time this state was entered." + } + } + }, "DiagnoseClusterOutputLocation": { "id": "DiagnoseClusterOutputLocation", "type": "object", @@ -1039,6 +1219,14 @@ "items": { "$ref": "OperationStatus" } + }, + "operationType": { + "type": "string", + "description": "[Output-only] The operation type." + }, + "description": { + "type": "string", + "description": "[Output-only] Short description of operation." } } }, @@ -1267,6 +1455,84 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setIamPolicy": { + "id": "dataproc.projects.clusters.setIamPolicy", + "path": "v1beta1/{+resource}:setIamPolicy", + "httpMethod": "POST", + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "parameters": { + "resource": { + "type": "string", + "description": "REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation.", + "required": true, + "pattern": "^projects/[^/]*/clusters/[^/]*$", + "location": "path" + } + }, + "parameterOrder": [ + "resource" + ], + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "id": "dataproc.projects.clusters.getIamPolicy", + "path": "v1beta1/{+resource}:getIamPolicy", + "httpMethod": "GET", + "description": "Gets the access control policy for a `resource`. Returns an empty policy if the resource exists and does not have a policy set.", + "parameters": { + "resource": { + "type": "string", + "description": "REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation.", + "required": true, + "pattern": "^projects/[^/]*/clusters/[^/]*$", + "location": "path" + } + }, + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "id": "dataproc.projects.clusters.testIamPermissions", + "path": "v1beta1/{+resource}:testIamPermissions", + "httpMethod": "POST", + "description": "Returns permissions that a caller has on the specified resource.", + "parameters": { + "resource": { + "type": "string", + "description": "REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation.", + "required": true, + "pattern": "^projects/[^/]*/clusters/[^/]*$", + "location": "path" + } + }, + "parameterOrder": [ + "resource" + ], + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -1439,6 +1705,84 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setIamPolicy": { + "id": "dataproc.projects.jobs.setIamPolicy", + "path": "v1beta1/{+resource}:setIamPolicy", + "httpMethod": "POST", + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "parameters": { + "resource": { + "type": "string", + "description": "REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation.", + "required": true, + "pattern": "^projects/[^/]*/jobs/[^/]*$", + "location": "path" + } + }, + "parameterOrder": [ + "resource" + ], + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "id": "dataproc.projects.jobs.getIamPolicy", + "path": "v1beta1/{+resource}:getIamPolicy", + "httpMethod": "GET", + "description": "Gets the access control policy for a `resource`. Returns an empty policy if the resource exists and does not have a policy set.", + "parameters": { + "resource": { + "type": "string", + "description": "REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation.", + "required": true, + "pattern": "^projects/[^/]*/jobs/[^/]*$", + "location": "path" + } + }, + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "id": "dataproc.projects.jobs.testIamPermissions", + "path": "v1beta1/{+resource}:testIamPermissions", + "httpMethod": "POST", + "description": "Returns permissions that a caller has on the specified resource.", + "parameters": { + "resource": { + "type": "string", + "description": "REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation.", + "required": true, + "pattern": "^projects/[^/]*/jobs/[^/]*$", + "location": "path" + } + }, + "parameterOrder": [ + "resource" + ], + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } diff --git a/etc/api/datastore/v1beta1/datastore-api.json b/etc/api/datastore/v1beta1/datastore-api.json index 59adba7f7f..3fb2642f07 100644 --- a/etc/api/datastore/v1beta1/datastore-api.json +++ b/etc/api/datastore/v1beta1/datastore-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/avoIk7N5NlV3bIlP2LkIXrAkC1A\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/F1n0tGKyLEWuABrjDmlIJRood2Q\"", "discoveryVersion": "v1", "id": "datastore:v1beta1", "name": "datastore", diff --git a/etc/api/datastore/v1beta2/datastore-api.json b/etc/api/datastore/v1beta2/datastore-api.json index 7cb13b9c99..a06d55e1e2 100644 --- a/etc/api/datastore/v1beta2/datastore-api.json +++ b/etc/api/datastore/v1beta2/datastore-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/BuUnnmmfSCMrHjYsSuIYwdFRxJ0\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/KQuWIZOSktBy7VDkAXC6BX3U2II\"", "discoveryVersion": "v1", "id": "datastore:v1beta2", "name": "datastore", diff --git a/etc/api/deploymentmanager/v2/deploymentmanager-api.json b/etc/api/deploymentmanager/v2/deploymentmanager-api.json index 58096201ff..b896379447 100644 --- a/etc/api/deploymentmanager/v2/deploymentmanager-api.json +++ b/etc/api/deploymentmanager/v2/deploymentmanager-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/cV3LW8Gmmk27SrA3CO5zY7f6Svg\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/8TFRfN8VgEkdF-90uBpiqAh_lBs\"", "discoveryVersion": "v1", "id": "deploymentmanager:v2", "name": "deploymentmanager", "canonicalName": "Deployment Manager", "version": "v2", - "revision": "20160125", + "revision": "20160201", "title": "Google Cloud Deployment Manager API", "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.", "ownerDomain": "google.com", @@ -120,6 +120,13 @@ "type": "string", "description": "[Output Only] Timestamp when the deployment was created, in RFC3339 text format ." }, + "labels": { + "type": "array", + "description": "Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?", + "items": { + "$ref": "DeploymentLabelEntry" + } + }, "manifest": { "type": "string", "description": "[Output Only] URL of the manifest representing the last manifest that was successfully deployed." @@ -142,17 +149,48 @@ } } }, + "DeploymentLabelEntry": { + "id": "DeploymentLabelEntry", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, "DeploymentUpdate": { "id": "DeploymentUpdate", "type": "object", "description": "", "properties": { + "labels": { + "type": "array", + "description": "[Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?", + "items": { + "$ref": "DeploymentUpdateLabelEntry" + } + }, "manifest": { "type": "string", "description": "[Output Only] URL of the manifest representing the update configuration of this deployment." } } }, + "DeploymentUpdateLabelEntry": { + "id": "DeploymentUpdateLabelEntry", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, "DeploymentsCancelPreviewRequest": { "id": "DeploymentsCancelPreviewRequest", "type": "object", diff --git a/etc/api/deploymentmanager/v2beta1/deploymentmanager-api.json b/etc/api/deploymentmanager/v2beta1/deploymentmanager-api.json index a1bb328d8a..56d19d5ba0 100644 --- a/etc/api/deploymentmanager/v2beta1/deploymentmanager-api.json +++ b/etc/api/deploymentmanager/v2beta1/deploymentmanager-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/FE8nbIMsA5QcLhFpvd5sWPsVRvs\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/v4bqID14mRMRpA4ym4XJr8ttZt4\"", "discoveryVersion": "v1", "id": "deploymentmanager:v2beta1", "name": "deploymentmanager", "version": "v2beta1", - "revision": "20160125", + "revision": "20160201", "title": "Google Cloud Deployment Manager API", "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.", "ownerDomain": "google.com", diff --git a/etc/api/deploymentmanager/v2beta2/deploymentmanager-api.json b/etc/api/deploymentmanager/v2beta2/deploymentmanager-api.json index 93eed42a75..9d11befd4a 100644 --- a/etc/api/deploymentmanager/v2beta2/deploymentmanager-api.json +++ b/etc/api/deploymentmanager/v2beta2/deploymentmanager-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/kDPoIRH1Fo2Zsyk2-I_71-6-8Gs\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/f122ll1O98XRh59Nz3NdMmHQpeM\"", "discoveryVersion": "v1", "id": "deploymentmanager:v2beta2", "name": "deploymentmanager", "canonicalName": "Deployment Manager", "version": "v2beta2", - "revision": "20160125", + "revision": "20160201", "title": "Google Cloud Deployment Manager API", "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.", "ownerDomain": "google.com", diff --git a/etc/api/dfareporting/v1.1/dfareporting-api.json b/etc/api/dfareporting/v1.1/dfareporting-api.json index 315010c4a9..fa80ab6114 100644 --- a/etc/api/dfareporting/v1.1/dfareporting-api.json +++ b/etc/api/dfareporting/v1.1/dfareporting-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/319esrA33JXryalLW73l3tVV_5c\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/NTg4Aipq2GpzigpSyM5LKh3VxPc\"", "discoveryVersion": "v1", "id": "dfareporting:v1.1", "name": "dfareporting", "version": "v1.1", - "revision": "20151109", + "revision": "20160128", "title": "DFA Reporting API", "description": "Lets you create, run and download reports.", "ownerDomain": "google.com", diff --git a/etc/api/dfareporting/v1.2/dfareporting-api.json b/etc/api/dfareporting/v1.2/dfareporting-api.json index 71a35c3e74..4f889271ef 100644 --- a/etc/api/dfareporting/v1.2/dfareporting-api.json +++ b/etc/api/dfareporting/v1.2/dfareporting-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/oOXyBUsFIx8_IsMbG4Q_9eLOGeQ\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1D6PF7mgkfgc8keSEkZ9h0N001k\"", "discoveryVersion": "v1", "id": "dfareporting:v1.2", "name": "dfareporting", "version": "v1.2", - "revision": "20151109", + "revision": "20160128", "title": "DFA Reporting API", "description": "Lets you create, run and download reports.", "ownerDomain": "google.com", diff --git a/etc/api/dfareporting/v1.3/dfareporting-api.json b/etc/api/dfareporting/v1.3/dfareporting-api.json index 9cdf000bb2..e42a10a185 100644 --- a/etc/api/dfareporting/v1.3/dfareporting-api.json +++ b/etc/api/dfareporting/v1.3/dfareporting-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/SzRZyeuU72AQNfR1pZCO9RUBOuo\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/thm1dQ41ieuipIFO1JuNS4--IpY\"", "discoveryVersion": "v1", "id": "dfareporting:v1.3", "name": "dfareporting", "version": "v1.3", - "revision": "20151109", + "revision": "20160128", "title": "DFA Reporting API", "description": "Lets you create, run and download reports.", "ownerDomain": "google.com", diff --git a/etc/api/dfareporting/v1/dfareporting-api.json b/etc/api/dfareporting/v1/dfareporting-api.json index 7aab27ce5d..1e38645959 100644 --- a/etc/api/dfareporting/v1/dfareporting-api.json +++ b/etc/api/dfareporting/v1/dfareporting-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/zqSZBPLxyXbOhmNNZzm1INM7-Vo\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1CHZrAT_Djr1VGV70ZNF2Qu82mY\"", "discoveryVersion": "v1", "id": "dfareporting:v1", "name": "dfareporting", "version": "v1", - "revision": "20151109", + "revision": "20160128", "title": "DFA Reporting API", "description": "Lets you create, run and download reports.", "ownerDomain": "google.com", diff --git a/etc/api/dfareporting/v2.0/dfareporting-api.json b/etc/api/dfareporting/v2.0/dfareporting-api.json index 15dd3d13e9..0777a2e82d 100644 --- a/etc/api/dfareporting/v2.0/dfareporting-api.json +++ b/etc/api/dfareporting/v2.0/dfareporting-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/bs3C4vbyO-4gQtoqcn1f7LTuR-s\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/C6xyLXx3qLxKuqaI4d4FbymlsJc\"", "discoveryVersion": "v1", "id": "dfareporting:v2.0", "name": "dfareporting", "version": "v2.0", - "revision": "20151109", + "revision": "20160128", "title": "DCM/DFA Reporting And Trafficking API", "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.", "ownerDomain": "google.com", @@ -149,7 +149,7 @@ }, "currencyId": { "type": "string", - "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB", + "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", "format": "int64" }, "defaultCreativeSizeId": { @@ -1643,9 +1643,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -2132,9 +2134,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -2906,9 +2910,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -3195,12 +3201,14 @@ "CLICK", "POST_CLICK", "POST_CLICK_AND_IMPRESSION", - "POST_IMPRESSION" + "POST_IMPRESSION", + "VIDEO_COMPLETION" ], "enumDescriptions": [ "", "", "", + "", "" ] } @@ -3735,7 +3743,7 @@ }, "currencyId": { "type": "string", - "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB", + "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", "format": "int64" }, "description": { @@ -7465,7 +7473,9 @@ "VIDEO_MIDPOINT", "VIDEO_MUTE", "VIDEO_PAUSE", + "VIDEO_PROGRESS", "VIDEO_REWIND", + "VIDEO_SKIP", "VIDEO_START", "VIDEO_STOP", "VIDEO_THIRD_QUARTILE" @@ -7487,6 +7497,8 @@ "", "", "", + "", + "", "" ] }, @@ -9702,6 +9714,7 @@ "OBJECT_MEDIA_ORDER", "OBJECT_PLACEMENT", "OBJECT_PLACEMENT_STRATEGY", + "OBJECT_PLAYSTORE_LINK", "OBJECT_PROVIDED_LIST_CLIENT", "OBJECT_RATE_CARD", "OBJECT_REMARKETING_LIST", @@ -9749,6 +9762,7 @@ "", "", "", + "", "" ], "location": "query" @@ -10200,7 +10214,7 @@ "accept": [ "*/*" ], - "maxSize": "100MB", + "maxSize": "1024MB", "protocols": { "simple": { "multipart": true, diff --git a/etc/api/dfareporting/v2.1/dfareporting-api.json b/etc/api/dfareporting/v2.1/dfareporting-api.json index 8a23d334bb..25b2596116 100644 --- a/etc/api/dfareporting/v2.1/dfareporting-api.json +++ b/etc/api/dfareporting/v2.1/dfareporting-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/UjhtDxTKK8jsw6gUmGvMSh2fbzI\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/zr8FQqQuZPkLoaFvaMhhChb5Bn0\"", "discoveryVersion": "v1", "id": "dfareporting:v2.1", "name": "dfareporting", "version": "v2.1", - "revision": "20151109", + "revision": "20160128", "title": "DCM/DFA Reporting And Trafficking API", "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.", "ownerDomain": "google.com", @@ -149,7 +149,7 @@ }, "currencyId": { "type": "string", - "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB", + "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", "format": "int64" }, "defaultCreativeSizeId": { @@ -1708,9 +1708,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -2201,9 +2203,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -2975,9 +2979,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -3264,12 +3270,14 @@ "CLICK", "POST_CLICK", "POST_CLICK_AND_IMPRESSION", - "POST_IMPRESSION" + "POST_IMPRESSION", + "VIDEO_COMPLETION" ], "enumDescriptions": [ "", "", "", + "", "" ] } @@ -3804,7 +3812,7 @@ }, "currencyId": { "type": "string", - "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB", + "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", "format": "int64" }, "description": { @@ -7214,13 +7222,25 @@ "type": "string", "description": "Product from which this remarketing list was originated.", "enum": [ + "REMARKETING_LIST_SOURCE_ADX", "REMARKETING_LIST_SOURCE_DBM", "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_DFP", "REMARKETING_LIST_SOURCE_DMP", "REMARKETING_LIST_SOURCE_GA", - "REMARKETING_LIST_SOURCE_OTHER" + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_PLAY_STORE", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_YOUTUBE" ], "enumDescriptions": [ + "", + "", + "", + "", + "", + "", "", "", "", @@ -8439,13 +8459,25 @@ "type": "string", "description": "Product from which this targetable remarketing list was originated.", "enum": [ + "REMARKETING_LIST_SOURCE_ADX", "REMARKETING_LIST_SOURCE_DBM", "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_DFP", "REMARKETING_LIST_SOURCE_DMP", "REMARKETING_LIST_SOURCE_GA", - "REMARKETING_LIST_SOURCE_OTHER" + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_PLAY_STORE", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_YOUTUBE" ], "enumDescriptions": [ + "", + "", + "", + "", + "", + "", "", "", "", @@ -8558,7 +8590,9 @@ "VIDEO_MIDPOINT", "VIDEO_MUTE", "VIDEO_PAUSE", + "VIDEO_PROGRESS", "VIDEO_REWIND", + "VIDEO_SKIP", "VIDEO_START", "VIDEO_STOP", "VIDEO_THIRD_QUARTILE" @@ -8580,6 +8614,8 @@ "", "", "", + "", + "", "" ] }, @@ -10822,6 +10858,7 @@ "OBJECT_MEDIA_ORDER", "OBJECT_PLACEMENT", "OBJECT_PLACEMENT_STRATEGY", + "OBJECT_PLAYSTORE_LINK", "OBJECT_PROVIDED_LIST_CLIENT", "OBJECT_RATE_CARD", "OBJECT_REMARKETING_LIST", @@ -10869,6 +10906,7 @@ "", "", "", + "", "" ], "location": "query" @@ -11352,7 +11390,7 @@ "accept": [ "*/*" ], - "maxSize": "100MB", + "maxSize": "1024MB", "protocols": { "simple": { "multipart": true, diff --git a/etc/api/dfareporting/v2.2/dfareporting-api.json b/etc/api/dfareporting/v2.2/dfareporting-api.json index 5dd2c378f9..2c678e0159 100644 --- a/etc/api/dfareporting/v2.2/dfareporting-api.json +++ b/etc/api/dfareporting/v2.2/dfareporting-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/W0JB6kGZnVBVqqWWGBrYKWq9PxE\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/pe0nuOIqkvSnuqKAY9SdBjfx-IY\"", "discoveryVersion": "v1", "id": "dfareporting:v2.2", "name": "dfareporting", "version": "v2.2", - "revision": "20151109", + "revision": "20160128", "title": "DCM/DFA Reporting And Trafficking API", "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.", "ownerDomain": "google.com", @@ -149,7 +149,7 @@ }, "currencyId": { "type": "string", - "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB", + "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", "format": "int64" }, "defaultCreativeSizeId": { @@ -1716,9 +1716,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -2213,9 +2215,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -2983,9 +2987,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -3272,12 +3278,14 @@ "CLICK", "POST_CLICK", "POST_CLICK_AND_IMPRESSION", - "POST_IMPRESSION" + "POST_IMPRESSION", + "VIDEO_COMPLETION" ], "enumDescriptions": [ "", "", "", + "", "" ] } @@ -3812,7 +3820,7 @@ }, "currencyId": { "type": "string", - "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB", + "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", "format": "int64" }, "description": { @@ -7206,13 +7214,25 @@ "type": "string", "description": "Product from which this remarketing list was originated.", "enum": [ + "REMARKETING_LIST_SOURCE_ADX", "REMARKETING_LIST_SOURCE_DBM", "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_DFP", "REMARKETING_LIST_SOURCE_DMP", "REMARKETING_LIST_SOURCE_GA", - "REMARKETING_LIST_SOURCE_OTHER" + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_PLAY_STORE", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_YOUTUBE" ], "enumDescriptions": [ + "", + "", + "", + "", + "", + "", "", "", "", @@ -8431,13 +8451,25 @@ "type": "string", "description": "Product from which this targetable remarketing list was originated.", "enum": [ + "REMARKETING_LIST_SOURCE_ADX", "REMARKETING_LIST_SOURCE_DBM", "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_DFP", "REMARKETING_LIST_SOURCE_DMP", "REMARKETING_LIST_SOURCE_GA", - "REMARKETING_LIST_SOURCE_OTHER" + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_PLAY_STORE", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_YOUTUBE" ], "enumDescriptions": [ + "", + "", + "", + "", + "", + "", "", "", "", @@ -8565,7 +8597,9 @@ "VIDEO_MIDPOINT", "VIDEO_MUTE", "VIDEO_PAUSE", + "VIDEO_PROGRESS", "VIDEO_REWIND", + "VIDEO_SKIP", "VIDEO_START", "VIDEO_STOP", "VIDEO_THIRD_QUARTILE" @@ -8587,6 +8621,8 @@ "", "", "", + "", + "", "" ] }, @@ -10829,6 +10865,7 @@ "OBJECT_MEDIA_ORDER", "OBJECT_PLACEMENT", "OBJECT_PLACEMENT_STRATEGY", + "OBJECT_PLAYSTORE_LINK", "OBJECT_PROVIDED_LIST_CLIENT", "OBJECT_RATE_CARD", "OBJECT_REMARKETING_LIST", @@ -10876,6 +10913,7 @@ "", "", "", + "", "" ], "location": "query" @@ -11359,7 +11397,7 @@ "accept": [ "*/*" ], - "maxSize": "100MB", + "maxSize": "1024MB", "protocols": { "simple": { "multipart": true, diff --git a/etc/api/dfareporting/v2.3/dfareporting-api.json b/etc/api/dfareporting/v2.3/dfareporting-api.json index 17d1591859..592e3eb7eb 100644 --- a/etc/api/dfareporting/v2.3/dfareporting-api.json +++ b/etc/api/dfareporting/v2.3/dfareporting-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/XC0BWMAur-_N-oeZNpcZjTjY2ew\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/D37CYe-AvF4CepcUkE4wi4kuh0A\"", "discoveryVersion": "v1", "id": "dfareporting:v2.3", "name": "dfareporting", "version": "v2.3", - "revision": "20151109", + "revision": "20160128", "title": "DCM/DFA Reporting And Trafficking API", "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.", "ownerDomain": "google.com", @@ -149,7 +149,7 @@ }, "currencyId": { "type": "string", - "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB", + "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", "format": "int64" }, "defaultCreativeSizeId": { @@ -1716,9 +1716,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -2227,9 +2229,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -3002,9 +3006,11 @@ "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", "ARTWORK_TYPE_MIXED" ], "enumDescriptions": [ + "", "", "", "" @@ -3291,12 +3297,14 @@ "CLICK", "POST_CLICK", "POST_CLICK_AND_IMPRESSION", - "POST_IMPRESSION" + "POST_IMPRESSION", + "VIDEO_COMPLETION" ], "enumDescriptions": [ "", "", "", + "", "" ] } @@ -3831,7 +3839,7 @@ }, "currencyId": { "type": "string", - "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB", + "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", "format": "int64" }, "description": { @@ -7221,13 +7229,25 @@ "type": "string", "description": "Product from which this remarketing list was originated.", "enum": [ + "REMARKETING_LIST_SOURCE_ADX", "REMARKETING_LIST_SOURCE_DBM", "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_DFP", "REMARKETING_LIST_SOURCE_DMP", "REMARKETING_LIST_SOURCE_GA", - "REMARKETING_LIST_SOURCE_OTHER" + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_PLAY_STORE", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_YOUTUBE" ], "enumDescriptions": [ + "", + "", + "", + "", + "", + "", "", "", "", @@ -8450,13 +8470,25 @@ "type": "string", "description": "Product from which this targetable remarketing list was originated.", "enum": [ + "REMARKETING_LIST_SOURCE_ADX", "REMARKETING_LIST_SOURCE_DBM", "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_DFP", "REMARKETING_LIST_SOURCE_DMP", "REMARKETING_LIST_SOURCE_GA", - "REMARKETING_LIST_SOURCE_OTHER" + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_PLAY_STORE", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_YOUTUBE" ], "enumDescriptions": [ + "", + "", + "", + "", + "", + "", "", "", "", @@ -8584,7 +8616,9 @@ "VIDEO_MIDPOINT", "VIDEO_MUTE", "VIDEO_PAUSE", + "VIDEO_PROGRESS", "VIDEO_REWIND", + "VIDEO_SKIP", "VIDEO_START", "VIDEO_STOP", "VIDEO_THIRD_QUARTILE" @@ -8606,6 +8640,8 @@ "", "", "", + "", + "", "" ] }, @@ -10848,6 +10884,7 @@ "OBJECT_MEDIA_ORDER", "OBJECT_PLACEMENT", "OBJECT_PLACEMENT_STRATEGY", + "OBJECT_PLAYSTORE_LINK", "OBJECT_PROVIDED_LIST_CLIENT", "OBJECT_RATE_CARD", "OBJECT_REMARKETING_LIST", @@ -10895,6 +10932,7 @@ "", "", "", + "", "" ], "location": "query" @@ -11378,7 +11416,7 @@ "accept": [ "*/*" ], - "maxSize": "100MB", + "maxSize": "1024MB", "protocols": { "simple": { "multipart": true, diff --git a/etc/api/dfareporting/v2.4/dfareporting-api.json b/etc/api/dfareporting/v2.4/dfareporting-api.json new file mode 100644 index 0000000000..de73465ffe --- /dev/null +++ b/etc/api/dfareporting/v2.4/dfareporting-api.json @@ -0,0 +1,17729 @@ +{ + "kind": "discovery#restDescription", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/5TfNJAYCdpNqfBuYUZWvagnNUsg\"", + "discoveryVersion": "v1", + "id": "dfareporting:v2.4", + "name": "dfareporting", + "version": "v2.4", + "revision": "20160128", + "title": "DCM/DFA Reporting And Trafficking API", + "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.", + "ownerDomain": "google.com", + "ownerName": "Google", + "icons": { + "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif", + "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif" + }, + "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/", + "protocol": "rest", + "baseUrl": "https://www.googleapis.com/dfareporting/v2.4/", + "basePath": "/dfareporting/v2.4/", + "rootUrl": "https://www.googleapis.com/", + "servicePath": "dfareporting/v2.4/", + "batchPath": "batch", + "parameters": { + "alt": { + "type": "string", + "description": "Data format for the response.", + "default": "json", + "enum": [ + "json" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json" + ], + "location": "query" + }, + "fields": { + "type": "string", + "description": "Selector specifying which fields to include in a partial response.", + "location": "query" + }, + "key": { + "type": "string", + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query" + }, + "oauth_token": { + "type": "string", + "description": "OAuth 2.0 token for the current user.", + "location": "query" + }, + "prettyPrint": { + "type": "boolean", + "description": "Returns response with indentations and line breaks.", + "default": "true", + "location": "query" + }, + "quotaUser": { + "type": "string", + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", + "location": "query" + }, + "userIp": { + "type": "string", + "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", + "location": "query" + } + }, + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/dfareporting": { + "description": "View and manage DoubleClick for Advertisers reports" + }, + "https://www.googleapis.com/auth/dfatrafficking": { + "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns" + } + } + } + }, + "schemas": { + "Account": { + "id": "Account", + "type": "object", + "description": "Contains properties of a DCM account.", + "properties": { + "accountPermissionIds": { + "type": "array", + "description": "Account permissions assigned to this account.", + "items": { + "type": "string", + "format": "int64" + } + }, + "accountProfile": { + "type": "string", + "description": "Profile for this account. This is a read-only field that can be left blank.", + "enum": [ + "ACCOUNT_PROFILE_BASIC", + "ACCOUNT_PROFILE_STANDARD" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "active": { + "type": "boolean", + "description": "Whether this account is active." + }, + "activeAdsLimitTier": { + "type": "string", + "description": "Maximum number of active ads allowed for this account.", + "enum": [ + "ACTIVE_ADS_TIER_100K", + "ACTIVE_ADS_TIER_200K", + "ACTIVE_ADS_TIER_300K", + "ACTIVE_ADS_TIER_40K", + "ACTIVE_ADS_TIER_75K" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "activeViewOptOut": { + "type": "boolean", + "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions." + }, + "availablePermissionIds": { + "type": "array", + "description": "User role permissions available to the user roles of this account.", + "items": { + "type": "string", + "format": "int64" + } + }, + "comscoreVceEnabled": { + "type": "boolean", + "description": "Whether campaigns created in this account will be enabled for comScore vCE by default." + }, + "countryId": { + "type": "string", + "description": "ID of the country associated with this account.", + "format": "int64" + }, + "currencyId": { + "type": "string", + "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", + "format": "int64" + }, + "defaultCreativeSizeId": { + "type": "string", + "description": "Default placement dimensions for this account.", + "format": "int64" + }, + "description": { + "type": "string", + "description": "Description of this account." + }, + "id": { + "type": "string", + "description": "ID of this account. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".", + "default": "dfareporting#account" + }, + "locale": { + "type": "string", + "description": "Locale of this account.\nAcceptable values are: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"en\" (English) \n- \"en-GB\" (English United Kingdom) \n- \"es\" (Spanish) \n- \"fr\" (French) \n- \"it\" (Italian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n- \"pl\" (Polish) \n- \"pt-BR\" (Portuguese Brazil) \n- \"ru\" (Russian) \n- \"sv\" (Swedish) \n- \"tr\" (Turkish) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW\" (Chinese Traditional)" + }, + "maximumImageSize": { + "type": "string", + "description": "Maximum image size allowed for this account.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique." + }, + "nielsenOcrEnabled": { + "type": "boolean", + "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default." + }, + "reportsConfiguration": { + "$ref": "ReportsConfiguration", + "description": "Reporting configuration of this account." + }, + "teaserSizeLimit": { + "type": "string", + "description": "File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.", + "format": "int64" + } + } + }, + "AccountActiveAdSummary": { + "id": "AccountActiveAdSummary", + "type": "object", + "description": "Gets a summary of active ads in an account.", + "properties": { + "accountId": { + "type": "string", + "description": "ID of the account.", + "format": "int64" + }, + "activeAds": { + "type": "string", + "description": "Ads that have been activated for the account", + "format": "int64" + }, + "activeAdsLimitTier": { + "type": "string", + "description": "Maximum number of active ads allowed for the account.", + "enum": [ + "ACTIVE_ADS_TIER_100K", + "ACTIVE_ADS_TIER_200K", + "ACTIVE_ADS_TIER_300K", + "ACTIVE_ADS_TIER_40K", + "ACTIVE_ADS_TIER_75K" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "availableAds": { + "type": "string", + "description": "Ads that can be activated for the account.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".", + "default": "dfareporting#accountActiveAdSummary" + } + } + }, + "AccountPermission": { + "id": "AccountPermission", + "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.", + "properties": { + "accountProfiles": { + "type": "array", + "description": "Account profiles associated with this account permission.\n\nPossible values are:\n- \"ACCOUNT_PROFILE_BASIC\"\n- \"ACCOUNT_PROFILE_STANDARD\"", + "items": { + "type": "string", + "enum": [ + "ACCOUNT_PROFILE_BASIC", + "ACCOUNT_PROFILE_STANDARD" + ], + "enumDescriptions": [ + "", + "" + ] + } + }, + "id": { + "type": "string", + "description": "ID of this account permission.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".", + "default": "dfareporting#accountPermission" + }, + "level": { + "type": "string", + "description": "Administrative level required to enable this account permission.", + "enum": [ + "ADMINISTRATOR", + "USER" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "name": { + "type": "string", + "description": "Name of this account permission." + }, + "permissionGroupId": { + "type": "string", + "description": "Permission group of this account permission.", + "format": "int64" + } + } + }, + "AccountPermissionGroup": { + "id": "AccountPermissionGroup", + "type": "object", + "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.", + "properties": { + "id": { + "type": "string", + "description": "ID of this account permission group.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".", + "default": "dfareporting#accountPermissionGroup" + }, + "name": { + "type": "string", + "description": "Name of this account permission group." + } + } + }, + "AccountPermissionGroupsListResponse": { + "id": "AccountPermissionGroupsListResponse", + "type": "object", + "description": "Account Permission Group List Response", + "properties": { + "accountPermissionGroups": { + "type": "array", + "description": "Account permission group collection.", + "items": { + "$ref": "AccountPermissionGroup" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".", + "default": "dfareporting#accountPermissionGroupsListResponse" + } + } + }, + "AccountPermissionsListResponse": { + "id": "AccountPermissionsListResponse", + "type": "object", + "description": "Account Permission List Response", + "properties": { + "accountPermissions": { + "type": "array", + "description": "Account permission collection.", + "items": { + "$ref": "AccountPermission" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".", + "default": "dfareporting#accountPermissionsListResponse" + } + } + }, + "AccountUserProfile": { + "id": "AccountUserProfile", + "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.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of the user profile. This is a read-only field that can be left blank.", + "format": "int64" + }, + "active": { + "type": "boolean", + "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable." + }, + "advertiserFilter": { + "$ref": "ObjectFilter", + "description": "Filter that describes which advertisers are visible to the user profile." + }, + "campaignFilter": { + "$ref": "ObjectFilter", + "description": "Filter that describes which campaigns are visible to the user profile." + }, + "comments": { + "type": "string", + "description": "Comments for this user profile." + }, + "email": { + "type": "string", + "description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion." + }, + "id": { + "type": "string", + "description": "ID of the user profile. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".", + "default": "dfareporting#accountUserProfile" + }, + "locale": { + "type": "string", + "description": "Locale of the user profile. This is a required field.\nAcceptable values are: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"en\" (English) \n- \"en-GB\" (English United Kingdom) \n- \"es\" (Spanish) \n- \"fr\" (French) \n- \"it\" (Italian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n- \"pl\" (Polish) \n- \"pt-BR\" (Portuguese Brazil)\n- \"ru\" (Russian) \n- \"sv\" (Swedish) \n- \"tr\" (Turkish) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW\" (Chinese Traditional)" + }, + "name": { + "type": "string", + "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;\"#%,\"." + }, + "siteFilter": { + "$ref": "ObjectFilter", + "description": "Filter that describes which sites are visible to the user profile." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.", + "format": "int64" + }, + "traffickerType": { + "type": "string", + "description": "Trafficker type of this user profile.", + "enum": [ + "EXTERNAL_TRAFFICKER", + "INTERNAL_NON_TRAFFICKER", + "INTERNAL_TRAFFICKER" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "userAccessType": { + "type": "string", + "description": "User type of the user profile. This is a read-only field that can be left blank.", + "enum": [ + "INTERNAL_ADMINISTRATOR", + "NORMAL_USER", + "SUPER_USER" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "userRoleFilter": { + "$ref": "ObjectFilter", + "description": "Filter that describes which user roles are visible to the user profile." + }, + "userRoleId": { + "type": "string", + "description": "User role ID of the user profile. This is a required field.", + "format": "int64" + } + } + }, + "AccountUserProfilesListResponse": { + "id": "AccountUserProfilesListResponse", + "type": "object", + "description": "Account User Profile List Response", + "properties": { + "accountUserProfiles": { + "type": "array", + "description": "Account user profile collection.", + "items": { + "$ref": "AccountUserProfile" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".", + "default": "dfareporting#accountUserProfilesListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "AccountsListResponse": { + "id": "AccountsListResponse", + "type": "object", + "description": "Account List Response", + "properties": { + "accounts": { + "type": "array", + "description": "Account collection.", + "items": { + "$ref": "Account" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".", + "default": "dfareporting#accountsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "Activities": { + "id": "Activities", + "type": "object", + "description": "Represents an activity group.", + "properties": { + "filters": { + "type": "array", + "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".", + "items": { + "$ref": "DimensionValue" + } + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#activities.", + "default": "dfareporting#activities" + }, + "metricNames": { + "type": "array", + "description": "List of names of floodlight activity metrics.", + "items": { + "type": "string" + } + } + } + }, + "Ad": { + "id": "Ad", + "type": "object", + "description": "Contains properties of a DCM ad.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this ad. This is a read-only field that can be left blank.", + "format": "int64" + }, + "active": { + "type": "boolean", + "description": "Whether this ad is active." + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this ad. This is a required field on insertion.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "archived": { + "type": "boolean", + "description": "Whether this ad is archived." + }, + "audienceSegmentId": { + "type": "string", + "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.", + "format": "int64" + }, + "campaignId": { + "type": "string", + "description": "Campaign ID of this ad. This is a required field on insertion.", + "format": "int64" + }, + "campaignIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field." + }, + "clickThroughUrl": { + "$ref": "ClickThroughUrl", + "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER." + }, + "clickThroughUrlSuffixProperties": { + "$ref": "ClickThroughUrlSuffixProperties", + "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative." + }, + "comments": { + "type": "string", + "description": "Comments for this ad." + }, + "compatibility": { + "type": "string", + "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.", + "enum": [ + "APP", + "APP_INTERSTITIAL", + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "IN_STREAM_VIDEO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the creation of this ad.This is a read-only field." + }, + "creativeGroupAssignments": { + "type": "array", + "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.", + "items": { + "$ref": "CreativeGroupAssignment" + } + }, + "creativeRotation": { + "$ref": "CreativeRotation", + "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment." + }, + "dayPartTargeting": { + "$ref": "DayPartTargeting", + "description": "Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD." + }, + "defaultClickThroughEventTagProperties": { + "$ref": "DefaultClickThroughEventTagProperties", + "description": "Default click-through event tag properties for this ad." + }, + "deliverySchedule": { + "$ref": "DeliverySchedule", + "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD." + }, + "dynamicClickTracker": { + "type": "boolean", + "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert." + }, + "endTime": { + "type": "string", + "description": "Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.", + "format": "date-time" + }, + "eventTagOverrides": { + "type": "array", + "description": "Event tag overrides for this ad.", + "items": { + "$ref": "EventTagOverride" + } + }, + "geoTargeting": { + "$ref": "GeoTargeting", + "description": "Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD." + }, + "id": { + "type": "string", + "description": "ID of this ad. This is a read-only, auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field." + }, + "keyValueTargetingExpression": { + "$ref": "KeyValueTargetingExpression", + "description": "Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".", + "default": "dfareporting#ad" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this ad. This is a read-only field." + }, + "name": { + "type": "string", + "description": "Name of this ad. This is a required field and must be less than 256 characters long." + }, + "placementAssignments": { + "type": "array", + "description": "Placement assignments for this ad.", + "items": { + "$ref": "PlacementAssignment" + } + }, + "remarketingListExpression": { + "$ref": "ListTargetingExpression", + "description": "Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad." + }, + "size": { + "$ref": "Size", + "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD." + }, + "sslCompliant": { + "type": "boolean", + "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated." + }, + "sslRequired": { + "type": "boolean", + "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated." + }, + "startTime": { + "type": "string", + "description": "Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.", + "format": "date-time" + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.", + "format": "int64" + }, + "technologyTargeting": { + "$ref": "TechnologyTargeting", + "description": "Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD." + }, + "type": { + "type": "string", + "description": "Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).", + "enum": [ + "AD_SERVING_CLICK_TRACKER", + "AD_SERVING_DEFAULT_AD", + "AD_SERVING_STANDARD_AD", + "AD_SERVING_TRACKING" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + } + } + }, + "AdSlot": { + "id": "AdSlot", + "type": "object", + "description": "Ad Slot", + "properties": { + "comment": { + "type": "string", + "description": "Comment for this ad slot." + }, + "compatibility": { + "type": "string", + "description": "Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.", + "enum": [ + "APP", + "APP_INTERSTITIAL", + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "IN_STREAM_VIDEO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "height": { + "type": "string", + "description": "Height of this ad slot.", + "format": "int64" + }, + "linkedPlacementId": { + "type": "string", + "description": "ID of the placement from an external platform that is linked to this ad slot.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "Name of this ad slot." + }, + "paymentSourceType": { + "type": "string", + "description": "Payment source type of this ad slot.", + "enum": [ + "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID", + "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "primary": { + "type": "boolean", + "description": "Primary ad slot of a roadblock inventory item." + }, + "width": { + "type": "string", + "description": "Width of this ad slot.", + "format": "int64" + } + } + }, + "AdsListResponse": { + "id": "AdsListResponse", + "type": "object", + "description": "Ad List Response", + "properties": { + "ads": { + "type": "array", + "description": "Ad collection.", + "items": { + "$ref": "Ad" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".", + "default": "dfareporting#adsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "Advertiser": { + "id": "Advertiser", + "type": "object", + "description": "Contains properties of a DCM advertiser.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this advertiser.This is a read-only field that can be left blank.", + "format": "int64" + }, + "advertiserGroupId": { + "type": "string", + "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.", + "format": "int64" + }, + "clickThroughUrlSuffix": { + "type": "string", + "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long." + }, + "defaultClickThroughEventTagId": { + "type": "string", + "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.", + "format": "int64" + }, + "defaultEmail": { + "type": "string", + "description": "Default email address used in sender field for tag emails." + }, + "floodlightConfigurationId": { + "type": "string", + "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: \n- This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. \n- This advertiser's original floodlight configuration is not already shared with another advertiser.", + "format": "int64" + }, + "floodlightConfigurationIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field." + }, + "id": { + "type": "string", + "description": "ID of this advertiser. This is a read-only, auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".", + "default": "dfareporting#advertiser" + }, + "name": { + "type": "string", + "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account." + }, + "originalFloodlightConfigurationId": { + "type": "string", + "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.", + "format": "int64" + }, + "status": { + "type": "string", + "description": "Status of this advertiser.", + "enum": [ + "APPROVED", + "ON_HOLD" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.", + "format": "int64" + }, + "suspended": { + "type": "boolean", + "description": "Suspension status of this advertiser." + } + } + }, + "AdvertiserGroup": { + "id": "AdvertiserGroup", + "type": "object", + "description": "Groups advertisers together so that reports can be generated for the entire group at once.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.", + "format": "int64" + }, + "id": { + "type": "string", + "description": "ID of this advertiser group. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".", + "default": "dfareporting#advertiserGroup" + }, + "name": { + "type": "string", + "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account." + } + } + }, + "AdvertiserGroupsListResponse": { + "id": "AdvertiserGroupsListResponse", + "type": "object", + "description": "Advertiser Group List Response", + "properties": { + "advertiserGroups": { + "type": "array", + "description": "Advertiser group collection.", + "items": { + "$ref": "AdvertiserGroup" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".", + "default": "dfareporting#advertiserGroupsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "AdvertisersListResponse": { + "id": "AdvertisersListResponse", + "type": "object", + "description": "Advertiser List Response", + "properties": { + "advertisers": { + "type": "array", + "description": "Advertiser collection.", + "items": { + "$ref": "Advertiser" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".", + "default": "dfareporting#advertisersListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "AudienceSegment": { + "id": "AudienceSegment", + "type": "object", + "description": "Audience Segment.", + "properties": { + "allocation": { + "type": "integer", + "description": "Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.", + "format": "int32" + }, + "id": { + "type": "string", + "description": "ID of this audience segment. This is a read-only, auto-generated field.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "Name of this audience segment. This is a required field and must be less than 65 characters long." + } + } + }, + "AudienceSegmentGroup": { + "id": "AudienceSegmentGroup", + "type": "object", + "description": "Audience Segment Group.", + "properties": { + "audienceSegments": { + "type": "array", + "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.", + "items": { + "$ref": "AudienceSegment" + } + }, + "id": { + "type": "string", + "description": "ID of this audience segment group. This is a read-only, auto-generated field.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long." + } + } + }, + "Browser": { + "id": "Browser", + "type": "object", + "description": "Contains information about a browser that can be targeted by ads.", + "properties": { + "browserVersionId": { + "type": "string", + "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.", + "format": "int64" + }, + "dartId": { + "type": "string", + "description": "DART ID of this browser. This is the ID used when generating reports.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".", + "default": "dfareporting#browser" + }, + "majorVersion": { + "type": "string", + "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is." + }, + "minorVersion": { + "type": "string", + "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is." + }, + "name": { + "type": "string", + "description": "Name of this browser." + } + } + }, + "BrowsersListResponse": { + "id": "BrowsersListResponse", + "type": "object", + "description": "Browser List Response", + "properties": { + "browsers": { + "type": "array", + "description": "Browser collection.", + "items": { + "$ref": "Browser" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".", + "default": "dfareporting#browsersListResponse" + } + } + }, + "Campaign": { + "id": "Campaign", + "type": "object", + "description": "Contains properties of a DCM campaign.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this campaign. This is a read-only field that can be left blank.", + "format": "int64" + }, + "additionalCreativeOptimizationConfigurations": { + "type": "array", + "description": "Additional creative optimization configurations for the campaign.", + "items": { + "$ref": "CreativeOptimizationConfiguration" + } + }, + "advertiserGroupId": { + "type": "string", + "description": "Advertiser group ID of the associated advertiser.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this campaign. This is a required field.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field." + }, + "archived": { + "type": "boolean", + "description": "Whether this campaign has been archived." + }, + "audienceSegmentGroups": { + "type": "array", + "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.", + "items": { + "$ref": "AudienceSegmentGroup" + } + }, + "billingInvoiceCode": { + "type": "string", + "description": "Billing invoice code included in the DCM client billing invoices associated with the campaign." + }, + "clickThroughUrlSuffixProperties": { + "$ref": "ClickThroughUrlSuffixProperties", + "description": "Click-through URL suffix override properties for this campaign." + }, + "comment": { + "type": "string", + "description": "Arbitrary comments about this campaign. Must be less than 256 characters long." + }, + "comscoreVceEnabled": { + "type": "boolean", + "description": "Whether comScore vCE reports are enabled for this campaign." + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the creation of this campaign. This is a read-only field." + }, + "creativeGroupIds": { + "type": "array", + "description": "List of creative group IDs that are assigned to the campaign.", + "items": { + "type": "string", + "format": "int64" + } + }, + "creativeOptimizationConfiguration": { + "$ref": "CreativeOptimizationConfiguration", + "description": "Creative optimization configuration for the campaign." + }, + "defaultClickThroughEventTagProperties": { + "$ref": "DefaultClickThroughEventTagProperties", + "description": "Click-through event tag ID override properties for this campaign." + }, + "endDate": { + "type": "string", + "description": "Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.", + "format": "date" + }, + "eventTagOverrides": { + "type": "array", + "description": "Overrides that can be used to activate or deactivate advertiser event tags.", + "items": { + "$ref": "EventTagOverride" + } + }, + "externalId": { + "type": "string", + "description": "External ID for this campaign." + }, + "id": { + "type": "string", + "description": "ID of this campaign. This is a read-only auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".", + "default": "dfareporting#campaign" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this campaign. This is a read-only field." + }, + "lookbackConfiguration": { + "$ref": "LookbackConfiguration", + "description": "Lookback window settings for the campaign." + }, + "name": { + "type": "string", + "description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser." + }, + "nielsenOcrEnabled": { + "type": "boolean", + "description": "Whether Nielsen reports are enabled for this campaign." + }, + "startDate": { + "type": "string", + "description": "Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.", + "format": "date" + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.", + "format": "int64" + }, + "traffickerEmails": { + "type": "array", + "description": "Campaign trafficker contact emails.", + "items": { + "type": "string" + } + } + } + }, + "CampaignCreativeAssociation": { + "id": "CampaignCreativeAssociation", + "type": "object", + "description": "Identifies a creative which has been associated with a given campaign.", + "properties": { + "creativeId": { + "type": "string", + "description": "ID of the creative associated with the campaign. This is a required field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".", + "default": "dfareporting#campaignCreativeAssociation" + } + } + }, + "CampaignCreativeAssociationsListResponse": { + "id": "CampaignCreativeAssociationsListResponse", + "type": "object", + "description": "Campaign Creative Association List Response", + "properties": { + "campaignCreativeAssociations": { + "type": "array", + "description": "Campaign creative association collection", + "items": { + "$ref": "CampaignCreativeAssociation" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".", + "default": "dfareporting#campaignCreativeAssociationsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "CampaignsListResponse": { + "id": "CampaignsListResponse", + "type": "object", + "description": "Campaign List Response", + "properties": { + "campaigns": { + "type": "array", + "description": "Campaign collection.", + "items": { + "$ref": "Campaign" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".", + "default": "dfareporting#campaignsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "ChangeLog": { + "id": "ChangeLog", + "type": "object", + "description": "Describes a change that a user has made to a resource.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of the modified object.", + "format": "int64" + }, + "action": { + "type": "string", + "description": "Action which caused the change." + }, + "changeTime": { + "type": "string", + "description": "Time when the object was modified.", + "format": "date-time" + }, + "fieldName": { + "type": "string", + "description": "Field name of the object which changed." + }, + "id": { + "type": "string", + "description": "ID of this change log.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".", + "default": "dfareporting#changeLog" + }, + "newValue": { + "type": "string", + "description": "New value of the object field." + }, + "objectId": { + "type": "string", + "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.", + "format": "int64" + }, + "objectType": { + "type": "string", + "description": "Object type of the change log." + }, + "oldValue": { + "type": "string", + "description": "Old value of the object field." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of the modified object.", + "format": "int64" + }, + "transactionId": { + "type": "string", + "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.", + "format": "int64" + }, + "userProfileId": { + "type": "string", + "description": "ID of the user who modified the object.", + "format": "int64" + }, + "userProfileName": { + "type": "string", + "description": "User profile name of the user who modified the object." + } + } + }, + "ChangeLogsListResponse": { + "id": "ChangeLogsListResponse", + "type": "object", + "description": "Change Log List Response", + "properties": { + "changeLogs": { + "type": "array", + "description": "Change log collection.", + "items": { + "$ref": "ChangeLog" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".", + "default": "dfareporting#changeLogsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "CitiesListResponse": { + "id": "CitiesListResponse", + "type": "object", + "description": "City List Response", + "properties": { + "cities": { + "type": "array", + "description": "City collection.", + "items": { + "$ref": "City" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".", + "default": "dfareporting#citiesListResponse" + } + } + }, + "City": { + "id": "City", + "type": "object", + "description": "Contains information about a city that can be targeted by ads.", + "properties": { + "countryCode": { + "type": "string", + "description": "Country code of the country to which this city belongs." + }, + "countryDartId": { + "type": "string", + "description": "DART ID of the country to which this city belongs.", + "format": "int64" + }, + "dartId": { + "type": "string", + "description": "DART ID of this city. This is the ID used for targeting and generating reports.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".", + "default": "dfareporting#city" + }, + "metroCode": { + "type": "string", + "description": "Metro region code of the metro region (DMA) to which this city belongs." + }, + "metroDmaId": { + "type": "string", + "description": "ID of the metro region (DMA) to which this city belongs.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "Name of this city." + }, + "regionCode": { + "type": "string", + "description": "Region code of the region to which this city belongs." + }, + "regionDartId": { + "type": "string", + "description": "DART ID of the region to which this city belongs.", + "format": "int64" + } + } + }, + "ClickTag": { + "id": "ClickTag", + "type": "object", + "description": "Creative Click Tag.", + "properties": { + "eventName": { + "type": "string", + "description": "Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives." + }, + "name": { + "type": "string", + "description": "Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field." + }, + "value": { + "type": "string", + "description": "Parameter value for the specified click tag. This field contains a click-through url." + } + } + }, + "ClickThroughUrl": { + "id": "ClickThroughUrl", + "type": "object", + "description": "Click-through URL", + "properties": { + "computedClickThroughUrl": { + "type": "string", + "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: \n- If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.\n- If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.\n- If neither of the above cases apply, then the customClickThroughUrl is assigned to this field." + }, + "customClickThroughUrl": { + "type": "string", + "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset." + }, + "defaultLandingPage": { + "type": "boolean", + "description": "Whether the campaign default landing page is used." + }, + "landingPageId": { + "type": "string", + "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.", + "format": "int64" + } + } + }, + "ClickThroughUrlSuffixProperties": { + "id": "ClickThroughUrlSuffixProperties", + "type": "object", + "description": "Click Through URL Suffix settings.", + "properties": { + "clickThroughUrlSuffix": { + "type": "string", + "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long." + }, + "overrideInheritedSuffix": { + "type": "boolean", + "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value." + } + } + }, + "CompanionClickThroughOverride": { + "id": "CompanionClickThroughOverride", + "type": "object", + "description": "Companion Click-through override.", + "properties": { + "clickThroughUrl": { + "$ref": "ClickThroughUrl", + "description": "Click-through URL of this companion click-through override." + }, + "creativeId": { + "type": "string", + "description": "ID of the creative for this companion click-through override.", + "format": "int64" + } + } + }, + "CompatibleFields": { + "id": "CompatibleFields", + "type": "object", + "description": "Represents a response to the queryCompatibleFields method.", + "properties": { + "crossDimensionReachReportCompatibleFields": { + "$ref": "CrossDimensionReachReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"." + }, + "floodlightReportCompatibleFields": { + "$ref": "FloodlightReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"." + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#compatibleFields.", + "default": "dfareporting#compatibleFields" + }, + "pathToConversionReportCompatibleFields": { + "$ref": "PathToConversionReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"." + }, + "reachReportCompatibleFields": { + "$ref": "ReachReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"REACH\"." + }, + "reportCompatibleFields": { + "$ref": "ReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"." + } + } + }, + "ConnectionType": { + "id": "ConnectionType", + "type": "object", + "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.", + "properties": { + "id": { + "type": "string", + "description": "ID of this connection type.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".", + "default": "dfareporting#connectionType" + }, + "name": { + "type": "string", + "description": "Name of this connection type." + } + } + }, + "ConnectionTypesListResponse": { + "id": "ConnectionTypesListResponse", + "type": "object", + "description": "Connection Type List Response", + "properties": { + "connectionTypes": { + "type": "array", + "description": "Collection of connection types such as broadband and mobile.", + "items": { + "$ref": "ConnectionType" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".", + "default": "dfareporting#connectionTypesListResponse" + } + } + }, + "ContentCategoriesListResponse": { + "id": "ContentCategoriesListResponse", + "type": "object", + "description": "Content Category List Response", + "properties": { + "contentCategories": { + "type": "array", + "description": "Content category collection.", + "items": { + "$ref": "ContentCategory" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".", + "default": "dfareporting#contentCategoriesListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "ContentCategory": { + "id": "ContentCategory", + "type": "object", + "description": "Organizes placements according to the contents of their associated webpages.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this content category. This is a read-only field that can be left blank.", + "format": "int64" + }, + "id": { + "type": "string", + "description": "ID of this content category. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".", + "default": "dfareporting#contentCategory" + }, + "name": { + "type": "string", + "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account." + } + } + }, + "CountriesListResponse": { + "id": "CountriesListResponse", + "type": "object", + "description": "Country List Response", + "properties": { + "countries": { + "type": "array", + "description": "Country collection.", + "items": { + "$ref": "Country" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".", + "default": "dfareporting#countriesListResponse" + } + } + }, + "Country": { + "id": "Country", + "type": "object", + "description": "Contains information about a country that can be targeted by ads.", + "properties": { + "countryCode": { + "type": "string", + "description": "Country code." + }, + "dartId": { + "type": "string", + "description": "DART ID of this country. This is the ID used for targeting and generating reports.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".", + "default": "dfareporting#country" + }, + "name": { + "type": "string", + "description": "Name of this country." + }, + "sslEnabled": { + "type": "boolean", + "description": "Whether ad serving supports secure servers in this country." + } + } + }, + "Creative": { + "id": "Creative", + "type": "object", + "description": "Contains properties of a Creative.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.", + "format": "int64" + }, + "active": { + "type": "boolean", + "description": "Whether the creative is active. Applicable to all creative types." + }, + "adParameters": { + "type": "string", + "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID." + }, + "adTagKeys": { + "type": "array", + "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "items": { + "type": "string" + } + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types.", + "format": "int64" + }, + "allowScriptAccess": { + "type": "boolean", + "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE." + }, + "archived": { + "type": "boolean", + "description": "Whether the creative is archived. Applicable to all creative types." + }, + "artworkType": { + "type": "string", + "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "enum": [ + "ARTWORK_TYPE_FLASH", + "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", + "ARTWORK_TYPE_MIXED" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "authoringSource": { + "type": "string", + "description": "Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.", + "enum": [ + "CREATIVE_AUTHORING_SOURCE_DBM", + "CREATIVE_AUTHORING_SOURCE_DCM", + "CREATIVE_AUTHORING_SOURCE_STUDIO" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "authoringTool": { + "type": "string", + "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.", + "enum": [ + "NINJA", + "SWIFFY" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "auto_advance_images": { + "type": "boolean", + "description": "Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE." + }, + "backgroundColor": { + "type": "string", + "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE." + }, + "backupImageClickThroughUrl": { + "type": "string", + "description": "Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER." + }, + "backupImageFeatures": { + "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: ENHANCED_BANNER and HTML5_BANNER.", + "items": { + "type": "string", + "enum": [ + "APPLICATION_CACHE", + "AUDIO", + "CANVAS", + "CANVAS_TEXT", + "CSS_ANIMATIONS", + "CSS_BACKGROUND_SIZE", + "CSS_BORDER_IMAGE", + "CSS_BORDER_RADIUS", + "CSS_BOX_SHADOW", + "CSS_COLUMNS", + "CSS_FLEX_BOX", + "CSS_FONT_FACE", + "CSS_GENERATED_CONTENT", + "CSS_GRADIENTS", + "CSS_HSLA", + "CSS_MULTIPLE_BGS", + "CSS_OPACITY", + "CSS_REFLECTIONS", + "CSS_RGBA", + "CSS_TEXT_SHADOW", + "CSS_TRANSFORMS", + "CSS_TRANSFORMS3D", + "CSS_TRANSITIONS", + "DRAG_AND_DROP", + "GEO_LOCATION", + "HASH_CHANGE", + "HISTORY", + "INDEXED_DB", + "INLINE_SVG", + "INPUT_ATTR_AUTOCOMPLETE", + "INPUT_ATTR_AUTOFOCUS", + "INPUT_ATTR_LIST", + "INPUT_ATTR_MAX", + "INPUT_ATTR_MIN", + "INPUT_ATTR_MULTIPLE", + "INPUT_ATTR_PATTERN", + "INPUT_ATTR_PLACEHOLDER", + "INPUT_ATTR_REQUIRED", + "INPUT_ATTR_STEP", + "INPUT_TYPE_COLOR", + "INPUT_TYPE_DATE", + "INPUT_TYPE_DATETIME", + "INPUT_TYPE_DATETIME_LOCAL", + "INPUT_TYPE_EMAIL", + "INPUT_TYPE_MONTH", + "INPUT_TYPE_NUMBER", + "INPUT_TYPE_RANGE", + "INPUT_TYPE_SEARCH", + "INPUT_TYPE_TEL", + "INPUT_TYPE_TIME", + "INPUT_TYPE_URL", + "INPUT_TYPE_WEEK", + "LOCAL_STORAGE", + "POST_MESSAGE", + "SESSION_STORAGE", + "SMIL", + "SVG_CLIP_PATHS", + "SVG_FE_IMAGE", + "SVG_FILTERS", + "SVG_HREF", + "TOUCH", + "VIDEO", + "WEBGL", + "WEB_SOCKETS", + "WEB_SQL_DATABASE", + "WEB_WORKERS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + } + }, + "backupImageReportingLabel": { + "type": "string", + "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER." + }, + "backupImageTargetWindow": { + "$ref": "TargetWindow", + "description": "Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER." + }, + "clickTags": { + "type": "array", + "description": "Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.", + "items": { + "$ref": "ClickTag" + } + }, + "commercialId": { + "type": "string", + "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID." + }, + "companionCreatives": { + "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 INSTREAM_VIDEO and all VPAID.", + "items": { + "type": "string", + "format": "int64" + } + }, + "compatibility": { + "type": "array", + "description": "Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.\n\nAcceptable values are:\n- \"APP\"\n- \"APP_INTERSTITIAL\"\n- \"IN_STREAM_VIDEO\"\n- \"DISPLAY\"\n- \"DISPLAY_INTERSTITIAL\"", + "items": { + "type": "string", + "enum": [ + "APP", + "APP_INTERSTITIAL", + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "IN_STREAM_VIDEO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + } + }, + "convertFlashToHtml5": { + "type": "boolean", + "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE." + }, + "counterCustomEvents": { + "type": "array", + "description": "List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.", + "items": { + "$ref": "CreativeCustomEvent" + } + }, + "creativeAssets": { + "type": "array", + "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT", + "items": { + "$ref": "CreativeAsset" + } + }, + "creativeFieldAssignments": { + "type": "array", + "description": "Creative field assignments for this creative. Applicable to all creative types.", + "items": { + "$ref": "CreativeFieldAssignment" + } + }, + "customKeyValues": { + "type": "array", + "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "items": { + "type": "string" + } + }, + "exitCustomEvents": { + "type": "array", + "description": "List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.", + "items": { + "$ref": "CreativeCustomEvent" + } + }, + "fsCommand": { + "$ref": "FsCommand", + "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE." + }, + "htmlCode": { + "type": "string", + "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA." + }, + "htmlCodeLocked": { + "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." + }, + "id": { + "type": "string", + "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".", + "default": "dfareporting#creative" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Creative last modification information. This is a read-only field. Applicable to all creative types." + }, + "latestTraffickedCreativeId": { + "type": "string", + "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types." + }, + "overrideCss": { + "type": "string", + "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA." + }, + "redirectUrl": { + "type": "string", + "description": "URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT" + }, + "renderingId": { + "type": "string", + "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.", + "format": "int64" + }, + "renderingIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types." + }, + "requiredFlashPluginVersion": { + "type": "string", + "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID." + }, + "requiredFlashVersion": { + "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, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.", + "format": "int32" + }, + "size": { + "$ref": "Size", + "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA." + }, + "skippable": { + "type": "boolean", + "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID." + }, + "sslCompliant": { + "type": "boolean", + "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types." + }, + "sslOverride": { + "type": "boolean", + "description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types." + }, + "studioAdvertiserId": { + "type": "string", + "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64" + }, + "studioCreativeId": { + "type": "string", + "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64" + }, + "studioTraffickedCreativeId": { + "type": "string", + "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64" + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.", + "format": "int64" + }, + "thirdPartyBackupImageImpressionsUrl": { + "type": "string", + "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA" + }, + "thirdPartyRichMediaImpressionsUrl": { + "type": "string", + "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA" + }, + "thirdPartyUrls": { + "type": "array", + "description": "Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.", + "items": { + "$ref": "ThirdPartyTrackingUrl" + } + }, + "timerCustomEvents": { + "type": "array", + "description": "List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.", + "items": { + "$ref": "CreativeCustomEvent" + } + }, + "totalFileSize": { + "type": "string", + "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", + "format": "int64" + }, + "type": { + "type": "string", + "description": "Type of this creative.This is a required field. Applicable to all creative types.", + "enum": [ + "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO", + "CUSTOM_INPAGE", + "CUSTOM_INTERSTITIAL", + "ENHANCED_BANNER", + "ENHANCED_IMAGE", + "FLASH_INPAGE", + "HTML5_BANNER", + "IMAGE", + "INSTREAM_VIDEO", + "INSTREAM_VIDEO_REDIRECT", + "INTERNAL_REDIRECT", + "INTERSTITIAL_INTERNAL_REDIRECT", + "REDIRECT", + "RICH_MEDIA_EXPANDING", + "RICH_MEDIA_IM_EXPAND", + "RICH_MEDIA_INPAGE", + "RICH_MEDIA_INPAGE_FLOATING", + "RICH_MEDIA_INTERSTITIAL_FLOAT", + "RICH_MEDIA_MOBILE_IN_APP", + "RICH_MEDIA_MULTI_FLOATING", + "RICH_MEDIA_PEEL_DOWN", + "TRACKING_TEXT", + "VPAID_LINEAR", + "VPAID_NON_LINEAR" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "version": { + "type": "integer", + "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.", + "format": "int32" + }, + "videoDescription": { + "type": "string", + "description": "Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID." + }, + "videoDuration": { + "type": "number", + "description": "Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.", + "format": "float" + } + } + }, + "CreativeAsset": { + "id": "CreativeAsset", + "type": "object", + "description": "Creative Asset.", + "properties": { + "actionScript3": { + "type": "boolean", + "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER." + }, + "active": { + "type": "boolean", + "description": "Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID." + }, + "alignment": { + "type": "string", + "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.", + "enum": [ + "ALIGNMENT_BOTTOM", + "ALIGNMENT_LEFT", + "ALIGNMENT_RIGHT", + "ALIGNMENT_TOP" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "artworkType": { + "type": "string", + "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "ARTWORK_TYPE_FLASH", + "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", + "ARTWORK_TYPE_MIXED" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "assetIdentifier": { + "$ref": "CreativeAssetId", + "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT." + }, + "backupImageExit": { + "$ref": "CreativeCustomEvent", + "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA." + }, + "bitRate": { + "type": "integer", + "description": "Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.", + "format": "int32" + }, + "childAssetType": { + "type": "string", + "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.", + "enum": [ + "CHILD_ASSET_TYPE_DATA", + "CHILD_ASSET_TYPE_FLASH", + "CHILD_ASSET_TYPE_IMAGE", + "CHILD_ASSET_TYPE_VIDEO" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "collapsedSize": { + "$ref": "Size", + "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN." + }, + "customStartTimeValue": { + "type": "integer", + "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.", + "format": "int32" + }, + "detectedFeatures": { + "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: ENHANCED_BANNER and HTML5_BANNER.", + "items": { + "type": "string", + "enum": [ + "APPLICATION_CACHE", + "AUDIO", + "CANVAS", + "CANVAS_TEXT", + "CSS_ANIMATIONS", + "CSS_BACKGROUND_SIZE", + "CSS_BORDER_IMAGE", + "CSS_BORDER_RADIUS", + "CSS_BOX_SHADOW", + "CSS_COLUMNS", + "CSS_FLEX_BOX", + "CSS_FONT_FACE", + "CSS_GENERATED_CONTENT", + "CSS_GRADIENTS", + "CSS_HSLA", + "CSS_MULTIPLE_BGS", + "CSS_OPACITY", + "CSS_REFLECTIONS", + "CSS_RGBA", + "CSS_TEXT_SHADOW", + "CSS_TRANSFORMS", + "CSS_TRANSFORMS3D", + "CSS_TRANSITIONS", + "DRAG_AND_DROP", + "GEO_LOCATION", + "HASH_CHANGE", + "HISTORY", + "INDEXED_DB", + "INLINE_SVG", + "INPUT_ATTR_AUTOCOMPLETE", + "INPUT_ATTR_AUTOFOCUS", + "INPUT_ATTR_LIST", + "INPUT_ATTR_MAX", + "INPUT_ATTR_MIN", + "INPUT_ATTR_MULTIPLE", + "INPUT_ATTR_PATTERN", + "INPUT_ATTR_PLACEHOLDER", + "INPUT_ATTR_REQUIRED", + "INPUT_ATTR_STEP", + "INPUT_TYPE_COLOR", + "INPUT_TYPE_DATE", + "INPUT_TYPE_DATETIME", + "INPUT_TYPE_DATETIME_LOCAL", + "INPUT_TYPE_EMAIL", + "INPUT_TYPE_MONTH", + "INPUT_TYPE_NUMBER", + "INPUT_TYPE_RANGE", + "INPUT_TYPE_SEARCH", + "INPUT_TYPE_TEL", + "INPUT_TYPE_TIME", + "INPUT_TYPE_URL", + "INPUT_TYPE_WEEK", + "LOCAL_STORAGE", + "POST_MESSAGE", + "SESSION_STORAGE", + "SMIL", + "SVG_CLIP_PATHS", + "SVG_FE_IMAGE", + "SVG_FILTERS", + "SVG_HREF", + "TOUCH", + "VIDEO", + "WEBGL", + "WEB_SOCKETS", + "WEB_SQL_DATABASE", + "WEB_WORKERS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + } + }, + "displayType": { + "type": "string", + "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "ASSET_DISPLAY_TYPE_EXPANDING", + "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH", + "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING", + "ASSET_DISPLAY_TYPE_FLOATING", + "ASSET_DISPLAY_TYPE_INPAGE", + "ASSET_DISPLAY_TYPE_OVERLAY", + "ASSET_DISPLAY_TYPE_PEEL_DOWN", + "ASSET_DISPLAY_TYPE_VPAID_LINEAR", + "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "duration": { + "type": "integer", + "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.", + "format": "int32" + }, + "durationType": { + "type": "string", + "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "ASSET_DURATION_TYPE_AUTO", + "ASSET_DURATION_TYPE_CUSTOM", + "ASSET_DURATION_TYPE_NONE" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "expandedDimension": { + "$ref": "Size", + "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID." + }, + "fileSize": { + "type": "string", + "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.", + "format": "int64" + }, + "flashVersion": { + "type": "integer", + "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.", + "format": "int32" + }, + "hideFlashObjects": { + "type": "boolean", + "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA." + }, + "hideSelectionBoxes": { + "type": "boolean", + "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA." + }, + "horizontallyLocked": { + "type": "boolean", + "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA." + }, + "id": { + "type": "string", + "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.", + "format": "int64" + }, + "mimeType": { + "type": "string", + "description": "Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID." + }, + "offset": { + "$ref": "OffsetPosition", + "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN." + }, + "originalBackup": { + "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." + }, + "position": { + "$ref": "OffsetPosition", + "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA." + }, + "positionLeftUnit": { + "type": "string", + "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "OFFSET_UNIT_PERCENT", + "OFFSET_UNIT_PIXEL", + "OFFSET_UNIT_PIXEL_FROM_CENTER" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "positionTopUnit": { + "type": "string", + "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "OFFSET_UNIT_PERCENT", + "OFFSET_UNIT_PIXEL", + "OFFSET_UNIT_PIXEL_FROM_CENTER" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "progressiveServingUrl": { + "type": "string", + "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID." + }, + "pushdown": { + "type": "boolean", + "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height." + }, + "pushdownDuration": { + "type": "number", + "description": "Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.", + "format": "float" + }, + "role": { + "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 ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.\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 creatives.\nTRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.\nALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.\nFor VPAID_LINEAR 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 creative.", + "enum": [ + "ADDITIONAL_FLASH", + "ADDITIONAL_IMAGE", + "ALTERNATE_VIDEO", + "BACKUP_IMAGE", + "OTHER", + "PARENT_VIDEO", + "PRIMARY", + "TRANSCODED_VIDEO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "size": { + "$ref": "Size", + "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA." + }, + "sslCompliant": { + "type": "boolean", + "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT." + }, + "startTimeType": { + "type": "string", + "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.", + "enum": [ + "ASSET_START_TIME_TYPE_CUSTOM", + "ASSET_START_TIME_TYPE_NONE" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "streamingServingUrl": { + "type": "string", + "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID." + }, + "transparency": { + "type": "boolean", + "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets." + }, + "verticallyLocked": { + "type": "boolean", + "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA." + }, + "videoDuration": { + "type": "number", + "description": "Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.", + "format": "float" + }, + "windowMode": { + "type": "string", + "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.", + "enum": [ + "OPAQUE", + "TRANSPARENT", + "WINDOW" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "zIndex": { + "type": "integer", + "description": "zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.", + "format": "int32" + }, + "zipFilename": { + "type": "string", + "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER." + }, + "zipFilesize": { + "type": "string", + "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER." + } + } + }, + "CreativeAssetId": { + "id": "CreativeAssetId", + "type": "object", + "description": "Creative Asset ID.", + "properties": { + "name": { + "type": "string", + "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed." + }, + "type": { + "type": "string", + "description": "Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.", + "enum": [ + "FLASH", + "HTML", + "HTML_IMAGE", + "IMAGE", + "VIDEO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + } + } + }, + "CreativeAssetMetadata": { + "id": "CreativeAssetMetadata", + "type": "object", + "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.", + "properties": { + "assetIdentifier": { + "$ref": "CreativeAssetId", + "description": "ID of the creative asset. This is a required field." + }, + "clickTags": { + "type": "array", + "description": "List of detected click tags for assets. This is a read-only auto-generated field.", + "items": { + "$ref": "ClickTag" + } + }, + "detectedFeatures": { + "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.", + "items": { + "type": "string", + "enum": [ + "APPLICATION_CACHE", + "AUDIO", + "CANVAS", + "CANVAS_TEXT", + "CSS_ANIMATIONS", + "CSS_BACKGROUND_SIZE", + "CSS_BORDER_IMAGE", + "CSS_BORDER_RADIUS", + "CSS_BOX_SHADOW", + "CSS_COLUMNS", + "CSS_FLEX_BOX", + "CSS_FONT_FACE", + "CSS_GENERATED_CONTENT", + "CSS_GRADIENTS", + "CSS_HSLA", + "CSS_MULTIPLE_BGS", + "CSS_OPACITY", + "CSS_REFLECTIONS", + "CSS_RGBA", + "CSS_TEXT_SHADOW", + "CSS_TRANSFORMS", + "CSS_TRANSFORMS3D", + "CSS_TRANSITIONS", + "DRAG_AND_DROP", + "GEO_LOCATION", + "HASH_CHANGE", + "HISTORY", + "INDEXED_DB", + "INLINE_SVG", + "INPUT_ATTR_AUTOCOMPLETE", + "INPUT_ATTR_AUTOFOCUS", + "INPUT_ATTR_LIST", + "INPUT_ATTR_MAX", + "INPUT_ATTR_MIN", + "INPUT_ATTR_MULTIPLE", + "INPUT_ATTR_PATTERN", + "INPUT_ATTR_PLACEHOLDER", + "INPUT_ATTR_REQUIRED", + "INPUT_ATTR_STEP", + "INPUT_TYPE_COLOR", + "INPUT_TYPE_DATE", + "INPUT_TYPE_DATETIME", + "INPUT_TYPE_DATETIME_LOCAL", + "INPUT_TYPE_EMAIL", + "INPUT_TYPE_MONTH", + "INPUT_TYPE_NUMBER", + "INPUT_TYPE_RANGE", + "INPUT_TYPE_SEARCH", + "INPUT_TYPE_TEL", + "INPUT_TYPE_TIME", + "INPUT_TYPE_URL", + "INPUT_TYPE_WEEK", + "LOCAL_STORAGE", + "POST_MESSAGE", + "SESSION_STORAGE", + "SMIL", + "SVG_CLIP_PATHS", + "SVG_FE_IMAGE", + "SVG_FILTERS", + "SVG_HREF", + "TOUCH", + "VIDEO", + "WEBGL", + "WEB_SOCKETS", + "WEB_SQL_DATABASE", + "WEB_WORKERS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".", + "default": "dfareporting#creativeAssetMetadata" + }, + "warnedValidationRules": { + "type": "array", + "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.\n\nPossible values are:\n- \"CLICK_TAG_NON_TOP_LEVEL\"\n- \"CLICK_TAG_MISSING\"\n- \"CLICK_TAG_MORE_THAN_ONE\"\n- \"CLICK_TAG_INVALID\"\n- \"ORPHANED_ASSET\"\n- \"PRIMARY_HTML_MISSING\"\n- \"EXTERNAL_FILE_REFERENCED\"\n- \"MRAID_REFERENCED\"\n- \"ADMOB_REFERENCED\"\n- \"FILE_TYPE_INVALID\"\n- \"ZIP_INVALID\"\n- \"LINKED_FILE_NOT_FOUND\"\n- \"MAX_FLASH_VERSION_11\"\n- \"NOT_SSL_COMPLIANT\"\n- \"FILE_DETAIL_EMPTY\"\n- \"ASSET_INVALID\"\n- \"GWD_PROPERTIES_INVALID\"\n- \"ENABLER_UNSUPPORTED_METHOD_DCM\"\n- \"ASSET_FORMAT_UNSUPPORTED_DCM\"\n- \"COMPONENT_UNSUPPORTED_DCM\"\n- \"HTML5_FEATURE_UNSUPPORTED' \"", + "items": { + "type": "string", + "enum": [ + "ADMOB_REFERENCED", + "ASSET_FORMAT_UNSUPPORTED_DCM", + "ASSET_INVALID", + "CLICK_TAG_HARD_CODED", + "CLICK_TAG_INVALID", + "CLICK_TAG_IN_GWD", + "CLICK_TAG_MISSING", + "CLICK_TAG_MORE_THAN_ONE", + "CLICK_TAG_NON_TOP_LEVEL", + "COMPONENT_UNSUPPORTED_DCM", + "ENABLER_UNSUPPORTED_METHOD_DCM", + "EXTERNAL_FILE_REFERENCED", + "FILE_DETAIL_EMPTY", + "FILE_TYPE_INVALID", + "GWD_PROPERTIES_INVALID", + "HTML5_FEATURE_UNSUPPORTED", + "LINKED_FILE_NOT_FOUND", + "MAX_FLASH_VERSION_11", + "MRAID_REFERENCED", + "NOT_SSL_COMPLIANT", + "ORPHANED_ASSET", + "PRIMARY_HTML_MISSING", + "ZIP_INVALID" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + } + } + } + }, + "CreativeAssignment": { + "id": "CreativeAssignment", + "type": "object", + "description": "Creative Assignment.", + "properties": { + "active": { + "type": "boolean", + "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation." + }, + "applyEventTags": { + "type": "boolean", + "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO." + }, + "clickThroughUrl": { + "$ref": "ClickThroughUrl", + "description": "Click-through URL of the creative assignment." + }, + "companionCreativeOverrides": { + "type": "array", + "description": "Companion creative overrides for this creative assignment. Applicable to video ads.", + "items": { + "$ref": "CompanionClickThroughOverride" + } + }, + "creativeGroupAssignments": { + "type": "array", + "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.", + "items": { + "$ref": "CreativeGroupAssignment" + } + }, + "creativeId": { + "type": "string", + "description": "ID of the creative to be assigned. This is a required field.", + "format": "int64" + }, + "creativeIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field." + }, + "endTime": { + "type": "string", + "description": "Date and time that the assigned creative should stop serving. Must be later than the start time.", + "format": "date-time" + }, + "richMediaExitOverrides": { + "type": "array", + "description": "Rich media exit overrides for this creative assignment.\nApplicable when the creative type is any of the following: \n- RICH_MEDIA_INPAGE\n- RICH_MEDIA_INPAGE_FLOATING\n- RICH_MEDIA_IM_EXPAND\n- RICH_MEDIA_EXPANDING\n- RICH_MEDIA_INTERSTITIAL_FLOAT\n- RICH_MEDIA_MOBILE_IN_APP\n- RICH_MEDIA_MULTI_FLOATING\n- RICH_MEDIA_PEEL_DOWN\n- ADVANCED_BANNER\n- VPAID_LINEAR\n- VPAID_NON_LINEAR", + "items": { + "$ref": "RichMediaExitOverride" + } + }, + "sequence": { + "type": "integer", + "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.", + "format": "int32" + }, + "sslCompliant": { + "type": "boolean", + "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated." + }, + "startTime": { + "type": "string", + "description": "Date and time that the assigned creative should start serving.", + "format": "date-time" + }, + "weight": { + "type": "integer", + "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.", + "format": "int32" + } + } + }, + "CreativeCustomEvent": { + "id": "CreativeCustomEvent", + "type": "object", + "description": "Creative Custom Event.", + "properties": { + "advertiserCustomEventId": { + "type": "string", + "description": "Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.", + "format": "int64" + }, + "advertiserCustomEventName": { + "type": "string", + "description": "User-entered name for the event." + }, + "advertiserCustomEventType": { + "type": "string", + "description": "Type of the event. This is a read-only field.", + "enum": [ + "ADVERTISER_EVENT_COUNTER", + "ADVERTISER_EVENT_EXIT", + "ADVERTISER_EVENT_TIMER" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "artworkLabel": { + "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." + }, + "artworkType": { + "type": "string", + "description": "Artwork type used by the creative.This is a read-only field.", + "enum": [ + "ARTWORK_TYPE_FLASH", + "ARTWORK_TYPE_HTML5", + "ARTWORK_TYPE_IMAGE", + "ARTWORK_TYPE_MIXED" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "exitUrl": { + "type": "string", + "description": "Exit URL of the event. This field is used only for exit events." + }, + "id": { + "type": "string", + "description": "ID of this event. This is a required field and should not be modified after insertion.", + "format": "int64" + }, + "popupWindowProperties": { + "$ref": "PopupWindowProperties", + "description": "Properties for rich media popup windows. This field is used only for exit events." + }, + "targetType": { + "type": "string", + "description": "Target type used by the event.", + "enum": [ + "TARGET_BLANK", + "TARGET_PARENT", + "TARGET_POPUP", + "TARGET_SELF", + "TARGET_TOP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "videoReportingId": { + "type": "string", + "description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field." + } + } + }, + "CreativeField": { + "id": "CreativeField", + "type": "object", + "description": "Contains properties of a creative field.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this creative field. This is a read-only field that can be left blank.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this creative field. This is a required field on insertion.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "id": { + "type": "string", + "description": "ID of this creative field. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".", + "default": "dfareporting#creativeField" + }, + "name": { + "type": "string", + "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.", + "format": "int64" + } + } + }, + "CreativeFieldAssignment": { + "id": "CreativeFieldAssignment", + "type": "object", + "description": "Creative Field Assignment.", + "properties": { + "creativeFieldId": { + "type": "string", + "description": "ID of the creative field.", + "format": "int64" + }, + "creativeFieldValueId": { + "type": "string", + "description": "ID of the creative field value.", + "format": "int64" + } + } + }, + "CreativeFieldValue": { + "id": "CreativeFieldValue", + "type": "object", + "description": "Contains properties of a creative field value.", + "properties": { + "id": { + "type": "string", + "description": "ID of this creative field value. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".", + "default": "dfareporting#creativeFieldValue" + }, + "value": { + "type": "string", + "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field." + } + } + }, + "CreativeFieldValuesListResponse": { + "id": "CreativeFieldValuesListResponse", + "type": "object", + "description": "Creative Field Value List Response", + "properties": { + "creativeFieldValues": { + "type": "array", + "description": "Creative field value collection.", + "items": { + "$ref": "CreativeFieldValue" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".", + "default": "dfareporting#creativeFieldValuesListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "CreativeFieldsListResponse": { + "id": "CreativeFieldsListResponse", + "type": "object", + "description": "Creative Field List Response", + "properties": { + "creativeFields": { + "type": "array", + "description": "Creative field collection.", + "items": { + "$ref": "CreativeField" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".", + "default": "dfareporting#creativeFieldsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "CreativeGroup": { + "id": "CreativeGroup", + "type": "object", + "description": "Contains properties of a creative group.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this creative group. This is a read-only field that can be left blank.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this creative group. This is a required field on insertion.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "groupNumber": { + "type": "integer", + "description": "Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.\nAcceptable values are: \n- 1\n- 2", + "format": "int32" + }, + "id": { + "type": "string", + "description": "ID of this creative group. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".", + "default": "dfareporting#creativeGroup" + }, + "name": { + "type": "string", + "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.", + "format": "int64" + } + } + }, + "CreativeGroupAssignment": { + "id": "CreativeGroupAssignment", + "type": "object", + "description": "Creative Group Assignment.", + "properties": { + "creativeGroupId": { + "type": "string", + "description": "ID of the creative group to be assigned.", + "format": "int64" + }, + "creativeGroupNumber": { + "type": "string", + "description": "Creative group number of the creative group assignment.", + "enum": [ + "CREATIVE_GROUP_ONE", + "CREATIVE_GROUP_TWO" + ], + "enumDescriptions": [ + "", + "" + ] + } + } + }, + "CreativeGroupsListResponse": { + "id": "CreativeGroupsListResponse", + "type": "object", + "description": "Creative Group List Response", + "properties": { + "creativeGroups": { + "type": "array", + "description": "Creative group collection.", + "items": { + "$ref": "CreativeGroup" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".", + "default": "dfareporting#creativeGroupsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "CreativeOptimizationConfiguration": { + "id": "CreativeOptimizationConfiguration", + "type": "object", + "description": "Creative optimization settings.", + "properties": { + "id": { + "type": "string", + "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long." + }, + "optimizationActivitys": { + "type": "array", + "description": "List of optimization activities associated with this configuration.", + "items": { + "$ref": "OptimizationActivity" + } + }, + "optimizationModel": { + "type": "string", + "description": "Optimization model for this configuration.", + "enum": [ + "CLICK", + "POST_CLICK", + "POST_CLICK_AND_IMPRESSION", + "POST_IMPRESSION", + "VIDEO_COMPLETION" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + } + } + }, + "CreativeRotation": { + "id": "CreativeRotation", + "type": "object", + "description": "Creative Rotation.", + "properties": { + "creativeAssignments": { + "type": "array", + "description": "Creative assignments in this creative rotation.", + "items": { + "$ref": "CreativeAssignment" + } + }, + "creativeOptimizationConfigurationId": { + "type": "string", + "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.", + "format": "int64" + }, + "type": { + "type": "string", + "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.", + "enum": [ + "CREATIVE_ROTATION_TYPE_RANDOM", + "CREATIVE_ROTATION_TYPE_SEQUENTIAL" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "weightCalculationStrategy": { + "type": "string", + "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.", + "enum": [ + "WEIGHT_STRATEGY_CUSTOM", + "WEIGHT_STRATEGY_EQUAL", + "WEIGHT_STRATEGY_HIGHEST_CTR", + "WEIGHT_STRATEGY_OPTIMIZED" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + } + } + }, + "CreativeSettings": { + "id": "CreativeSettings", + "type": "object", + "description": "Creative Settings", + "properties": { + "iFrameFooter": { + "type": "string", + "description": "Header text for iFrames for this site. Must be less than or equal to 2000 characters long." + }, + "iFrameHeader": { + "type": "string", + "description": "Header text for iFrames for this site. Must be less than or equal to 2000 characters long." + } + } + }, + "CreativesListResponse": { + "id": "CreativesListResponse", + "type": "object", + "description": "Creative List Response", + "properties": { + "creatives": { + "type": "array", + "description": "Creative collection.", + "items": { + "$ref": "Creative" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".", + "default": "dfareporting#creativesListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "CrossDimensionReachReportCompatibleFields": { + "id": "CrossDimensionReachReportCompatibleFields", + "type": "object", + "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".", + "properties": { + "breakdown": { + "type": "array", + "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "dimensionFilters": { + "type": "array", + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.", + "default": "dfareporting#crossDimensionReachReportCompatibleFields" + }, + "metrics": { + "type": "array", + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + } + }, + "overlapMetrics": { + "type": "array", + "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.", + "items": { + "$ref": "Metric" + } + } + } + }, + "CustomRichMediaEvents": { + "id": "CustomRichMediaEvents", + "type": "object", + "description": "Represents a Custom Rich Media Events group.", + "properties": { + "filteredEventIds": { + "type": "array", + "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.", + "items": { + "$ref": "DimensionValue" + } + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.", + "default": "dfareporting#customRichMediaEvents" + } + } + }, + "DateRange": { + "id": "DateRange", + "type": "object", + "description": "Represents a date range.", + "properties": { + "endDate": { + "type": "string", + "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".", + "format": "date" + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#dateRange.", + "default": "dfareporting#dateRange" + }, + "relativeDateRange": { + "type": "string", + "description": "The date range relative to the date of when the report is run.", + "enum": [ + "LAST_24_MONTHS", + "LAST_30_DAYS", + "LAST_365_DAYS", + "LAST_7_DAYS", + "LAST_90_DAYS", + "MONTH_TO_DATE", + "PREVIOUS_MONTH", + "PREVIOUS_QUARTER", + "PREVIOUS_WEEK", + "PREVIOUS_YEAR", + "QUARTER_TO_DATE", + "TODAY", + "WEEK_TO_DATE", + "YEAR_TO_DATE", + "YESTERDAY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "startDate": { + "type": "string", + "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".", + "format": "date" + } + } + }, + "DayPartTargeting": { + "id": "DayPartTargeting", + "type": "object", + "description": "Day Part Targeting.", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Days of the week when the ad will serve.\n\nAcceptable values are:\n- \"SUNDAY\"\n- \"MONDAY\"\n- \"TUESDAY\"\n- \"WEDNESDAY\"\n- \"THURSDAY\"\n- \"FRIDAY\"\n- \"SATURDAY\"", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ] + } + }, + "hoursOfDay": { + "type": "array", + "description": "Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.", + "items": { + "type": "integer", + "format": "int32" + } + }, + "userLocalTime": { + "type": "boolean", + "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies." + } + } + }, + "DefaultClickThroughEventTagProperties": { + "id": "DefaultClickThroughEventTagProperties", + "type": "object", + "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.", + "properties": { + "defaultClickThroughEventTagId": { + "type": "string", + "description": "ID of the click-through event tag to apply to all ads in this entity's scope.", + "format": "int64" + }, + "overrideInheritedEventTag": { + "type": "boolean", + "description": "Whether this entity should override the inherited default click-through event tag with its own defined value." + } + } + }, + "DeliverySchedule": { + "id": "DeliverySchedule", + "type": "object", + "description": "Delivery Schedule.", + "properties": { + "frequencyCap": { + "$ref": "FrequencyCap", + "description": "Limit on the number of times an individual user can be served the ad within a specified period of time." + }, + "hardCutoff": { + "type": "boolean", + "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals." + }, + "impressionRatio": { + "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. Must be between 1 and 10.", + "format": "int64" + }, + "priority": { + "type": "string", + "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.", + "enum": [ + "AD_PRIORITY_01", + "AD_PRIORITY_02", + "AD_PRIORITY_03", + "AD_PRIORITY_04", + "AD_PRIORITY_05", + "AD_PRIORITY_06", + "AD_PRIORITY_07", + "AD_PRIORITY_08", + "AD_PRIORITY_09", + "AD_PRIORITY_10", + "AD_PRIORITY_11", + "AD_PRIORITY_12", + "AD_PRIORITY_13", + "AD_PRIORITY_14", + "AD_PRIORITY_15", + "AD_PRIORITY_16" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + } + } + }, + "DfpSettings": { + "id": "DfpSettings", + "type": "object", + "description": "DFP Settings", + "properties": { + "dfp_network_code": { + "type": "string", + "description": "DFP network code for this directory site." + }, + "dfp_network_name": { + "type": "string", + "description": "DFP network name for this directory site." + }, + "programmaticPlacementAccepted": { + "type": "boolean", + "description": "Whether this directory site accepts programmatic placements." + }, + "pubPaidPlacementAccepted": { + "type": "boolean", + "description": "Whether this directory site accepts publisher-paid tags." + }, + "publisherPortalOnly": { + "type": "boolean", + "description": "Whether this directory site is available only via DoubleClick Publisher Portal." + } + } + }, + "Dimension": { + "id": "Dimension", + "type": "object", + "description": "Represents a dimension.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#dimension.", + "default": "dfareporting#dimension" + }, + "name": { + "type": "string", + "description": "The dimension name, e.g. dfa:advertiser" + } + } + }, + "DimensionFilter": { + "id": "DimensionFilter", + "type": "object", + "description": "Represents a dimension filter.", + "properties": { + "dimensionName": { + "type": "string", + "description": "The name of the dimension to filter." + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.", + "default": "dfareporting#dimensionFilter" + }, + "value": { + "type": "string", + "description": "The value of the dimension to filter." + } + } + }, + "DimensionValue": { + "id": "DimensionValue", + "type": "object", + "description": "Represents a DimensionValue resource.", + "properties": { + "dimensionName": { + "type": "string", + "description": "The name of the dimension." + }, + "etag": { + "type": "string", + "description": "The eTag of this response for caching purposes." + }, + "id": { + "type": "string", + "description": "The ID associated with the value if available." + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#dimensionValue.", + "default": "dfareporting#dimensionValue" + }, + "matchType": { + "type": "string", + "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.", + "enum": [ + "BEGINS_WITH", + "CONTAINS", + "EXACT", + "WILDCARD_EXPRESSION" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "value": { + "type": "string", + "description": "The value of the dimension." + } + } + }, + "DimensionValueList": { + "id": "DimensionValueList", + "type": "object", + "description": "Represents the list of DimensionValue resources.", + "properties": { + "etag": { + "type": "string", + "description": "The eTag of this response for caching purposes." + }, + "items": { + "type": "array", + "description": "The dimension values returned in this response.", + "items": { + "$ref": "DimensionValue" + } + }, + "kind": { + "type": "string", + "description": "The kind of list this is, in this case dfareporting#dimensionValueList.", + "default": "dfareporting#dimensionValueList" + }, + "nextPageToken": { + "type": "string", + "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted." + } + } + }, + "DimensionValueRequest": { + "id": "DimensionValueRequest", + "type": "object", + "description": "Represents a DimensionValuesRequest.", + "properties": { + "dimensionName": { + "type": "string", + "description": "The name of the dimension for which values should be requested.", + "annotations": { + "required": [ + "dfareporting.dimensionValues.query" + ] + } + }, + "endDate": { + "type": "string", + "description": "The end date of the date range for which to retrieve dimension values. A string of the format \"yyyy-MM-dd\".", + "format": "date", + "annotations": { + "required": [ + "dfareporting.dimensionValues.query" + ] + } + }, + "filters": { + "type": "array", + "description": "The list of filters by which to filter values. The filters are ANDed.", + "items": { + "$ref": "DimensionFilter" + } + }, + "kind": { + "type": "string", + "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest.", + "default": "dfareporting#dimensionValueRequest" + }, + "startDate": { + "type": "string", + "description": "The start date of the date range for which to retrieve dimension values. A string of the format \"yyyy-MM-dd\".", + "format": "date", + "annotations": { + "required": [ + "dfareporting.dimensionValues.query" + ] + } + } + } + }, + "DirectorySite": { + "id": "DirectorySite", + "type": "object", + "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.", + "properties": { + "active": { + "type": "boolean", + "description": "Whether this directory site is active." + }, + "contactAssignments": { + "type": "array", + "description": "Directory site contacts.", + "items": { + "$ref": "DirectorySiteContactAssignment" + } + }, + "countryId": { + "type": "string", + "description": "Country ID of this directory site.", + "format": "int64" + }, + "currencyId": { + "type": "string", + "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", + "format": "int64" + }, + "description": { + "type": "string", + "description": "Description of this directory site." + }, + "id": { + "type": "string", + "description": "ID of this directory site. This is a read-only, auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field." + }, + "inpageTagFormats": { + "type": "array", + "description": "Tag types for regular placements.\n\nAcceptable values are:\n- \"STANDARD\"\n- \"IFRAME_JAVASCRIPT_INPAGE\"\n- \"INTERNAL_REDIRECT_INPAGE\"\n- \"JAVASCRIPT_INPAGE\"", + "items": { + "type": "string", + "enum": [ + "IFRAME_JAVASCRIPT_INPAGE", + "INTERNAL_REDIRECT_INPAGE", + "JAVASCRIPT_INPAGE", + "STANDARD" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + } + }, + "interstitialTagFormats": { + "type": "array", + "description": "Tag types for interstitial placements.\n\nAcceptable values are:\n- \"IFRAME_JAVASCRIPT_INTERSTITIAL\"\n- \"INTERNAL_REDIRECT_INTERSTITIAL\"\n- \"JAVASCRIPT_INTERSTITIAL\"", + "items": { + "type": "string", + "enum": [ + "IFRAME_JAVASCRIPT_INTERSTITIAL", + "INTERNAL_REDIRECT_INTERSTITIAL", + "JAVASCRIPT_INTERSTITIAL" + ], + "enumDescriptions": [ + "", + "", + "" + ] + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".", + "default": "dfareporting#directorySite" + }, + "name": { + "type": "string", + "description": "Name of this directory site." + }, + "parentId": { + "type": "string", + "description": "Parent directory site ID.", + "format": "int64" + }, + "settings": { + "$ref": "DirectorySiteSettings", + "description": "Directory site settings." + }, + "url": { + "type": "string", + "description": "URL of this directory site." + } + } + }, + "DirectorySiteContact": { + "id": "DirectorySiteContact", + "type": "object", + "description": "Contains properties of a Site Directory contact.", + "properties": { + "address": { + "type": "string", + "description": "Address of this directory site contact." + }, + "email": { + "type": "string", + "description": "Email address of this directory site contact." + }, + "firstName": { + "type": "string", + "description": "First name of this directory site contact." + }, + "id": { + "type": "string", + "description": "ID of this directory site contact. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySiteContact\".", + "default": "dfareporting#directorySiteContact" + }, + "lastName": { + "type": "string", + "description": "Last name of this directory site contact." + }, + "phone": { + "type": "string", + "description": "Phone number of this directory site contact." + }, + "role": { + "type": "string", + "description": "Directory site contact role.", + "enum": [ + "ADMIN", + "EDIT", + "VIEW" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "title": { + "type": "string", + "description": "Title or designation of this directory site contact." + }, + "type": { + "type": "string", + "description": "Directory site contact type.", + "enum": [ + "BILLING", + "OTHER", + "SALES", + "TECHNICAL" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + } + } + }, + "DirectorySiteContactAssignment": { + "id": "DirectorySiteContactAssignment", + "type": "object", + "description": "Directory Site Contact Assignment", + "properties": { + "contactId": { + "type": "string", + "description": "ID of this directory site contact. This is a read-only, auto-generated field.", + "format": "int64" + }, + "visibility": { + "type": "string", + "description": "Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.", + "enum": [ + "PRIVATE", + "PUBLIC" + ], + "enumDescriptions": [ + "", + "" + ] + } + } + }, + "DirectorySiteContactsListResponse": { + "id": "DirectorySiteContactsListResponse", + "type": "object", + "description": "Directory Site Contact List Response", + "properties": { + "directorySiteContacts": { + "type": "array", + "description": "Directory site contact collection", + "items": { + "$ref": "DirectorySiteContact" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySiteContactsListResponse\".", + "default": "dfareporting#directorySiteContactsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "DirectorySiteSettings": { + "id": "DirectorySiteSettings", + "type": "object", + "description": "Directory Site Settings", + "properties": { + "activeViewOptOut": { + "type": "boolean", + "description": "Whether this directory site has disabled active view creatives." + }, + "dfp_settings": { + "$ref": "DfpSettings", + "description": "Directory site DFP settings." + }, + "instream_video_placement_accepted": { + "type": "boolean", + "description": "Whether this site accepts in-stream video ads." + }, + "interstitialPlacementAccepted": { + "type": "boolean", + "description": "Whether this site accepts interstitial ads." + }, + "nielsenOcrOptOut": { + "type": "boolean", + "description": "Whether this directory site has disabled Nielsen OCR reach ratings." + }, + "verificationTagOptOut": { + "type": "boolean", + "description": "Whether this directory site has disabled generation of Verification ins tags." + }, + "videoActiveViewOptOut": { + "type": "boolean", + "description": "Whether this directory site has disabled active view for in-stream video creatives." + } + } + }, + "DirectorySitesListResponse": { + "id": "DirectorySitesListResponse", + "type": "object", + "description": "Directory Site List Response", + "properties": { + "directorySites": { + "type": "array", + "description": "Directory site collection.", + "items": { + "$ref": "DirectorySite" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".", + "default": "dfareporting#directorySitesListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "EventTag": { + "id": "EventTag", + "type": "object", + "description": "Contains properties of an event tag.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this event tag. This is a read-only field that can be left blank.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "campaignId": { + "type": "string", + "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.", + "format": "int64" + }, + "campaignIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field." + }, + "enabledByDefault": { + "type": "boolean", + "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads." + }, + "excludeFromAdxRequests": { + "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." + }, + "id": { + "type": "string", + "description": "ID of this event tag. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".", + "default": "dfareporting#eventTag" + }, + "name": { + "type": "string", + "description": "Name of this event tag. This is a required field and must be less than 256 characters long." + }, + "siteFilterType": { + "type": "string", + "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.", + "enum": [ + "BLACKLIST", + "WHITELIST" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "siteIds": { + "type": "array", + "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.", + "items": { + "type": "string", + "format": "int64" + } + }, + "sslCompliant": { + "type": "boolean", + "description": "Whether this tag is SSL-compliant or not. This is a read-only field." + }, + "status": { + "type": "string", + "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.", + "enum": [ + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.", + "format": "int64" + }, + "type": { + "type": "string", + "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.", + "enum": [ + "CLICK_THROUGH_EVENT_TAG", + "IMPRESSION_IMAGE_EVENT_TAG", + "IMPRESSION_JAVASCRIPT_EVENT_TAG" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "url": { + "type": "string", + "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion." + }, + "urlEscapeLevels": { + "type": "integer", + "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.", + "format": "int32" + } + } + }, + "EventTagOverride": { + "id": "EventTagOverride", + "type": "object", + "description": "Event tag override information.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether this override is enabled." + }, + "id": { + "type": "string", + "description": "ID of this event tag override. This is a read-only, auto-generated field.", + "format": "int64" + } + } + }, + "EventTagsListResponse": { + "id": "EventTagsListResponse", + "type": "object", + "description": "Event Tag List Response", + "properties": { + "eventTags": { + "type": "array", + "description": "Event tag collection.", + "items": { + "$ref": "EventTag" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".", + "default": "dfareporting#eventTagsListResponse" + } + } + }, + "File": { + "id": "File", + "type": "object", + "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".", + "properties": { + "dateRange": { + "$ref": "DateRange", + "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run." + }, + "etag": { + "type": "string", + "description": "The eTag of this response for caching purposes." + }, + "fileName": { + "type": "string", + "description": "The filename of the file." + }, + "format": { + "type": "string", + "description": "The output format of the report. Only available once the file is available.", + "enum": [ + "CSV", + "EXCEL" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "id": { + "type": "string", + "description": "The unique ID of this report file.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#file.", + "default": "dfareporting#file" + }, + "lastModifiedTime": { + "type": "string", + "description": "The timestamp in milliseconds since epoch when this file was last modified.", + "format": "int64" + }, + "reportId": { + "type": "string", + "description": "The ID of the report this file was generated from.", + "format": "int64" + }, + "status": { + "type": "string", + "description": "The status of the report file.", + "enum": [ + "CANCELLED", + "FAILED", + "PROCESSING", + "REPORT_AVAILABLE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "urls": { + "type": "object", + "description": "The URLs where the completed report file can be downloaded.", + "properties": { + "apiUrl": { + "type": "string", + "description": "The URL for downloading the report data through the API." + }, + "browserUrl": { + "type": "string", + "description": "The URL for downloading the report data through a browser." + } + } + } + } + }, + "FileList": { + "id": "FileList", + "type": "object", + "description": "Represents the list of File resources.", + "properties": { + "etag": { + "type": "string", + "description": "The eTag of this response for caching purposes." + }, + "items": { + "type": "array", + "description": "The files returned in this response.", + "items": { + "$ref": "File" + } + }, + "kind": { + "type": "string", + "description": "The kind of list this is, in this case dfareporting#fileList.", + "default": "dfareporting#fileList" + }, + "nextPageToken": { + "type": "string", + "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted." + } + } + }, + "Flight": { + "id": "Flight", + "type": "object", + "description": "Flight", + "properties": { + "endDate": { + "type": "string", + "description": "Inventory item flight end date.", + "format": "date" + }, + "rateOrCost": { + "type": "string", + "description": "Rate or cost of this flight.", + "format": "int64" + }, + "startDate": { + "type": "string", + "description": "Inventory item flight start date.", + "format": "date" + }, + "units": { + "type": "string", + "description": "Units of this flight.", + "format": "int64" + } + } + }, + "FloodlightActivitiesGenerateTagResponse": { + "id": "FloodlightActivitiesGenerateTagResponse", + "type": "object", + "description": "Floodlight Activity GenerateTag Response", + "properties": { + "floodlightActivityTag": { + "type": "string", + "description": "Generated tag for this floodlight activity." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".", + "default": "dfareporting#floodlightActivitiesGenerateTagResponse" + } + } + }, + "FloodlightActivitiesListResponse": { + "id": "FloodlightActivitiesListResponse", + "type": "object", + "description": "Floodlight Activity List Response", + "properties": { + "floodlightActivities": { + "type": "array", + "description": "Floodlight activity collection.", + "items": { + "$ref": "FloodlightActivity" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".", + "default": "dfareporting#floodlightActivitiesListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "FloodlightActivity": { + "id": "FloodlightActivity", + "type": "object", + "description": "Contains properties of a Floodlight activity.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "cacheBustingType": { + "type": "string", + "description": "Code type used for cache busting in the generated tag.", + "enum": [ + "ACTIVE_SERVER_PAGE", + "COLD_FUSION", + "JAVASCRIPT", + "JSP", + "PHP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "countingMethod": { + "type": "string", + "description": "Counting method for conversions for this floodlight activity. This is a required field.", + "enum": [ + "ITEMS_SOLD_COUNTING", + "SESSION_COUNTING", + "STANDARD_COUNTING", + "TRANSACTIONS_COUNTING", + "UNIQUE_COUNTING" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "defaultTags": { + "type": "array", + "description": "Dynamic floodlight tags.", + "items": { + "$ref": "FloodlightActivityDynamicTag" + } + }, + "expectedUrl": { + "type": "string", + "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long." + }, + "floodlightActivityGroupId": { + "type": "string", + "description": "Floodlight activity group ID of this floodlight activity. This is a required field.", + "format": "int64" + }, + "floodlightActivityGroupName": { + "type": "string", + "description": "Name of the associated floodlight activity group. This is a read-only field." + }, + "floodlightActivityGroupTagString": { + "type": "string", + "description": "Tag string of the associated floodlight activity group. This is a read-only field." + }, + "floodlightActivityGroupType": { + "type": "string", + "description": "Type of the associated floodlight activity group. This is a read-only field.", + "enum": [ + "COUNTER", + "SALE" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "floodlightConfigurationId": { + "type": "string", + "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.", + "format": "int64" + }, + "floodlightConfigurationIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field." + }, + "hidden": { + "type": "boolean", + "description": "Whether this activity is archived." + }, + "id": { + "type": "string", + "description": "ID of this floodlight activity. This is a read-only, auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field." + }, + "imageTagEnabled": { + "type": "boolean", + "description": "Whether the image tag is enabled for this activity." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".", + "default": "dfareporting#floodlightActivity" + }, + "name": { + "type": "string", + "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes." + }, + "notes": { + "type": "string", + "description": "General notes or implementation instructions for the tag." + }, + "publisherTags": { + "type": "array", + "description": "Publisher dynamic floodlight tags.", + "items": { + "$ref": "FloodlightActivityPublisherDynamicTag" + } + }, + "secure": { + "type": "boolean", + "description": "Whether this tag should use SSL." + }, + "sslCompliant": { + "type": "boolean", + "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags." + }, + "sslRequired": { + "type": "boolean", + "description": "Whether this floodlight activity must be SSL-compliant." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.", + "format": "int64" + }, + "tagFormat": { + "type": "string", + "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.", + "enum": [ + "HTML", + "XHTML" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "tagString": { + "type": "string", + "description": "Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion." + }, + "userDefinedVariableTypes": { + "type": "array", + "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-20]=\" in the tags. Each of these can have a user defined type.\nAcceptable values are:\n- \"U1\"\n- \"U2\"\n- \"U3\"\n- \"U4\"\n- \"U5\"\n- \"U6\"\n- \"U7\"\n- \"U8\"\n- \"U9\"\n- \"U10\"\n- \"U11\"\n- \"U12\"\n- \"U13\"\n- \"U14\"\n- \"U15\"\n- \"U16\"\n- \"U17\"\n- \"U18\"\n- \"U19\"\n- \"U20\"", + "items": { + "type": "string", + "enum": [ + "U1", + "U10", + "U11", + "U12", + "U13", + "U14", + "U15", + "U16", + "U17", + "U18", + "U19", + "U2", + "U20", + "U3", + "U4", + "U5", + "U6", + "U7", + "U8", + "U9" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + } + } + } + }, + "FloodlightActivityDynamicTag": { + "id": "FloodlightActivityDynamicTag", + "type": "object", + "description": "Dynamic Tag", + "properties": { + "id": { + "type": "string", + "description": "ID of this dynamic tag. This is a read-only, auto-generated field.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "Name of this tag." + }, + "tag": { + "type": "string", + "description": "Tag code." + } + } + }, + "FloodlightActivityGroup": { + "id": "FloodlightActivityGroup", + "type": "object", + "description": "Contains properties of a Floodlight activity group.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "floodlightConfigurationId": { + "type": "string", + "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.", + "format": "int64" + }, + "floodlightConfigurationIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field." + }, + "id": { + "type": "string", + "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".", + "default": "dfareporting#floodlightActivityGroup" + }, + "name": { + "type": "string", + "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.", + "format": "int64" + }, + "tagString": { + "type": "string", + "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion." + }, + "type": { + "type": "string", + "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.", + "enum": [ + "COUNTER", + "SALE" + ], + "enumDescriptions": [ + "", + "" + ] + } + } + }, + "FloodlightActivityGroupsListResponse": { + "id": "FloodlightActivityGroupsListResponse", + "type": "object", + "description": "Floodlight Activity Group List Response", + "properties": { + "floodlightActivityGroups": { + "type": "array", + "description": "Floodlight activity group collection.", + "items": { + "$ref": "FloodlightActivityGroup" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".", + "default": "dfareporting#floodlightActivityGroupsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "FloodlightActivityPublisherDynamicTag": { + "id": "FloodlightActivityPublisherDynamicTag", + "type": "object", + "description": "Publisher Dynamic Tag", + "properties": { + "clickThrough": { + "type": "boolean", + "description": "Whether this tag is applicable only for click-throughs." + }, + "directorySiteId": { + "type": "string", + "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.", + "format": "int64" + }, + "dynamicTag": { + "$ref": "FloodlightActivityDynamicTag", + "description": "Dynamic floodlight tag." + }, + "siteId": { + "type": "string", + "description": "Site ID of this dynamic tag.", + "format": "int64" + }, + "siteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field." + }, + "viewThrough": { + "type": "boolean", + "description": "Whether this tag is applicable only for view-throughs." + } + } + }, + "FloodlightConfiguration": { + "id": "FloodlightConfiguration", + "type": "object", + "description": "Contains properties of a Floodlight configuration.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of the parent advertiser of this floodlight configuration.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "analyticsDataSharingEnabled": { + "type": "boolean", + "description": "Whether advertiser data is shared with Google Analytics." + }, + "exposureToConversionEnabled": { + "type": "boolean", + "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting." + }, + "firstDayOfWeek": { + "type": "string", + "description": "Day that will be counted as the first day of the week in reports. This is a required field.", + "enum": [ + "MONDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "id": { + "type": "string", + "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field." + }, + "inAppAttributionTrackingEnabled": { + "type": "boolean", + "description": "Whether in-app attribution tracking is enabled." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".", + "default": "dfareporting#floodlightConfiguration" + }, + "lookbackConfiguration": { + "$ref": "LookbackConfiguration", + "description": "Lookback window settings for this floodlight configuration." + }, + "naturalSearchConversionAttributionOption": { + "type": "string", + "description": "Types of attribution options for natural search conversions.", + "enum": [ + "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION", + "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION", + "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "omnitureSettings": { + "$ref": "OmnitureSettings", + "description": "Settings for DCM Omniture integration." + }, + "standardVariableTypes": { + "type": "array", + "description": "List of standard variables enabled for this configuration.\n\nAcceptable values are:\n- \"ORD\"\n- \"NUM\"", + "items": { + "type": "string", + "enum": [ + "NUM", + "ORD", + "TRAN", + "U" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + } + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.", + "format": "int64" + }, + "tagSettings": { + "$ref": "TagSettings", + "description": "Configuration settings for dynamic and image floodlight tags." + }, + "thirdPartyAuthenticationTokens": { + "type": "array", + "description": "List of third-party authentication tokens enabled for this configuration.", + "items": { + "$ref": "ThirdPartyAuthenticationToken" + } + }, + "userDefinedVariableConfigurations": { + "type": "array", + "description": "List of user defined variables enabled for this configuration.", + "items": { + "$ref": "UserDefinedVariableConfiguration" + } + } + } + }, + "FloodlightConfigurationsListResponse": { + "id": "FloodlightConfigurationsListResponse", + "type": "object", + "description": "Floodlight Configuration List Response", + "properties": { + "floodlightConfigurations": { + "type": "array", + "description": "Floodlight configuration collection.", + "items": { + "$ref": "FloodlightConfiguration" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".", + "default": "dfareporting#floodlightConfigurationsListResponse" + } + } + }, + "FloodlightReportCompatibleFields": { + "id": "FloodlightReportCompatibleFields", + "type": "object", + "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".", + "properties": { + "dimensionFilters": { + "type": "array", + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "dimensions": { + "type": "array", + "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.", + "default": "dfareporting#floodlightReportCompatibleFields" + }, + "metrics": { + "type": "array", + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + } + } + } + }, + "FrequencyCap": { + "id": "FrequencyCap", + "type": "object", + "description": "Frequency Cap.", + "properties": { + "duration": { + "type": "string", + "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.", + "format": "int64" + }, + "impressions": { + "type": "string", + "description": "Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.", + "format": "int64" + } + } + }, + "FsCommand": { + "id": "FsCommand", + "type": "object", + "description": "FsCommand.", + "properties": { + "left": { + "type": "integer", + "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.", + "format": "int32" + }, + "positionOption": { + "type": "string", + "description": "Position in the browser where the window will open.", + "enum": [ + "CENTERED", + "DISTANCE_FROM_TOP_LEFT_CORNER" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "top": { + "type": "integer", + "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.", + "format": "int32" + }, + "windowHeight": { + "type": "integer", + "description": "Height of the window.", + "format": "int32" + }, + "windowWidth": { + "type": "integer", + "description": "Width of the window.", + "format": "int32" + } + } + }, + "GeoTargeting": { + "id": "GeoTargeting", + "type": "object", + "description": "Geographical Targeting.", + "properties": { + "cities": { + "type": "array", + "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.", + "items": { + "$ref": "City" + } + }, + "countries": { + "type": "array", + "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.", + "items": { + "$ref": "Country" + } + }, + "excludeCountries": { + "type": "boolean", + "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad." + }, + "metros": { + "type": "array", + "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.", + "items": { + "$ref": "Metro" + } + }, + "postalCodes": { + "type": "array", + "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.", + "items": { + "$ref": "PostalCode" + } + }, + "regions": { + "type": "array", + "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.", + "items": { + "$ref": "Region" + } + } + } + }, + "InventoryItem": { + "id": "InventoryItem", + "type": "object", + "description": "Represents a buy from the DoubleClick Planning inventory store.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this inventory item.", + "format": "int64" + }, + "adSlots": { + "type": "array", + "description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.", + "items": { + "$ref": "AdSlot" + } + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this inventory item.", + "format": "int64" + }, + "contentCategoryId": { + "type": "string", + "description": "Content category ID of this inventory item.", + "format": "int64" + }, + "estimatedClickThroughRate": { + "type": "string", + "description": "Estimated click-through rate of this inventory item.", + "format": "int64" + }, + "estimatedConversionRate": { + "type": "string", + "description": "Estimated conversion rate of this inventory item.", + "format": "int64" + }, + "id": { + "type": "string", + "description": "ID of this inventory item.", + "format": "int64" + }, + "inPlan": { + "type": "boolean", + "description": "Whether this inventory item is in plan." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".", + "default": "dfareporting#inventoryItem" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this inventory item." + }, + "name": { + "type": "string", + "description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots." + }, + "negotiationChannelId": { + "type": "string", + "description": "Negotiation channel ID of this inventory item.", + "format": "int64" + }, + "orderId": { + "type": "string", + "description": "Order ID of this inventory item.", + "format": "int64" + }, + "placementStrategyId": { + "type": "string", + "description": "Placement strategy ID of this inventory item.", + "format": "int64" + }, + "pricing": { + "$ref": "Pricing", + "description": "Pricing of this inventory item." + }, + "projectId": { + "type": "string", + "description": "Project ID of this inventory item.", + "format": "int64" + }, + "rfpId": { + "type": "string", + "description": "RFP ID of this inventory item.", + "format": "int64" + }, + "siteId": { + "type": "string", + "description": "ID of the site this inventory item is associated with.", + "format": "int64" + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this inventory item.", + "format": "int64" + }, + "type": { + "type": "string", + "description": "Type of inventory item.", + "enum": [ + "PLANNING_PLACEMENT_TYPE_CREDIT", + "PLANNING_PLACEMENT_TYPE_REGULAR" + ], + "enumDescriptions": [ + "", + "" + ] + } + } + }, + "InventoryItemsListResponse": { + "id": "InventoryItemsListResponse", + "type": "object", + "description": "Inventory item List Response", + "properties": { + "inventoryItems": { + "type": "array", + "description": "Inventory item collection", + "items": { + "$ref": "InventoryItem" + } + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".", + "default": "dfareporting#inventoryItemsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + } + } + }, + "KeyValueTargetingExpression": { + "id": "KeyValueTargetingExpression", + "type": "object", + "description": "Key Value Targeting Expression.", + "properties": { + "expression": { + "type": "string", + "description": "Keyword expression being targeted by the ad." + } + } + }, + "LandingPage": { + "id": "LandingPage", + "type": "object", + "description": "Contains information about where a user's browser is taken after the user clicks an ad.", + "properties": { + "default": { + "type": "boolean", + "description": "Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign." + }, + "id": { + "type": "string", + "description": "ID of this landing page. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".", + "default": "dfareporting#landingPage" + }, + "name": { + "type": "string", + "description": "Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign." + }, + "url": { + "type": "string", + "description": "URL of this landing page. This is a required field." + } + } + }, + "LandingPagesListResponse": { + "id": "LandingPagesListResponse", + "type": "object", + "description": "Landing Page List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPagesListResponse\".", + "default": "dfareporting#landingPagesListResponse" + }, + "landingPages": { + "type": "array", + "description": "Landing page collection", + "items": { + "$ref": "LandingPage" + } + } + } + }, + "LastModifiedInfo": { + "id": "LastModifiedInfo", + "type": "object", + "description": "Modification timestamp.", + "properties": { + "time": { + "type": "string", + "description": "Timestamp of the last change in milliseconds since epoch.", + "format": "int64" + } + } + }, + "ListPopulationClause": { + "id": "ListPopulationClause", + "type": "object", + "description": "A group clause made up of list population terms representing constraints joined by ORs.", + "properties": { + "terms": { + "type": "array", + "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.", + "items": { + "$ref": "ListPopulationTerm" + } + } + } + }, + "ListPopulationRule": { + "id": "ListPopulationRule", + "type": "object", + "description": "Remarketing List Population Rule.", + "properties": { + "floodlightActivityId": { + "type": "string", + "description": "Floodlight activity ID associated with this rule. This field can be left blank.", + "format": "int64" + }, + "floodlightActivityName": { + "type": "string", + "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field." + }, + "listPopulationClauses": { + "type": "array", + "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.", + "items": { + "$ref": "ListPopulationClause" + } + } + } + }, + "ListPopulationTerm": { + "id": "ListPopulationTerm", + "type": "object", + "description": "Remarketing List Population Rule Term.", + "properties": { + "contains": { + "type": "boolean", + "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default." + }, + "negation": { + "type": "boolean", + "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM." + }, + "operator": { + "type": "string", + "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.", + "enum": [ + "NUM_EQUALS", + "NUM_GREATER_THAN", + "NUM_GREATER_THAN_EQUAL", + "NUM_LESS_THAN", + "NUM_LESS_THAN_EQUAL", + "STRING_CONTAINS", + "STRING_EQUALS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ] + }, + "remarketingListId": { + "type": "string", + "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.", + "format": "int64" + }, + "type": { + "type": "string", + "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.", + "enum": [ + "CUSTOM_VARIABLE_TERM", + "LIST_MEMBERSHIP_TERM", + "REFERRER_TERM" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "value": { + "type": "string", + "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM." + }, + "variableFriendlyName": { + "type": "string", + "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM." + }, + "variableName": { + "type": "string", + "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM." + } + } + }, + "ListTargetingExpression": { + "id": "ListTargetingExpression", + "type": "object", + "description": "Remarketing List Targeting Expression.", + "properties": { + "expression": { + "type": "string", + "description": "Expression describing which lists are being targeted by the ad." + } + } + }, + "LookbackConfiguration": { + "id": "LookbackConfiguration", + "type": "object", + "description": "Lookback configuration settings.", + "properties": { + "clickDuration": { + "type": "integer", + "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.", + "format": "int32" + }, + "postImpressionActivitiesDuration": { + "type": "integer", + "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.", + "format": "int32" + } + } + }, + "Metric": { + "id": "Metric", + "type": "object", + "description": "Represents a metric.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#metric.", + "default": "dfareporting#metric" + }, + "name": { + "type": "string", + "description": "The metric name, e.g. dfa:impressions" + } + } + }, + "Metro": { + "id": "Metro", + "type": "object", + "description": "Contains information about a metro region that can be targeted by ads.", + "properties": { + "countryCode": { + "type": "string", + "description": "Country code of the country to which this metro region belongs." + }, + "countryDartId": { + "type": "string", + "description": "DART ID of the country to which this metro region belongs.", + "format": "int64" + }, + "dartId": { + "type": "string", + "description": "DART ID of this metro region.", + "format": "int64" + }, + "dmaId": { + "type": "string", + "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".", + "default": "dfareporting#metro" + }, + "metroCode": { + "type": "string", + "description": "Metro code of this metro region. This is equivalent to dma_id." + }, + "name": { + "type": "string", + "description": "Name of this metro region." + } + } + }, + "MetrosListResponse": { + "id": "MetrosListResponse", + "type": "object", + "description": "Metro List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".", + "default": "dfareporting#metrosListResponse" + }, + "metros": { + "type": "array", + "description": "Metro collection.", + "items": { + "$ref": "Metro" + } + } + } + }, + "MobileCarrier": { + "id": "MobileCarrier", + "type": "object", + "description": "Contains information about a mobile carrier that can be targeted by ads.", + "properties": { + "countryCode": { + "type": "string", + "description": "Country code of the country to which this mobile carrier belongs." + }, + "countryDartId": { + "type": "string", + "description": "DART ID of the country to which this mobile carrier belongs.", + "format": "int64" + }, + "id": { + "type": "string", + "description": "ID of this mobile carrier.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".", + "default": "dfareporting#mobileCarrier" + }, + "name": { + "type": "string", + "description": "Name of this mobile carrier." + } + } + }, + "MobileCarriersListResponse": { + "id": "MobileCarriersListResponse", + "type": "object", + "description": "Mobile Carrier List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".", + "default": "dfareporting#mobileCarriersListResponse" + }, + "mobileCarriers": { + "type": "array", + "description": "Mobile carrier collection.", + "items": { + "$ref": "MobileCarrier" + } + } + } + }, + "ObjectFilter": { + "id": "ObjectFilter", + "type": "object", + "description": "Object Filter.", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".", + "default": "dfareporting#objectFilter" + }, + "objectIds": { + "type": "array", + "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.", + "items": { + "type": "string", + "format": "int64" + } + }, + "status": { + "type": "string", + "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.", + "enum": [ + "ALL", + "ASSIGNED", + "NONE" + ], + "enumDescriptions": [ + "", + "", + "" + ] + } + } + }, + "OffsetPosition": { + "id": "OffsetPosition", + "type": "object", + "description": "Offset Position.", + "properties": { + "left": { + "type": "integer", + "description": "Offset distance from left side of an asset or a window.", + "format": "int32" + }, + "top": { + "type": "integer", + "description": "Offset distance from top side of an asset or a window.", + "format": "int32" + } + } + }, + "OmnitureSettings": { + "id": "OmnitureSettings", + "type": "object", + "description": "Omniture Integration Settings.", + "properties": { + "omnitureCostDataEnabled": { + "type": "boolean", + "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true." + }, + "omnitureIntegrationEnabled": { + "type": "boolean", + "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled." + } + } + }, + "OperatingSystem": { + "id": "OperatingSystem", + "type": "object", + "description": "Contains information about an operating system that can be targeted by ads.", + "properties": { + "dartId": { + "type": "string", + "description": "DART ID of this operating system. This is the ID used for targeting.", + "format": "int64" + }, + "desktop": { + "type": "boolean", + "description": "Whether this operating system is for desktop." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".", + "default": "dfareporting#operatingSystem" + }, + "mobile": { + "type": "boolean", + "description": "Whether this operating system is for mobile." + }, + "name": { + "type": "string", + "description": "Name of this operating system." + } + } + }, + "OperatingSystemVersion": { + "id": "OperatingSystemVersion", + "type": "object", + "description": "Contains information about a particular version of an operating system that can be targeted by ads.", + "properties": { + "id": { + "type": "string", + "description": "ID of this operating system version.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".", + "default": "dfareporting#operatingSystemVersion" + }, + "majorVersion": { + "type": "string", + "description": "Major version (leftmost number) of this operating system version." + }, + "minorVersion": { + "type": "string", + "description": "Minor version (number after the first dot) of this operating system version." + }, + "name": { + "type": "string", + "description": "Name of this operating system version." + }, + "operatingSystem": { + "$ref": "OperatingSystem", + "description": "Operating system of this operating system version." + } + } + }, + "OperatingSystemVersionsListResponse": { + "id": "OperatingSystemVersionsListResponse", + "type": "object", + "description": "Operating System Version List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".", + "default": "dfareporting#operatingSystemVersionsListResponse" + }, + "operatingSystemVersions": { + "type": "array", + "description": "Operating system version collection.", + "items": { + "$ref": "OperatingSystemVersion" + } + } + } + }, + "OperatingSystemsListResponse": { + "id": "OperatingSystemsListResponse", + "type": "object", + "description": "Operating System List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".", + "default": "dfareporting#operatingSystemsListResponse" + }, + "operatingSystems": { + "type": "array", + "description": "Operating system collection.", + "items": { + "$ref": "OperatingSystem" + } + } + } + }, + "OptimizationActivity": { + "id": "OptimizationActivity", + "type": "object", + "description": "Creative optimization activity.", + "properties": { + "floodlightActivityId": { + "type": "string", + "description": "Floodlight activity ID of this optimization activity. This is a required field.", + "format": "int64" + }, + "floodlightActivityIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field." + }, + "weight": { + "type": "integer", + "description": "Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.", + "format": "int32" + } + } + }, + "Order": { + "id": "Order", + "type": "object", + "description": "Describes properties of a DoubleClick Planning order.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this order.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this order.", + "format": "int64" + }, + "approverUserProfileIds": { + "type": "array", + "description": "IDs for users that have to approve documents created for this order.", + "items": { + "type": "string", + "format": "int64" + } + }, + "buyerInvoiceId": { + "type": "string", + "description": "Buyer invoice ID associated with this order." + }, + "buyerOrganizationName": { + "type": "string", + "description": "Name of the buyer organization." + }, + "comments": { + "type": "string", + "description": "Comments in this order." + }, + "contacts": { + "type": "array", + "description": "Contacts for this order.", + "items": { + "$ref": "OrderContact" + } + }, + "id": { + "type": "string", + "description": "ID of this order. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\".", + "default": "dfareporting#order" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this order." + }, + "name": { + "type": "string", + "description": "Name of this order." + }, + "notes": { + "type": "string", + "description": "Notes of this order." + }, + "planningTermId": { + "type": "string", + "description": "ID of the terms and conditions template used in this order.", + "format": "int64" + }, + "projectId": { + "type": "string", + "description": "Project ID of this order.", + "format": "int64" + }, + "sellerOrderId": { + "type": "string", + "description": "Seller order ID associated with this order." + }, + "sellerOrganizationName": { + "type": "string", + "description": "Name of the seller organization." + }, + "siteId": { + "type": "array", + "description": "Site IDs this order is associated with.", + "items": { + "type": "string", + "format": "int64" + } + }, + "siteNames": { + "type": "array", + "description": "Free-form site names this order is associated with.", + "items": { + "type": "string" + } + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this order.", + "format": "int64" + }, + "termsAndConditions": { + "type": "string", + "description": "Terms and conditions of this order." + } + } + }, + "OrderContact": { + "id": "OrderContact", + "type": "object", + "description": "Contact of an order.", + "properties": { + "contactInfo": { + "type": "string", + "description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID." + }, + "contactName": { + "type": "string", + "description": "Name of this contact." + }, + "contactTitle": { + "type": "string", + "description": "Title of this contact." + }, + "contactType": { + "type": "string", + "description": "Type of this contact.", + "enum": [ + "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT", + "PLANNING_ORDER_CONTACT_BUYER_CONTACT", + "PLANNING_ORDER_CONTACT_SELLER_CONTACT" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "signatureUserProfileId": { + "type": "string", + "description": "ID of the user profile containing the signature that will be embedded into order documents.", + "format": "int64" + } + } + }, + "OrderDocument": { + "id": "OrderDocument", + "type": "object", + "description": "Contains properties of a DoubleClick Planning order document.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this order document.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this order document.", + "format": "int64" + }, + "amendedOrderDocumentId": { + "type": "string", + "description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.", + "format": "int64" + }, + "approvedByUserProfileIds": { + "type": "array", + "description": "IDs of users who have approved this order document.", + "items": { + "type": "string", + "format": "int64" + } + }, + "cancelled": { + "type": "boolean", + "description": "Whether this order document is cancelled." + }, + "createdInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the creation of this order document." + }, + "effectiveDate": { + "type": "string", + "description": "Effective date of this order document.", + "format": "date" + }, + "id": { + "type": "string", + "description": "ID of this order document.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\".", + "default": "dfareporting#orderDocument" + }, + "lastSentRecipients": { + "type": "array", + "description": "List of email addresses that received the last sent document.", + "items": { + "type": "string" + } + }, + "lastSentTime": { + "type": "string", + "description": "Timestamp of the last email sent with this order document.", + "format": "date-time" + }, + "orderId": { + "type": "string", + "description": "ID of the order from which this order document is created.", + "format": "int64" + }, + "projectId": { + "type": "string", + "description": "Project ID of this order document.", + "format": "int64" + }, + "signed": { + "type": "boolean", + "description": "Whether this order document has been signed." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this order document.", + "format": "int64" + }, + "title": { + "type": "string", + "description": "Title of this order document." + }, + "type": { + "type": "string", + "description": "Type of this order document", + "enum": [ + "PLANNING_ORDER_TYPE_CHANGE_ORDER", + "PLANNING_ORDER_TYPE_INSERTION_ORDER" + ], + "enumDescriptions": [ + "", + "" + ] + } + } + }, + "OrderDocumentsListResponse": { + "id": "OrderDocumentsListResponse", + "type": "object", + "description": "Order document List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\".", + "default": "dfareporting#orderDocumentsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "orderDocuments": { + "type": "array", + "description": "Order document collection", + "items": { + "$ref": "OrderDocument" + } + } + } + }, + "OrdersListResponse": { + "id": "OrdersListResponse", + "type": "object", + "description": "Order List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\".", + "default": "dfareporting#ordersListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "orders": { + "type": "array", + "description": "Order collection.", + "items": { + "$ref": "Order" + } + } + } + }, + "PathToConversionReportCompatibleFields": { + "id": "PathToConversionReportCompatibleFields", + "type": "object", + "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".", + "properties": { + "conversionDimensions": { + "type": "array", + "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "customFloodlightVariables": { + "type": "array", + "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.", + "default": "dfareporting#pathToConversionReportCompatibleFields" + }, + "metrics": { + "type": "array", + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + } + }, + "perInteractionDimensions": { + "type": "array", + "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.", + "items": { + "$ref": "Dimension" + } + } + } + }, + "Placement": { + "id": "Placement", + "type": "object", + "description": "Contains properties of a placement.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this placement. This field can be left blank.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this placement. This field can be left blank.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "archived": { + "type": "boolean", + "description": "Whether this placement is archived." + }, + "campaignId": { + "type": "string", + "description": "Campaign ID of this placement. This field is a required field on insertion.", + "format": "int64" + }, + "campaignIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field." + }, + "comment": { + "type": "string", + "description": "Comments for this placement." + }, + "compatibility": { + "type": "string", + "description": "Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.This field is required on insertion.", + "enum": [ + "APP", + "APP_INTERSTITIAL", + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "IN_STREAM_VIDEO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "contentCategoryId": { + "type": "string", + "description": "ID of the content category assigned to this placement.", + "format": "int64" + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the creation of this placement. This is a read-only field." + }, + "directorySiteId": { + "type": "string", + "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.", + "format": "int64" + }, + "directorySiteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field." + }, + "externalId": { + "type": "string", + "description": "External ID for this placement." + }, + "id": { + "type": "string", + "description": "ID of this placement. This is a read-only, auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field." + }, + "keyName": { + "type": "string", + "description": "Key name of this placement. This is a read-only, auto-generated field." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".", + "default": "dfareporting#placement" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this placement. This is a read-only field." + }, + "lookbackConfiguration": { + "$ref": "LookbackConfiguration", + "description": "Lookback window settings for this placement." + }, + "name": { + "type": "string", + "description": "Name of this placement.This is a required field and must be less than 256 characters long." + }, + "paymentApproved": { + "type": "boolean", + "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements." + }, + "paymentSource": { + "type": "string", + "description": "Payment source for this placement. This is a required field that is read-only after insertion.", + "enum": [ + "PLACEMENT_AGENCY_PAID", + "PLACEMENT_PUBLISHER_PAID" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "placementGroupId": { + "type": "string", + "description": "ID of this placement's group, if applicable.", + "format": "int64" + }, + "placementGroupIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field." + }, + "placementStrategyId": { + "type": "string", + "description": "ID of the placement strategy assigned to this placement.", + "format": "int64" + }, + "pricingSchedule": { + "$ref": "PricingSchedule", + "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType." + }, + "primary": { + "type": "boolean", + "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement." + }, + "publisherUpdateInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the last publisher update. This is a read-only field." + }, + "siteId": { + "type": "string", + "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.", + "format": "int64" + }, + "siteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field." + }, + "size": { + "$ref": "Size", + "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion." + }, + "sslRequired": { + "type": "boolean", + "description": "Whether creatives assigned to this placement must be SSL-compliant." + }, + "status": { + "type": "string", + "description": "Third-party placement status.", + "enum": [ + "ACKNOWLEDGE_ACCEPTANCE", + "ACKNOWLEDGE_REJECTION", + "DRAFT", + "PAYMENT_ACCEPTED", + "PAYMENT_REJECTED", + "PENDING_REVIEW" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ] + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this placement. This field can be left blank.", + "format": "int64" + }, + "tagFormats": { + "type": "array", + "description": "Tag formats to generate for this placement. This field is required on insertion.\nAcceptable values are:\n- \"PLACEMENT_TAG_STANDARD\"\n- \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_IFRAME_ILAYER\"\n- \"PLACEMENT_TAG_INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_JAVASCRIPT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\"\n- \"PLACEMENT_TAG_CLICK_COMMANDS\"\n- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\"\n- \"PLACEMENT_TAG_TRACKING\"\n- \"PLACEMENT_TAG_TRACKING_IFRAME\"\n- \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\"", + "items": { + "type": "string", + "enum": [ + "PLACEMENT_TAG_CLICK_COMMANDS", + "PLACEMENT_TAG_IFRAME_ILAYER", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", + "PLACEMENT_TAG_INTERNAL_REDIRECT", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_JAVASCRIPT", + "PLACEMENT_TAG_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_STANDARD", + "PLACEMENT_TAG_TRACKING", + "PLACEMENT_TAG_TRACKING_IFRAME", + "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + } + }, + "tagSetting": { + "$ref": "TagSetting", + "description": "Tag settings for this placement." + } + } + }, + "PlacementAssignment": { + "id": "PlacementAssignment", + "type": "object", + "description": "Placement Assignment.", + "properties": { + "active": { + "type": "boolean", + "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation." + }, + "placementId": { + "type": "string", + "description": "ID of the placement to be assigned. This is a required field.", + "format": "int64" + }, + "placementIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field." + }, + "sslRequired": { + "type": "boolean", + "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated." + } + } + }, + "PlacementGroup": { + "id": "PlacementGroup", + "type": "object", + "description": "Contains properties of a package or roadblock.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this placement group. This is a read-only field that can be left blank.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this placement group. This is a required field on insertion.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "archived": { + "type": "boolean", + "description": "Whether this placement group is archived." + }, + "campaignId": { + "type": "string", + "description": "Campaign ID of this placement group. This field is required on insertion.", + "format": "int64" + }, + "campaignIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field." + }, + "childPlacementIds": { + "type": "array", + "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.", + "items": { + "type": "string", + "format": "int64" + } + }, + "comment": { + "type": "string", + "description": "Comments for this placement group." + }, + "contentCategoryId": { + "type": "string", + "description": "ID of the content category assigned to this placement group.", + "format": "int64" + }, + "createInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the creation of this placement group. This is a read-only field." + }, + "directorySiteId": { + "type": "string", + "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.", + "format": "int64" + }, + "directorySiteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field." + }, + "externalId": { + "type": "string", + "description": "External ID for this placement." + }, + "id": { + "type": "string", + "description": "ID of this placement group. This is a read-only, auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".", + "default": "dfareporting#placementGroup" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this placement group. This is a read-only field." + }, + "name": { + "type": "string", + "description": "Name of this placement group. This is a required field and must be less than 256 characters long." + }, + "placementGroupType": { + "type": "string", + "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.", + "enum": [ + "PLACEMENT_PACKAGE", + "PLACEMENT_ROADBLOCK" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "placementStrategyId": { + "type": "string", + "description": "ID of the placement strategy assigned to this placement group.", + "format": "int64" + }, + "pricingSchedule": { + "$ref": "PricingSchedule", + "description": "Pricing schedule of this placement group. This field is required on insertion." + }, + "primaryPlacementId": { + "type": "string", + "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.", + "format": "int64" + }, + "primaryPlacementIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field." + }, + "siteId": { + "type": "string", + "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.", + "format": "int64" + }, + "siteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.", + "format": "int64" + } + } + }, + "PlacementGroupsListResponse": { + "id": "PlacementGroupsListResponse", + "type": "object", + "description": "Placement Group List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".", + "default": "dfareporting#placementGroupsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "placementGroups": { + "type": "array", + "description": "Placement group collection.", + "items": { + "$ref": "PlacementGroup" + } + } + } + }, + "PlacementStrategiesListResponse": { + "id": "PlacementStrategiesListResponse", + "type": "object", + "description": "Placement Strategy List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".", + "default": "dfareporting#placementStrategiesListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "placementStrategies": { + "type": "array", + "description": "Placement strategy collection.", + "items": { + "$ref": "PlacementStrategy" + } + } + } + }, + "PlacementStrategy": { + "id": "PlacementStrategy", + "type": "object", + "description": "Contains properties of a placement strategy.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.", + "format": "int64" + }, + "id": { + "type": "string", + "description": "ID of this placement strategy. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".", + "default": "dfareporting#placementStrategy" + }, + "name": { + "type": "string", + "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account." + } + } + }, + "PlacementTag": { + "id": "PlacementTag", + "type": "object", + "description": "Placement Tag", + "properties": { + "placementId": { + "type": "string", + "description": "Placement ID", + "format": "int64" + }, + "tagDatas": { + "type": "array", + "description": "Tags generated for this placement.", + "items": { + "$ref": "TagData" + } + } + } + }, + "PlacementsGenerateTagsResponse": { + "id": "PlacementsGenerateTagsResponse", + "type": "object", + "description": "Placement GenerateTags Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".", + "default": "dfareporting#placementsGenerateTagsResponse" + }, + "placementTags": { + "type": "array", + "description": "Set of generated tags for the specified placements.", + "items": { + "$ref": "PlacementTag" + } + } + } + }, + "PlacementsListResponse": { + "id": "PlacementsListResponse", + "type": "object", + "description": "Placement List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".", + "default": "dfareporting#placementsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "placements": { + "type": "array", + "description": "Placement collection.", + "items": { + "$ref": "Placement" + } + } + } + }, + "PlatformType": { + "id": "PlatformType", + "type": "object", + "description": "Contains information about a platform type that can be targeted by ads.", + "properties": { + "id": { + "type": "string", + "description": "ID of this platform type.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".", + "default": "dfareporting#platformType" + }, + "name": { + "type": "string", + "description": "Name of this platform type." + } + } + }, + "PlatformTypesListResponse": { + "id": "PlatformTypesListResponse", + "type": "object", + "description": "Platform Type List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".", + "default": "dfareporting#platformTypesListResponse" + }, + "platformTypes": { + "type": "array", + "description": "Platform type collection.", + "items": { + "$ref": "PlatformType" + } + } + } + }, + "PopupWindowProperties": { + "id": "PopupWindowProperties", + "type": "object", + "description": "Popup Window Properties.", + "properties": { + "dimension": { + "$ref": "Size", + "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID" + }, + "offset": { + "$ref": "OffsetPosition", + "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES." + }, + "positionType": { + "type": "string", + "description": "Popup window position either centered or at specific coordinate.", + "enum": [ + "CENTER", + "COORDINATES" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "showAddressBar": { + "type": "boolean", + "description": "Whether to display the browser address bar." + }, + "showMenuBar": { + "type": "boolean", + "description": "Whether to display the browser menu bar." + }, + "showScrollBar": { + "type": "boolean", + "description": "Whether to display the browser scroll bar." + }, + "showStatusBar": { + "type": "boolean", + "description": "Whether to display the browser status bar." + }, + "showToolBar": { + "type": "boolean", + "description": "Whether to display the browser tool bar." + }, + "title": { + "type": "string", + "description": "Title of popup window." + } + } + }, + "PostalCode": { + "id": "PostalCode", + "type": "object", + "description": "Contains information about a postal code that can be targeted by ads.", + "properties": { + "code": { + "type": "string", + "description": "Postal code. This is equivalent to the id field." + }, + "countryCode": { + "type": "string", + "description": "Country code of the country to which this postal code belongs." + }, + "countryDartId": { + "type": "string", + "description": "DART ID of the country to which this postal code belongs.", + "format": "int64" + }, + "id": { + "type": "string", + "description": "ID of this postal code." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".", + "default": "dfareporting#postalCode" + } + } + }, + "PostalCodesListResponse": { + "id": "PostalCodesListResponse", + "type": "object", + "description": "Postal Code List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".", + "default": "dfareporting#postalCodesListResponse" + }, + "postalCodes": { + "type": "array", + "description": "Postal code collection.", + "items": { + "$ref": "PostalCode" + } + } + } + }, + "Pricing": { + "id": "Pricing", + "type": "object", + "description": "Pricing Information", + "properties": { + "capCostType": { + "type": "string", + "description": "Cap cost type of this inventory item.", + "enum": [ + "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE", + "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY", + "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "endDate": { + "type": "string", + "description": "End date of this inventory item.", + "format": "date" + }, + "flights": { + "type": "array", + "description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.", + "items": { + "$ref": "Flight" + } + }, + "groupType": { + "type": "string", + "description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.", + "enum": [ + "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE", + "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "pricingType": { + "type": "string", + "description": "Pricing type of this inventory item.", + "enum": [ + "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS", + "PLANNING_PLACEMENT_PRICING_TYPE_CPA", + "PLANNING_PLACEMENT_PRICING_TYPE_CPC", + "PLANNING_PLACEMENT_PRICING_TYPE_CPM", + "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS", + "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS", + "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ] + }, + "startDate": { + "type": "string", + "description": "Start date of this inventory item.", + "format": "date" + } + } + }, + "PricingSchedule": { + "id": "PricingSchedule", + "type": "object", + "description": "Pricing Schedule", + "properties": { + "capCostOption": { + "type": "string", + "description": "Placement cap cost option.", + "enum": [ + "CAP_COST_CUMULATIVE", + "CAP_COST_MONTHLY", + "CAP_COST_NONE" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "disregardOverdelivery": { + "type": "boolean", + "description": "Whether cap costs are ignored by ad serving." + }, + "endDate": { + "type": "string", + "description": "Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.", + "format": "date" + }, + "flighted": { + "type": "boolean", + "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically." + }, + "floodlightActivityId": { + "type": "string", + "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.", + "format": "int64" + }, + "pricingPeriods": { + "type": "array", + "description": "Pricing periods for this placement.", + "items": { + "$ref": "PricingSchedulePricingPeriod" + } + }, + "pricingType": { + "type": "string", + "description": "Placement pricing type. This field is required on insertion.", + "enum": [ + "PRICING_TYPE_CPA", + "PRICING_TYPE_CPC", + "PRICING_TYPE_CPM", + "PRICING_TYPE_FLAT_RATE_CLICKS", + "PRICING_TYPE_FLAT_RATE_IMPRESSIONS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "startDate": { + "type": "string", + "description": "Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.", + "format": "date" + }, + "testingStartDate": { + "type": "string", + "description": "Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.", + "format": "date" + } + } + }, + "PricingSchedulePricingPeriod": { + "id": "PricingSchedulePricingPeriod", + "type": "object", + "description": "Pricing Period", + "properties": { + "endDate": { + "type": "string", + "description": "Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.", + "format": "date" + }, + "pricingComment": { + "type": "string", + "description": "Comments for this pricing period." + }, + "rateOrCostNanos": { + "type": "string", + "description": "Rate or cost of this pricing period.", + "format": "int64" + }, + "startDate": { + "type": "string", + "description": "Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.", + "format": "date" + }, + "units": { + "type": "string", + "description": "Units of this pricing period.", + "format": "int64" + } + } + }, + "Project": { + "id": "Project", + "type": "object", + "description": "Contains properties of a DoubleClick Planning project.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this project.", + "format": "int64" + }, + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this project.", + "format": "int64" + }, + "audienceAgeGroup": { + "type": "string", + "description": "Audience age group of this project.", + "enum": [ + "PLANNING_AUDIENCE_AGE_18_24", + "PLANNING_AUDIENCE_AGE_25_34", + "PLANNING_AUDIENCE_AGE_35_44", + "PLANNING_AUDIENCE_AGE_45_54", + "PLANNING_AUDIENCE_AGE_55_64", + "PLANNING_AUDIENCE_AGE_65_OR_MORE", + "PLANNING_AUDIENCE_AGE_UNKNOWN" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ] + }, + "audienceGender": { + "type": "string", + "description": "Audience gender of this project.", + "enum": [ + "PLANNING_AUDIENCE_GENDER_FEMALE", + "PLANNING_AUDIENCE_GENDER_MALE" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "budget": { + "type": "string", + "description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.", + "format": "int64" + }, + "clientBillingCode": { + "type": "string", + "description": "Client billing code of this project." + }, + "clientName": { + "type": "string", + "description": "Name of the project client." + }, + "endDate": { + "type": "string", + "description": "End date of the project.", + "format": "date" + }, + "id": { + "type": "string", + "description": "ID of this project. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".", + "default": "dfareporting#project" + }, + "lastModifiedInfo": { + "$ref": "LastModifiedInfo", + "description": "Information about the most recent modification of this project." + }, + "name": { + "type": "string", + "description": "Name of this project." + }, + "overview": { + "type": "string", + "description": "Overview of this project." + }, + "startDate": { + "type": "string", + "description": "Start date of the project.", + "format": "date" + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this project.", + "format": "int64" + }, + "targetClicks": { + "type": "string", + "description": "Number of clicks that the advertiser is targeting.", + "format": "int64" + }, + "targetConversions": { + "type": "string", + "description": "Number of conversions that the advertiser is targeting.", + "format": "int64" + }, + "targetCpaNanos": { + "type": "string", + "description": "CPA that the advertiser is targeting.", + "format": "int64" + }, + "targetCpcNanos": { + "type": "string", + "description": "CPC that the advertiser is targeting.", + "format": "int64" + }, + "targetCpmNanos": { + "type": "string", + "description": "CPM that the advertiser is targeting.", + "format": "int64" + }, + "targetImpressions": { + "type": "string", + "description": "Number of impressions that the advertiser is targeting.", + "format": "int64" + } + } + }, + "ProjectsListResponse": { + "id": "ProjectsListResponse", + "type": "object", + "description": "Project List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\".", + "default": "dfareporting#projectsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "projects": { + "type": "array", + "description": "Project collection.", + "items": { + "$ref": "Project" + } + } + } + }, + "ReachReportCompatibleFields": { + "id": "ReachReportCompatibleFields", + "type": "object", + "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".", + "properties": { + "dimensionFilters": { + "type": "array", + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "dimensions": { + "type": "array", + "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.", + "default": "dfareporting#reachReportCompatibleFields" + }, + "metrics": { + "type": "array", + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + } + }, + "pivotedActivityMetrics": { + "type": "array", + "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.", + "items": { + "$ref": "Metric" + } + }, + "reachByFrequencyMetrics": { + "type": "array", + "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.", + "items": { + "$ref": "Metric" + } + } + } + }, + "Recipient": { + "id": "Recipient", + "type": "object", + "description": "Represents a recipient.", + "properties": { + "deliveryType": { + "type": "string", + "description": "The delivery type for the recipient.", + "enum": [ + "ATTACHMENT", + "LINK" + ], + "enumDescriptions": [ + "", + "" + ], + "annotations": { + "required": [ + "dfareporting.reports.insert", + "dfareporting.reports.update" + ] + } + }, + "email": { + "type": "string", + "description": "The email address of the recipient.", + "annotations": { + "required": [ + "dfareporting.reports.insert", + "dfareporting.reports.update" + ] + } + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#recipient.", + "default": "dfareporting#recipient" + } + } + }, + "Region": { + "id": "Region", + "type": "object", + "description": "Contains information about a region that can be targeted by ads.", + "properties": { + "countryCode": { + "type": "string", + "description": "Country code of the country to which this region belongs." + }, + "countryDartId": { + "type": "string", + "description": "DART ID of the country to which this region belongs.", + "format": "int64" + }, + "dartId": { + "type": "string", + "description": "DART ID of this region.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".", + "default": "dfareporting#region" + }, + "name": { + "type": "string", + "description": "Name of this region." + }, + "regionCode": { + "type": "string", + "description": "Region code." + } + } + }, + "RegionsListResponse": { + "id": "RegionsListResponse", + "type": "object", + "description": "Region List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".", + "default": "dfareporting#regionsListResponse" + }, + "regions": { + "type": "array", + "description": "Region collection.", + "items": { + "$ref": "Region" + } + } + } + }, + "RemarketingList": { + "id": "RemarketingList", + "type": "object", + "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", + "format": "int64" + }, + "active": { + "type": "boolean", + "description": "Whether this remarketing list is active." + }, + "advertiserId": { + "type": "string", + "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." + }, + "description": { + "type": "string", + "description": "Remarketing list description." + }, + "id": { + "type": "string", + "description": "Remarketing list ID. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".", + "default": "dfareporting#remarketingList" + }, + "lifeSpan": { + "type": "string", + "description": "Number of days that a user should remain in the remarketing list without an impression.", + "format": "int64" + }, + "listPopulationRule": { + "$ref": "ListPopulationRule", + "description": "Rule used to populate the remarketing list with users." + }, + "listSize": { + "type": "string", + "description": "Number of users currently in the list. This is a read-only field.", + "format": "int64" + }, + "listSource": { + "type": "string", + "description": "Product from which this remarketing list was originated.", + "enum": [ + "REMARKETING_LIST_SOURCE_ADX", + "REMARKETING_LIST_SOURCE_DBM", + "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_DFP", + "REMARKETING_LIST_SOURCE_DMP", + "REMARKETING_LIST_SOURCE_GA", + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_PLAY_STORE", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_YOUTUBE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "name": { + "type": "string", + "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", + "format": "int64" + } + } + }, + "RemarketingListShare": { + "id": "RemarketingListShare", + "type": "object", + "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".", + "default": "dfareporting#remarketingListShare" + }, + "remarketingListId": { + "type": "string", + "description": "Remarketing list ID. This is a read-only, auto-generated field.", + "format": "int64" + }, + "sharedAccountIds": { + "type": "array", + "description": "Accounts that the remarketing list is shared with.", + "items": { + "type": "string", + "format": "int64" + } + }, + "sharedAdvertiserIds": { + "type": "array", + "description": "Advertisers that the remarketing list is shared with.", + "items": { + "type": "string", + "format": "int64" + } + } + } + }, + "RemarketingListsListResponse": { + "id": "RemarketingListsListResponse", + "type": "object", + "description": "Remarketing list response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".", + "default": "dfareporting#remarketingListsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "remarketingLists": { + "type": "array", + "description": "Remarketing list collection.", + "items": { + "$ref": "RemarketingList" + } + } + } + }, + "Report": { + "id": "Report", + "type": "object", + "description": "Represents a Report resource.", + "properties": { + "accountId": { + "type": "string", + "description": "The account ID to which this report belongs.", + "format": "int64", + "annotations": { + "required": [ + "dfareporting.reports.update" + ] + } + }, + "criteria": { + "type": "object", + "description": "The report criteria for a report of type \"STANDARD\".", + "properties": { + "activities": { + "$ref": "Activities", + "description": "Activity group." + }, + "customRichMediaEvents": { + "$ref": "CustomRichMediaEvents", + "description": "Custom Rich Media Events group." + }, + "dateRange": { + "$ref": "DateRange", + "description": "The date range for which this report should be run." + }, + "dimensionFilters": { + "type": "array", + "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.", + "items": { + "$ref": "DimensionValue" + } + }, + "dimensions": { + "type": "array", + "description": "The list of standard dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + } + }, + "metricNames": { + "type": "array", + "description": "The list of names of metrics the report should include.", + "items": { + "type": "string" + } + } + } + }, + "crossDimensionReachCriteria": { + "type": "object", + "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".", + "properties": { + "breakdown": { + "type": "array", + "description": "The list of dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + } + }, + "dateRange": { + "$ref": "DateRange", + "description": "The date range this report should be run for." + }, + "dimension": { + "type": "string", + "description": "The dimension option.", + "enum": [ + "ADVERTISER", + "CAMPAIGN", + "SITE_BY_ADVERTISER", + "SITE_BY_CAMPAIGN" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "dimensionFilters": { + "type": "array", + "description": "The list of filters on which dimensions are filtered.", + "items": { + "$ref": "DimensionValue" + } + }, + "metricNames": { + "type": "array", + "description": "The list of names of metrics the report should include.", + "items": { + "type": "string" + } + }, + "overlapMetricNames": { + "type": "array", + "description": "The list of names of overlap metrics the report should include.", + "items": { + "type": "string" + } + }, + "pivoted": { + "type": "boolean", + "description": "Whether the report is pivoted or not. Defaults to true." + } + } + }, + "delivery": { + "type": "object", + "description": "The report's email delivery settings.", + "properties": { + "emailOwner": { + "type": "boolean", + "description": "Whether the report should be emailed to the report owner." + }, + "emailOwnerDeliveryType": { + "type": "string", + "description": "The type of delivery for the owner to receive, if enabled.", + "enum": [ + "ATTACHMENT", + "LINK" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "message": { + "type": "string", + "description": "The message to be sent with each email." + }, + "recipients": { + "type": "array", + "description": "The list of recipients to which to email the report.", + "items": { + "$ref": "Recipient" + } + } + } + }, + "etag": { + "type": "string", + "description": "The eTag of this response for caching purposes." + }, + "fileName": { + "type": "string", + "description": "The filename used when generating report files for this report." + }, + "floodlightCriteria": { + "type": "object", + "description": "The report criteria for a report of type \"FLOODLIGHT\".", + "properties": { + "customRichMediaEvents": { + "type": "array", + "description": "The list of custom rich media events to include.", + "items": { + "$ref": "DimensionValue" + } + }, + "dateRange": { + "$ref": "DateRange", + "description": "The date range this report should be run for." + }, + "dimensionFilters": { + "type": "array", + "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.", + "items": { + "$ref": "DimensionValue" + } + }, + "dimensions": { + "type": "array", + "description": "The list of dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + } + }, + "floodlightConfigId": { + "$ref": "DimensionValue", + "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'." + }, + "metricNames": { + "type": "array", + "description": "The list of names of metrics the report should include.", + "items": { + "type": "string" + } + }, + "reportProperties": { + "type": "object", + "description": "The properties of the report.", + "properties": { + "includeAttributedIPConversions": { + "type": "boolean", + "description": "Include conversions that have no cookie, but do have an exposure path." + }, + "includeUnattributedCookieConversions": { + "type": "boolean", + "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window." + }, + "includeUnattributedIPConversions": { + "type": "boolean", + "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion." + } + } + } + } + }, + "format": { + "type": "string", + "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.", + "enum": [ + "CSV", + "EXCEL" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "id": { + "type": "string", + "description": "The unique ID identifying this report resource.", + "format": "int64", + "annotations": { + "required": [ + "dfareporting.reports.update" + ] + } + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#report.", + "default": "dfareporting#report" + }, + "lastModifiedTime": { + "type": "string", + "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.", + "format": "uint64", + "annotations": { + "required": [ + "dfareporting.reports.update" + ] + } + }, + "name": { + "type": "string", + "description": "The name of the report.", + "annotations": { + "required": [ + "dfareporting.reports.insert", + "dfareporting.reports.update" + ] + } + }, + "ownerProfileId": { + "type": "string", + "description": "The user profile id of the owner of this report.", + "format": "int64", + "annotations": { + "required": [ + "dfareporting.reports.update" + ] + } + }, + "pathToConversionCriteria": { + "type": "object", + "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".", + "properties": { + "activityFilters": { + "type": "array", + "description": "The list of 'dfa:activity' values to filter on.", + "items": { + "$ref": "DimensionValue" + } + }, + "conversionDimensions": { + "type": "array", + "description": "The list of conversion dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + } + }, + "customFloodlightVariables": { + "type": "array", + "description": "The list of custom floodlight variables the report should include.", + "items": { + "$ref": "SortedDimension" + } + }, + "customRichMediaEvents": { + "type": "array", + "description": "The list of custom rich media events to include.", + "items": { + "$ref": "DimensionValue" + } + }, + "dateRange": { + "$ref": "DateRange", + "description": "The date range this report should be run for." + }, + "floodlightConfigId": { + "$ref": "DimensionValue", + "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'." + }, + "metricNames": { + "type": "array", + "description": "The list of names of metrics the report should include.", + "items": { + "type": "string" + } + }, + "perInteractionDimensions": { + "type": "array", + "description": "The list of per interaction dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + } + }, + "reportProperties": { + "type": "object", + "description": "The properties of the report.", + "properties": { + "clicksLookbackWindow": { + "type": "integer", + "description": "DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.", + "format": "int32" + }, + "impressionsLookbackWindow": { + "type": "integer", + "description": "DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.", + "format": "int32" + }, + "includeAttributedIPConversions": { + "type": "boolean", + "description": "Deprecated: has no effect." + }, + "includeUnattributedCookieConversions": { + "type": "boolean", + "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window." + }, + "includeUnattributedIPConversions": { + "type": "boolean", + "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion." + }, + "maximumClickInteractions": { + "type": "integer", + "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.", + "format": "int32" + }, + "maximumImpressionInteractions": { + "type": "integer", + "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.", + "format": "int32" + }, + "maximumInteractionGap": { + "type": "integer", + "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.", + "format": "int32" + }, + "pivotOnInteractionPath": { + "type": "boolean", + "description": "Enable pivoting on interaction path." + } + } + } + } + }, + "reachCriteria": { + "type": "object", + "description": "The report criteria for a report of type \"REACH\".", + "properties": { + "activities": { + "$ref": "Activities", + "description": "Activity group." + }, + "customRichMediaEvents": { + "$ref": "CustomRichMediaEvents", + "description": "Custom Rich Media Events group." + }, + "dateRange": { + "$ref": "DateRange", + "description": "The date range this report should be run for." + }, + "dimensionFilters": { + "type": "array", + "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.", + "items": { + "$ref": "DimensionValue" + } + }, + "dimensions": { + "type": "array", + "description": "The list of dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + } + }, + "enableAllDimensionCombinations": { + "type": "boolean", + "description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months." + }, + "metricNames": { + "type": "array", + "description": "The list of names of metrics the report should include.", + "items": { + "type": "string" + } + }, + "reachByFrequencyMetricNames": { + "type": "array", + "description": "The list of names of Reach By Frequency metrics the report should include.", + "items": { + "type": "string" + } + } + } + }, + "schedule": { + "type": "object", + "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".", + "properties": { + "active": { + "type": "boolean", + "description": "Whether the schedule is active or not. Must be set to either true or false.", + "annotations": { + "required": [ + "dfareporting.reports.insert", + "dfareporting.reports.update" + ] + } + }, + "every": { + "type": "integer", + "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".", + "format": "int32" + }, + "expirationDate": { + "type": "string", + "description": "The expiration date when the scheduled report stops running.", + "format": "date", + "annotations": { + "required": [ + "dfareporting.reports.insert", + "dfareporting.reports.update" + ] + } + }, + "repeats": { + "type": "string", + "description": "The interval for which the report is repeated. Note: \n- \"DAILY\" also requires field \"every\" to be set. \n- \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n- \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set.", + "annotations": { + "required": [ + "dfareporting.reports.insert", + "dfareporting.reports.update" + ] + } + }, + "repeatsOnWeekDays": { + "type": "array", + "description": "List of week days \"WEEKLY\" on which scheduled reports should run.", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ] + } + }, + "runsOnDayOfMonth": { + "type": "string", + "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month.\nExample: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.", + "enum": [ + "DAY_OF_MONTH", + "WEEK_OF_MONTH" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "startDate": { + "type": "string", + "description": "Start date of date range for which scheduled reports should be run.", + "format": "date", + "annotations": { + "required": [ + "dfareporting.reports.insert", + "dfareporting.reports.update" + ] + } + } + } + }, + "subAccountId": { + "type": "string", + "description": "The subaccount ID to which this report belongs if applicable.", + "format": "int64" + }, + "type": { + "type": "string", + "description": "The type of the report.", + "enum": [ + "CROSS_DIMENSION_REACH", + "FLOODLIGHT", + "PATH_TO_CONVERSION", + "REACH", + "STANDARD" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "annotations": { + "required": [ + "dfareporting.reports.insert", + "dfareporting.reports.update" + ] + } + } + } + }, + "ReportCompatibleFields": { + "id": "ReportCompatibleFields", + "type": "object", + "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".", + "properties": { + "dimensionFilters": { + "type": "array", + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "dimensions": { + "type": "array", + "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.", + "items": { + "$ref": "Dimension" + } + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.", + "default": "dfareporting#reportCompatibleFields" + }, + "metrics": { + "type": "array", + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + } + }, + "pivotedActivityMetrics": { + "type": "array", + "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.", + "items": { + "$ref": "Metric" + } + } + } + }, + "ReportList": { + "id": "ReportList", + "type": "object", + "description": "Represents the list of reports.", + "properties": { + "etag": { + "type": "string", + "description": "The eTag of this response for caching purposes." + }, + "items": { + "type": "array", + "description": "The reports returned in this response.", + "items": { + "$ref": "Report" + } + }, + "kind": { + "type": "string", + "description": "The kind of list this is, in this case dfareporting#reportList.", + "default": "dfareporting#reportList" + }, + "nextPageToken": { + "type": "string", + "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted." + } + } + }, + "ReportsConfiguration": { + "id": "ReportsConfiguration", + "type": "object", + "description": "Reporting Configuration", + "properties": { + "exposureToConversionEnabled": { + "type": "boolean", + "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting." + }, + "lookbackConfiguration": { + "$ref": "LookbackConfiguration", + "description": "Default lookback windows for new advertisers in this account." + }, + "reportGenerationTimeZoneId": { + "type": "string", + "description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.\nAcceptable values are:\n\n- \"1\" for \"America/New_York\" \n- \"2\" for \"Europe/London\" \n- \"3\" for \"Europe/Paris\" \n- \"4\" for \"Africa/Johannesburg\" \n- \"5\" for \"Asia/Jerusalem\" \n- \"6\" for \"Asia/Shanghai\" \n- \"7\" for \"Asia/Hong_Kong\" \n- \"8\" for \"Asia/Tokyo\" \n- \"9\" for \"Australia/Sydney\" \n- \"10\" for \"Asia/Dubai\" \n- \"11\" for \"America/Los_Angeles\" \n- \"12\" for \"Pacific/Auckland\" \n- \"13\" for \"America/Sao_Paulo\"", + "format": "int64" + } + } + }, + "RichMediaExitOverride": { + "id": "RichMediaExitOverride", + "type": "object", + "description": "Rich Media Exit Override.", + "properties": { + "customExitUrl": { + "type": "string", + "description": "Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true." + }, + "exitId": { + "type": "string", + "description": "ID for the override to refer to a specific exit in the creative.", + "format": "int64" + }, + "useCustomExitUrl": { + "type": "boolean", + "description": "Whether to use the custom exit URL." + } + } + }, + "Site": { + "id": "Site", + "type": "object", + "description": "Contains properties of a site.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this site. This is a read-only field that can be left blank.", + "format": "int64" + }, + "approved": { + "type": "boolean", + "description": "Whether this site is approved." + }, + "directorySiteId": { + "type": "string", + "description": "Directory site associated with this site. This is a required field that is read-only after insertion.", + "format": "int64" + }, + "directorySiteIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field." + }, + "id": { + "type": "string", + "description": "ID of this site. This is a read-only, auto-generated field.", + "format": "int64" + }, + "idDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field." + }, + "keyName": { + "type": "string", + "description": "Key name of this site. This is a read-only, auto-generated field." + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".", + "default": "dfareporting#site" + }, + "name": { + "type": "string", + "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account." + }, + "siteContacts": { + "type": "array", + "description": "Site contacts.", + "items": { + "$ref": "SiteContact" + } + }, + "siteSettings": { + "$ref": "SiteSettings", + "description": "Site-wide settings." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this site. This is a read-only field that can be left blank.", + "format": "int64" + } + } + }, + "SiteContact": { + "id": "SiteContact", + "type": "object", + "description": "Site Contact", + "properties": { + "address": { + "type": "string", + "description": "Address of this site contact." + }, + "contactType": { + "type": "string", + "description": "Site contact type.", + "enum": [ + "SALES_PERSON", + "TRAFFICKER" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "email": { + "type": "string", + "description": "Email address of this site contact. This is a required field." + }, + "firstName": { + "type": "string", + "description": "First name of this site contact." + }, + "id": { + "type": "string", + "description": "ID of this site contact. This is a read-only, auto-generated field.", + "format": "int64" + }, + "lastName": { + "type": "string", + "description": "Last name of this site contact." + }, + "phone": { + "type": "string", + "description": "Primary phone number of this site contact." + }, + "title": { + "type": "string", + "description": "Title or designation of this site contact." + } + } + }, + "SiteSettings": { + "id": "SiteSettings", + "type": "object", + "description": "Site Settings", + "properties": { + "activeViewOptOut": { + "type": "boolean", + "description": "Whether active view creatives are disabled for this site." + }, + "creativeSettings": { + "$ref": "CreativeSettings", + "description": "Site-wide creative settings." + }, + "disableBrandSafeAds": { + "type": "boolean", + "description": "Whether brand safe ads are disabled for this site." + }, + "disableNewCookie": { + "type": "boolean", + "description": "Whether new cookies are disabled for this site." + }, + "lookbackConfiguration": { + "$ref": "LookbackConfiguration", + "description": "Lookback window settings for this site." + }, + "tagSetting": { + "$ref": "TagSetting", + "description": "Configuration settings for dynamic and image floodlight tags." + }, + "videoActiveViewOptOut": { + "type": "boolean", + "description": "Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView." + } + } + }, + "SitesListResponse": { + "id": "SitesListResponse", + "type": "object", + "description": "Site List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".", + "default": "dfareporting#sitesListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "sites": { + "type": "array", + "description": "Site collection.", + "items": { + "$ref": "Site" + } + } + } + }, + "Size": { + "id": "Size", + "type": "object", + "description": "Represents the dimensions of ads, placements, creatives, or creative assets.", + "properties": { + "height": { + "type": "integer", + "description": "Height of this size.", + "format": "int32" + }, + "iab": { + "type": "boolean", + "description": "IAB standard size. This is a read-only, auto-generated field." + }, + "id": { + "type": "string", + "description": "ID of this size. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".", + "default": "dfareporting#size" + }, + "width": { + "type": "integer", + "description": "Width of this size.", + "format": "int32" + } + } + }, + "SizesListResponse": { + "id": "SizesListResponse", + "type": "object", + "description": "Size List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".", + "default": "dfareporting#sizesListResponse" + }, + "sizes": { + "type": "array", + "description": "Size collection.", + "items": { + "$ref": "Size" + } + } + } + }, + "SortedDimension": { + "id": "SortedDimension", + "type": "object", + "description": "Represents a sorted dimension.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#sortedDimension.", + "default": "dfareporting#sortedDimension" + }, + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "sortOrder": { + "type": "string", + "description": "An optional sort order for the dimension column.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ] + } + } + }, + "Subaccount": { + "id": "Subaccount", + "type": "object", + "description": "Contains properties of a DCM subaccount.", + "properties": { + "accountId": { + "type": "string", + "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.", + "format": "int64" + }, + "availablePermissionIds": { + "type": "array", + "description": "IDs of the available user role permissions for this subaccount.", + "items": { + "type": "string", + "format": "int64" + } + }, + "id": { + "type": "string", + "description": "ID of this subaccount. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".", + "default": "dfareporting#subaccount" + }, + "name": { + "type": "string", + "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account." + } + } + }, + "SubaccountsListResponse": { + "id": "SubaccountsListResponse", + "type": "object", + "description": "Subaccount List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".", + "default": "dfareporting#subaccountsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "subaccounts": { + "type": "array", + "description": "Subaccount collection.", + "items": { + "$ref": "Subaccount" + } + } + } + }, + "TagData": { + "id": "TagData", + "type": "object", + "description": "Placement Tag Data", + "properties": { + "adId": { + "type": "string", + "description": "Ad associated with this placement tag.", + "format": "int64" + }, + "clickTag": { + "type": "string", + "description": "Tag string to record a click." + }, + "creativeId": { + "type": "string", + "description": "Creative associated with this placement tag.", + "format": "int64" + }, + "format": { + "type": "string", + "description": "TagData tag format of this tag.", + "enum": [ + "PLACEMENT_TAG_CLICK_COMMANDS", + "PLACEMENT_TAG_IFRAME_ILAYER", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", + "PLACEMENT_TAG_INTERNAL_REDIRECT", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_JAVASCRIPT", + "PLACEMENT_TAG_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_STANDARD", + "PLACEMENT_TAG_TRACKING", + "PLACEMENT_TAG_TRACKING_IFRAME", + "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "impressionTag": { + "type": "string", + "description": "Tag string for serving an ad." + } + } + }, + "TagSetting": { + "id": "TagSetting", + "type": "object", + "description": "Tag Settings", + "properties": { + "additionalKeyValues": { + "type": "string", + "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field." + }, + "includeClickThroughUrls": { + "type": "boolean", + "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements." + }, + "includeClickTracking": { + "type": "boolean", + "description": "Whether click-tracking string should be included in the tags." + }, + "keywordOption": { + "type": "string", + "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.", + "enum": [ + "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD", + "IGNORE", + "PLACEHOLDER_WITH_LIST_OF_KEYWORDS" + ], + "enumDescriptions": [ + "", + "", + "" + ] + } + } + }, + "TagSettings": { + "id": "TagSettings", + "type": "object", + "description": "Dynamic and Image Tag Settings.", + "properties": { + "dynamicTagEnabled": { + "type": "boolean", + "description": "Whether dynamic floodlight tags are enabled." + }, + "imageTagEnabled": { + "type": "boolean", + "description": "Whether image tags are enabled." + } + } + }, + "TargetWindow": { + "id": "TargetWindow", + "type": "object", + "description": "Target Window.", + "properties": { + "customHtml": { + "type": "string", + "description": "User-entered value." + }, + "targetWindowOption": { + "type": "string", + "description": "Type of browser window for which the backup image of the flash creative can be displayed.", + "enum": [ + "CURRENT_WINDOW", + "CUSTOM", + "NEW_WINDOW" + ], + "enumDescriptions": [ + "", + "", + "" + ] + } + } + }, + "TargetableRemarketingList": { + "id": "TargetableRemarketingList", + "type": "object", + "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", + "format": "int64" + }, + "active": { + "type": "boolean", + "description": "Whether this targetable remarketing list is active." + }, + "advertiserId": { + "type": "string", + "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.", + "format": "int64" + }, + "advertiserIdDimensionValue": { + "$ref": "DimensionValue", + "description": "Dimension value for the ID of the advertiser." + }, + "description": { + "type": "string", + "description": "Targetable remarketing list description." + }, + "id": { + "type": "string", + "description": "Targetable remarketing list ID.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".", + "default": "dfareporting#targetableRemarketingList" + }, + "lifeSpan": { + "type": "string", + "description": "Number of days that a user should remain in the targetable remarketing list without an impression.", + "format": "int64" + }, + "listSize": { + "type": "string", + "description": "Number of users currently in the list. This is a read-only field.", + "format": "int64" + }, + "listSource": { + "type": "string", + "description": "Product from which this targetable remarketing list was originated.", + "enum": [ + "REMARKETING_LIST_SOURCE_ADX", + "REMARKETING_LIST_SOURCE_DBM", + "REMARKETING_LIST_SOURCE_DFA", + "REMARKETING_LIST_SOURCE_DFP", + "REMARKETING_LIST_SOURCE_DMP", + "REMARKETING_LIST_SOURCE_GA", + "REMARKETING_LIST_SOURCE_GPLUS", + "REMARKETING_LIST_SOURCE_OTHER", + "REMARKETING_LIST_SOURCE_PLAY_STORE", + "REMARKETING_LIST_SOURCE_XFP", + "REMARKETING_LIST_SOURCE_YOUTUBE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "name": { + "type": "string", + "description": "Name of the targetable remarketing list. Is no greater than 128 characters long." + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", + "format": "int64" + } + } + }, + "TargetableRemarketingListsListResponse": { + "id": "TargetableRemarketingListsListResponse", + "type": "object", + "description": "Targetable remarketing list response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".", + "default": "dfareporting#targetableRemarketingListsListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "targetableRemarketingLists": { + "type": "array", + "description": "Targetable remarketing list collection.", + "items": { + "$ref": "TargetableRemarketingList" + } + } + } + }, + "TechnologyTargeting": { + "id": "TechnologyTargeting", + "type": "object", + "description": "Technology Targeting.", + "properties": { + "browsers": { + "type": "array", + "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.", + "items": { + "$ref": "Browser" + } + }, + "connectionTypes": { + "type": "array", + "description": "Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.", + "items": { + "$ref": "ConnectionType" + } + }, + "mobileCarriers": { + "type": "array", + "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.", + "items": { + "$ref": "MobileCarrier" + } + }, + "operatingSystemVersions": { + "type": "array", + "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.", + "items": { + "$ref": "OperatingSystemVersion" + } + }, + "operatingSystems": { + "type": "array", + "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.", + "items": { + "$ref": "OperatingSystem" + } + }, + "platformTypes": { + "type": "array", + "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.", + "items": { + "$ref": "PlatformType" + } + } + } + }, + "ThirdPartyAuthenticationToken": { + "id": "ThirdPartyAuthenticationToken", + "type": "object", + "description": "Third Party Authentication Token", + "properties": { + "name": { + "type": "string", + "description": "Name of the third-party authentication token." + }, + "value": { + "type": "string", + "description": "Value of the third-party authentication token. This is a read-only, auto-generated field." + } + } + }, + "ThirdPartyTrackingUrl": { + "id": "ThirdPartyTrackingUrl", + "type": "object", + "description": "Third-party Tracking URL.", + "properties": { + "thirdPartyUrlType": { + "type": "string", + "description": "Third-party URL type for in-stream video creatives.", + "enum": [ + "CLICK_TRACKING", + "IMPRESSION", + "RICH_MEDIA_BACKUP_IMPRESSION", + "RICH_MEDIA_IMPRESSION", + "RICH_MEDIA_RM_IMPRESSION", + "SURVEY", + "VIDEO_COMPLETE", + "VIDEO_CUSTOM", + "VIDEO_FIRST_QUARTILE", + "VIDEO_FULLSCREEN", + "VIDEO_MIDPOINT", + "VIDEO_MUTE", + "VIDEO_PAUSE", + "VIDEO_PROGRESS", + "VIDEO_REWIND", + "VIDEO_SKIP", + "VIDEO_START", + "VIDEO_STOP", + "VIDEO_THIRD_QUARTILE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "url": { + "type": "string", + "description": "URL for the specified third-party URL type." + } + } + }, + "UserDefinedVariableConfiguration": { + "id": "UserDefinedVariableConfiguration", + "type": "object", + "description": "User Defined Variable configuration.", + "properties": { + "dataType": { + "type": "string", + "description": "Data type for the variable. This is a required field.", + "enum": [ + "NUMBER", + "STRING" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "reportName": { + "type": "string", + "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"\u003c\u003e\"." + }, + "variableType": { + "type": "string", + "description": "Variable name in the tag. This is a required field.", + "enum": [ + "U1", + "U10", + "U11", + "U12", + "U13", + "U14", + "U15", + "U16", + "U17", + "U18", + "U19", + "U2", + "U20", + "U3", + "U4", + "U5", + "U6", + "U7", + "U8", + "U9" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + } + } + }, + "UserProfile": { + "id": "UserProfile", + "type": "object", + "description": "Represents a UserProfile resource.", + "properties": { + "accountId": { + "type": "string", + "description": "The account ID to which this profile belongs.", + "format": "int64" + }, + "accountName": { + "type": "string", + "description": "The account name this profile belongs to." + }, + "etag": { + "type": "string", + "description": "The eTag of this response for caching purposes." + }, + "kind": { + "type": "string", + "description": "The kind of resource this is, in this case dfareporting#userProfile.", + "default": "dfareporting#userProfile" + }, + "profileId": { + "type": "string", + "description": "The unique ID of the user profile.", + "format": "int64" + }, + "subAccountId": { + "type": "string", + "description": "The sub account ID this profile belongs to if applicable.", + "format": "int64" + }, + "subAccountName": { + "type": "string", + "description": "The sub account name this profile belongs to if applicable." + }, + "userName": { + "type": "string", + "description": "The user name." + } + } + }, + "UserProfileList": { + "id": "UserProfileList", + "type": "object", + "description": "Represents the list of user profiles.", + "properties": { + "etag": { + "type": "string", + "description": "The eTag of this response for caching purposes." + }, + "items": { + "type": "array", + "description": "The user profiles returned in this response.", + "items": { + "$ref": "UserProfile" + } + }, + "kind": { + "type": "string", + "description": "The kind of list this is, in this case dfareporting#userProfileList.", + "default": "dfareporting#userProfileList" + } + } + }, + "UserRole": { + "id": "UserRole", + "type": "object", + "description": "Contains properties of auser role, which is used to manage user access.", + "properties": { + "accountId": { + "type": "string", + "description": "Account ID of this user role. This is a read-only field that can be left blank.", + "format": "int64" + }, + "defaultUserRole": { + "type": "boolean", + "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions." + }, + "id": { + "type": "string", + "description": "ID of this user role. This is a read-only, auto-generated field.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".", + "default": "dfareporting#userRole" + }, + "name": { + "type": "string", + "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account." + }, + "parentUserRoleId": { + "type": "string", + "description": "ID of the user role that this user role is based on or copied from. This is a required field.", + "format": "int64" + }, + "permissions": { + "type": "array", + "description": "List of permissions associated with this user role.", + "items": { + "$ref": "UserRolePermission" + } + }, + "subaccountId": { + "type": "string", + "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.", + "format": "int64" + } + } + }, + "UserRolePermission": { + "id": "UserRolePermission", + "type": "object", + "description": "Contains properties of a user role permission.", + "properties": { + "availability": { + "type": "string", + "description": "Levels of availability for a user role permission.", + "enum": [ + "ACCOUNT_ALWAYS", + "ACCOUNT_BY_DEFAULT", + "NOT_AVAILABLE_BY_DEFAULT", + "SUBACCOUNT_AND_ACCOUNT_ALWAYS", + "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ] + }, + "id": { + "type": "string", + "description": "ID of this user role permission.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".", + "default": "dfareporting#userRolePermission" + }, + "name": { + "type": "string", + "description": "Name of this user role permission." + }, + "permissionGroupId": { + "type": "string", + "description": "ID of the permission group that this user role permission belongs to.", + "format": "int64" + } + } + }, + "UserRolePermissionGroup": { + "id": "UserRolePermissionGroup", + "type": "object", + "description": "Represents a grouping of related user role permissions.", + "properties": { + "id": { + "type": "string", + "description": "ID of this user role permission.", + "format": "int64" + }, + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".", + "default": "dfareporting#userRolePermissionGroup" + }, + "name": { + "type": "string", + "description": "Name of this user role permission group." + } + } + }, + "UserRolePermissionGroupsListResponse": { + "id": "UserRolePermissionGroupsListResponse", + "type": "object", + "description": "User Role Permission Group List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".", + "default": "dfareporting#userRolePermissionGroupsListResponse" + }, + "userRolePermissionGroups": { + "type": "array", + "description": "User role permission group collection.", + "items": { + "$ref": "UserRolePermissionGroup" + } + } + } + }, + "UserRolePermissionsListResponse": { + "id": "UserRolePermissionsListResponse", + "type": "object", + "description": "User Role Permission List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".", + "default": "dfareporting#userRolePermissionsListResponse" + }, + "userRolePermissions": { + "type": "array", + "description": "User role permission collection.", + "items": { + "$ref": "UserRolePermission" + } + } + } + }, + "UserRolesListResponse": { + "id": "UserRolesListResponse", + "type": "object", + "description": "User Role List Response", + "properties": { + "kind": { + "type": "string", + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".", + "default": "dfareporting#userRolesListResponse" + }, + "nextPageToken": { + "type": "string", + "description": "Pagination token to be used for the next list operation." + }, + "userRoles": { + "type": "array", + "description": "User role collection.", + "items": { + "$ref": "UserRole" + } + } + } + } + }, + "resources": { + "accountActiveAdSummaries": { + "methods": { + "get": { + "id": "dfareporting.accountActiveAdSummaries.get", + "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}", + "httpMethod": "GET", + "description": "Gets the account's active ad summary by account ID.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "summaryAccountId": { + "type": "string", + "description": "Account ID.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "summaryAccountId" + ], + "response": { + "$ref": "AccountActiveAdSummary" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "accountPermissionGroups": { + "methods": { + "get": { + "id": "dfareporting.accountPermissionGroups.get", + "path": "userprofiles/{profileId}/accountPermissionGroups/{id}", + "httpMethod": "GET", + "description": "Gets one account permission group by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Account permission group ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "AccountPermissionGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.accountPermissionGroups.list", + "path": "userprofiles/{profileId}/accountPermissionGroups", + "httpMethod": "GET", + "description": "Retrieves the list of account permission groups.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "AccountPermissionGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "accountPermissions": { + "methods": { + "get": { + "id": "dfareporting.accountPermissions.get", + "path": "userprofiles/{profileId}/accountPermissions/{id}", + "httpMethod": "GET", + "description": "Gets one account permission by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Account permission ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "AccountPermission" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.accountPermissions.list", + "path": "userprofiles/{profileId}/accountPermissions", + "httpMethod": "GET", + "description": "Retrieves the list of account permissions.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "AccountPermissionsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "accountUserProfiles": { + "methods": { + "get": { + "id": "dfareporting.accountUserProfiles.get", + "path": "userprofiles/{profileId}/accountUserProfiles/{id}", + "httpMethod": "GET", + "description": "Gets one account user profile by ID.", + "parameters": { + "id": { + "type": "string", + "description": "User profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "AccountUserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.accountUserProfiles.insert", + "path": "userprofiles/{profileId}/accountUserProfiles", + "httpMethod": "POST", + "description": "Inserts a new account user profile.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "AccountUserProfile" + }, + "response": { + "$ref": "AccountUserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.accountUserProfiles.list", + "path": "userprofiles/{profileId}/accountUserProfiles", + "httpMethod": "GET", + "description": "Retrieves a list of account user profiles, possibly filtered.", + "parameters": { + "active": { + "type": "boolean", + "description": "Select only active user profiles.", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only user profiles with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "subaccountId": { + "type": "string", + "description": "Select only user profiles with the specified subaccount ID.", + "format": "int64", + "location": "query" + }, + "userRoleId": { + "type": "string", + "description": "Select only user profiles with the specified user role ID.", + "format": "int64", + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "AccountUserProfilesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.accountUserProfiles.patch", + "path": "userprofiles/{profileId}/accountUserProfiles", + "httpMethod": "PATCH", + "description": "Updates an existing account user profile. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "User profile ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "AccountUserProfile" + }, + "response": { + "$ref": "AccountUserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.accountUserProfiles.update", + "path": "userprofiles/{profileId}/accountUserProfiles", + "httpMethod": "PUT", + "description": "Updates an existing account user profile.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "AccountUserProfile" + }, + "response": { + "$ref": "AccountUserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "accounts": { + "methods": { + "get": { + "id": "dfareporting.accounts.get", + "path": "userprofiles/{profileId}/accounts/{id}", + "httpMethod": "GET", + "description": "Gets one account by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Account ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.accounts.list", + "path": "userprofiles/{profileId}/accounts", + "httpMethod": "GET", + "description": "Retrieves the list of accounts, possibly filtered.", + "parameters": { + "active": { + "type": "boolean", + "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only accounts with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "AccountsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.accounts.patch", + "path": "userprofiles/{profileId}/accounts", + "httpMethod": "PATCH", + "description": "Updates an existing account. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Account ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "Account" + }, + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.accounts.update", + "path": "userprofiles/{profileId}/accounts", + "httpMethod": "PUT", + "description": "Updates an existing account.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Account" + }, + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "ads": { + "methods": { + "get": { + "id": "dfareporting.ads.get", + "path": "userprofiles/{profileId}/ads/{id}", + "httpMethod": "GET", + "description": "Gets one ad by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Ad ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Ad" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.ads.insert", + "path": "userprofiles/{profileId}/ads", + "httpMethod": "POST", + "description": "Inserts a new ad.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Ad" + }, + "response": { + "$ref": "Ad" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.ads.list", + "path": "userprofiles/{profileId}/ads", + "httpMethod": "GET", + "description": "Retrieves a list of ads, possibly filtered.", + "parameters": { + "active": { + "type": "boolean", + "description": "Select only active ads.", + "location": "query" + }, + "advertiserId": { + "type": "string", + "description": "Select only ads with this advertiser ID.", + "format": "int64", + "location": "query" + }, + "archived": { + "type": "boolean", + "description": "Select only archived ads.", + "location": "query" + }, + "audienceSegmentIds": { + "type": "string", + "description": "Select only ads with these audience segment IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "campaignIds": { + "type": "string", + "description": "Select only ads with these campaign IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "compatibility": { + "type": "string", + "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.", + "enum": [ + "APP", + "APP_INTERSTITIAL", + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "IN_STREAM_VIDEO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "location": "query" + }, + "creativeIds": { + "type": "string", + "description": "Select only ads with these creative IDs assigned.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "creativeOptimizationConfigurationIds": { + "type": "string", + "description": "Select only ads with these creative optimization configuration IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "creativeType": { + "type": "string", + "description": "Select only ads with the specified creativeType.", + "enum": [ + "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO", + "CUSTOM_INPAGE", + "CUSTOM_INTERSTITIAL", + "ENHANCED_BANNER", + "ENHANCED_IMAGE", + "FLASH_INPAGE", + "HTML5_BANNER", + "IMAGE", + "INSTREAM_VIDEO", + "INSTREAM_VIDEO_REDIRECT", + "INTERNAL_REDIRECT", + "INTERSTITIAL_INTERNAL_REDIRECT", + "REDIRECT", + "RICH_MEDIA_EXPANDING", + "RICH_MEDIA_IM_EXPAND", + "RICH_MEDIA_INPAGE", + "RICH_MEDIA_INPAGE_FLOATING", + "RICH_MEDIA_INTERSTITIAL_FLOAT", + "RICH_MEDIA_MOBILE_IN_APP", + "RICH_MEDIA_MULTI_FLOATING", + "RICH_MEDIA_PEEL_DOWN", + "TRACKING_TEXT", + "VPAID_LINEAR", + "VPAID_NON_LINEAR" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "location": "query" + }, + "dynamicClickTracker": { + "type": "boolean", + "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only ads with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "landingPageIds": { + "type": "string", + "description": "Select only ads with these landing page IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "overriddenEventTagId": { + "type": "string", + "description": "Select only ads with this event tag override ID.", + "format": "int64", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "placementIds": { + "type": "string", + "description": "Select only ads with these placement IDs assigned.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "remarketingListIds": { + "type": "string", + "description": "Select only ads whose list targeting expression use these remarketing list IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".", + "location": "query" + }, + "sizeIds": { + "type": "string", + "description": "Select only ads with these size IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sslCompliant": { + "type": "boolean", + "description": "Select only ads that are SSL-compliant.", + "location": "query" + }, + "sslRequired": { + "type": "boolean", + "description": "Select only ads that require SSL.", + "location": "query" + }, + "type": { + "type": "string", + "description": "Select only ads with these types.", + "enum": [ + "AD_SERVING_CLICK_TRACKER", + "AD_SERVING_DEFAULT_AD", + "AD_SERVING_STANDARD_AD", + "AD_SERVING_TRACKING" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "repeated": true, + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "AdsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.ads.patch", + "path": "userprofiles/{profileId}/ads", + "httpMethod": "PATCH", + "description": "Updates an existing ad. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Ad ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "Ad" + }, + "response": { + "$ref": "Ad" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.ads.update", + "path": "userprofiles/{profileId}/ads", + "httpMethod": "PUT", + "description": "Updates an existing ad.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Ad" + }, + "response": { + "$ref": "Ad" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "advertiserGroups": { + "methods": { + "delete": { + "id": "dfareporting.advertiserGroups.delete", + "path": "userprofiles/{profileId}/advertiserGroups/{id}", + "httpMethod": "DELETE", + "description": "Deletes an existing advertiser group.", + "parameters": { + "id": { + "type": "string", + "description": "Advertiser group ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.advertiserGroups.get", + "path": "userprofiles/{profileId}/advertiserGroups/{id}", + "httpMethod": "GET", + "description": "Gets one advertiser group by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Advertiser group ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "AdvertiserGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.advertiserGroups.insert", + "path": "userprofiles/{profileId}/advertiserGroups", + "httpMethod": "POST", + "description": "Inserts a new advertiser group.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "AdvertiserGroup" + }, + "response": { + "$ref": "AdvertiserGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.advertiserGroups.list", + "path": "userprofiles/{profileId}/advertiserGroups", + "httpMethod": "GET", + "description": "Retrieves a list of advertiser groups, possibly filtered.", + "parameters": { + "ids": { + "type": "string", + "description": "Select only advertiser groups with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "AdvertiserGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.advertiserGroups.patch", + "path": "userprofiles/{profileId}/advertiserGroups", + "httpMethod": "PATCH", + "description": "Updates an existing advertiser group. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Advertiser group ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "AdvertiserGroup" + }, + "response": { + "$ref": "AdvertiserGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.advertiserGroups.update", + "path": "userprofiles/{profileId}/advertiserGroups", + "httpMethod": "PUT", + "description": "Updates an existing advertiser group.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "AdvertiserGroup" + }, + "response": { + "$ref": "AdvertiserGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "advertisers": { + "methods": { + "get": { + "id": "dfareporting.advertisers.get", + "path": "userprofiles/{profileId}/advertisers/{id}", + "httpMethod": "GET", + "description": "Gets one advertiser by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Advertiser ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.advertisers.insert", + "path": "userprofiles/{profileId}/advertisers", + "httpMethod": "POST", + "description": "Inserts a new advertiser.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.advertisers.list", + "path": "userprofiles/{profileId}/advertisers", + "httpMethod": "GET", + "description": "Retrieves a list of advertisers, possibly filtered.", + "parameters": { + "advertiserGroupIds": { + "type": "string", + "description": "Select only advertisers with these advertiser group IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "floodlightConfigurationIds": { + "type": "string", + "description": "Select only advertisers with these floodlight configuration IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only advertisers with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "includeAdvertisersWithoutGroupsOnly": { + "type": "boolean", + "description": "Select only advertisers which do not belong to any advertiser group.", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "onlyParent": { + "type": "boolean", + "description": "Select only advertisers which use another advertiser's floodlight configuration.", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "status": { + "type": "string", + "description": "Select only advertisers with the specified status.", + "enum": [ + "APPROVED", + "ON_HOLD" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "subaccountId": { + "type": "string", + "description": "Select only advertisers with these subaccount IDs.", + "format": "int64", + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "AdvertisersListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.advertisers.patch", + "path": "userprofiles/{profileId}/advertisers", + "httpMethod": "PATCH", + "description": "Updates an existing advertiser. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Advertiser ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.advertisers.update", + "path": "userprofiles/{profileId}/advertisers", + "httpMethod": "PUT", + "description": "Updates an existing advertiser.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "browsers": { + "methods": { + "list": { + "id": "dfareporting.browsers.list", + "path": "userprofiles/{profileId}/browsers", + "httpMethod": "GET", + "description": "Retrieves a list of browsers.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "BrowsersListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "campaignCreativeAssociations": { + "methods": { + "insert": { + "id": "dfareporting.campaignCreativeAssociations.insert", + "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations", + "httpMethod": "POST", + "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.", + "parameters": { + "campaignId": { + "type": "string", + "description": "Campaign ID in this association.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "campaignId" + ], + "request": { + "$ref": "CampaignCreativeAssociation" + }, + "response": { + "$ref": "CampaignCreativeAssociation" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.campaignCreativeAssociations.list", + "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations", + "httpMethod": "GET", + "description": "Retrieves the list of creative IDs associated with the specified campaign.", + "parameters": { + "campaignId": { + "type": "string", + "description": "Campaign ID in this association.", + "required": true, + "format": "int64", + "location": "path" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "campaignId" + ], + "response": { + "$ref": "CampaignCreativeAssociationsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "campaigns": { + "methods": { + "get": { + "id": "dfareporting.campaigns.get", + "path": "userprofiles/{profileId}/campaigns/{id}", + "httpMethod": "GET", + "description": "Gets one campaign by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Campaign ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.campaigns.insert", + "path": "userprofiles/{profileId}/campaigns", + "httpMethod": "POST", + "description": "Inserts a new campaign.", + "parameters": { + "defaultLandingPageName": { + "type": "string", + "description": "Default landing page name for this new campaign. Must be less than 256 characters long.", + "required": true, + "location": "query" + }, + "defaultLandingPageUrl": { + "type": "string", + "description": "Default landing page URL for this new campaign.", + "required": true, + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "defaultLandingPageName", + "defaultLandingPageUrl" + ], + "request": { + "$ref": "Campaign" + }, + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.campaigns.list", + "path": "userprofiles/{profileId}/campaigns", + "httpMethod": "GET", + "description": "Retrieves a list of campaigns, possibly filtered.", + "parameters": { + "advertiserGroupIds": { + "type": "string", + "description": "Select only campaigns whose advertisers belong to these advertiser groups.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "advertiserIds": { + "type": "string", + "description": "Select only campaigns that belong to these advertisers.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "archived": { + "type": "boolean", + "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.", + "location": "query" + }, + "atLeastOneOptimizationActivity": { + "type": "boolean", + "description": "Select only campaigns that have at least one optimization activity.", + "location": "query" + }, + "excludedIds": { + "type": "string", + "description": "Exclude campaigns with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only campaigns with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "overriddenEventTagId": { + "type": "string", + "description": "Select only campaigns that have overridden this event tag ID.", + "format": "int64", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "subaccountId": { + "type": "string", + "description": "Select only campaigns that belong to this subaccount.", + "format": "int64", + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "CampaignsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.campaigns.patch", + "path": "userprofiles/{profileId}/campaigns", + "httpMethod": "PATCH", + "description": "Updates an existing campaign. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Campaign ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "Campaign" + }, + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.campaigns.update", + "path": "userprofiles/{profileId}/campaigns", + "httpMethod": "PUT", + "description": "Updates an existing campaign.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Campaign" + }, + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "changeLogs": { + "methods": { + "get": { + "id": "dfareporting.changeLogs.get", + "path": "userprofiles/{profileId}/changeLogs/{id}", + "httpMethod": "GET", + "description": "Gets one change log by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Change log ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "ChangeLog" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.changeLogs.list", + "path": "userprofiles/{profileId}/changeLogs", + "httpMethod": "GET", + "description": "Retrieves a list of change logs.", + "parameters": { + "action": { + "type": "string", + "description": "Select only change logs with the specified action.", + "enum": [ + "ACTION_ADD", + "ACTION_ASSIGN", + "ACTION_ASSOCIATE", + "ACTION_CREATE", + "ACTION_DELETE", + "ACTION_DISABLE", + "ACTION_EMAIL_TAGS", + "ACTION_ENABLE", + "ACTION_LINK", + "ACTION_MARK_AS_DEFAULT", + "ACTION_PUSH", + "ACTION_REMOVE", + "ACTION_SEND", + "ACTION_SHARE", + "ACTION_UNASSIGN", + "ACTION_UNLINK", + "ACTION_UPDATE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only change logs with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxChangeTime": { + "type": "string", + "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "minChangeTime": { + "type": "string", + "description": "Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.", + "location": "query" + }, + "objectIds": { + "type": "string", + "description": "Select only change logs with these object IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "objectType": { + "type": "string", + "description": "Select only change logs with the specified object type.", + "enum": [ + "OBJECT_ACCOUNT", + "OBJECT_ACCOUNT_BILLING_FEATURE", + "OBJECT_AD", + "OBJECT_ADVERTISER", + "OBJECT_ADVERTISER_GROUP", + "OBJECT_BILLING_ACCOUNT_GROUP", + "OBJECT_BILLING_FEATURE", + "OBJECT_BILLING_MINIMUM_FEE", + "OBJECT_BILLING_PROFILE", + "OBJECT_CAMPAIGN", + "OBJECT_CONTENT_CATEGORY", + "OBJECT_CREATIVE", + "OBJECT_CREATIVE_ASSET", + "OBJECT_CREATIVE_BUNDLE", + "OBJECT_CREATIVE_FIELD", + "OBJECT_CREATIVE_GROUP", + "OBJECT_DFA_SITE", + "OBJECT_EVENT_TAG", + "OBJECT_FLOODLIGHT_ACTIVITY_GROUP", + "OBJECT_FLOODLIGHT_ACTVITY", + "OBJECT_FLOODLIGHT_CONFIGURATION", + "OBJECT_INSTREAM_CREATIVE", + "OBJECT_LANDING_PAGE", + "OBJECT_MEDIA_ORDER", + "OBJECT_PLACEMENT", + "OBJECT_PLACEMENT_STRATEGY", + "OBJECT_PLAYSTORE_LINK", + "OBJECT_PROVIDED_LIST_CLIENT", + "OBJECT_RATE_CARD", + "OBJECT_REMARKETING_LIST", + "OBJECT_RICHMEDIA_CREATIVE", + "OBJECT_SD_SITE", + "OBJECT_SIZE", + "OBJECT_SUBACCOUNT", + "OBJECT_USER_PROFILE", + "OBJECT_USER_PROFILE_FILTER", + "OBJECT_USER_ROLE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Select only change logs whose object ID, user name, old or new values match the search string.", + "location": "query" + }, + "userProfileIds": { + "type": "string", + "description": "Select only change logs with these user profile IDs.", + "format": "int64", + "repeated": true, + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "ChangeLogsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "cities": { + "methods": { + "list": { + "id": "dfareporting.cities.list", + "path": "userprofiles/{profileId}/cities", + "httpMethod": "GET", + "description": "Retrieves a list of cities, possibly filtered.", + "parameters": { + "countryDartIds": { + "type": "string", + "description": "Select only cities from these countries.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "dartIds": { + "type": "string", + "description": "Select only cities with these DART IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "namePrefix": { + "type": "string", + "description": "Select only cities with names starting with this prefix.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "regionDartIds": { + "type": "string", + "description": "Select only cities from these regions.", + "format": "int64", + "repeated": true, + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "CitiesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "connectionTypes": { + "methods": { + "get": { + "id": "dfareporting.connectionTypes.get", + "path": "userprofiles/{profileId}/connectionTypes/{id}", + "httpMethod": "GET", + "description": "Gets one connection type by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Connection type ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "ConnectionType" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.connectionTypes.list", + "path": "userprofiles/{profileId}/connectionTypes", + "httpMethod": "GET", + "description": "Retrieves a list of connection types.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "ConnectionTypesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "contentCategories": { + "methods": { + "delete": { + "id": "dfareporting.contentCategories.delete", + "path": "userprofiles/{profileId}/contentCategories/{id}", + "httpMethod": "DELETE", + "description": "Deletes an existing content category.", + "parameters": { + "id": { + "type": "string", + "description": "Content category ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.contentCategories.get", + "path": "userprofiles/{profileId}/contentCategories/{id}", + "httpMethod": "GET", + "description": "Gets one content category by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Content category ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "ContentCategory" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.contentCategories.insert", + "path": "userprofiles/{profileId}/contentCategories", + "httpMethod": "POST", + "description": "Inserts a new content category.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "ContentCategory" + }, + "response": { + "$ref": "ContentCategory" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.contentCategories.list", + "path": "userprofiles/{profileId}/contentCategories", + "httpMethod": "GET", + "description": "Retrieves a list of content categories, possibly filtered.", + "parameters": { + "ids": { + "type": "string", + "description": "Select only content categories with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "ContentCategoriesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.contentCategories.patch", + "path": "userprofiles/{profileId}/contentCategories", + "httpMethod": "PATCH", + "description": "Updates an existing content category. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Content category ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "ContentCategory" + }, + "response": { + "$ref": "ContentCategory" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.contentCategories.update", + "path": "userprofiles/{profileId}/contentCategories", + "httpMethod": "PUT", + "description": "Updates an existing content category.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "ContentCategory" + }, + "response": { + "$ref": "ContentCategory" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "countries": { + "methods": { + "get": { + "id": "dfareporting.countries.get", + "path": "userprofiles/{profileId}/countries/{dartId}", + "httpMethod": "GET", + "description": "Gets one country by ID.", + "parameters": { + "dartId": { + "type": "string", + "description": "Country DART ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "dartId" + ], + "response": { + "$ref": "Country" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.countries.list", + "path": "userprofiles/{profileId}/countries", + "httpMethod": "GET", + "description": "Retrieves a list of countries.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "CountriesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "creativeAssets": { + "methods": { + "insert": { + "id": "dfareporting.creativeAssets.insert", + "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets", + "httpMethod": "POST", + "description": "Inserts a new creative asset.", + "parameters": { + "advertiserId": { + "type": "string", + "description": "Advertiser ID of this creative. This is a required field.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "advertiserId" + ], + "request": { + "$ref": "CreativeAssetMetadata" + }, + "response": { + "$ref": "CreativeAssetMetadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ], + "supportsMediaUpload": true, + "mediaUpload": { + "accept": [ + "*/*" + ], + "maxSize": "1024MB", + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/dfareporting/v2.4/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets" + }, + "resumable": { + "multipart": true, + "path": "/resumable/upload/dfareporting/v2.4/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets" + } + } + } + } + } + }, + "creativeFieldValues": { + "methods": { + "delete": { + "id": "dfareporting.creativeFieldValues.delete", + "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}", + "httpMethod": "DELETE", + "description": "Deletes an existing creative field value.", + "parameters": { + "creativeFieldId": { + "type": "string", + "description": "Creative field ID for this creative field value.", + "required": true, + "format": "int64", + "location": "path" + }, + "id": { + "type": "string", + "description": "Creative Field Value ID", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "creativeFieldId", + "id" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.creativeFieldValues.get", + "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}", + "httpMethod": "GET", + "description": "Gets one creative field value by ID.", + "parameters": { + "creativeFieldId": { + "type": "string", + "description": "Creative field ID for this creative field value.", + "required": true, + "format": "int64", + "location": "path" + }, + "id": { + "type": "string", + "description": "Creative Field Value ID", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "creativeFieldId", + "id" + ], + "response": { + "$ref": "CreativeFieldValue" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.creativeFieldValues.insert", + "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues", + "httpMethod": "POST", + "description": "Inserts a new creative field value.", + "parameters": { + "creativeFieldId": { + "type": "string", + "description": "Creative field ID for this creative field value.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "creativeFieldId" + ], + "request": { + "$ref": "CreativeFieldValue" + }, + "response": { + "$ref": "CreativeFieldValue" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.creativeFieldValues.list", + "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues", + "httpMethod": "GET", + "description": "Retrieves a list of creative field values, possibly filtered.", + "parameters": { + "creativeFieldId": { + "type": "string", + "description": "Creative field ID for this creative field value.", + "required": true, + "format": "int64", + "location": "path" + }, + "ids": { + "type": "string", + "description": "Select only creative field values with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "VALUE" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "creativeFieldId" + ], + "response": { + "$ref": "CreativeFieldValuesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.creativeFieldValues.patch", + "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues", + "httpMethod": "PATCH", + "description": "Updates an existing creative field value. This method supports patch semantics.", + "parameters": { + "creativeFieldId": { + "type": "string", + "description": "Creative field ID for this creative field value.", + "required": true, + "format": "int64", + "location": "path" + }, + "id": { + "type": "string", + "description": "Creative Field Value ID", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "creativeFieldId", + "id" + ], + "request": { + "$ref": "CreativeFieldValue" + }, + "response": { + "$ref": "CreativeFieldValue" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.creativeFieldValues.update", + "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues", + "httpMethod": "PUT", + "description": "Updates an existing creative field value.", + "parameters": { + "creativeFieldId": { + "type": "string", + "description": "Creative field ID for this creative field value.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "creativeFieldId" + ], + "request": { + "$ref": "CreativeFieldValue" + }, + "response": { + "$ref": "CreativeFieldValue" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "creativeFields": { + "methods": { + "delete": { + "id": "dfareporting.creativeFields.delete", + "path": "userprofiles/{profileId}/creativeFields/{id}", + "httpMethod": "DELETE", + "description": "Deletes an existing creative field.", + "parameters": { + "id": { + "type": "string", + "description": "Creative Field ID", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.creativeFields.get", + "path": "userprofiles/{profileId}/creativeFields/{id}", + "httpMethod": "GET", + "description": "Gets one creative field by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Creative Field ID", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "CreativeField" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.creativeFields.insert", + "path": "userprofiles/{profileId}/creativeFields", + "httpMethod": "POST", + "description": "Inserts a new creative field.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "CreativeField" + }, + "response": { + "$ref": "CreativeField" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.creativeFields.list", + "path": "userprofiles/{profileId}/creativeFields", + "httpMethod": "GET", + "description": "Retrieves a list of creative fields, possibly filtered.", + "parameters": { + "advertiserIds": { + "type": "string", + "description": "Select only creative fields that belong to these advertisers.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only creative fields with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "CreativeFieldsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.creativeFields.patch", + "path": "userprofiles/{profileId}/creativeFields", + "httpMethod": "PATCH", + "description": "Updates an existing creative field. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Creative Field ID", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "CreativeField" + }, + "response": { + "$ref": "CreativeField" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.creativeFields.update", + "path": "userprofiles/{profileId}/creativeFields", + "httpMethod": "PUT", + "description": "Updates an existing creative field.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "CreativeField" + }, + "response": { + "$ref": "CreativeField" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "creativeGroups": { + "methods": { + "get": { + "id": "dfareporting.creativeGroups.get", + "path": "userprofiles/{profileId}/creativeGroups/{id}", + "httpMethod": "GET", + "description": "Gets one creative group by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Creative group ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "CreativeGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.creativeGroups.insert", + "path": "userprofiles/{profileId}/creativeGroups", + "httpMethod": "POST", + "description": "Inserts a new creative group.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "CreativeGroup" + }, + "response": { + "$ref": "CreativeGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.creativeGroups.list", + "path": "userprofiles/{profileId}/creativeGroups", + "httpMethod": "GET", + "description": "Retrieves a list of creative groups, possibly filtered.", + "parameters": { + "advertiserIds": { + "type": "string", + "description": "Select only creative groups that belong to these advertisers.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "groupNumber": { + "type": "integer", + "description": "Select only creative groups that belong to this subgroup.", + "format": "int32", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only creative groups with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "CreativeGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.creativeGroups.patch", + "path": "userprofiles/{profileId}/creativeGroups", + "httpMethod": "PATCH", + "description": "Updates an existing creative group. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Creative group ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "CreativeGroup" + }, + "response": { + "$ref": "CreativeGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.creativeGroups.update", + "path": "userprofiles/{profileId}/creativeGroups", + "httpMethod": "PUT", + "description": "Updates an existing creative group.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "CreativeGroup" + }, + "response": { + "$ref": "CreativeGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "creatives": { + "methods": { + "get": { + "id": "dfareporting.creatives.get", + "path": "userprofiles/{profileId}/creatives/{id}", + "httpMethod": "GET", + "description": "Gets one creative by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Creative ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.creatives.insert", + "path": "userprofiles/{profileId}/creatives", + "httpMethod": "POST", + "description": "Inserts a new creative.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.creatives.list", + "path": "userprofiles/{profileId}/creatives", + "httpMethod": "GET", + "description": "Retrieves a list of creatives, possibly filtered.", + "parameters": { + "active": { + "type": "boolean", + "description": "Select only active creatives. Leave blank to select active and inactive creatives.", + "location": "query" + }, + "advertiserId": { + "type": "string", + "description": "Select only creatives with this advertiser ID.", + "format": "int64", + "location": "query" + }, + "archived": { + "type": "boolean", + "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.", + "location": "query" + }, + "campaignId": { + "type": "string", + "description": "Select only creatives with this campaign ID.", + "format": "int64", + "location": "query" + }, + "companionCreativeIds": { + "type": "string", + "description": "Select only in-stream video creatives with these companion IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "creativeFieldIds": { + "type": "string", + "description": "Select only creatives with these creative field IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only creatives with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "renderingIds": { + "type": "string", + "description": "Select only creatives with these rendering IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".", + "location": "query" + }, + "sizeIds": { + "type": "string", + "description": "Select only creatives with these size IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "studioCreativeId": { + "type": "string", + "description": "Select only creatives corresponding to this Studio creative ID.", + "format": "int64", + "location": "query" + }, + "types": { + "type": "string", + "description": "Select only creatives with these creative types.", + "enum": [ + "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO", + "CUSTOM_INPAGE", + "CUSTOM_INTERSTITIAL", + "ENHANCED_BANNER", + "ENHANCED_IMAGE", + "FLASH_INPAGE", + "HTML5_BANNER", + "IMAGE", + "INSTREAM_VIDEO", + "INSTREAM_VIDEO_REDIRECT", + "INTERNAL_REDIRECT", + "INTERSTITIAL_INTERNAL_REDIRECT", + "REDIRECT", + "RICH_MEDIA_EXPANDING", + "RICH_MEDIA_IM_EXPAND", + "RICH_MEDIA_INPAGE", + "RICH_MEDIA_INPAGE_FLOATING", + "RICH_MEDIA_INTERSTITIAL_FLOAT", + "RICH_MEDIA_MOBILE_IN_APP", + "RICH_MEDIA_MULTI_FLOATING", + "RICH_MEDIA_PEEL_DOWN", + "TRACKING_TEXT", + "VPAID_LINEAR", + "VPAID_NON_LINEAR" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "repeated": true, + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "CreativesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.creatives.patch", + "path": "userprofiles/{profileId}/creatives", + "httpMethod": "PATCH", + "description": "Updates an existing creative. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Creative ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.creatives.update", + "path": "userprofiles/{profileId}/creatives", + "httpMethod": "PUT", + "description": "Updates an existing creative.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "dimensionValues": { + "methods": { + "query": { + "id": "dfareporting.dimensionValues.query", + "path": "userprofiles/{profileId}/dimensionvalues/query", + "httpMethod": "POST", + "description": "Retrieves list of report dimension values for a list of filters.", + "parameters": { + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "minimum": "0", + "maximum": "100", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "The value of the nextToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "The DFA user profile ID.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "DimensionValueRequest" + }, + "response": { + "$ref": "DimensionValueList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + } + }, + "directorySiteContacts": { + "methods": { + "get": { + "id": "dfareporting.directorySiteContacts.get", + "path": "userprofiles/{profileId}/directorySiteContacts/{id}", + "httpMethod": "GET", + "description": "Gets one directory site contact by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Directory site contact ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "DirectorySiteContact" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.directorySiteContacts.list", + "path": "userprofiles/{profileId}/directorySiteContacts", + "httpMethod": "GET", + "description": "Retrieves a list of directory site contacts, possibly filtered.", + "parameters": { + "directorySiteIds": { + "type": "string", + "description": "Select only directory site contacts with these directory site IDs. This is a required field.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only directory site contacts with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"directory site contact*2015\" will return objects with names like \"directory site contact June 2015\", \"directory site contact April 2015\", or simply \"directory site contact 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site contact\" will match objects with name \"my directory site contact\", \"directory site contact 2015\", or simply \"directory site contact\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "DirectorySiteContactsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "directorySites": { + "methods": { + "get": { + "id": "dfareporting.directorySites.get", + "path": "userprofiles/{profileId}/directorySites/{id}", + "httpMethod": "GET", + "description": "Gets one directory site by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Directory site ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "DirectorySite" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.directorySites.insert", + "path": "userprofiles/{profileId}/directorySites", + "httpMethod": "POST", + "description": "Inserts a new directory site.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "DirectorySite" + }, + "response": { + "$ref": "DirectorySite" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.directorySites.list", + "path": "userprofiles/{profileId}/directorySites", + "httpMethod": "GET", + "description": "Retrieves a list of directory sites, possibly filtered.", + "parameters": { + "acceptsInStreamVideoPlacements": { + "type": "boolean", + "description": "This search filter is no longer supported and will have no effect on the results returned.", + "location": "query" + }, + "acceptsInterstitialPlacements": { + "type": "boolean", + "description": "This search filter is no longer supported and will have no effect on the results returned.", + "location": "query" + }, + "acceptsPublisherPaidPlacements": { + "type": "boolean", + "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.", + "location": "query" + }, + "active": { + "type": "boolean", + "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.", + "location": "query" + }, + "countryId": { + "type": "string", + "description": "Select only directory sites with this country ID.", + "format": "int64", + "location": "query" + }, + "dfp_network_code": { + "type": "string", + "description": "Select only directory sites with this DFP network code.", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only directory sites with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "parentId": { + "type": "string", + "description": "Select only directory sites with this parent ID.", + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "DirectorySitesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "eventTags": { + "methods": { + "delete": { + "id": "dfareporting.eventTags.delete", + "path": "userprofiles/{profileId}/eventTags/{id}", + "httpMethod": "DELETE", + "description": "Deletes an existing event tag.", + "parameters": { + "id": { + "type": "string", + "description": "Event tag ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.eventTags.get", + "path": "userprofiles/{profileId}/eventTags/{id}", + "httpMethod": "GET", + "description": "Gets one event tag by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Event tag ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "EventTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.eventTags.insert", + "path": "userprofiles/{profileId}/eventTags", + "httpMethod": "POST", + "description": "Inserts a new event tag.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "EventTag" + }, + "response": { + "$ref": "EventTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.eventTags.list", + "path": "userprofiles/{profileId}/eventTags", + "httpMethod": "GET", + "description": "Retrieves a list of event tags, possibly filtered.", + "parameters": { + "adId": { + "type": "string", + "description": "Select only event tags that belong to this ad.", + "format": "int64", + "location": "query" + }, + "advertiserId": { + "type": "string", + "description": "Select only event tags that belong to this advertiser.", + "format": "int64", + "location": "query" + }, + "campaignId": { + "type": "string", + "description": "Select only event tags that belong to this campaign.", + "format": "int64", + "location": "query" + }, + "definitionsOnly": { + "type": "boolean", + "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.", + "location": "query" + }, + "enabled": { + "type": "boolean", + "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.", + "location": "query" + }, + "eventTagTypes": { + "type": "string", + "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.", + "enum": [ + "CLICK_THROUGH_EVENT_TAG", + "IMPRESSION_IMAGE_EVENT_TAG", + "IMPRESSION_JAVASCRIPT_EVENT_TAG" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only event tags with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "EventTagsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.eventTags.patch", + "path": "userprofiles/{profileId}/eventTags", + "httpMethod": "PATCH", + "description": "Updates an existing event tag. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Event tag ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "EventTag" + }, + "response": { + "$ref": "EventTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.eventTags.update", + "path": "userprofiles/{profileId}/eventTags", + "httpMethod": "PUT", + "description": "Updates an existing event tag.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "EventTag" + }, + "response": { + "$ref": "EventTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "files": { + "methods": { + "get": { + "id": "dfareporting.files.get", + "path": "reports/{reportId}/files/{fileId}", + "httpMethod": "GET", + "description": "Retrieves a report file by its report ID and file ID.", + "parameters": { + "fileId": { + "type": "string", + "description": "The ID of the report file.", + "required": true, + "format": "int64", + "location": "path" + }, + "reportId": { + "type": "string", + "description": "The ID of the report.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "reportId", + "fileId" + ], + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ], + "supportsMediaDownload": true + }, + "list": { + "id": "dfareporting.files.list", + "path": "userprofiles/{profileId}/files", + "httpMethod": "GET", + "description": "Lists files for a user profile.", + "parameters": { + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "minimum": "0", + "maximum": "10", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "The value of the nextToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "The DFA profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "scope": { + "type": "string", + "description": "The scope that defines which results are returned, default is 'MINE'.", + "default": "MINE", + "enum": [ + "ALL", + "MINE", + "SHARED_WITH_ME" + ], + "enumDescriptions": [ + "All files in account.", + "My files.", + "Files shared with me." + ], + "location": "query" + }, + "sortField": { + "type": "string", + "description": "The field by which to sort the list.", + "default": "LAST_MODIFIED_TIME", + "enum": [ + "ID", + "LAST_MODIFIED_TIME" + ], + "enumDescriptions": [ + "Sort by file ID.", + "Sort by 'lastmodifiedAt' field." + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is 'DESCENDING'.", + "default": "DESCENDING", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "FileList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + } + }, + "floodlightActivities": { + "methods": { + "delete": { + "id": "dfareporting.floodlightActivities.delete", + "path": "userprofiles/{profileId}/floodlightActivities/{id}", + "httpMethod": "DELETE", + "description": "Deletes an existing floodlight activity.", + "parameters": { + "id": { + "type": "string", + "description": "Floodlight activity ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "generatetag": { + "id": "dfareporting.floodlightActivities.generatetag", + "path": "userprofiles/{profileId}/floodlightActivities/generatetag", + "httpMethod": "POST", + "description": "Generates a tag for a floodlight activity.", + "parameters": { + "floodlightActivityId": { + "type": "string", + "description": "Floodlight activity ID for which we want to generate a tag.", + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "FloodlightActivitiesGenerateTagResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.floodlightActivities.get", + "path": "userprofiles/{profileId}/floodlightActivities/{id}", + "httpMethod": "GET", + "description": "Gets one floodlight activity by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Floodlight activity ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "FloodlightActivity" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.floodlightActivities.insert", + "path": "userprofiles/{profileId}/floodlightActivities", + "httpMethod": "POST", + "description": "Inserts a new floodlight activity.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "FloodlightActivity" + }, + "response": { + "$ref": "FloodlightActivity" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.floodlightActivities.list", + "path": "userprofiles/{profileId}/floodlightActivities", + "httpMethod": "GET", + "description": "Retrieves a list of floodlight activities, possibly filtered.", + "parameters": { + "advertiserId": { + "type": "string", + "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query" + }, + "floodlightActivityGroupIds": { + "type": "string", + "description": "Select only floodlight activities with the specified floodlight activity group IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "floodlightActivityGroupName": { + "type": "string", + "description": "Select only floodlight activities with the specified floodlight activity group name.", + "location": "query" + }, + "floodlightActivityGroupTagString": { + "type": "string", + "description": "Select only floodlight activities with the specified floodlight activity group tag string.", + "location": "query" + }, + "floodlightActivityGroupType": { + "type": "string", + "description": "Select only floodlight activities with the specified floodlight activity group type.", + "enum": [ + "COUNTER", + "SALE" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "floodlightConfigurationId": { + "type": "string", + "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "tagString": { + "type": "string", + "description": "Select only floodlight activities with the specified tag string.", + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "FloodlightActivitiesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.floodlightActivities.patch", + "path": "userprofiles/{profileId}/floodlightActivities", + "httpMethod": "PATCH", + "description": "Updates an existing floodlight activity. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Floodlight activity ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "FloodlightActivity" + }, + "response": { + "$ref": "FloodlightActivity" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.floodlightActivities.update", + "path": "userprofiles/{profileId}/floodlightActivities", + "httpMethod": "PUT", + "description": "Updates an existing floodlight activity.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "FloodlightActivity" + }, + "response": { + "$ref": "FloodlightActivity" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "floodlightActivityGroups": { + "methods": { + "get": { + "id": "dfareporting.floodlightActivityGroups.get", + "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}", + "httpMethod": "GET", + "description": "Gets one floodlight activity group by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Floodlight activity Group ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "FloodlightActivityGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.floodlightActivityGroups.insert", + "path": "userprofiles/{profileId}/floodlightActivityGroups", + "httpMethod": "POST", + "description": "Inserts a new floodlight activity group.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "FloodlightActivityGroup" + }, + "response": { + "$ref": "FloodlightActivityGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.floodlightActivityGroups.list", + "path": "userprofiles/{profileId}/floodlightActivityGroups", + "httpMethod": "GET", + "description": "Retrieves a list of floodlight activity groups, possibly filtered.", + "parameters": { + "advertiserId": { + "type": "string", + "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query" + }, + "floodlightConfigurationId": { + "type": "string", + "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "type": { + "type": "string", + "description": "Select only floodlight activity groups with the specified floodlight activity group type.", + "enum": [ + "COUNTER", + "SALE" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "FloodlightActivityGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.floodlightActivityGroups.patch", + "path": "userprofiles/{profileId}/floodlightActivityGroups", + "httpMethod": "PATCH", + "description": "Updates an existing floodlight activity group. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Floodlight activity Group ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "FloodlightActivityGroup" + }, + "response": { + "$ref": "FloodlightActivityGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.floodlightActivityGroups.update", + "path": "userprofiles/{profileId}/floodlightActivityGroups", + "httpMethod": "PUT", + "description": "Updates an existing floodlight activity group.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "FloodlightActivityGroup" + }, + "response": { + "$ref": "FloodlightActivityGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "floodlightConfigurations": { + "methods": { + "get": { + "id": "dfareporting.floodlightConfigurations.get", + "path": "userprofiles/{profileId}/floodlightConfigurations/{id}", + "httpMethod": "GET", + "description": "Gets one floodlight configuration by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Floodlight configuration ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "FloodlightConfiguration" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.floodlightConfigurations.list", + "path": "userprofiles/{profileId}/floodlightConfigurations", + "httpMethod": "GET", + "description": "Retrieves a list of floodlight configurations, possibly filtered.", + "parameters": { + "ids": { + "type": "string", + "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "FloodlightConfigurationsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.floodlightConfigurations.patch", + "path": "userprofiles/{profileId}/floodlightConfigurations", + "httpMethod": "PATCH", + "description": "Updates an existing floodlight configuration. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Floodlight configuration ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "FloodlightConfiguration" + }, + "response": { + "$ref": "FloodlightConfiguration" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.floodlightConfigurations.update", + "path": "userprofiles/{profileId}/floodlightConfigurations", + "httpMethod": "PUT", + "description": "Updates an existing floodlight configuration.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "FloodlightConfiguration" + }, + "response": { + "$ref": "FloodlightConfiguration" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "inventoryItems": { + "methods": { + "get": { + "id": "dfareporting.inventoryItems.get", + "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}", + "httpMethod": "GET", + "description": "Gets one inventory item by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Inventory item ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "projectId": { + "type": "string", + "description": "Project ID for order documents.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "projectId", + "id" + ], + "response": { + "$ref": "InventoryItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.inventoryItems.list", + "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems", + "httpMethod": "GET", + "description": "Retrieves a list of inventory items, possibly filtered.", + "parameters": { + "ids": { + "type": "string", + "description": "Select only inventory items with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "inPlan": { + "type": "boolean", + "description": "Select only inventory items that are in plan.", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "orderId": { + "type": "string", + "description": "Select only inventory items that belong to specified orders.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "projectId": { + "type": "string", + "description": "Project ID for order documents.", + "required": true, + "format": "int64", + "location": "path" + }, + "siteId": { + "type": "string", + "description": "Select only inventory items that are associated with these sites.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "type": { + "type": "string", + "description": "Select only inventory items with this type.", + "enum": [ + "PLANNING_PLACEMENT_TYPE_CREDIT", + "PLANNING_PLACEMENT_TYPE_REGULAR" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "projectId" + ], + "response": { + "$ref": "InventoryItemsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "landingPages": { + "methods": { + "delete": { + "id": "dfareporting.landingPages.delete", + "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}", + "httpMethod": "DELETE", + "description": "Deletes an existing campaign landing page.", + "parameters": { + "campaignId": { + "type": "string", + "description": "Landing page campaign ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "id": { + "type": "string", + "description": "Landing page ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "campaignId", + "id" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.landingPages.get", + "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}", + "httpMethod": "GET", + "description": "Gets one campaign landing page by ID.", + "parameters": { + "campaignId": { + "type": "string", + "description": "Landing page campaign ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "id": { + "type": "string", + "description": "Landing page ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "campaignId", + "id" + ], + "response": { + "$ref": "LandingPage" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.landingPages.insert", + "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages", + "httpMethod": "POST", + "description": "Inserts a new landing page for the specified campaign.", + "parameters": { + "campaignId": { + "type": "string", + "description": "Landing page campaign ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "campaignId" + ], + "request": { + "$ref": "LandingPage" + }, + "response": { + "$ref": "LandingPage" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.landingPages.list", + "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages", + "httpMethod": "GET", + "description": "Retrieves the list of landing pages for the specified campaign.", + "parameters": { + "campaignId": { + "type": "string", + "description": "Landing page campaign ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "campaignId" + ], + "response": { + "$ref": "LandingPagesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.landingPages.patch", + "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages", + "httpMethod": "PATCH", + "description": "Updates an existing campaign landing page. This method supports patch semantics.", + "parameters": { + "campaignId": { + "type": "string", + "description": "Landing page campaign ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "id": { + "type": "string", + "description": "Landing page ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "campaignId", + "id" + ], + "request": { + "$ref": "LandingPage" + }, + "response": { + "$ref": "LandingPage" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.landingPages.update", + "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages", + "httpMethod": "PUT", + "description": "Updates an existing campaign landing page.", + "parameters": { + "campaignId": { + "type": "string", + "description": "Landing page campaign ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "campaignId" + ], + "request": { + "$ref": "LandingPage" + }, + "response": { + "$ref": "LandingPage" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "metros": { + "methods": { + "list": { + "id": "dfareporting.metros.list", + "path": "userprofiles/{profileId}/metros", + "httpMethod": "GET", + "description": "Retrieves a list of metros.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "MetrosListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "mobileCarriers": { + "methods": { + "get": { + "id": "dfareporting.mobileCarriers.get", + "path": "userprofiles/{profileId}/mobileCarriers/{id}", + "httpMethod": "GET", + "description": "Gets one mobile carrier by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Mobile carrier ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "MobileCarrier" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.mobileCarriers.list", + "path": "userprofiles/{profileId}/mobileCarriers", + "httpMethod": "GET", + "description": "Retrieves a list of mobile carriers.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "MobileCarriersListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "operatingSystemVersions": { + "methods": { + "get": { + "id": "dfareporting.operatingSystemVersions.get", + "path": "userprofiles/{profileId}/operatingSystemVersions/{id}", + "httpMethod": "GET", + "description": "Gets one operating system version by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Operating system version ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "OperatingSystemVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.operatingSystemVersions.list", + "path": "userprofiles/{profileId}/operatingSystemVersions", + "httpMethod": "GET", + "description": "Retrieves a list of operating system versions.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "OperatingSystemVersionsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "operatingSystems": { + "methods": { + "get": { + "id": "dfareporting.operatingSystems.get", + "path": "userprofiles/{profileId}/operatingSystems/{dartId}", + "httpMethod": "GET", + "description": "Gets one operating system by DART ID.", + "parameters": { + "dartId": { + "type": "string", + "description": "Operating system DART ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "dartId" + ], + "response": { + "$ref": "OperatingSystem" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.operatingSystems.list", + "path": "userprofiles/{profileId}/operatingSystems", + "httpMethod": "GET", + "description": "Retrieves a list of operating systems.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "OperatingSystemsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "orderDocuments": { + "methods": { + "get": { + "id": "dfareporting.orderDocuments.get", + "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}", + "httpMethod": "GET", + "description": "Gets one order document by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Order document ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "projectId": { + "type": "string", + "description": "Project ID for order documents.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "projectId", + "id" + ], + "response": { + "$ref": "OrderDocument" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.orderDocuments.list", + "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments", + "httpMethod": "GET", + "description": "Retrieves a list of order documents, possibly filtered.", + "parameters": { + "approved": { + "type": "boolean", + "description": "Select only order documents that have been approved by at least one user.", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only order documents with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "orderId": { + "type": "string", + "description": "Select only order documents for specified orders.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "projectId": { + "type": "string", + "description": "Project ID for order documents.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".", + "location": "query" + }, + "siteId": { + "type": "string", + "description": "Select only order documents that are associated with these sites.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "projectId" + ], + "response": { + "$ref": "OrderDocumentsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "orders": { + "methods": { + "get": { + "id": "dfareporting.orders.get", + "path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}", + "httpMethod": "GET", + "description": "Gets one order by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Order ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "projectId": { + "type": "string", + "description": "Project ID for orders.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "projectId", + "id" + ], + "response": { + "$ref": "Order" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.orders.list", + "path": "userprofiles/{profileId}/projects/{projectId}/orders", + "httpMethod": "GET", + "description": "Retrieves a list of orders, possibly filtered.", + "parameters": { + "ids": { + "type": "string", + "description": "Select only orders with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "projectId": { + "type": "string", + "description": "Project ID for orders.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".", + "location": "query" + }, + "siteId": { + "type": "string", + "description": "Select only orders that are associated with these site IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "projectId" + ], + "response": { + "$ref": "OrdersListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "placementGroups": { + "methods": { + "get": { + "id": "dfareporting.placementGroups.get", + "path": "userprofiles/{profileId}/placementGroups/{id}", + "httpMethod": "GET", + "description": "Gets one placement group by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Placement group ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "PlacementGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.placementGroups.insert", + "path": "userprofiles/{profileId}/placementGroups", + "httpMethod": "POST", + "description": "Inserts a new placement group.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "PlacementGroup" + }, + "response": { + "$ref": "PlacementGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.placementGroups.list", + "path": "userprofiles/{profileId}/placementGroups", + "httpMethod": "GET", + "description": "Retrieves a list of placement groups, possibly filtered.", + "parameters": { + "advertiserIds": { + "type": "string", + "description": "Select only placement groups that belong to these advertisers.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "archived": { + "type": "boolean", + "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.", + "location": "query" + }, + "campaignIds": { + "type": "string", + "description": "Select only placement groups that belong to these campaigns.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "contentCategoryIds": { + "type": "string", + "description": "Select only placement groups that are associated with these content categories.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "directorySiteIds": { + "type": "string", + "description": "Select only placement groups that are associated with these directory sites.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only placement groups with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxEndDate": { + "type": "string", + "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "maxStartDate": { + "type": "string", + "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query" + }, + "minEndDate": { + "type": "string", + "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query" + }, + "minStartDate": { + "type": "string", + "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "placementGroupType": { + "type": "string", + "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.", + "enum": [ + "PLACEMENT_PACKAGE", + "PLACEMENT_ROADBLOCK" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "placementStrategyIds": { + "type": "string", + "description": "Select only placement groups that are associated with these placement strategies.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "pricingTypes": { + "type": "string", + "description": "Select only placement groups with these pricing types.", + "enum": [ + "PRICING_TYPE_CPA", + "PRICING_TYPE_CPC", + "PRICING_TYPE_CPM", + "PRICING_TYPE_FLAT_RATE_CLICKS", + "PRICING_TYPE_FLAT_RATE_IMPRESSIONS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "repeated": true, + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".", + "location": "query" + }, + "siteIds": { + "type": "string", + "description": "Select only placement groups that are associated with these sites.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "PlacementGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.placementGroups.patch", + "path": "userprofiles/{profileId}/placementGroups", + "httpMethod": "PATCH", + "description": "Updates an existing placement group. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Placement group ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "PlacementGroup" + }, + "response": { + "$ref": "PlacementGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.placementGroups.update", + "path": "userprofiles/{profileId}/placementGroups", + "httpMethod": "PUT", + "description": "Updates an existing placement group.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "PlacementGroup" + }, + "response": { + "$ref": "PlacementGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "placementStrategies": { + "methods": { + "delete": { + "id": "dfareporting.placementStrategies.delete", + "path": "userprofiles/{profileId}/placementStrategies/{id}", + "httpMethod": "DELETE", + "description": "Deletes an existing placement strategy.", + "parameters": { + "id": { + "type": "string", + "description": "Placement strategy ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.placementStrategies.get", + "path": "userprofiles/{profileId}/placementStrategies/{id}", + "httpMethod": "GET", + "description": "Gets one placement strategy by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Placement strategy ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "PlacementStrategy" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.placementStrategies.insert", + "path": "userprofiles/{profileId}/placementStrategies", + "httpMethod": "POST", + "description": "Inserts a new placement strategy.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "PlacementStrategy" + }, + "response": { + "$ref": "PlacementStrategy" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.placementStrategies.list", + "path": "userprofiles/{profileId}/placementStrategies", + "httpMethod": "GET", + "description": "Retrieves a list of placement strategies, possibly filtered.", + "parameters": { + "ids": { + "type": "string", + "description": "Select only placement strategies with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "PlacementStrategiesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.placementStrategies.patch", + "path": "userprofiles/{profileId}/placementStrategies", + "httpMethod": "PATCH", + "description": "Updates an existing placement strategy. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Placement strategy ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "PlacementStrategy" + }, + "response": { + "$ref": "PlacementStrategy" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.placementStrategies.update", + "path": "userprofiles/{profileId}/placementStrategies", + "httpMethod": "PUT", + "description": "Updates an existing placement strategy.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "PlacementStrategy" + }, + "response": { + "$ref": "PlacementStrategy" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "placements": { + "methods": { + "generatetags": { + "id": "dfareporting.placements.generatetags", + "path": "userprofiles/{profileId}/placements/generatetags", + "httpMethod": "POST", + "description": "Generates tags for a placement.", + "parameters": { + "campaignId": { + "type": "string", + "description": "Generate placements belonging to this campaign. This is a required field.", + "format": "int64", + "location": "query" + }, + "placementIds": { + "type": "string", + "description": "Generate tags for these placements.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "tagFormats": { + "type": "string", + "description": "Tag formats to generate for these placements.", + "enum": [ + "PLACEMENT_TAG_CLICK_COMMANDS", + "PLACEMENT_TAG_IFRAME_ILAYER", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", + "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", + "PLACEMENT_TAG_INTERNAL_REDIRECT", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", + "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_JAVASCRIPT", + "PLACEMENT_TAG_JAVASCRIPT_LEGACY", + "PLACEMENT_TAG_STANDARD", + "PLACEMENT_TAG_TRACKING", + "PLACEMENT_TAG_TRACKING_IFRAME", + "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "repeated": true, + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "PlacementsGenerateTagsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.placements.get", + "path": "userprofiles/{profileId}/placements/{id}", + "httpMethod": "GET", + "description": "Gets one placement by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Placement ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Placement" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.placements.insert", + "path": "userprofiles/{profileId}/placements", + "httpMethod": "POST", + "description": "Inserts a new placement.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Placement" + }, + "response": { + "$ref": "Placement" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.placements.list", + "path": "userprofiles/{profileId}/placements", + "httpMethod": "GET", + "description": "Retrieves a list of placements, possibly filtered.", + "parameters": { + "advertiserIds": { + "type": "string", + "description": "Select only placements that belong to these advertisers.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "archived": { + "type": "boolean", + "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.", + "location": "query" + }, + "campaignIds": { + "type": "string", + "description": "Select only placements that belong to these campaigns.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "compatibilities": { + "type": "string", + "description": "Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.", + "enum": [ + "APP", + "APP_INTERSTITIAL", + "DISPLAY", + "DISPLAY_INTERSTITIAL", + "IN_STREAM_VIDEO" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "repeated": true, + "location": "query" + }, + "contentCategoryIds": { + "type": "string", + "description": "Select only placements that are associated with these content categories.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "directorySiteIds": { + "type": "string", + "description": "Select only placements that are associated with these directory sites.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "groupIds": { + "type": "string", + "description": "Select only placements that belong to these placement groups.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only placements with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxEndDate": { + "type": "string", + "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "maxStartDate": { + "type": "string", + "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query" + }, + "minEndDate": { + "type": "string", + "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query" + }, + "minStartDate": { + "type": "string", + "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "paymentSource": { + "type": "string", + "description": "Select only placements with this payment source.", + "enum": [ + "PLACEMENT_AGENCY_PAID", + "PLACEMENT_PUBLISHER_PAID" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "placementStrategyIds": { + "type": "string", + "description": "Select only placements that are associated with these placement strategies.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "pricingTypes": { + "type": "string", + "description": "Select only placements with these pricing types.", + "enum": [ + "PRICING_TYPE_CPA", + "PRICING_TYPE_CPC", + "PRICING_TYPE_CPM", + "PRICING_TYPE_FLAT_RATE_CLICKS", + "PRICING_TYPE_FLAT_RATE_IMPRESSIONS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "repeated": true, + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\".", + "location": "query" + }, + "siteIds": { + "type": "string", + "description": "Select only placements that are associated with these sites.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "sizeIds": { + "type": "string", + "description": "Select only placements that are associated with these sizes.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "PlacementsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.placements.patch", + "path": "userprofiles/{profileId}/placements", + "httpMethod": "PATCH", + "description": "Updates an existing placement. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Placement ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "Placement" + }, + "response": { + "$ref": "Placement" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.placements.update", + "path": "userprofiles/{profileId}/placements", + "httpMethod": "PUT", + "description": "Updates an existing placement.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Placement" + }, + "response": { + "$ref": "Placement" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "platformTypes": { + "methods": { + "get": { + "id": "dfareporting.platformTypes.get", + "path": "userprofiles/{profileId}/platformTypes/{id}", + "httpMethod": "GET", + "description": "Gets one platform type by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Platform type ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "PlatformType" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.platformTypes.list", + "path": "userprofiles/{profileId}/platformTypes", + "httpMethod": "GET", + "description": "Retrieves a list of platform types.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "PlatformTypesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "postalCodes": { + "methods": { + "get": { + "id": "dfareporting.postalCodes.get", + "path": "userprofiles/{profileId}/postalCodes/{code}", + "httpMethod": "GET", + "description": "Gets one postal code by ID.", + "parameters": { + "code": { + "type": "string", + "description": "Postal code ID.", + "required": true, + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "code" + ], + "response": { + "$ref": "PostalCode" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.postalCodes.list", + "path": "userprofiles/{profileId}/postalCodes", + "httpMethod": "GET", + "description": "Retrieves a list of postal codes.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "PostalCodesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "projects": { + "methods": { + "get": { + "id": "dfareporting.projects.get", + "path": "userprofiles/{profileId}/projects/{id}", + "httpMethod": "GET", + "description": "Gets one project by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Project ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Project" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.projects.list", + "path": "userprofiles/{profileId}/projects", + "httpMethod": "GET", + "description": "Retrieves a list of projects, possibly filtered.", + "parameters": { + "advertiserIds": { + "type": "string", + "description": "Select only projects with these advertiser IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only projects with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "ProjectsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "regions": { + "methods": { + "list": { + "id": "dfareporting.regions.list", + "path": "userprofiles/{profileId}/regions", + "httpMethod": "GET", + "description": "Retrieves a list of regions.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "RegionsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "remarketingListShares": { + "methods": { + "get": { + "id": "dfareporting.remarketingListShares.get", + "path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}", + "httpMethod": "GET", + "description": "Gets one remarketing list share by remarketing list ID.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "remarketingListId": { + "type": "string", + "description": "Remarketing list ID.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "remarketingListId" + ], + "response": { + "$ref": "RemarketingListShare" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.remarketingListShares.patch", + "path": "userprofiles/{profileId}/remarketingListShares", + "httpMethod": "PATCH", + "description": "Updates an existing remarketing list share. This method supports patch semantics.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "remarketingListId": { + "type": "string", + "description": "Remarketing list ID.", + "required": true, + "format": "int64", + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "remarketingListId" + ], + "request": { + "$ref": "RemarketingListShare" + }, + "response": { + "$ref": "RemarketingListShare" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.remarketingListShares.update", + "path": "userprofiles/{profileId}/remarketingListShares", + "httpMethod": "PUT", + "description": "Updates an existing remarketing list share.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "RemarketingListShare" + }, + "response": { + "$ref": "RemarketingListShare" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "remarketingLists": { + "methods": { + "get": { + "id": "dfareporting.remarketingLists.get", + "path": "userprofiles/{profileId}/remarketingLists/{id}", + "httpMethod": "GET", + "description": "Gets one remarketing list by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Remarketing list ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "RemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.remarketingLists.insert", + "path": "userprofiles/{profileId}/remarketingLists", + "httpMethod": "POST", + "description": "Inserts a new remarketing list.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "RemarketingList" + }, + "response": { + "$ref": "RemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.remarketingLists.list", + "path": "userprofiles/{profileId}/remarketingLists", + "httpMethod": "GET", + "description": "Retrieves a list of remarketing lists, possibly filtered.", + "parameters": { + "active": { + "type": "boolean", + "description": "Select only active or only inactive remarketing lists.", + "location": "query" + }, + "advertiserId": { + "type": "string", + "description": "Select only remarketing lists owned by this advertiser.", + "required": true, + "format": "int64", + "location": "query" + }, + "floodlightActivityId": { + "type": "string", + "description": "Select only remarketing lists that have this floodlight activity ID.", + "format": "int64", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "name": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "advertiserId" + ], + "response": { + "$ref": "RemarketingListsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.remarketingLists.patch", + "path": "userprofiles/{profileId}/remarketingLists", + "httpMethod": "PATCH", + "description": "Updates an existing remarketing list. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Remarketing list ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "RemarketingList" + }, + "response": { + "$ref": "RemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.remarketingLists.update", + "path": "userprofiles/{profileId}/remarketingLists", + "httpMethod": "PUT", + "description": "Updates an existing remarketing list.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "RemarketingList" + }, + "response": { + "$ref": "RemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "reports": { + "methods": { + "delete": { + "id": "dfareporting.reports.delete", + "path": "userprofiles/{profileId}/reports/{reportId}", + "httpMethod": "DELETE", + "description": "Deletes a report by its ID.", + "parameters": { + "profileId": { + "type": "string", + "description": "The DFA user profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "reportId": { + "type": "string", + "description": "The ID of the report.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "reportId" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "get": { + "id": "dfareporting.reports.get", + "path": "userprofiles/{profileId}/reports/{reportId}", + "httpMethod": "GET", + "description": "Retrieves a report by its ID.", + "parameters": { + "profileId": { + "type": "string", + "description": "The DFA user profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "reportId": { + "type": "string", + "description": "The ID of the report.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "reportId" + ], + "response": { + "$ref": "Report" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "insert": { + "id": "dfareporting.reports.insert", + "path": "userprofiles/{profileId}/reports", + "httpMethod": "POST", + "description": "Creates a report.", + "parameters": { + "profileId": { + "type": "string", + "description": "The DFA user profile ID.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Report" + }, + "response": { + "$ref": "Report" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "list": { + "id": "dfareporting.reports.list", + "path": "userprofiles/{profileId}/reports", + "httpMethod": "GET", + "description": "Retrieves list of reports.", + "parameters": { + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "minimum": "0", + "maximum": "10", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "The value of the nextToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "The DFA user profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "scope": { + "type": "string", + "description": "The scope that defines which results are returned, default is 'MINE'.", + "default": "MINE", + "enum": [ + "ALL", + "MINE" + ], + "enumDescriptions": [ + "All reports in account.", + "My reports." + ], + "location": "query" + }, + "sortField": { + "type": "string", + "description": "The field by which to sort the list.", + "default": "LAST_MODIFIED_TIME", + "enum": [ + "ID", + "LAST_MODIFIED_TIME", + "NAME" + ], + "enumDescriptions": [ + "Sort by report ID.", + "Sort by 'lastModifiedTime' field.", + "Sort by name of reports." + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is 'DESCENDING'.", + "default": "DESCENDING", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "ReportList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "patch": { + "id": "dfareporting.reports.patch", + "path": "userprofiles/{profileId}/reports/{reportId}", + "httpMethod": "PATCH", + "description": "Updates a report. This method supports patch semantics.", + "parameters": { + "profileId": { + "type": "string", + "description": "The DFA user profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "reportId": { + "type": "string", + "description": "The ID of the report.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "reportId" + ], + "request": { + "$ref": "Report" + }, + "response": { + "$ref": "Report" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "run": { + "id": "dfareporting.reports.run", + "path": "userprofiles/{profileId}/reports/{reportId}/run", + "httpMethod": "POST", + "description": "Runs a report.", + "parameters": { + "profileId": { + "type": "string", + "description": "The DFA profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "reportId": { + "type": "string", + "description": "The ID of the report.", + "required": true, + "format": "int64", + "location": "path" + }, + "synchronous": { + "type": "boolean", + "description": "If set and true, tries to run the report synchronously.", + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "reportId" + ], + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + }, + "update": { + "id": "dfareporting.reports.update", + "path": "userprofiles/{profileId}/reports/{reportId}", + "httpMethod": "PUT", + "description": "Updates a report.", + "parameters": { + "profileId": { + "type": "string", + "description": "The DFA user profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "reportId": { + "type": "string", + "description": "The ID of the report.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "reportId" + ], + "request": { + "$ref": "Report" + }, + "response": { + "$ref": "Report" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + }, + "resources": { + "compatibleFields": { + "methods": { + "query": { + "id": "dfareporting.reports.compatibleFields.query", + "path": "userprofiles/{profileId}/reports/compatiblefields/query", + "httpMethod": "POST", + "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.", + "parameters": { + "profileId": { + "type": "string", + "description": "The DFA user profile ID.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Report" + }, + "response": { + "$ref": "CompatibleFields" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + } + }, + "files": { + "methods": { + "get": { + "id": "dfareporting.reports.files.get", + "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}", + "httpMethod": "GET", + "description": "Retrieves a report file.", + "parameters": { + "fileId": { + "type": "string", + "description": "The ID of the report file.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "The DFA profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "reportId": { + "type": "string", + "description": "The ID of the report.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "reportId", + "fileId" + ], + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ], + "supportsMediaDownload": true + }, + "list": { + "id": "dfareporting.reports.files.list", + "path": "userprofiles/{profileId}/reports/{reportId}/files", + "httpMethod": "GET", + "description": "Lists files for a report.", + "parameters": { + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "minimum": "0", + "maximum": "10", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "The value of the nextToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "The DFA profile ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "reportId": { + "type": "string", + "description": "The ID of the parent report.", + "required": true, + "format": "int64", + "location": "path" + }, + "sortField": { + "type": "string", + "description": "The field by which to sort the list.", + "default": "LAST_MODIFIED_TIME", + "enum": [ + "ID", + "LAST_MODIFIED_TIME" + ], + "enumDescriptions": [ + "Sort by file ID.", + "Sort by 'lastmodifiedAt' field." + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is 'DESCENDING'.", + "default": "DESCENDING", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "Ascending order.", + "Descending order." + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "reportId" + ], + "response": { + "$ref": "FileList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting" + ] + } + } + } + } + }, + "sites": { + "methods": { + "get": { + "id": "dfareporting.sites.get", + "path": "userprofiles/{profileId}/sites/{id}", + "httpMethod": "GET", + "description": "Gets one site by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Site ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.sites.insert", + "path": "userprofiles/{profileId}/sites", + "httpMethod": "POST", + "description": "Inserts a new site.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.sites.list", + "path": "userprofiles/{profileId}/sites", + "httpMethod": "GET", + "description": "Retrieves a list of sites, possibly filtered.", + "parameters": { + "acceptsInStreamVideoPlacements": { + "type": "boolean", + "description": "This search filter is no longer supported and will have no effect on the results returned.", + "location": "query" + }, + "acceptsInterstitialPlacements": { + "type": "boolean", + "description": "This search filter is no longer supported and will have no effect on the results returned.", + "location": "query" + }, + "acceptsPublisherPaidPlacements": { + "type": "boolean", + "description": "Select only sites that accept publisher paid placements.", + "location": "query" + }, + "adWordsSite": { + "type": "boolean", + "description": "Select only AdWords sites.", + "location": "query" + }, + "approved": { + "type": "boolean", + "description": "Select only approved sites.", + "location": "query" + }, + "campaignIds": { + "type": "string", + "description": "Select only sites with these campaign IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "directorySiteIds": { + "type": "string", + "description": "Select only sites with these directory site IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only sites with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "subaccountId": { + "type": "string", + "description": "Select only sites with this subaccount ID.", + "format": "int64", + "location": "query" + }, + "unmappedSite": { + "type": "boolean", + "description": "Select only sites that have not been mapped to a directory site.", + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "SitesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.sites.patch", + "path": "userprofiles/{profileId}/sites", + "httpMethod": "PATCH", + "description": "Updates an existing site. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Site ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.sites.update", + "path": "userprofiles/{profileId}/sites", + "httpMethod": "PUT", + "description": "Updates an existing site.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "sizes": { + "methods": { + "get": { + "id": "dfareporting.sizes.get", + "path": "userprofiles/{profileId}/sizes/{id}", + "httpMethod": "GET", + "description": "Gets one size by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Size ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Size" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.sizes.insert", + "path": "userprofiles/{profileId}/sizes", + "httpMethod": "POST", + "description": "Inserts a new size.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Size" + }, + "response": { + "$ref": "Size" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.sizes.list", + "path": "userprofiles/{profileId}/sizes", + "httpMethod": "GET", + "description": "Retrieves a list of sizes, possibly filtered.", + "parameters": { + "height": { + "type": "integer", + "description": "Select only sizes with this height.", + "format": "int32", + "location": "query" + }, + "iabStandard": { + "type": "boolean", + "description": "Select only IAB standard sizes.", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only sizes with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "width": { + "type": "integer", + "description": "Select only sizes with this width.", + "format": "int32", + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "SizesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "subaccounts": { + "methods": { + "get": { + "id": "dfareporting.subaccounts.get", + "path": "userprofiles/{profileId}/subaccounts/{id}", + "httpMethod": "GET", + "description": "Gets one subaccount by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Subaccount ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "Subaccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.subaccounts.insert", + "path": "userprofiles/{profileId}/subaccounts", + "httpMethod": "POST", + "description": "Inserts a new subaccount.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Subaccount" + }, + "response": { + "$ref": "Subaccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.subaccounts.list", + "path": "userprofiles/{profileId}/subaccounts", + "httpMethod": "GET", + "description": "Gets a list of subaccounts, possibly filtered.", + "parameters": { + "ids": { + "type": "string", + "description": "Select only subaccounts with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "SubaccountsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.subaccounts.patch", + "path": "userprofiles/{profileId}/subaccounts", + "httpMethod": "PATCH", + "description": "Updates an existing subaccount. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "Subaccount ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "Subaccount" + }, + "response": { + "$ref": "Subaccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.subaccounts.update", + "path": "userprofiles/{profileId}/subaccounts", + "httpMethod": "PUT", + "description": "Updates an existing subaccount.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "Subaccount" + }, + "response": { + "$ref": "Subaccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "targetableRemarketingLists": { + "methods": { + "get": { + "id": "dfareporting.targetableRemarketingLists.get", + "path": "userprofiles/{profileId}/targetableRemarketingLists/{id}", + "httpMethod": "GET", + "description": "Gets one remarketing list by ID.", + "parameters": { + "id": { + "type": "string", + "description": "Remarketing list ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "TargetableRemarketingList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.targetableRemarketingLists.list", + "path": "userprofiles/{profileId}/targetableRemarketingLists", + "httpMethod": "GET", + "description": "Retrieves a list of targetable remarketing lists, possibly filtered.", + "parameters": { + "active": { + "type": "boolean", + "description": "Select only active or only inactive targetable remarketing lists.", + "location": "query" + }, + "advertiserId": { + "type": "string", + "description": "Select only targetable remarketing lists targetable by these advertisers.", + "required": true, + "format": "int64", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "name": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + } + }, + "parameterOrder": [ + "profileId", + "advertiserId" + ], + "response": { + "$ref": "TargetableRemarketingListsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "userProfiles": { + "methods": { + "get": { + "id": "dfareporting.userProfiles.get", + "path": "userprofiles/{profileId}", + "httpMethod": "GET", + "description": "Gets one user profile by ID.", + "parameters": { + "profileId": { + "type": "string", + "description": "The user profile ID.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "UserProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting", + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.userProfiles.list", + "path": "userprofiles", + "httpMethod": "GET", + "description": "Retrieves list of user profiles for a user.", + "response": { + "$ref": "UserProfileList" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfareporting", + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "userRolePermissionGroups": { + "methods": { + "get": { + "id": "dfareporting.userRolePermissionGroups.get", + "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}", + "httpMethod": "GET", + "description": "Gets one user role permission group by ID.", + "parameters": { + "id": { + "type": "string", + "description": "User role permission group ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "UserRolePermissionGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.userRolePermissionGroups.list", + "path": "userprofiles/{profileId}/userRolePermissionGroups", + "httpMethod": "GET", + "description": "Gets a list of all supported user role permission groups.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "UserRolePermissionGroupsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "userRolePermissions": { + "methods": { + "get": { + "id": "dfareporting.userRolePermissions.get", + "path": "userprofiles/{profileId}/userRolePermissions/{id}", + "httpMethod": "GET", + "description": "Gets one user role permission by ID.", + "parameters": { + "id": { + "type": "string", + "description": "User role permission ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "UserRolePermission" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.userRolePermissions.list", + "path": "userprofiles/{profileId}/userRolePermissions", + "httpMethod": "GET", + "description": "Gets a list of user role permissions, possibly filtered.", + "parameters": { + "ids": { + "type": "string", + "description": "Select only user role permissions with these IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "UserRolePermissionsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "userRoles": { + "methods": { + "delete": { + "id": "dfareporting.userRoles.delete", + "path": "userprofiles/{profileId}/userRoles/{id}", + "httpMethod": "DELETE", + "description": "Deletes an existing user role.", + "parameters": { + "id": { + "type": "string", + "description": "User role ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "get": { + "id": "dfareporting.userRoles.get", + "path": "userprofiles/{profileId}/userRoles/{id}", + "httpMethod": "GET", + "description": "Gets one user role by ID.", + "parameters": { + "id": { + "type": "string", + "description": "User role ID.", + "required": true, + "format": "int64", + "location": "path" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "response": { + "$ref": "UserRole" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "insert": { + "id": "dfareporting.userRoles.insert", + "path": "userprofiles/{profileId}/userRoles", + "httpMethod": "POST", + "description": "Inserts a new user role.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "UserRole" + }, + "response": { + "$ref": "UserRole" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "list": { + "id": "dfareporting.userRoles.list", + "path": "userprofiles/{profileId}/userRoles", + "httpMethod": "GET", + "description": "Retrieves a list of user roles, possibly filtered.", + "parameters": { + "accountUserRoleOnly": { + "type": "boolean", + "description": "Select only account level user roles not associated with any specific subaccount.", + "location": "query" + }, + "ids": { + "type": "string", + "description": "Select only user roles with the specified IDs.", + "format": "int64", + "repeated": true, + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Value of the nextPageToken from the previous result page.", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + }, + "searchString": { + "type": "string", + "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".", + "location": "query" + }, + "sortField": { + "type": "string", + "description": "Field by which to sort the list.", + "enum": [ + "ID", + "NAME" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "Order of sorted results, default is ASCENDING.", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "enumDescriptions": [ + "", + "" + ], + "location": "query" + }, + "subaccountId": { + "type": "string", + "description": "Select only user roles that belong to this subaccount.", + "format": "int64", + "location": "query" + } + }, + "parameterOrder": [ + "profileId" + ], + "response": { + "$ref": "UserRolesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "patch": { + "id": "dfareporting.userRoles.patch", + "path": "userprofiles/{profileId}/userRoles", + "httpMethod": "PATCH", + "description": "Updates an existing user role. This method supports patch semantics.", + "parameters": { + "id": { + "type": "string", + "description": "User role ID.", + "required": true, + "format": "int64", + "location": "query" + }, + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId", + "id" + ], + "request": { + "$ref": "UserRole" + }, + "response": { + "$ref": "UserRole" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + }, + "update": { + "id": "dfareporting.userRoles.update", + "path": "userprofiles/{profileId}/userRoles", + "httpMethod": "PUT", + "description": "Updates an existing user role.", + "parameters": { + "profileId": { + "type": "string", + "description": "User profile ID associated with this request.", + "required": true, + "format": "int64", + "location": "path" + } + }, + "parameterOrder": [ + "profileId" + ], + "request": { + "$ref": "UserRole" + }, + "response": { + "$ref": "UserRole" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + } + } +} diff --git a/etc/api/discovery/v1/discovery-api.json b/etc/api/discovery/v1/discovery-api.json index c860008cab..82251b51a7 100644 --- a/etc/api/discovery/v1/discovery-api.json +++ b/etc/api/discovery/v1/discovery-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/C2w1FBSA95uk1-Zjy2Ye2MYY6qU\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7WOjGNdCOs-QAXk7eVA9E1_GpoI\"", "discoveryVersion": "v1", "id": "discovery:v1", "name": "discovery", diff --git a/etc/api/dns/v1/dns-api.json b/etc/api/dns/v1/dns-api.json index 442124ec9b..6c0a65b5cd 100644 --- a/etc/api/dns/v1/dns-api.json +++ b/etc/api/dns/v1/dns-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/k7-75ISPMqliZXBrvCRrh8yqxe0\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/YvTvEjSR_sXxd8XvUihYx8e9Xjo\"", "discoveryVersion": "v1", "id": "dns:v1", "name": "dns", "version": "v1", - "revision": "20151028", + "revision": "20160209", "title": "Google Cloud DNS API", "description": "The Google Cloud DNS API provides services for configuring and serving authoritative DNS records.", "ownerDomain": "google.com", @@ -115,7 +115,7 @@ }, "startTime": { "type": "string", - "description": "The time that this operation was started by the server. This is in RFC3339 text format." + "description": "The time that this operation was started by the server (output only). This is in RFC3339 text format." }, "status": { "type": "string", diff --git a/etc/api/dns/v1beta1/dns-api.json b/etc/api/dns/v1beta1/dns-api.json deleted file mode 100644 index 8f59a5ea81..0000000000 --- a/etc/api/dns/v1beta1/dns-api.json +++ /dev/null @@ -1,700 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/z8EvZOnlqaBoJtlcMyMinOpCnyk\"", - "discoveryVersion": "v1", - "id": "dns:v1beta1", - "name": "dns", - "version": "v1beta1", - "revision": "20150729", - "title": "Google Cloud DNS API", - "description": "The Google Cloud DNS API provides services for configuring and serving authoritative DNS records.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "https://developers.google.com/cloud-dns", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/dns/v1beta1/projects/", - "basePath": "/dns/v1beta1/projects/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "dns/v1beta1/projects/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/ndev.clouddns.readonly": { - "description": "View your DNS records hosted by Google Cloud DNS" - }, - "https://www.googleapis.com/auth/ndev.clouddns.readwrite": { - "description": "View and manage your DNS records hosted by Google Cloud DNS" - } - } - } - }, - "schemas": { - "Change": { - "id": "Change", - "type": "object", - "description": "An atomic update to a collection of ResourceRecordSets.", - "properties": { - "additions": { - "type": "array", - "description": "Which ResourceRecordSets to add?", - "items": { - "$ref": "ResourceRecordSet" - } - }, - "deletions": { - "type": "array", - "description": "Which ResourceRecordSets to remove? Must match existing data exactly.", - "items": { - "$ref": "ResourceRecordSet" - } - }, - "id": { - "type": "string", - "description": "Unique identifier for the resource; defined by the server (output only)." - }, - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#change\".", - "default": "dns#change" - }, - "startTime": { - "type": "string", - "description": "The time that this operation was started by the server. This is in RFC3339 text format." - }, - "status": { - "type": "string", - "description": "Status of the operation (output only)." - } - } - }, - "ChangesListResponse": { - "id": "ChangesListResponse", - "type": "object", - "description": "The response to a request to enumerate Changes to a ResourceRecordSets collection.", - "properties": { - "changes": { - "type": "array", - "description": "The requested changes.", - "items": { - "$ref": "Change" - } - }, - "kind": { - "type": "string", - "description": "Type of resource.", - "default": "dns#changesListResponse" - }, - "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": { - "id": "ManagedZone", - "type": "object", - "description": "A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.", - "properties": { - "creationTime": { - "type": "string", - "description": "The time that this resource was created on the server. 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 managed zone's function." - }, - "dnsName": { - "type": "string", - "description": "The DNS name of this managed zone, for instance \"example.com.\"." - }, - "id": { - "type": "string", - "description": "Unique identifier for the resource; defined by the server (output only)", - "format": "uint64" - }, - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#managedZone\".", - "default": "dns#managedZone" - }, - "name": { - "type": "string", - "description": "User assigned name for this resource. Must be unique within the project. The name must be 1-32 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes." - }, - "nameServerSet": { - "type": "string", - "description": "Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset." - }, - "nameServers": { - "type": "array", - "description": "Delegate your managed_zone to these virtual name servers; defined by the server (output only)", - "items": { - "type": "string" - } - } - } - }, - "ManagedZonesListResponse": { - "id": "ManagedZonesListResponse", - "type": "object", - "properties": { - "kind": { - "type": "string", - "description": "Type of resource.", - "default": "dns#managedZonesListResponse" - }, - "managedZones": { - "type": "array", - "description": "The managed zone resources.", - "items": { - "$ref": "ManagedZone" - } - }, - "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." - } - } - }, - "Project": { - "id": "Project", - "type": "object", - "description": "A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.", - "properties": { - "id": { - "type": "string", - "description": "User assigned unique identifier for the resource (output only)." - }, - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#project\".", - "default": "dns#project" - }, - "number": { - "type": "string", - "description": "Unique numeric identifier for the resource; defined by the server (output only).", - "format": "uint64" - }, - "quota": { - "$ref": "Quota", - "description": "Quotas assigned to this project (output only)." - } - } - }, - "Quota": { - "id": "Quota", - "type": "object", - "description": "Limits associated with a Project.", - "properties": { - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#quota\".", - "default": "dns#quota" - }, - "managedZones": { - "type": "integer", - "description": "Maximum allowed number of managed zones in the project.", - "format": "int32" - }, - "resourceRecordsPerRrset": { - "type": "integer", - "description": "Maximum allowed number of ResourceRecords per ResourceRecordSet.", - "format": "int32" - }, - "rrsetAdditionsPerChange": { - "type": "integer", - "description": "Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest.", - "format": "int32" - }, - "rrsetDeletionsPerChange": { - "type": "integer", - "description": "Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.", - "format": "int32" - }, - "rrsetsPerManagedZone": { - "type": "integer", - "description": "Maximum allowed number of ResourceRecordSets per zone in the project.", - "format": "int32" - }, - "totalRrdataSizePerChange": { - "type": "integer", - "description": "Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.", - "format": "int32" - } - } - }, - "ResourceRecordSet": { - "id": "ResourceRecordSet", - "type": "object", - "description": "A unit of data that will be returned by the DNS servers.", - "properties": { - "kind": { - "type": "string", - "description": "Identifies what kind of resource this is. Value: the fixed string \"dns#resourceRecordSet\".", - "default": "dns#resourceRecordSet" - }, - "name": { - "type": "string", - "description": "For example, www.example.com." - }, - "rrdatas": { - "type": "array", - "description": "As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).", - "items": { - "type": "string" - } - }, - "ttl": { - "type": "integer", - "description": "Number of seconds that this ResourceRecordSet can be cached by resolvers.", - "format": "int32" - }, - "type": { - "type": "string", - "description": "The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on." - } - } - }, - "ResourceRecordSetsListResponse": { - "id": "ResourceRecordSetsListResponse", - "type": "object", - "properties": { - "kind": { - "type": "string", - "description": "Type of resource.", - "default": "dns#resourceRecordSetsListResponse" - }, - "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 consistent snapshot of a collection larger than the maximum page size." - }, - "rrsets": { - "type": "array", - "description": "The resource record set resources.", - "items": { - "$ref": "ResourceRecordSet" - } - } - } - } - }, - "resources": { - "changes": { - "methods": { - "create": { - "id": "dns.changes.create", - "path": "{project}/managedZones/{managedZone}/changes", - "httpMethod": "POST", - "description": "Atomically update the ResourceRecordSet collection.", - "parameters": { - "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": "Change" - }, - "response": { - "$ref": "Change" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/ndev.clouddns.readwrite" - ] - }, - "get": { - "id": "dns.changes.get", - "path": "{project}/managedZones/{managedZone}/changes/{changeId}", - "httpMethod": "GET", - "description": "Fetch the representation of an existing Change.", - "parameters": { - "changeId": { - "type": "string", - "description": "The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse.", - "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", - "changeId" - ], - "response": { - "$ref": "Change" - }, - "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.changes.list", - "path": "{project}/managedZones/{managedZone}/changes", - "httpMethod": "GET", - "description": "Enumerate Changes to a ResourceRecordSet collection.", - "parameters": { - "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" - }, - "sortBy": { - "type": "string", - "description": "Sorting criterion. The only supported value is change sequence.", - "default": "changeSequence", - "enum": [ - "changeSequence" - ], - "enumDescriptions": [ - "" - ], - "location": "query" - }, - "sortOrder": { - "type": "string", - "description": "Sorting order direction: 'ascending' or 'descending'.", - "location": "query" - } - }, - "parameterOrder": [ - "project", - "managedZone" - ], - "response": { - "$ref": "ChangesListResponse" - }, - "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": { - "methods": { - "create": { - "id": "dns.managedZones.create", - "path": "{project}/managedZones", - "httpMethod": "POST", - "description": "Create a new ManagedZone.", - "parameters": { - "project": { - "type": "string", - "description": "Identifies the project addressed by this request.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project" - ], - "request": { - "$ref": "ManagedZone" - }, - "response": { - "$ref": "ManagedZone" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/ndev.clouddns.readwrite" - ] - }, - "delete": { - "id": "dns.managedZones.delete", - "path": "{project}/managedZones/{managedZone}", - "httpMethod": "DELETE", - "description": "Delete a previously created ManagedZone.", - "parameters": { - "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" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/ndev.clouddns.readwrite" - ] - }, - "get": { - "id": "dns.managedZones.get", - "path": "{project}/managedZones/{managedZone}", - "httpMethod": "GET", - "description": "Fetch the representation of an existing ManagedZone.", - "parameters": { - "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" - ], - "response": { - "$ref": "ManagedZone" - }, - "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.managedZones.list", - "path": "{project}/managedZones", - "httpMethod": "GET", - "description": "Enumerate ManagedZones that have been created but not yet deleted.", - "parameters": { - "dnsName": { - "type": "string", - "description": "Restricts the list to return only zones with this domain name.", - "location": "query" - }, - "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" - ], - "response": { - "$ref": "ManagedZonesListResponse" - }, - "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" - ] - } - } - }, - "projects": { - "methods": { - "get": { - "id": "dns.projects.get", - "path": "{project}", - "httpMethod": "GET", - "description": "Fetch the representation of an existing Project.", - "parameters": { - "project": { - "type": "string", - "description": "Identifies the project addressed by this request.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project" - ], - "response": { - "$ref": "Project" - }, - "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" - ] - } - } - }, - "resourceRecordSets": { - "methods": { - "list": { - "id": "dns.resourceRecordSets.list", - "path": "{project}/managedZones/{managedZone}/rrsets", - "httpMethod": "GET", - "description": "Enumerate ResourceRecordSets that have been created but not yet deleted.", - "parameters": { - "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" - }, - "name": { - "type": "string", - "description": "Restricts the list to return only records with this fully qualified domain name.", - "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" - }, - "type": { - "type": "string", - "description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present.", - "location": "query" - } - }, - "parameterOrder": [ - "project", - "managedZone" - ], - "response": { - "$ref": "ResourceRecordSetsListResponse" - }, - "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" - ] - } - } - } - } -} diff --git a/etc/api/doubleclickbidmanager/v1/doubleclickbidmanager-api.json b/etc/api/doubleclickbidmanager/v1/doubleclickbidmanager-api.json index 08d58e8d5f..035f8e94c8 100644 --- a/etc/api/doubleclickbidmanager/v1/doubleclickbidmanager-api.json +++ b/etc/api/doubleclickbidmanager/v1/doubleclickbidmanager-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/KspyYaNMMXkE18eGep174M1_JMc\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/KhQlHpyUs8rKakqcULR3lepd_Vc\"", "discoveryVersion": "v1", "id": "doubleclickbidmanager:v1", "name": "doubleclickbidmanager", "canonicalName": "DoubleClick Bid Manager", "version": "v1", - "revision": "20160120", + "revision": "20160225", "title": "DoubleClick Bid Manager API", "description": "API for viewing and managing your reports in DoubleClick Bid Manager.", "ownerDomain": "google.com", @@ -1208,6 +1208,7 @@ "TYPE_NIELSEN_DAILY_REACH_BUILD", "TYPE_NIELSEN_ONLINE_GLOBAL_MARKET", "TYPE_NIELSEN_SITE", + "TYPE_NOT_SUPPORTED", "TYPE_ORDER_ID", "TYPE_PAGE_CATEGORY", "TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE", @@ -1250,6 +1251,7 @@ "", "", "", + "", "" ] } diff --git a/etc/api/doubleclicksearch/v2/doubleclicksearch-api.json b/etc/api/doubleclicksearch/v2/doubleclicksearch-api.json index f599e4bef8..bc0ef57df7 100644 --- a/etc/api/doubleclicksearch/v2/doubleclicksearch-api.json +++ b/etc/api/doubleclicksearch/v2/doubleclicksearch-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/tz9B7o1oSSLio8p-JXbxaU2en84\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/GZARS-KMkd3MBeJCdPYZ0gyz7c8\"", "discoveryVersion": "v1", "id": "doubleclicksearch:v2", "name": "doubleclicksearch", "version": "v2", - "revision": "20160120", + "revision": "20160217", "title": "DoubleClick Search API", "description": "Report and modify your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions).", "ownerDomain": "google.com", diff --git a/etc/api/drive/v1/drive-api.json b/etc/api/drive/v1/drive-api.json index 696c257537..012b0c017e 100644 --- a/etc/api/drive/v1/drive-api.json +++ b/etc/api/drive/v1/drive-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1HZxEckvtTVY5hNh8smrda9U4KE\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/pIjmOx9uYYuW6v2cybFTI7k6ZlE\"", "discoveryVersion": "v1", "id": "drive:v1", "name": "drive", "version": "v1", - "revision": "20160126", + "revision": "20160222", "title": "Drive API", "description": "The API to interact with Drive.", "ownerDomain": "google.com", diff --git a/etc/api/drive/v2/drive-api.json b/etc/api/drive/v2/drive-api.json index 6a1a9aa775..31c8ee3ad5 100644 --- a/etc/api/drive/v2/drive-api.json +++ b/etc/api/drive/v2/drive-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/xj17OdsD26zYiecunhsD3S_RWA0\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/y9-bbu1ga5xB61EmZ3HwBhgL63I\"", "discoveryVersion": "v1", "id": "drive:v2", "name": "drive", "version": "v2", - "revision": "20160126", + "revision": "20160222", "title": "Drive API", "description": "The API to interact with Drive.", "ownerDomain": "google.com", @@ -898,6 +898,10 @@ "type": "boolean", "description": "Whether the current user can comment on the file." }, + "canReadRevisions": { + "type": "boolean", + "description": "Whether the current user has read access to the Revisions resource of the file." + }, "copyable": { "type": "boolean", "description": "Whether the file can be copied by the current user." @@ -2523,6 +2527,36 @@ "https://www.googleapis.com/auth/drive" ] }, + "export": { + "id": "drive.files.export", + "path": "files/{fileId}/export", + "httpMethod": "GET", + "description": "Exports a Google Doc to the requested MIME type and returns the exported content.", + "parameters": { + "fileId": { + "type": "string", + "description": "The ID of the file.", + "required": true, + "location": "path" + }, + "mimeType": { + "type": "string", + "description": "The MIME type of the format requested for this export.", + "required": true, + "location": "query" + } + }, + "parameterOrder": [ + "fileId", + "mimeType" + ], + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly" + ], + "supportsMediaDownload": true + }, "generateIds": { "id": "drive.files.generateIds", "path": "files/generateIds", diff --git a/etc/api/drive/v3/drive-api.json b/etc/api/drive/v3/drive-api.json index b36bf196b1..baab42994d 100644 --- a/etc/api/drive/v3/drive-api.json +++ b/etc/api/drive/v3/drive-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/4v0wLphe5UXLJdQFE80Eas9uwIw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/XHyDUGr4ipCpaFgErXSlgQ1HJ1I\"", "discoveryVersion": "v1", "id": "drive:v3", "name": "drive", "version": "v3", - "revision": "20160126", + "revision": "20160222", "title": "Drive API", "description": "The API to interact with Drive.", "ownerDomain": "google.com", @@ -420,6 +420,10 @@ "type": "boolean", "description": "Whether the user can edit the file's content." }, + "canReadRevisions": { + "type": "boolean", + "description": "Whether the current user has read access to the Revisions resource of the file." + }, "canShare": { "type": "boolean", "description": "Whether the user can modify the file's permissions and sharing settings." @@ -1595,7 +1599,7 @@ "id": "drive.files.export", "path": "files/{fileId}/export", "httpMethod": "GET", - "description": "Exports a Google Doc to the requested MIME type.", + "description": "Exports a Google Doc to the requested MIME type and returns the exported content.", "parameters": { "fileId": { "type": "string", diff --git a/etc/api/fitness/v1/fitness-api.json b/etc/api/fitness/v1/fitness-api.json index 3a603bebc2..81a6b9268a 100644 --- a/etc/api/fitness/v1/fitness-api.json +++ b/etc/api/fitness/v1/fitness-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/3TZb9pJUcpA5KrLperTiOBHtcMA\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/TL15SCjr77AOU2DmVX156flg8x0\"", "discoveryVersion": "v1", "id": "fitness:v1", "name": "fitness", diff --git a/etc/api/freebase/v1-sandbox/freebase-api.json b/etc/api/freebase/v1-sandbox/freebase-api.json deleted file mode 100644 index 60989b0052..0000000000 --- a/etc/api/freebase/v1-sandbox/freebase-api.json +++ /dev/null @@ -1,412 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/1uDhJzUzzQ0xFe9pZzLRKR2hVps\"", - "discoveryVersion": "v1", - "id": "freebase:v1-sandbox", - "name": "freebase", - "version": "v1-sandbox", - "revision": "20150715", - "title": "Freebase Search", - "description": "Find Freebase entities using textual queries and other constraints.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "https://www.google.com/images/icons/product/freebase-16.png", - "x32": "https://www.google.com/images/icons/product/freebase-32.png" - }, - "documentationLink": "https://developers.google.com/freebase/", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/freebase/v1-sandbox/", - "basePath": "/freebase/v1-sandbox/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "freebase/v1-sandbox/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "schemas": { - "ReconcileCandidate": { - "id": "ReconcileCandidate", - "type": "object", - "properties": { - "confidence": { - "type": "number", - "description": "Percentage likelihood that this candidate is the unique matching entity. Value will be between 0.0 and 1.0", - "format": "float" - }, - "lang": { - "type": "string", - "description": "Language code that candidate and notable names are displayed in." - }, - "mid": { - "type": "string", - "description": "Freebase MID of candidate entity." - }, - "name": { - "type": "string", - "description": "Freebase name of matching entity in specified language." - }, - "notable": { - "type": "object", - "description": "Type or profession the candidate is notable for.", - "properties": { - "id": { - "type": "string", - "description": "MID of notable category." - }, - "name": { - "type": "string", - "description": "Name of notable category in specified language." - } - } - } - } - }, - "ReconcileGet": { - "id": "ReconcileGet", - "type": "object", - "properties": { - "candidate": { - "type": "array", - "description": "If filled, then the listed candidates are potential matches, and such should be evaluated by a more discerning algorithm or human. The matches are ordered by confidence.", - "items": { - "$ref": "ReconcileCandidate" - } - }, - "costs": { - "type": "object", - "description": "Server costs for reconciling.", - "properties": { - "hits": { - "type": "integer", - "description": "Total number of hits found.", - "format": "int32" - }, - "ms": { - "type": "integer", - "description": "Total milliseconds spent.", - "format": "int32" - } - } - }, - "match": { - "$ref": "ReconcileCandidate", - "description": "If filled, this entity is guaranteed to match at requested confidence probability (default 99%)." - }, - "warning": { - "type": "array", - "description": "If filled, then there were recoverable problems that affected the request. For example, some of the properties were ignored because they either are not valid Freebase predicates or are not indexed for reconciliation. The candidates returned should be considered valid results, with the caveat that sections of the request were ignored as specified by the warning text.", - "items": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "Location of warning in the request e.g. invalid predicate." - }, - "message": { - "type": "string", - "description": "Warning message to display to the user." - }, - "reason": { - "type": "string", - "description": "Code for identifying classes of warnings." - } - } - } - } - } - } - }, - "methods": { - "reconcile": { - "id": "freebase.reconcile", - "path": "reconcile", - "httpMethod": "GET", - "description": "Reconcile entities to Freebase open data.", - "parameters": { - "confidence": { - "type": "number", - "description": "Required confidence for a candidate to match. Must be between .5 and 1.0", - "default": "0.99", - "format": "float", - "minimum": "0.0", - "maximum": "1.0", - "location": "query" - }, - "kind": { - "type": "string", - "description": "Classifications of entity e.g. type, category, title.", - "repeated": true, - "location": "query" - }, - "lang": { - "type": "string", - "description": "Languages for names and values. First language is used for display. Default is 'en'.", - "repeated": true, - "location": "query" - }, - "limit": { - "type": "integer", - "description": "Maximum number of candidates to return.", - "default": "3", - "format": "int32", - "minimum": "0", - "maximum": "25", - "location": "query" - }, - "name": { - "type": "string", - "description": "Name of entity.", - "location": "query" - }, - "prop": { - "type": "string", - "description": "Property values for entity formatted as\n:", - "repeated": true, - "location": "query" - } - }, - "response": { - "$ref": "ReconcileGet" - } - }, - "search": { - "id": "freebase.search", - "path": "search", - "httpMethod": "GET", - "description": "Search Freebase open data.", - "parameters": { - "as_of_time": { - "type": "string", - "description": "A mql as_of_time value to use with mql_output queries.", - "location": "query" - }, - "callback": { - "type": "string", - "description": "JS method name for JSONP callbacks.", - "pattern": "([A-Za-z0-9_$.]|\\[|\\])+", - "location": "query" - }, - "cursor": { - "type": "integer", - "description": "The cursor value to use for the next page of results.", - "format": "int32", - "location": "query" - }, - "domain": { - "type": "string", - "description": "Restrict to topics with this Freebase domain id.", - "repeated": true, - "location": "query" - }, - "encode": { - "type": "string", - "description": "The encoding of the response. You can use this parameter to enable html encoding.", - "default": "off", - "enum": [ - "html", - "off" - ], - "enumDescriptions": [ - "Encode certain characters in the response (such as tags and ambersands) using html encoding.", - "No encoding of the response. You should not print the results directly on an web page without html-escaping the content first." - ], - "location": "query" - }, - "exact": { - "type": "boolean", - "description": "Query on exact name and keys only.", - "location": "query" - }, - "filter": { - "type": "string", - "description": "A filter to apply to the query.", - "pattern": "^\\(.*\\)$", - "repeated": true, - "location": "query" - }, - "format": { - "type": "string", - "description": "Structural format of the json response.", - "default": "entity", - "enum": [ - "ac", - "classic", - "entity", - "guids", - "ids", - "mids" - ], - "enumDescriptions": [ - "Compact format useful for autocomplete/suggest UIs.", - "[DEPRECATED] Same format as was returned by api.freebase.com.", - "Basic information about the entities.", - "[DEPRECATED] Ordered list of a freebase guids.", - "Ordered list of freebase ids.", - "Ordered list of freebase mids." - ], - "location": "query" - }, - "help": { - "type": "string", - "description": "The keyword to request help on.", - "enum": [ - "langs", - "mappings", - "predicates" - ], - "enumDescriptions": [ - "The language codes served by the service.", - "The property/path mappings supported by the filter and output request parameters.", - "The predicates and path-terminating properties supported by the filter and output request parameters." - ], - "location": "query" - }, - "indent": { - "type": "boolean", - "description": "Whether to indent the json results or not.", - "location": "query" - }, - "lang": { - "type": "string", - "description": "The code of the language to run the query with. Default is 'en'.", - "repeated": true, - "location": "query" - }, - "limit": { - "type": "integer", - "description": "Maximum number of results to return.", - "default": "20", - "format": "int32", - "location": "query" - }, - "mid": { - "type": "string", - "description": "A mid to use instead of a query.", - "pattern": "^/[mgtx]/[0-2][0-9bcdfghjklmnpqrstvwxyz_]{1,24}$", - "repeated": true, - "location": "query" - }, - "mql_output": { - "type": "string", - "description": "The MQL query to run againist the results to extract more data.", - "location": "query" - }, - "output": { - "type": "string", - "description": "An output expression to request data from matches.", - "pattern": "^\\(.*\\)$", - "location": "query" - }, - "prefixed": { - "type": "boolean", - "description": "Prefix match against names and aliases.", - "location": "query" - }, - "query": { - "type": "string", - "description": "Query term to search for.", - "location": "query" - }, - "scoring": { - "type": "string", - "description": "Relevance scoring algorithm to use.", - "default": "entity", - "enum": [ - "entity", - "freebase", - "schema" - ], - "enumDescriptions": [ - "Use freebase and popularity entity ranking.", - "Use freebase entity ranking.", - "Use schema ranking for properties and types." - ], - "location": "query" - }, - "spell": { - "type": "string", - "description": "Request 'did you mean' suggestions", - "default": "no_spelling", - "enum": [ - "always", - "no_results", - "no_spelling" - ], - "enumDescriptions": [ - "Request spelling suggestions for any query at least three characters long.", - "Request spelling suggestions if no results were found.", - "Don't request spelling suggestions." - ], - "location": "query" - }, - "stemmed": { - "type": "boolean", - "description": "Query on stemmed names and aliases. May not be used with prefixed.", - "location": "query" - }, - "type": { - "type": "string", - "description": "Restrict to topics with this Freebase type id.", - "repeated": true, - "location": "query" - }, - "with": { - "type": "string", - "description": "A rule to match against.", - "repeated": true, - "location": "query" - }, - "without": { - "type": "string", - "description": "A rule to not match against.", - "repeated": true, - "location": "query" - } - }, - "supportsMediaDownload": true - } - } -} diff --git a/etc/api/freebase/v1/freebase-api.json b/etc/api/freebase/v1/freebase-api.json index f895f59206..fc96ffdbbd 100644 --- a/etc/api/freebase/v1/freebase-api.json +++ b/etc/api/freebase/v1/freebase-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/CmDAaWvE3uGB62NVlvDFX7ybl88\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/MDyvJbZqDibEMeHBKb3tlDUfU-M\"", "discoveryVersion": "v1", "id": "freebase:v1", "name": "freebase", diff --git a/etc/api/freebase/v1sandbox/freebase-api.json b/etc/api/freebase/v1sandbox/freebase-api.json deleted file mode 100644 index 09255f2f24..0000000000 --- a/etc/api/freebase/v1sandbox/freebase-api.json +++ /dev/null @@ -1,412 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/eOsxHqbqBq4G1nA6of-PTFhvOp8\"", - "discoveryVersion": "v1", - "id": "freebase:v1sandbox", - "name": "freebase", - "version": "v1sandbox", - "revision": "20150715", - "title": "Freebase Search", - "description": "Find Freebase entities using textual queries and other constraints.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "https://www.google.com/images/icons/product/freebase-16.png", - "x32": "https://www.google.com/images/icons/product/freebase-32.png" - }, - "documentationLink": "https://developers.google.com/freebase/", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/freebase/v1sandbox/", - "basePath": "/freebase/v1sandbox/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "freebase/v1sandbox/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "schemas": { - "ReconcileCandidate": { - "id": "ReconcileCandidate", - "type": "object", - "properties": { - "confidence": { - "type": "number", - "description": "Percentage likelihood that this candidate is the unique matching entity. Value will be between 0.0 and 1.0", - "format": "float" - }, - "lang": { - "type": "string", - "description": "Language code that candidate and notable names are displayed in." - }, - "mid": { - "type": "string", - "description": "Freebase MID of candidate entity." - }, - "name": { - "type": "string", - "description": "Freebase name of matching entity in specified language." - }, - "notable": { - "type": "object", - "description": "Type or profession the candidate is notable for.", - "properties": { - "id": { - "type": "string", - "description": "MID of notable category." - }, - "name": { - "type": "string", - "description": "Name of notable category in specified language." - } - } - } - } - }, - "ReconcileGet": { - "id": "ReconcileGet", - "type": "object", - "properties": { - "candidate": { - "type": "array", - "description": "If filled, then the listed candidates are potential matches, and such should be evaluated by a more discerning algorithm or human. The matches are ordered by confidence.", - "items": { - "$ref": "ReconcileCandidate" - } - }, - "costs": { - "type": "object", - "description": "Server costs for reconciling.", - "properties": { - "hits": { - "type": "integer", - "description": "Total number of hits found.", - "format": "int32" - }, - "ms": { - "type": "integer", - "description": "Total milliseconds spent.", - "format": "int32" - } - } - }, - "match": { - "$ref": "ReconcileCandidate", - "description": "If filled, this entity is guaranteed to match at requested confidence probability (default 99%)." - }, - "warning": { - "type": "array", - "description": "If filled, then there were recoverable problems that affected the request. For example, some of the properties were ignored because they either are not valid Freebase predicates or are not indexed for reconciliation. The candidates returned should be considered valid results, with the caveat that sections of the request were ignored as specified by the warning text.", - "items": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "Location of warning in the request e.g. invalid predicate." - }, - "message": { - "type": "string", - "description": "Warning message to display to the user." - }, - "reason": { - "type": "string", - "description": "Code for identifying classes of warnings." - } - } - } - } - } - } - }, - "methods": { - "reconcile": { - "id": "freebase.reconcile", - "path": "reconcile", - "httpMethod": "GET", - "description": "Reconcile entities to Freebase open data.", - "parameters": { - "confidence": { - "type": "number", - "description": "Required confidence for a candidate to match. Must be between .5 and 1.0", - "default": "0.99", - "format": "float", - "minimum": "0.0", - "maximum": "1.0", - "location": "query" - }, - "kind": { - "type": "string", - "description": "Classifications of entity e.g. type, category, title.", - "repeated": true, - "location": "query" - }, - "lang": { - "type": "string", - "description": "Languages for names and values. First language is used for display. Default is 'en'.", - "repeated": true, - "location": "query" - }, - "limit": { - "type": "integer", - "description": "Maximum number of candidates to return.", - "default": "3", - "format": "int32", - "minimum": "0", - "maximum": "25", - "location": "query" - }, - "name": { - "type": "string", - "description": "Name of entity.", - "location": "query" - }, - "prop": { - "type": "string", - "description": "Property values for entity formatted as\n:", - "repeated": true, - "location": "query" - } - }, - "response": { - "$ref": "ReconcileGet" - } - }, - "search": { - "id": "freebase.search", - "path": "search", - "httpMethod": "GET", - "description": "Search Freebase open data.", - "parameters": { - "as_of_time": { - "type": "string", - "description": "A mql as_of_time value to use with mql_output queries.", - "location": "query" - }, - "callback": { - "type": "string", - "description": "JS method name for JSONP callbacks.", - "pattern": "([A-Za-z0-9_$.]|\\[|\\])+", - "location": "query" - }, - "cursor": { - "type": "integer", - "description": "The cursor value to use for the next page of results.", - "format": "int32", - "location": "query" - }, - "domain": { - "type": "string", - "description": "Restrict to topics with this Freebase domain id.", - "repeated": true, - "location": "query" - }, - "encode": { - "type": "string", - "description": "The encoding of the response. You can use this parameter to enable html encoding.", - "default": "off", - "enum": [ - "html", - "off" - ], - "enumDescriptions": [ - "Encode certain characters in the response (such as tags and ambersands) using html encoding.", - "No encoding of the response. You should not print the results directly on an web page without html-escaping the content first." - ], - "location": "query" - }, - "exact": { - "type": "boolean", - "description": "Query on exact name and keys only.", - "location": "query" - }, - "filter": { - "type": "string", - "description": "A filter to apply to the query.", - "pattern": "^\\(.*\\)$", - "repeated": true, - "location": "query" - }, - "format": { - "type": "string", - "description": "Structural format of the json response.", - "default": "entity", - "enum": [ - "ac", - "classic", - "entity", - "guids", - "ids", - "mids" - ], - "enumDescriptions": [ - "Compact format useful for autocomplete/suggest UIs.", - "[DEPRECATED] Same format as was returned by api.freebase.com.", - "Basic information about the entities.", - "[DEPRECATED] Ordered list of a freebase guids.", - "Ordered list of freebase ids.", - "Ordered list of freebase mids." - ], - "location": "query" - }, - "help": { - "type": "string", - "description": "The keyword to request help on.", - "enum": [ - "langs", - "mappings", - "predicates" - ], - "enumDescriptions": [ - "The language codes served by the service.", - "The property/path mappings supported by the filter and output request parameters.", - "The predicates and path-terminating properties supported by the filter and output request parameters." - ], - "location": "query" - }, - "indent": { - "type": "boolean", - "description": "Whether to indent the json results or not.", - "location": "query" - }, - "lang": { - "type": "string", - "description": "The code of the language to run the query with. Default is 'en'.", - "repeated": true, - "location": "query" - }, - "limit": { - "type": "integer", - "description": "Maximum number of results to return.", - "default": "20", - "format": "int32", - "location": "query" - }, - "mid": { - "type": "string", - "description": "A mid to use instead of a query.", - "pattern": "^/[mgtx]/[0-2][0-9bcdfghjklmnpqrstvwxyz_]{1,24}$", - "repeated": true, - "location": "query" - }, - "mql_output": { - "type": "string", - "description": "The MQL query to run againist the results to extract more data.", - "location": "query" - }, - "output": { - "type": "string", - "description": "An output expression to request data from matches.", - "pattern": "^\\(.*\\)$", - "location": "query" - }, - "prefixed": { - "type": "boolean", - "description": "Prefix match against names and aliases.", - "location": "query" - }, - "query": { - "type": "string", - "description": "Query term to search for.", - "location": "query" - }, - "scoring": { - "type": "string", - "description": "Relevance scoring algorithm to use.", - "default": "entity", - "enum": [ - "entity", - "freebase", - "schema" - ], - "enumDescriptions": [ - "Use freebase and popularity entity ranking.", - "Use freebase entity ranking.", - "Use schema ranking for properties and types." - ], - "location": "query" - }, - "spell": { - "type": "string", - "description": "Request 'did you mean' suggestions", - "default": "no_spelling", - "enum": [ - "always", - "no_results", - "no_spelling" - ], - "enumDescriptions": [ - "Request spelling suggestions for any query at least three characters long.", - "Request spelling suggestions if no results were found.", - "Don't request spelling suggestions." - ], - "location": "query" - }, - "stemmed": { - "type": "boolean", - "description": "Query on stemmed names and aliases. May not be used with prefixed.", - "location": "query" - }, - "type": { - "type": "string", - "description": "Restrict to topics with this Freebase type id.", - "repeated": true, - "location": "query" - }, - "with": { - "type": "string", - "description": "A rule to match against.", - "repeated": true, - "location": "query" - }, - "without": { - "type": "string", - "description": "A rule to not match against.", - "repeated": true, - "location": "query" - } - }, - "supportsMediaDownload": true - } - } -} diff --git a/etc/api/fusiontables/v1/fusiontables-api.json b/etc/api/fusiontables/v1/fusiontables-api.json index dcac3cd0e2..f99f234e0b 100644 --- a/etc/api/fusiontables/v1/fusiontables-api.json +++ b/etc/api/fusiontables/v1/fusiontables-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/jTQUPi85zXybewxP4Z6O-G8n4p8\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/DRDKnNm8-98MUMNMap5uImOcQHM\"", "discoveryVersion": "v1", "id": "fusiontables:v1", "name": "fusiontables", "version": "v1", - "revision": "20150618", + "revision": "20160212", "title": "Fusion Tables API", "description": "API for working with Fusion Tables data.", "ownerDomain": "google.com", diff --git a/etc/api/fusiontables/v2/fusiontables-api.json b/etc/api/fusiontables/v2/fusiontables-api.json index 8e83c80323..79594b69d7 100644 --- a/etc/api/fusiontables/v2/fusiontables-api.json +++ b/etc/api/fusiontables/v2/fusiontables-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1cY2H5CSq5iYOAXHFbJnjHbrVqw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/HLmnkQW8dS44Z1Tis905tAoePQ8\"", "discoveryVersion": "v1", "id": "fusiontables:v2", "name": "fusiontables", "version": "v2", - "revision": "20150618", + "revision": "20160212", "title": "Fusion Tables API", "description": "API for working with Fusion Tables data.", "ownerDomain": "google.com", diff --git a/etc/api/games/v1/games-api.json b/etc/api/games/v1/games-api.json index d95710c327..e4b09bf466 100644 --- a/etc/api/games/v1/games-api.json +++ b/etc/api/games/v1/games-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/dadzq60iAtGqkBsDw6XsI82tB8k\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Fl2JtinGhCfVFBoiE_KkQ61uWHk\"", "discoveryVersion": "v1", "id": "games:v1", "name": "games", "canonicalName": "Games", "version": "v1", - "revision": "20160126", + "revision": "20160224", "title": "Google Play Game Services API", "description": "The API for Google Play Game Services.", "ownerDomain": "google.com", @@ -77,7 +77,7 @@ "description": "Share your Google+ profile information and view and manage your game activity" }, "https://www.googleapis.com/auth/plus.login": { - "description": "Know your basic profile info and list of people in your circles." + "description": "Know the list of people in your circles, your age range, and language" } } } @@ -4141,11 +4141,13 @@ "required": true, "enum": [ "PUBLIC", - "SOCIAL" + "SOCIAL", + "SOCIAL_1P" ], "enumDescriptions": [ "List all scores in the public leaderboard.", - "List only social scores." + "List only social scores.", + "List only social scores, not respecting the fACL." ], "location": "path" }, @@ -4215,11 +4217,13 @@ "required": true, "enum": [ "PUBLIC", - "SOCIAL" + "SOCIAL", + "SOCIAL_1P" ], "enumDescriptions": [ "List all scores in the public leaderboard.", - "List only social scores." + "List only social scores.", + "List only social scores, not respecting the fACL." ], "location": "path" }, diff --git a/etc/api/gamesconfiguration/v1configuration/gamesconfiguration-api.json b/etc/api/gamesconfiguration/v1configuration/gamesconfiguration-api.json index 9c108151b5..d4957fd43d 100644 --- a/etc/api/gamesconfiguration/v1configuration/gamesconfiguration-api.json +++ b/etc/api/gamesconfiguration/v1configuration/gamesconfiguration-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/t5vqYLUmSmMfNcTChdj18ZnwiOc\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ydL88tNpjuxfU-H47Pet3qzcs1I\"", "discoveryVersion": "v1", "id": "gamesConfiguration:v1configuration", "name": "gamesConfiguration", "canonicalName": "Games Configuration", "version": "v1configuration", - "revision": "20160126", + "revision": "20160224", "title": "Google Play Game Services Publishing API", "description": "The Publishing API for Google Play Game Services.", "ownerDomain": "google.com", diff --git a/etc/api/gamesmanagement/v1management/gamesmanagement-api.json b/etc/api/gamesmanagement/v1management/gamesmanagement-api.json index 6d2c44a0a0..a1b6ef8906 100644 --- a/etc/api/gamesmanagement/v1management/gamesmanagement-api.json +++ b/etc/api/gamesmanagement/v1management/gamesmanagement-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ZAaGjSDatxyE_oBWtgco_gXf7hY\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/zyg1d1q0ZiPsgtBlXjvRMcBLPek\"", "discoveryVersion": "v1", "id": "gamesManagement:v1management", "name": "gamesManagement", "canonicalName": "Games Management", "version": "v1management", - "revision": "20160126", + "revision": "20160224", "title": "Google Play Game Services Management API", "description": "The Management API for Google Play Game Services.", "ownerDomain": "google.com", @@ -74,7 +74,7 @@ "description": "Share your Google+ profile information and view and manage your game activity" }, "https://www.googleapis.com/auth/plus.login": { - "description": "Know your basic profile info and list of people in your circles." + "description": "Know the list of people in your circles, your age range, and language" } } } diff --git a/etc/api/gan/v1beta1/gan-api.json b/etc/api/gan/v1beta1/gan-api.json index 3cf5f13ca5..79c7de0187 100644 --- a/etc/api/gan/v1beta1/gan-api.json +++ b/etc/api/gan/v1beta1/gan-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/-PZmHNR_r_9eczcWEHuf2w7Z6Ig\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/-jqyyMY4XdTTysNYdyPiCssNOgE\"", "discoveryVersion": "v1", "id": "gan:v1beta1", "name": "gan", diff --git a/etc/api/genomics/v1/genomics-api.json b/etc/api/genomics/v1/genomics-api.json index 347b2bfb3e..2b26a524b5 100644 --- a/etc/api/genomics/v1/genomics-api.json +++ b/etc/api/genomics/v1/genomics-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/dKN-qLgalAAFQaYkGpbmBfZPnMw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/hALYXo8ybL-2tjJliTY4Rr-Kr5Y\"", "discoveryVersion": "v1", "id": "genomics:v1", "name": "genomics", "version": "v1", - "revision": "20160124", + "revision": "20160224", "title": "Genomics API", "description": "An API to store, process, explore, and share genomic data. It supports reference-based alignments, genetic variants, and reference genomes. This API provides an implementation of the Global Alliance for Genomics and Health (GA4GH) v0.5.1 API as well as several extensions.", "ownerDomain": "google.com", @@ -186,7 +186,7 @@ "Policy": { "id": "Policy", "type": "object", - "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).", + "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).", "properties": { "version": { "type": "integer", @@ -899,6 +899,16 @@ "type": "string", "description": "The end position of the range on the reference, 0-based exclusive. If specified, `referenceName` must also be specified.", "format": "int64" + }, + "shard": { + "type": "integer", + "description": "Restricts results to a shard containing approximately `1/totalShards` of the normal response payload for this query. Results from a sharded request are disjoint from those returned by all queries which differ only in their shard parameter. A shard may yield 0 results; this is especially likely for large values of `totalShards`. Valid values are `[0, totalShards)`.", + "format": "int32" + }, + "totalShards": { + "type": "integer", + "description": "Specifying `totalShards` causes a disjoint subset of the normal response payload to be returned for each query with a unique `shard` parameter specified. A best effort is made to yield equally sized shards. Sharding can be used to distribute processing amongst workers, where each worker is assigned a unique `shard` number and all workers specify the same `totalShards` number. The union of reads returned for all sharded queries `[0, totalShards)` is equal to those returned by a single unsharded query. Queries for different values of `totalShards` with common divisors will share shard boundaries. For example, streaming `shard` 2 of 5 `totalShards` yields the same results as streaming `shard`s 4 and 5 of 10 `totalShards`. This property can be leveraged for adaptive retries.", + "format": "int32" } } }, @@ -1190,7 +1200,7 @@ "properties": { "referenceName": { "type": "string", - "description": "The name of the reference associated with this ReferenceBound." + "description": "The name of the reference associated with this reference bound." }, "upperBound": { "type": "string", @@ -1371,7 +1381,7 @@ }, "maxCalls": { "type": "integer", - "description": "The maximum number of calls to return in a single page. Note that this limit may be exceeded; at least one variant is always returned per page, even if it has more calls than this limit. If unspecified, defaults to 5000. The maximum value is 10000.", + "description": "The maximum number of calls to return in a single page. Note that this limit may be exceeded in the event that a matching variant contains more calls than the requested maximum. If unspecified, defaults to 5000. The maximum value is 10000.", "format": "int32" } } @@ -1520,6 +1530,23 @@ } } }, + "MergeVariantsRequest": { + "id": "MergeVariantsRequest", + "type": "object", + "properties": { + "variantSetId": { + "type": "string", + "description": "The destination variant set." + }, + "variants": { + "type": "array", + "description": "The variants to be merged with existing variants.", + "items": { + "$ref": "Variant" + } + } + } + }, "SearchCallSetsRequest": { "id": "SearchCallSetsRequest", "type": "object", @@ -2595,6 +2622,22 @@ "https://www.googleapis.com/auth/genomics.readonly" ] }, + "merge": { + "id": "genomics.variants.merge", + "path": "v1/variants:merge", + "httpMethod": "POST", + "description": "Merges the given variants with existing variants. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each variant will be merged with an existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created. When variants are merged, the call information from the new variant is added to the existing variant, and other fields (such as key/value pairs) are discarded.", + "request": { + "$ref": "MergeVariantsRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ] + }, "stream": { "id": "genomics.variants.stream", "path": "v1/variants:stream", @@ -2705,7 +2748,7 @@ "id": "genomics.variantsets.delete", "path": "v1/variantsets/{variantSetId}", "httpMethod": "DELETE", - "description": "Deletes the contents of a variant set. The variant set object is not deleted. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", + "description": "Deletes a variant set including all variants, call sets, and calls within. This is not reversible. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "parameters": { "variantSetId": { "type": "string", diff --git a/etc/api/genomics/v1alpha2/genomics-api.json b/etc/api/genomics/v1alpha2/genomics-api.json index 05c558b6cd..7c5934d649 100644 --- a/etc/api/genomics/v1alpha2/genomics-api.json +++ b/etc/api/genomics/v1alpha2/genomics-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ta1I7zV4LB0PTeBNdEf_KiUs1io\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Ew7uJtCvtBtC91IhtqB2TFZFFcU\"", "discoveryVersion": "v1", "id": "genomics:v1alpha2", "name": "genomics", "version": "v1alpha2", - "revision": "20160124", + "revision": "20160224", "title": "Genomics API", "description": "An API to store, process, explore, and share genomic data. It supports reference-based alignments, genetic variants, and reference genomes. This API provides an implementation of the Global Alliance for Genomics and Health (GA4GH) v0.5.1 API as well as several extensions.", "ownerDomain": "google.com", @@ -206,7 +206,7 @@ "Pipeline": { "id": "Pipeline", "type": "object", - "description": "The pipeline object.", + "description": "The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.", "properties": { "projectId": { "type": "string", @@ -214,57 +214,75 @@ }, "name": { "type": "string", - "description": "Required. User-specified pipeline name. Note this does not have to be unique." + "description": "Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines." }, "description": { "type": "string", - "description": "Optional user-specified description." + "description": "Optional. User-specified description." }, - "parameters": { + "inputParameters": { "type": "array", - "description": "Parameters that pipeline uses to run.", + "description": "Input parameters of the pipeline.", + "items": { + "$ref": "PipelineParameter" + } + }, + "outputParameters": { + "type": "array", + "description": "Output parameters of the pipeline.", "items": { "$ref": "PipelineParameter" } }, "docker": { - "$ref": "DockerExecutor" + "$ref": "DockerExecutor", + "description": "Specifies the docker run information." }, "resources": { "$ref": "PipelineResources", - "description": "Required. Specifies resource requirements for the pipeline run. Minimally CPU and RAM must be specified." + "description": "Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb" }, "pipelineId": { "type": "string", - "description": "Unique pipeline id that is generated by the service when CreatePipeline is called." + "description": "Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline." } } }, "PipelineParameter": { "id": "PipelineParameter", "type": "object", - "description": "Parameters facilitate setting and delivering data into the pipeline’s execution environment. They are specified as either inputs or outputs to the pipeline when it is run. A parameter can be defined either as a literal or a reference type. A literal parameter is one whose value, either the default provided at creation time or provided by the user at runtime, is passed as-is into the pipeline. A reference parameter is one whose value is interpreted as a data source or sink. Reference parameters are almost always required to be provided by the user at runtime. The following types of reference parameters are supported: GCS objects ========== value = “gs://bucket/[path]” If the parameter is a pipeline input, the value is interpreted as a data source and the object(s) described by the GCS path will be copied into the pipeline. Likewise, if the parameter is a pipeline output, it is interpreted as a data source, and the applicable contents will be copied to the GCS path indicated. GCE disks ================= value = “disk://disk_name/[path]” Indicates that a persistent disk should be mounted into the pipeline’s execution environment. The disk_name refers to Disk entry in the PipelineResources.Disks field of the RunPipelineRequest.", + "description": "Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: \"pd1\", mountPoint: \"/mnt/disk/\"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Note that we do not use `cp -r`, so for inputs, the Google Cloud Storage path (runtime value) must be a file or a glob, while the local path must be a file or a directory, respectively. For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Again note that there is no `-r`, so the Google Cloud Storage path (runtime value) must be a file or a directory, while the local path can be a file or a glob, respectively. One restriction, due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.", "properties": { "name": { "type": "string", - "description": "Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline. It is also used for passing the parameter into execution environments, e.g. the Docker executor uppercases the name and uses it as ab environment variable. Some execution environments may restrict the allowed characters." + "description": "Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline." }, "description": { "type": "string", - "description": "Optional human-readable description, for eventual use in friendly documentation and error messages." + "description": "Optional. Human-readable description." }, - "value": { + "defaultValue": { "type": "string", - "description": "Value of the parameter. If this is a LITERAL parameter, this field is treated as a default value to be passed to the pipeline in the absence of the runner providing a value for it. If this is a REFERENCE parameter, this field is required as it is considered the target of the reference provided by the pipeline runner." + "description": "The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`." }, - "type": { + "localCopy": { + "$ref": "LocalCopy", + "description": "If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be." + } + } + }, + "LocalCopy": { + "id": "LocalCopy", + "type": "object", + "description": "LocalCopy defines how a remote file should be copied to and from the VM.", + "properties": { + "path": { "type": "string", - "description": "The type of the parameter indicates how it should be interpreted.", - "enum": [ - "TYPE_UNSPECIFIED", - "LITERAL", - "REFERENCE" - ] + "description": "Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt," + }, + "disk": { + "type": "string", + "description": "Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or \"boot\", which represents the Docker instance's boot disk and has a mount point of `/`." } } }, @@ -275,11 +293,11 @@ "properties": { "imageName": { "type": "string", - "description": "Image name from either Docker Hub or Google Container Repository. Users that run pipelines must have READ access to the image." + "description": "Required. Image name from either Docker Hub or Google Container Repository. Users that run pipelines must have READ access to the image." }, "cmd": { "type": "string", - "description": "The command string to run." + "description": "Required. The command string to run. Parameters that do not have `localCopy` specified should be used as environment variables, while those that do can be accessed at the defined paths." } } }, @@ -289,17 +307,17 @@ "description": "The system resources for the pipeline run.", "properties": { "minimumCpuCores": { - "type": "string", - "description": "The minimum number of cores to use.", - "format": "int64" + "type": "integer", + "description": "Required at create time; optional at run time. The minimum number of cores to use.", + "format": "int32" }, "preemptible": { "type": "boolean", - "description": "If applicable, preemptible machines may be used for the run." + "description": "Optional. At create time means that preemptible machines may be used for the run. At run time, means they should be used. Cannot be true at run time if false at create time." }, "minimumRamGb": { "type": "number", - "description": "The minimum amount of RAM to use.", + "description": "Required at create time; optional at run time. The minimum amount of RAM to use.", "format": "double" }, "disks": { @@ -311,7 +329,7 @@ }, "zones": { "type": "array", - "description": "List of Google Compute Engine availability zones to which resource creation will restricted.", + "description": "List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.", "items": { "type": "string" } @@ -325,11 +343,11 @@ "properties": { "name": { "type": "string", - "description": "Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?" + "description": "Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name \"boot\" is reserved for system use." }, "type": { "type": "string", - "description": "The type of the disk to create, if applicable.", + "description": "Required. The type of the disk to create.", "enum": [ "TYPE_UNSPECIFIED", "PERSISTENT_HDD", @@ -338,9 +356,9 @@ ] }, "sizeGb": { - "type": "string", + "type": "integer", "description": "The size of the disk. This field is not applicable for local SSD.", - "format": "int64" + "format": "int32" }, "source": { "type": "string", @@ -348,18 +366,22 @@ }, "autoDelete": { "type": "boolean", - "description": "Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details." + "description": "Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. Optional. At create time means that an auto delete disk may be used. At run time, means it should be used. Cannot be true at run time if false at create time." }, "readOnly": { "type": "boolean", - "description": "Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details." + "description": "Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time." + }, + "mountPoint": { + "type": "string", + "description": "Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`." } } }, "RunPipelineRequest": { "id": "RunPipelineRequest", "type": "object", - "description": "The request to run a pipeline. If pipeline_id is specified, it refers to a saved pipeline created with CreatePipeline and set as the pipeline_id of the returned Pipeline object. If a pipeline object is specified, that pipeline is run once with the given args and then deleted. It is an error to specify both pipeline_id and pipeline. RunPipelineArgs must be specified.", + "description": "The request to run a pipeline. If `pipelineId` is specified, it refers to a saved pipeline created with CreatePipeline and set as the `pipelineId` of the returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline is run once with the given args and not saved. It is an error to specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified.", "properties": { "pipelineId": { "type": "string", @@ -386,14 +408,14 @@ }, "inputs": { "type": "object", - "description": "Pipeline input arguments; keys are defined in the pipeline documentation.", + "description": "Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.", "additionalProperties": { "type": "string" } }, "outputs": { "type": "object", - "description": "Pipeline output arguments; keys are defined in the pipeline documentation.", + "description": "Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.", "additionalProperties": { "type": "string" } @@ -404,7 +426,7 @@ }, "clientId": { "type": "string", - "description": "Optional for callers to use in filtering operations returned by this request." + "description": "Optional. For callers to use in filtering operations returned by this request." }, "resources": { "$ref": "PipelineResources", @@ -423,11 +445,11 @@ "properties": { "email": { "type": "string", - "description": "Required. Email address of the service account." + "description": "Required. Email address of the service account. 'default' is a valid option and uses the compute service account associated with the project." }, "scopes": { "type": "array", - "description": "Required. List of scopes to be made available for this service account.", + "description": "Required. List of scopes to be made available for this service account. Should include * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control", "items": { "type": "string" } @@ -441,38 +463,14 @@ "properties": { "gcsPath": { "type": "string", - "description": "The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in \".log\", in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as \"-stdout.log\" and \"-stderr.log\"." - } - } - }, - "ListPipelinesRequest": { - "id": "ListPipelinesRequest", - "type": "object", - "description": "A request to list pipelines in a given project. Pipelines can be filtered by name using name_prefix: all pipelines with names that begin with name_prefix will be returned. Uses standard pagination: page_size indicates how many pipelines to return, and page_token comes from a previous ListPipelinesResponse to indicate offset.", - "properties": { - "projectId": { - "type": "string", - "description": "Required. The name of the project to search for pipelines. Caller must have READ access to this project." - }, - "namePrefix": { - "type": "string", - "description": "Pipelines with names that match this prefix should be returned." - }, - "pageSize": { - "type": "integer", - "description": "Number of pipelines to return at once.", - "format": "int32" - }, - "pageToken": { - "type": "string", - "description": "Token to use to indicate where to start getting results." + "description": "The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in `.log`, in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as `-stdout.log` and `-stderr.log`." } } }, "ListPipelinesResponse": { "id": "ListPipelinesResponse", "type": "object", - "description": "The response of ListPipelines. Contains at most page_size pipelines. If it contains page_size pipelines, and more pipelines exist, then next_page_token will be populated.", + "description": "The response of ListPipelines. Contains at most `pageSize` pipelines. If it contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken` will be populated and should be used as the `pageToken` argument to a subsequent ListPipelines request.", "properties": { "pipelines": { "type": "array", @@ -487,6 +485,121 @@ } } }, + "ControllerConfig": { + "id": "ControllerConfig", + "type": "object", + "description": "Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users.", + "properties": { + "image": { + "type": "string" + }, + "cmd": { + "type": "string" + }, + "gcsLogPath": { + "type": "string" + }, + "machineType": { + "type": "string" + }, + "vars": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "disks": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "gcsSources": { + "type": "object", + "additionalProperties": { + "$ref": "RepeatedString" + } + }, + "gcsSinks": { + "type": "object", + "additionalProperties": { + "$ref": "RepeatedString" + } + } + } + }, + "RepeatedString": { + "id": "RepeatedString", + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UpdateStatusRequest": { + "id": "UpdateStatusRequest", + "type": "object", + "description": "Request to update operation status. Should only be used by VMs created by the Pipelines Service and not by end users.", + "properties": { + "operationId": { + "type": "string" + }, + "timestampEvents": { + "type": "array", + "items": { + "$ref": "TimestampEvent" + } + }, + "errorCode": { + "type": "string", + "enum": [ + "OK", + "CANCELLED", + "UNKNOWN", + "INVALID_ARGUMENT", + "DEADLINE_EXCEEDED", + "NOT_FOUND", + "ALREADY_EXISTS", + "PERMISSION_DENIED", + "UNAUTHENTICATED", + "RESOURCE_EXHAUSTED", + "FAILED_PRECONDITION", + "ABORTED", + "OUT_OF_RANGE", + "UNIMPLEMENTED", + "INTERNAL", + "UNAVAILABLE", + "DATA_LOSS" + ] + }, + "errorMessage": { + "type": "string" + }, + "validationToken": { + "type": "string", + "format": "uint64" + } + } + }, + "TimestampEvent": { + "id": "TimestampEvent", + "type": "object", + "description": "Stores the list of events and times they occured for major events in job execution.", + "properties": { + "description": { + "type": "string", + "description": "String indicating the type of event" + }, + "timestamp": { + "type": "string", + "description": "The time this event occured." + } + } + }, "ImportReadGroupSetsResponse": { "id": "ImportReadGroupSetsResponse", "type": "object", @@ -662,7 +775,7 @@ "id": "genomics.pipelines.create", "path": "v1alpha2/pipelines", "httpMethod": "POST", - "description": "Creates a pipeline that can be later run. Caller must have WRITE permission to the project.", + "description": "Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project.", "request": { "$ref": "Pipeline" }, @@ -678,7 +791,7 @@ "id": "genomics.pipelines.run", "path": "v1alpha2/pipelines:run", "httpMethod": "POST", - "description": "Runs a pipeline. If pipeline_id is specified in the request, then run a saved pipeline. If a pipeline object is specified, then run that pipeline once and then delete it. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used.", + "description": "Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used.", "request": { "$ref": "RunPipelineRequest" }, @@ -716,11 +829,31 @@ }, "list": { "id": "genomics.pipelines.list", - "path": "v1alpha2/pipelines:list", - "httpMethod": "POST", + "path": "v1alpha2/pipelines", + "httpMethod": "GET", "description": "Lists pipelines. Caller must have READ permission to the project.", - "request": { - "$ref": "ListPipelinesRequest" + "parameters": { + "projectId": { + "type": "string", + "description": "Required. The name of the project to search for pipelines. Caller must have READ access to this project.", + "location": "query" + }, + "namePrefix": { + "type": "string", + "description": "Optional. Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned.", + "location": "query" + }, + "pageSize": { + "type": "integer", + "description": "Optional. Number of pipelines to return at once. Defaults to 256, and max is 2048.", + "format": "int32", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Optional. Token to use to indicate where to start getting results. If unspecified, returns the first page of results.", + "location": "query" + } }, "response": { "$ref": "ListPipelinesResponse" @@ -734,7 +867,7 @@ "id": "genomics.pipelines.delete", "path": "v1alpha2/pipelines/{pipelineId}", "httpMethod": "DELETE", - "description": "Deletes pipeline based on ID. Caller must have WRITE permission to the project.", + "description": "Deletes a pipeline based on ID. Caller must have WRITE permission to the project.", "parameters": { "pipelineId": { "type": "string", @@ -753,6 +886,57 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/genomics" ] + }, + "update_status": { + "id": "genomics.pipelines.update_status", + "path": "v1alpha2/pipelines:update_status", + "httpMethod": "PUT", + "description": "Updates status of a given operation. Should only be called by VMs created by the Pipelines Service and not by end users.", + "request": { + "$ref": "UpdateStatusRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ] + } + }, + "resources": { + "controller_config": { + "methods": { + "get": { + "id": "genomics.pipelines.controller_config.get", + "path": "v1alpha2/pipelines/controller_config/{operationId}", + "httpMethod": "GET", + "description": "Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users.", + "parameters": { + "operationId": { + "type": "string", + "description": "The operation to retrieve controller configuration for.", + "required": true, + "location": "path" + }, + "validationToken": { + "type": "string", + "format": "uint64", + "location": "query" + } + }, + "parameterOrder": [ + "operationId" + ], + "response": { + "$ref": "ControllerConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ] + } + } } } } diff --git a/etc/api/genomics/v1beta/genomics-api.json b/etc/api/genomics/v1beta/genomics-api.json deleted file mode 100644 index 16d75e6e7d..0000000000 --- a/etc/api/genomics/v1beta/genomics-api.json +++ /dev/null @@ -1,2315 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/P0iF9O81Ih4OkuOxr8vmJcp5un4\"", - "discoveryVersion": "v1", - "id": "genomics:v1beta", - "name": "genomics", - "version": "v1beta", - "revision": "20150208", - "title": "Genomics API", - "description": "Provides access to Genomics data.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "https://developers.google.com/genomics/v1beta/reference", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/genomics/v1beta/", - "basePath": "/genomics/v1beta/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "genomics/v1beta/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/bigquery": { - "description": "View and manage your data in Google BigQuery" - }, - "https://www.googleapis.com/auth/devstorage.read_write": { - "description": "Manage your data in Google Cloud Storage" - }, - "https://www.googleapis.com/auth/genomics": { - "description": "View and manage Genomics data" - }, - "https://www.googleapis.com/auth/genomics.readonly": { - "description": "View Genomics data" - } - } - } - }, - "schemas": { - "Call": { - "id": "Call", - "type": "object", - "description": "A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.", - "properties": { - "callSetId": { - "type": "string", - "description": "The ID of the call set this variant call belongs to." - }, - "callSetName": { - "type": "string", - "description": "The name of the call set this variant call belongs to." - }, - "genotype": { - "type": "array", - "description": "The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of [\"A\", \"C\"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.", - "items": { - "type": "integer", - "format": "int32" - } - }, - "genotypeLikelihood": { - "type": "array", - "description": "The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in info.", - "items": { - "type": "number", - "format": "double" - } - }, - "info": { - "type": "object", - "description": "A map of additional variant call information.", - "additionalProperties": { - "type": "array", - "description": "A string which maps to an array of values.", - "items": { - "type": "string" - } - } - }, - "phaseset": { - "type": "string", - "description": "If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *." - } - } - }, - "CallSet": { - "id": "CallSet", - "type": "object", - "description": "A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.", - "properties": { - "created": { - "type": "string", - "description": "The date this call set was created in milliseconds from the epoch.", - "format": "int64" - }, - "id": { - "type": "string", - "description": "The Google generated ID of the call set, immutable." - }, - "info": { - "type": "object", - "description": "A map of additional call set information.", - "additionalProperties": { - "type": "array", - "description": "A string which maps to an array of values.", - "items": { - "type": "string" - } - } - }, - "name": { - "type": "string", - "description": "The call set name." - }, - "sampleId": { - "type": "string", - "description": "The sample ID this call set corresponds to." - }, - "variantSetIds": { - "type": "array", - "description": "The IDs of the variant sets this call set belongs to.", - "items": { - "type": "string" - } - } - } - }, - "CoverageBucket": { - "id": "CoverageBucket", - "type": "object", - "description": "A bucket over which read coverage has been precomputed. A bucket corresponds to a specific range of the reference sequence.", - "properties": { - "meanCoverage": { - "type": "number", - "description": "The average number of reads which are aligned to each individual reference base in this bucket.", - "format": "float" - }, - "range": { - "$ref": "GenomicRange", - "description": "The genomic coordinate range spanned by this bucket." - } - } - }, - "Dataset": { - "id": "Dataset", - "type": "object", - "description": "A Dataset is a collection of genomic data.", - "properties": { - "id": { - "type": "string", - "description": "The Google generated ID of the dataset, immutable." - }, - "isPublic": { - "type": "boolean", - "description": "Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project." - }, - "name": { - "type": "string", - "description": "The dataset name." - }, - "projectId": { - "type": "string", - "description": "The Google Developers Console project number that this dataset belongs to.", - "format": "int64" - } - } - }, - "ExperimentalCreateJobRequest": { - "id": "ExperimentalCreateJobRequest", - "type": "object", - "description": "The job creation request.", - "properties": { - "align": { - "type": "boolean", - "description": "Specifies whether or not to run the alignment pipeline. Either align or callVariants must be set." - }, - "callVariants": { - "type": "boolean", - "description": "Specifies whether or not to run the variant calling pipeline. Either align or callVariants must be set." - }, - "gcsOutputPath": { - "type": "string", - "description": "Specifies where to copy the results of certain pipelines. This should be in the form of gs://bucket/path." - }, - "pairedSourceUris": { - "type": "array", - "description": "A list of Google Cloud Storage URIs of paired end .fastq files to operate upon. If specified, this represents the second file of each paired .fastq file. The first file of each pair should be specified in sourceUris.", - "items": { - "type": "string" - } - }, - "projectId": { - "type": "string", - "description": "Required. The Google Cloud Project ID with which to associate the request.", - "format": "int64" - }, - "sourceUris": { - "type": "array", - "description": "A list of Google Cloud Storage URIs of data files to operate upon. These can be .bam, interleaved .fastq, or paired .fastq. If specifying paired .fastq files, the first of each pair of files should be listed here, and the second of each pair should be listed in pairedSourceUris.", - "items": { - "type": "string" - } - } - } - }, - "ExperimentalCreateJobResponse": { - "id": "ExperimentalCreateJobResponse", - "type": "object", - "description": "The job creation response.", - "properties": { - "jobId": { - "type": "string", - "description": "A job ID that can be used to get status information." - } - } - }, - "ExportReadsetsRequest": { - "id": "ExportReadsetsRequest", - "type": "object", - "description": "The readset export request.", - "properties": { - "exportUri": { - "type": "string", - "description": "A Google Cloud Storage URI where the exported BAM file will be created. The currently authenticated user must have write access to the new file location. An error will be returned if the URI already contains data." - }, - "projectId": { - "type": "string", - "description": "The Google Developers Console project number that owns this export.", - "format": "int64" - }, - "readsetIds": { - "type": "array", - "description": "The IDs of the readsets to export.", - "items": { - "type": "string" - } - }, - "referenceNames": { - "type": "array", - "description": "The reference names to export. If this is not specified, all reference sequences, including unmapped reads, are exported. Use * to export only unmapped reads.", - "items": { - "type": "string" - } - } - } - }, - "ExportReadsetsResponse": { - "id": "ExportReadsetsResponse", - "type": "object", - "description": "The readset export response.", - "properties": { - "jobId": { - "type": "string", - "description": "A job ID that can be used to get status information." - } - } - }, - "ExportVariantsRequest": { - "id": "ExportVariantsRequest", - "type": "object", - "description": "The variant data export request.", - "properties": { - "bigqueryDataset": { - "type": "string", - "description": "The BigQuery dataset to export data to. Note that this is distinct from the Genomics concept of \"dataset\"." - }, - "bigqueryTable": { - "type": "string", - "description": "The BigQuery table to export data to. If the table doesn't exist, it will be created. If it already exists, it will be overwritten." - }, - "callSetIds": { - "type": "array", - "description": "If provided, only variant call information from the specified call sets will be exported. By default all variant calls are exported.", - "items": { - "type": "string" - } - }, - "format": { - "type": "string", - "description": "The format for the exported data.", - "enum": [ - "bigquery" - ], - "enumDescriptions": [ - "" - ] - }, - "projectId": { - "type": "string", - "description": "The Google Cloud project number that owns the destination BigQuery dataset. The caller must have WRITE access to this project. This project will also own the resulting export job.", - "format": "int64" - }, - "variantSetId": { - "type": "string", - "description": "Required. The ID of the variant set that contains variant data which should be exported. The caller must have READ access to this variant set." - } - } - }, - "ExportVariantsResponse": { - "id": "ExportVariantsResponse", - "type": "object", - "description": "The variant data export response.", - "properties": { - "jobId": { - "type": "string", - "description": "A job ID that can be used to get status information." - } - } - }, - "GenomicRange": { - "id": "GenomicRange", - "type": "object", - "description": "An inclusive, exclusive genomic coordinate range over a reference sequence.", - "properties": { - "sequenceEnd": { - "type": "string", - "description": "The end position of the range on the reference, 1-based exclusive. If specified, sequenceName must also be specified.", - "format": "uint64" - }, - "sequenceName": { - "type": "string", - "description": "The reference sequence name, for example chr1, 1, or chrX." - }, - "sequenceStart": { - "type": "string", - "description": "The start position of the range on the reference, 1-based inclusive. If specified, sequenceName must also be specified.", - "format": "uint64" - } - } - }, - "Header": { - "id": "Header", - "type": "object", - "properties": { - "sortingOrder": { - "type": "string", - "description": "(SO) Sorting order of alignments." - }, - "version": { - "type": "string", - "description": "(VN) BAM format version." - } - } - }, - "HeaderSection": { - "id": "HeaderSection", - "type": "object", - "description": "The header section of the BAM/SAM file.", - "properties": { - "comments": { - "type": "array", - "description": "(@CO) One-line text comments.", - "items": { - "type": "string" - } - }, - "fileUri": { - "type": "string", - "description": "[Deprecated] This field is deprecated and will no longer be populated. Please use filename instead." - }, - "filename": { - "type": "string", - "description": "The name of the file from which this data was imported." - }, - "headers": { - "type": "array", - "description": "(@HD) The header line.", - "items": { - "$ref": "Header" - } - }, - "programs": { - "type": "array", - "description": "(@PG) Programs.", - "items": { - "$ref": "Program" - } - }, - "readGroups": { - "type": "array", - "description": "(@RG) Read group.", - "items": { - "$ref": "ReadGroup" - } - }, - "refSequences": { - "type": "array", - "description": "(@SQ) Reference sequence dictionary.", - "items": { - "$ref": "ReferenceSequence" - } - } - } - }, - "ImportReadsetsRequest": { - "id": "ImportReadsetsRequest", - "type": "object", - "description": "The readset import request.", - "properties": { - "datasetId": { - "type": "string", - "description": "Required. The ID of the dataset these readsets will belong to. The caller must have WRITE permissions to this dataset." - }, - "sourceUris": { - "type": "array", - "description": "A list of URIs pointing at BAM files in Google Cloud Storage.", - "items": { - "type": "string" - } - } - } - }, - "ImportReadsetsResponse": { - "id": "ImportReadsetsResponse", - "type": "object", - "description": "The readset import response.", - "properties": { - "jobId": { - "type": "string", - "description": "A job ID that can be used to get status information." - } - } - }, - "ImportVariantsRequest": { - "id": "ImportVariantsRequest", - "type": "object", - "description": "The variant data import request.", - "properties": { - "format": { - "type": "string", - "description": "The format of the variant data being imported.", - "enum": [ - "completeGenomics", - "vcf" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "sourceUris": { - "type": "array", - "description": "A list of URIs pointing at VCF files in Google Cloud Storage. See the VCF Specification for more details on the input format.", - "items": { - "type": "string" - } - }, - "variantSetId": { - "type": "string", - "description": "Required. The variant set to which variant data should be imported." - } - } - }, - "ImportVariantsResponse": { - "id": "ImportVariantsResponse", - "type": "object", - "description": "The variant data import response.", - "properties": { - "jobId": { - "type": "string", - "description": "A job ID that can be used to get status information." - } - } - }, - "Job": { - "id": "Job", - "type": "object", - "description": "A Job represents an ongoing process that can be monitored for status information.", - "properties": { - "created": { - "type": "string", - "description": "The date this job was created, in milliseconds from the epoch.", - "format": "int64" - }, - "description": { - "type": "string", - "description": "A more detailed description of this job's current status." - }, - "errors": { - "type": "array", - "description": "Any errors that occurred during processing.", - "items": { - "type": "string" - } - }, - "id": { - "type": "string", - "description": "The job ID." - }, - "importedIds": { - "type": "array", - "description": "If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.", - "items": { - "type": "string" - } - }, - "projectId": { - "type": "string", - "description": "The Google Developers Console project number to which this job belongs.", - "format": "int64" - }, - "request": { - "$ref": "JobRequest", - "description": "A summarized representation of the original service request." - }, - "status": { - "type": "string", - "description": "The status of this job.", - "enum": [ - "canceled", - "failure", - "new", - "pending", - "running", - "success", - "unknownStatus" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "" - ] - }, - "warnings": { - "type": "array", - "description": "Any warnings that occurred during processing.", - "items": { - "type": "string" - } - } - } - }, - "JobRequest": { - "id": "JobRequest", - "type": "object", - "description": "A summary representation of the service request that spawned the job.", - "properties": { - "destination": { - "type": "array", - "description": "The data destination of the request, for example, a Google BigQuery Table or Dataset ID.", - "items": { - "type": "string" - } - }, - "source": { - "type": "array", - "description": "The data source of the request, for example, a Google Cloud Storage object path or Readset ID.", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "description": "The original request type.", - "enum": [ - "alignReadsets", - "callReadsets", - "experimentalCreateJob", - "exportReadsets", - "exportVariants", - "importReadsets", - "importVariants", - "unknownType" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "" - ] - } - } - }, - "ListCoverageBucketsResponse": { - "id": "ListCoverageBucketsResponse", - "type": "object", - "properties": { - "bucketWidth": { - "type": "string", - "description": "The length of each coverage bucket in base pairs. Note that buckets at the end of a reference sequence may be shorter. This value is omitted if the bucket width is infinity (the default behaviour, with no range or targetBucketWidth).", - "format": "uint64" - }, - "coverageBuckets": { - "type": "array", - "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0 overlapping reads is not returned. A bucket never crosses more than one reference sequence. Each bucket has width bucketWidth, unless its end is the end of the reference sequence.", - "items": { - "$ref": "CoverageBucket" - } - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results." - } - } - }, - "ListDatasetsResponse": { - "id": "ListDatasetsResponse", - "type": "object", - "description": "The dataset list response.", - "properties": { - "datasets": { - "type": "array", - "description": "The list of matching Datasets.", - "items": { - "$ref": "Dataset" - } - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results." - } - } - }, - "MergeVariantsRequest": { - "id": "MergeVariantsRequest", - "type": "object", - "properties": { - "variants": { - "type": "array", - "description": "The variants to be merged with existing variants.", - "items": { - "$ref": "Variant" - } - } - } - }, - "Metadata": { - "id": "Metadata", - "type": "object", - "description": "Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.", - "properties": { - "description": { - "type": "string", - "description": "A textual description of this metadata." - }, - "id": { - "type": "string", - "description": "User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent." - }, - "info": { - "type": "object", - "description": "Remaining structured metadata key-value pairs.", - "additionalProperties": { - "type": "array", - "description": "A string which maps to an array of values.", - "items": { - "type": "string" - } - } - }, - "key": { - "type": "string", - "description": "The top-level key." - }, - "number": { - "type": "string", - "description": "The number of values that can be included in a field described by this metadata." - }, - "type": { - "type": "string", - "description": "The type of data. Possible types include: Integer, Float, Flag, Character, and String.", - "enum": [ - "character", - "flag", - "float", - "integer", - "string", - "unknownType" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" - ] - }, - "value": { - "type": "string", - "description": "The value field for simple metadata" - } - } - }, - "Program": { - "id": "Program", - "type": "object", - "properties": { - "commandLine": { - "type": "string", - "description": "(CL) Command line." - }, - "id": { - "type": "string", - "description": "(ID) Program record identifier." - }, - "name": { - "type": "string", - "description": "(PN) Program name." - }, - "prevProgramId": { - "type": "string", - "description": "(PP) Previous program ID." - }, - "version": { - "type": "string", - "description": "(VN) Program version." - } - } - }, - "Read": { - "id": "Read", - "type": "object", - "description": "A Read is a group of bases that may or may not have been aligned to a reference. It contains quality information and other metadata.", - "properties": { - "alignedBases": { - "type": "string", - "description": "The originalBases after the cigar field has been applied. Deletions are represented with '-' and insertions are omitted." - }, - "baseQuality": { - "type": "string", - "description": "Represents the quality of each base in this read. Each character represents one base. To get the quality, take the ASCII value of the character and subtract 33. (QUAL)" - }, - "cigar": { - "type": "string", - "description": "A condensed representation of how this read matches up to the reference. (CIGAR)" - }, - "flags": { - "type": "integer", - "description": "Each bit of this number has a different meaning if enabled. See the full BAM spec for more details. (FLAG)", - "format": "int32" - }, - "id": { - "type": "string", - "description": "The Google generated ID of the read, immutable." - }, - "mappingQuality": { - "type": "integer", - "description": "A score up to 255 that represents how likely this read's aligned position is to be correct. A higher value is better. (MAPQ)", - "format": "int32" - }, - "matePosition": { - "type": "integer", - "description": "The 1-based start position of the paired read. (PNEXT)", - "format": "int32" - }, - "mateReferenceSequenceName": { - "type": "string", - "description": "The name of the sequence that the paired read is aligned to. This is usually the same as referenceSequenceName. (RNEXT)" - }, - "name": { - "type": "string", - "description": "The name of the read. When imported from a BAM file, this is the query template name. (QNAME)" - }, - "originalBases": { - "type": "string", - "description": "The list of bases that this read represents (such as \"CATCGA\"). (SEQ)" - }, - "position": { - "type": "integer", - "description": "The 1-based start position of the aligned read. If the first base starts at the very beginning of the reference sequence, then the position would be '1'. (POS)", - "format": "int32" - }, - "readsetId": { - "type": "string", - "description": "The ID of the readset this read belongs to." - }, - "referenceSequenceName": { - "type": "string", - "description": "The name of the sequence that this read is aligned to. This would be, for example, 'X' for the X Chromosome or '20' for Chromosome 20. (RNAME)" - }, - "tags": { - "type": "object", - "description": "A map of additional read information. (TAG)", - "additionalProperties": { - "type": "array", - "description": "A string which maps to an array of values.", - "items": { - "type": "string" - } - } - }, - "templateLength": { - "type": "integer", - "description": "Length of the original piece of DNA that produced both this read and the paired read. (TLEN)", - "format": "int32" - } - } - }, - "ReadGroup": { - "id": "ReadGroup", - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "(DT) Date the run was produced (ISO8601 date or date/time)." - }, - "description": { - "type": "string", - "description": "(DS) Description." - }, - "flowOrder": { - "type": "string", - "description": "(FO) Flow order. The array of nucleotide bases that correspond to the nucleotides used for each flow of each read." - }, - "id": { - "type": "string", - "description": "(ID) Read group identifier." - }, - "keySequence": { - "type": "string", - "description": "(KS) The array of nucleotide bases that correspond to the key sequence of each read." - }, - "library": { - "type": "string", - "description": "(LS) Library." - }, - "platformUnit": { - "type": "string", - "description": "(PU) Platform unit." - }, - "predictedInsertSize": { - "type": "integer", - "description": "(PI) Predicted median insert size.", - "format": "int32" - }, - "processingProgram": { - "type": "string", - "description": "(PG) Programs used for processing the read group." - }, - "sample": { - "type": "string", - "description": "(SM) Sample." - }, - "sequencingCenterName": { - "type": "string", - "description": "(CN) Name of sequencing center producing the read." - }, - "sequencingTechnology": { - "type": "string", - "description": "(PL) Platform/technology used to produce the reads." - } - } - }, - "Readset": { - "id": "Readset", - "type": "object", - "description": "A Readset is a collection of Reads.", - "properties": { - "datasetId": { - "type": "string", - "description": "The ID of the dataset this readset belongs to." - }, - "fileData": { - "type": "array", - "description": "File information from the original BAM import. See the BAM format specification for additional information on each field.", - "items": { - "$ref": "HeaderSection" - } - }, - "id": { - "type": "string", - "description": "The Google generated ID of the readset, immutable." - }, - "name": { - "type": "string", - "description": "The readset name, typically this is the sample name." - } - } - }, - "ReferenceBound": { - "id": "ReferenceBound", - "type": "object", - "description": "ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.", - "properties": { - "referenceName": { - "type": "string", - "description": "The reference the bound is associate with." - }, - "upperBound": { - "type": "string", - "description": "An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.", - "format": "int64" - } - } - }, - "ReferenceSequence": { - "id": "ReferenceSequence", - "type": "object", - "properties": { - "assemblyId": { - "type": "string", - "description": "(AS) Genome assembly identifier." - }, - "length": { - "type": "integer", - "description": "(LN) Reference sequence length.", - "format": "int32" - }, - "md5Checksum": { - "type": "string", - "description": "(M5) MD5 checksum of the sequence in the uppercase, excluding spaces but including pads as *." - }, - "name": { - "type": "string", - "description": "(SN) Reference sequence name." - }, - "species": { - "type": "string", - "description": "(SP) Species." - }, - "uri": { - "type": "string", - "description": "(UR) URI of the sequence." - } - } - }, - "SearchCallSetsRequest": { - "id": "SearchCallSetsRequest", - "type": "object", - "description": "The call set search request.", - "properties": { - "name": { - "type": "string", - "description": "Only return call sets for which a substring of the name matches this string." - }, - "pageSize": { - "type": "integer", - "description": "The maximum number of call sets to return.", - "format": "int32" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response." - }, - "variantSetIds": { - "type": "array", - "description": "Restrict the query to call sets within the given variant sets. At least one ID must be provided.", - "items": { - "type": "string" - } - } - } - }, - "SearchCallSetsResponse": { - "id": "SearchCallSetsResponse", - "type": "object", - "description": "The call set search response.", - "properties": { - "callSets": { - "type": "array", - "description": "The list of matching call sets.", - "items": { - "$ref": "CallSet" - } - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results." - } - } - }, - "SearchJobsRequest": { - "id": "SearchJobsRequest", - "type": "object", - "description": "The jobs search request.", - "properties": { - "createdAfter": { - "type": "string", - "description": "If specified, only jobs created on or after this date, given in milliseconds since Unix epoch, will be returned.", - "format": "int64" - }, - "createdBefore": { - "type": "string", - "description": "If specified, only jobs created prior to this date, given in milliseconds since Unix epoch, will be returned.", - "format": "int64" - }, - "maxResults": { - "type": "string", - "description": "Specifies the number of results to return in a single page. Defaults to 128. The maximum value is 256.", - "format": "uint64" - }, - "pageToken": { - "type": "string", - "description": "The continuation token which is used to page through large result sets. To get the next page of results, set this parameter to the value of the nextPageToken from the previous response." - }, - "projectId": { - "type": "string", - "description": "Required. Only return jobs which belong to this Google Developers Console project.", - "format": "int64" - }, - "status": { - "type": "array", - "description": "Only return jobs which have a matching status.", - "items": { - "type": "string", - "enum": [ - "canceled", - "failure", - "new", - "pending", - "running", - "success", - "unknownStatus" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "" - ] - } - } - } - }, - "SearchJobsResponse": { - "id": "SearchJobsResponse", - "type": "object", - "description": "The job search response.", - "properties": { - "jobs": { - "type": "array", - "description": "The list of jobs results, ordered newest to oldest.", - "items": { - "$ref": "Job" - } - }, - "nextPageToken": { - "type": "string", - "description": "The continuation token which is used to page through large result sets. Provide this value is a subsequent request to return the next page of results. This field will be empty if there are no more results." - } - } - }, - "SearchReadsRequest": { - "id": "SearchReadsRequest", - "type": "object", - "description": "The read search request.", - "properties": { - "maxResults": { - "type": "string", - "description": "Specifies number of results to return in a single page. If unspecified, it will default to 256. The maximum value is 2048.", - "format": "uint64" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response." - }, - "readsetIds": { - "type": "array", - "description": "The readsets within which to search for reads. At least one readset ID must be provided. All specified readsets must be aligned against a common set of reference sequences; this defines the genomic coordinates for the query.", - "items": { - "type": "string" - } - }, - "sequenceEnd": { - "type": "string", - "description": "The end position (1-based, inclusive) of the target range. If specified, sequenceName must also be specified. Defaults to the end of the target reference sequence, if any.", - "format": "uint64" - }, - "sequenceName": { - "type": "string", - "description": "Restricts the results to a particular reference sequence such as 1, chr1, or X. The set of valid references sequences depends on the readsets specified. If set to *, only unmapped Reads are returned." - }, - "sequenceStart": { - "type": "string", - "description": "The start position (1-based, inclusive) of the target range. If specified, sequenceName must also be specified. Defaults to the start of the target reference sequence, if any.", - "format": "uint64" - } - } - }, - "SearchReadsResponse": { - "id": "SearchReadsResponse", - "type": "object", - "description": "The read search response.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results." - }, - "reads": { - "type": "array", - "description": "The list of matching Reads. The resulting Reads are sorted by position; the smallest positions are returned first. Unmapped reads, which have no position, are returned last and are further sorted alphabetically by name.", - "items": { - "$ref": "Read" - } - } - } - }, - "SearchReadsetsRequest": { - "id": "SearchReadsetsRequest", - "type": "object", - "description": "The readset search request.", - "properties": { - "datasetIds": { - "type": "array", - "description": "Restricts this query to readsets within the given datasets. At least one ID must be provided.", - "items": { - "type": "string" - } - }, - "maxResults": { - "type": "string", - "description": "Specifies number of results to return in a single page. If unspecified, it will default to 128. The maximum value is 1024.", - "format": "uint64" - }, - "name": { - "type": "string", - "description": "Only return readsets for which a substring of the name matches this string." - }, - "pageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response." - } - } - }, - "SearchReadsetsResponse": { - "id": "SearchReadsetsResponse", - "type": "object", - "description": "The readset search response.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results." - }, - "readsets": { - "type": "array", - "description": "The list of matching Readsets.", - "items": { - "$ref": "Readset" - } - } - } - }, - "SearchVariantSetsRequest": { - "id": "SearchVariantSetsRequest", - "type": "object", - "description": "The search variant sets request.", - "properties": { - "datasetIds": { - "type": "array", - "description": "Exactly one dataset ID must be provided here. Only variant sets which belong to this dataset will be returned.", - "items": { - "type": "string" - } - }, - "pageSize": { - "type": "integer", - "description": "The maximum number of variant sets to return in a request.", - "format": "int32" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response." - } - } - }, - "SearchVariantSetsResponse": { - "id": "SearchVariantSetsResponse", - "type": "object", - "description": "The search variant sets response.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results." - }, - "variantSets": { - "type": "array", - "description": "The variant sets belonging to the requested dataset.", - "items": { - "$ref": "VariantSet" - } - } - } - }, - "SearchVariantsRequest": { - "id": "SearchVariantsRequest", - "type": "object", - "description": "The variant search request.", - "properties": { - "callSetIds": { - "type": "array", - "description": "Only return variant calls which belong to call sets with these ids. Leaving this blank returns all variant calls. If a variant has no calls belonging to any of these call sets, it won't be returned at all. Currently, variants with no calls from any call set will never be returned.", - "items": { - "type": "string" - } - }, - "end": { - "type": "string", - "description": "Required. The end of the window (0-based, exclusive) for which overlapping variants should be returned.", - "format": "int64" - }, - "maxCalls": { - "type": "integer", - "description": "The maximum number of calls to return. However, at least one variant will always be returned, even if it has more calls than this limit.", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "description": "The maximum number of variants to return.", - "format": "int32" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response." - }, - "referenceName": { - "type": "string", - "description": "Required. Only return variants in this reference sequence." - }, - "start": { - "type": "string", - "description": "Required. The beginning of the window (0-based, inclusive) for which overlapping variants should be returned.", - "format": "int64" - }, - "variantName": { - "type": "string", - "description": "Only return variants which have exactly this name." - }, - "variantSetIds": { - "type": "array", - "description": "Exactly one variant set ID must be provided. Only variants from this variant set will be returned.", - "items": { - "type": "string" - } - } - } - }, - "SearchVariantsResponse": { - "id": "SearchVariantsResponse", - "type": "object", - "description": "The variant search response.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results." - }, - "variants": { - "type": "array", - "description": "The list of matching Variants.", - "items": { - "$ref": "Variant" - } - } - } - }, - "Variant": { - "id": "Variant", - "type": "object", - "description": "A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.", - "properties": { - "alternateBases": { - "type": "array", - "description": "The bases that appear instead of the reference bases.", - "items": { - "type": "string" - } - }, - "calls": { - "type": "array", - "description": "The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.", - "items": { - "$ref": "Call" - } - }, - "created": { - "type": "string", - "description": "The date this variant was created, in milliseconds from the epoch.", - "format": "int64" - }, - "end": { - "type": "string", - "description": "The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.", - "format": "int64" - }, - "filter": { - "type": "array", - "description": "A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.", - "items": { - "type": "string" - } - }, - "id": { - "type": "string", - "description": "The Google generated ID of the variant, immutable." - }, - "info": { - "type": "object", - "description": "A map of additional variant information.", - "additionalProperties": { - "type": "array", - "description": "A string which maps to an array of values.", - "items": { - "type": "string" - } - } - }, - "names": { - "type": "array", - "description": "Names for the variant, for example a RefSNP ID.", - "items": { - "type": "string" - } - }, - "quality": { - "type": "number", - "description": "A measure of how likely this variant is to be real. A higher value is better.", - "format": "double" - }, - "referenceBases": { - "type": "string", - "description": "The reference bases for this variant. They start at the given position." - }, - "referenceName": { - "type": "string", - "description": "The reference on which this variant occurs. (such as chr20 or X)" - }, - "start": { - "type": "string", - "description": "The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.", - "format": "int64" - }, - "variantSetId": { - "type": "string", - "description": "The ID of the variant set this variant belongs to." - } - } - }, - "VariantSet": { - "id": "VariantSet", - "type": "object", - "description": "A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.", - "properties": { - "datasetId": { - "type": "string", - "description": "The dataset to which this variant set belongs. Immutable." - }, - "id": { - "type": "string", - "description": "The Google-generated ID of the variant set. Immutable." - }, - "metadata": { - "type": "array", - "description": "The metadata associated with this variant set.", - "items": { - "$ref": "Metadata" - } - }, - "referenceBounds": { - "type": "array", - "description": "A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.", - "items": { - "$ref": "ReferenceBound" - } - } - } - } - }, - "resources": { - "callsets": { - "methods": { - "create": { - "id": "genomics.callsets.create", - "path": "callsets", - "httpMethod": "POST", - "description": "Creates a new call set.", - "request": { - "$ref": "CallSet" - }, - "response": { - "$ref": "CallSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "delete": { - "id": "genomics.callsets.delete", - "path": "callsets/{callSetId}", - "httpMethod": "DELETE", - "description": "Deletes a call set.", - "parameters": { - "callSetId": { - "type": "string", - "description": "The ID of the call set to be deleted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "callSetId" - ], - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "get": { - "id": "genomics.callsets.get", - "path": "callsets/{callSetId}", - "httpMethod": "GET", - "description": "Gets a call set by ID.", - "parameters": { - "callSetId": { - "type": "string", - "description": "The ID of the call set.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "callSetId" - ], - "response": { - "$ref": "CallSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "patch": { - "id": "genomics.callsets.patch", - "path": "callsets/{callSetId}", - "httpMethod": "PATCH", - "description": "Updates a call set. This method supports patch semantics.", - "parameters": { - "callSetId": { - "type": "string", - "description": "The ID of the call set to be updated.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "callSetId" - ], - "request": { - "$ref": "CallSet" - }, - "response": { - "$ref": "CallSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "search": { - "id": "genomics.callsets.search", - "path": "callsets/search", - "httpMethod": "POST", - "description": "Gets a list of call sets matching the criteria.\n\nImplements GlobalAllianceApi.searchCallSets.", - "request": { - "$ref": "SearchCallSetsRequest" - }, - "response": { - "$ref": "SearchCallSetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "update": { - "id": "genomics.callsets.update", - "path": "callsets/{callSetId}", - "httpMethod": "PUT", - "description": "Updates a call set.", - "parameters": { - "callSetId": { - "type": "string", - "description": "The ID of the call set to be updated.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "callSetId" - ], - "request": { - "$ref": "CallSet" - }, - "response": { - "$ref": "CallSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - } - } - }, - "datasets": { - "methods": { - "create": { - "id": "genomics.datasets.create", - "path": "datasets", - "httpMethod": "POST", - "description": "Creates a new dataset.", - "request": { - "$ref": "Dataset" - }, - "response": { - "$ref": "Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "delete": { - "id": "genomics.datasets.delete", - "path": "datasets/{datasetId}", - "httpMethod": "DELETE", - "description": "Deletes a dataset.", - "parameters": { - "datasetId": { - "type": "string", - "description": "The ID of the dataset to be deleted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "datasetId" - ], - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "get": { - "id": "genomics.datasets.get", - "path": "datasets/{datasetId}", - "httpMethod": "GET", - "description": "Gets a dataset by ID.", - "parameters": { - "datasetId": { - "type": "string", - "description": "The ID of the dataset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "datasetId" - ], - "response": { - "$ref": "Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "list": { - "id": "genomics.datasets.list", - "path": "datasets", - "httpMethod": "GET", - "description": "Lists all datasets.", - "parameters": { - "maxResults": { - "type": "string", - "description": "The maximum number of results returned by this request.", - "default": "50", - "format": "uint64", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "projectId": { - "type": "string", - "description": "Only return datasets which belong to this Google Developers Console project. Only accepts project numbers. Returns all public projects if no project number is specified.", - "format": "int64", - "location": "query" - } - }, - "response": { - "$ref": "ListDatasetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "patch": { - "id": "genomics.datasets.patch", - "path": "datasets/{datasetId}", - "httpMethod": "PATCH", - "description": "Updates a dataset. This method supports patch semantics.", - "parameters": { - "datasetId": { - "type": "string", - "description": "The ID of the dataset to be updated.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "datasetId" - ], - "request": { - "$ref": "Dataset" - }, - "response": { - "$ref": "Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "undelete": { - "id": "genomics.datasets.undelete", - "path": "datasets/{datasetId}/undelete", - "httpMethod": "POST", - "description": "Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.", - "parameters": { - "datasetId": { - "type": "string", - "description": "The ID of the dataset to be undeleted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "datasetId" - ], - "response": { - "$ref": "Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "update": { - "id": "genomics.datasets.update", - "path": "datasets/{datasetId}", - "httpMethod": "PUT", - "description": "Updates a dataset.", - "parameters": { - "datasetId": { - "type": "string", - "description": "The ID of the dataset to be updated.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "datasetId" - ], - "request": { - "$ref": "Dataset" - }, - "response": { - "$ref": "Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - } - } - }, - "experimental": { - "resources": { - "jobs": { - "methods": { - "create": { - "id": "genomics.experimental.jobs.create", - "path": "experimental/jobs/create", - "httpMethod": "POST", - "description": "Creates and asynchronously runs an ad-hoc job. This is an experimental call and may be removed or changed at any time.", - "request": { - "$ref": "ExperimentalCreateJobRequest" - }, - "response": { - "$ref": "ExperimentalCreateJobResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/devstorage.read_write", - "https://www.googleapis.com/auth/genomics" - ] - } - } - } - } - }, - "jobs": { - "methods": { - "cancel": { - "id": "genomics.jobs.cancel", - "path": "jobs/{jobId}/cancel", - "httpMethod": "POST", - "description": "Cancels a job by ID. Note that it is possible for partial results to be generated and stored for cancelled jobs.", - "parameters": { - "jobId": { - "type": "string", - "description": "Required. The ID of the job.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "jobId" - ], - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "get": { - "id": "genomics.jobs.get", - "path": "jobs/{jobId}", - "httpMethod": "GET", - "description": "Gets a job by ID.", - "parameters": { - "jobId": { - "type": "string", - "description": "Required. The ID of the job.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "jobId" - ], - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "search": { - "id": "genomics.jobs.search", - "path": "jobs/search", - "httpMethod": "POST", - "description": "Gets a list of jobs matching the criteria.", - "request": { - "$ref": "SearchJobsRequest" - }, - "response": { - "$ref": "SearchJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - } - } - }, - "reads": { - "methods": { - "search": { - "id": "genomics.reads.search", - "path": "reads/search", - "httpMethod": "POST", - "description": "Gets a list of reads for one or more readsets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested readsets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only readset IDs yields all reads in those readsets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order.", - "request": { - "$ref": "SearchReadsRequest" - }, - "response": { - "$ref": "SearchReadsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - } - } - }, - "readsets": { - "methods": { - "delete": { - "id": "genomics.readsets.delete", - "path": "readsets/{readsetId}", - "httpMethod": "DELETE", - "description": "Deletes a readset.", - "parameters": { - "readsetId": { - "type": "string", - "description": "The ID of the readset to be deleted. The caller must have WRITE permissions to the dataset associated with this readset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "readsetId" - ], - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "export": { - "id": "genomics.readsets.export", - "path": "readsets/export", - "httpMethod": "POST", - "description": "Exports readsets to a BAM file in Google Cloud Storage. Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. In particular, comments in the input file header will not be preserved, and some custom tags will be converted to strings.", - "request": { - "$ref": "ExportReadsetsRequest" - }, - "response": { - "$ref": "ExportReadsetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/devstorage.read_write", - "https://www.googleapis.com/auth/genomics" - ] - }, - "get": { - "id": "genomics.readsets.get", - "path": "readsets/{readsetId}", - "httpMethod": "GET", - "description": "Gets a readset by ID.", - "parameters": { - "readsetId": { - "type": "string", - "description": "The ID of the readset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "readsetId" - ], - "response": { - "$ref": "Readset" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "import": { - "id": "genomics.readsets.import", - "path": "readsets/import", - "httpMethod": "POST", - "description": "Creates readsets by asynchronously importing the provided information. Note that currently comments in the input file header are not imported and some custom tags will be converted to strings, rather than preserving tag types. The caller must have WRITE permissions to the dataset.", - "request": { - "$ref": "ImportReadsetsRequest" - }, - "response": { - "$ref": "ImportReadsetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/devstorage.read_write", - "https://www.googleapis.com/auth/genomics" - ] - }, - "patch": { - "id": "genomics.readsets.patch", - "path": "readsets/{readsetId}", - "httpMethod": "PATCH", - "description": "Updates a readset. This method supports patch semantics.", - "parameters": { - "readsetId": { - "type": "string", - "description": "The ID of the readset to be updated. The caller must have WRITE permissions to the dataset associated with this readset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "readsetId" - ], - "request": { - "$ref": "Readset" - }, - "response": { - "$ref": "Readset" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "search": { - "id": "genomics.readsets.search", - "path": "readsets/search", - "httpMethod": "POST", - "description": "Gets a list of readsets matching the criteria.", - "request": { - "$ref": "SearchReadsetsRequest" - }, - "response": { - "$ref": "SearchReadsetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "update": { - "id": "genomics.readsets.update", - "path": "readsets/{readsetId}", - "httpMethod": "PUT", - "description": "Updates a readset.", - "parameters": { - "readsetId": { - "type": "string", - "description": "The ID of the readset to be updated. The caller must have WRITE permissions to the dataset associated with this readset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "readsetId" - ], - "request": { - "$ref": "Readset" - }, - "response": { - "$ref": "Readset" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - } - }, - "resources": { - "coveragebuckets": { - "methods": { - "list": { - "id": "genomics.readsets.coveragebuckets.list", - "path": "readsets/{readsetId}/coveragebuckets", - "httpMethod": "GET", - "description": "Lists fixed width coverage buckets for a readset, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at various bucket widths, enabling various coverage \"zoom levels\". The caller must have READ permissions for the target readset.", - "parameters": { - "maxResults": { - "type": "string", - "description": "The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 2048.", - "default": "1024", - "format": "uint64", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "range.sequenceEnd": { - "type": "string", - "description": "The end position of the range on the reference, 1-based exclusive. If specified, sequenceName must also be specified.", - "format": "uint64", - "location": "query" - }, - "range.sequenceName": { - "type": "string", - "description": "The reference sequence name, for example chr1, 1, or chrX.", - "location": "query" - }, - "range.sequenceStart": { - "type": "string", - "description": "The start position of the range on the reference, 1-based inclusive. If specified, sequenceName must also be specified.", - "format": "uint64", - "location": "query" - }, - "readsetId": { - "type": "string", - "description": "Required. The ID of the readset over which coverage is requested.", - "required": true, - "location": "path" - }, - "targetBucketWidth": { - "type": "string", - "description": "The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as bucketWidth in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed bucketWidth is currently 2048 base pairs; this is subject to change.", - "format": "uint64", - "location": "query" - } - }, - "parameterOrder": [ - "readsetId" - ], - "response": { - "$ref": "ListCoverageBucketsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - } - } - } - } - }, - "variants": { - "methods": { - "create": { - "id": "genomics.variants.create", - "path": "variants", - "httpMethod": "POST", - "description": "Creates a new variant.", - "request": { - "$ref": "Variant" - }, - "response": { - "$ref": "Variant" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "delete": { - "id": "genomics.variants.delete", - "path": "variants/{variantId}", - "httpMethod": "DELETE", - "description": "Deletes a variant.", - "parameters": { - "variantId": { - "type": "string", - "description": "The ID of the variant to be deleted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "variantId" - ], - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "export": { - "id": "genomics.variants.export", - "path": "variants/export", - "httpMethod": "POST", - "description": "Exports variant data to an external destination.", - "request": { - "$ref": "ExportVariantsRequest" - }, - "response": { - "$ref": "ExportVariantsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/genomics" - ] - }, - "get": { - "id": "genomics.variants.get", - "path": "variants/{variantId}", - "httpMethod": "GET", - "description": "Gets a variant by ID.", - "parameters": { - "variantId": { - "type": "string", - "description": "The ID of the variant.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "variantId" - ], - "response": { - "$ref": "Variant" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "import": { - "id": "genomics.variants.import", - "path": "variants/import", - "httpMethod": "POST", - "description": "Creates variant data by asynchronously importing the provided information. The variants for import will be merged with any existing data and each other according to the behavior of mergeVariants. In particular, this means for merged VCF variants that have conflicting INFO fields, some data will be arbitrarily discarded. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set.", - "request": { - "$ref": "ImportVariantsRequest" - }, - "response": { - "$ref": "ImportVariantsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/devstorage.read_write", - "https://www.googleapis.com/auth/genomics" - ] - }, - "search": { - "id": "genomics.variants.search", - "path": "variants/search", - "httpMethod": "POST", - "description": "Gets a list of variants matching the criteria.\n\nImplements GlobalAllianceApi.searchVariants.", - "request": { - "$ref": "SearchVariantsRequest" - }, - "response": { - "$ref": "SearchVariantsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "update": { - "id": "genomics.variants.update", - "path": "variants/{variantId}", - "httpMethod": "PUT", - "description": "Updates a variant's names and info fields. All other modifications are silently ignored. Returns the modified variant without its calls.", - "parameters": { - "variantId": { - "type": "string", - "description": "The ID of the variant to be updated.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "variantId" - ], - "request": { - "$ref": "Variant" - }, - "response": { - "$ref": "Variant" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - } - } - }, - "variantsets": { - "methods": { - "delete": { - "id": "genomics.variantsets.delete", - "path": "variantsets/{variantSetId}", - "httpMethod": "DELETE", - "description": "Deletes the contents of a variant set. The variant set object is not deleted.", - "parameters": { - "variantSetId": { - "type": "string", - "description": "The ID of the variant set to be deleted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "variantSetId" - ], - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "get": { - "id": "genomics.variantsets.get", - "path": "variantsets/{variantSetId}", - "httpMethod": "GET", - "description": "Gets a variant set by ID.", - "parameters": { - "variantSetId": { - "type": "string", - "description": "Required. The ID of the variant set.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "variantSetId" - ], - "response": { - "$ref": "VariantSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "mergeVariants": { - "id": "genomics.variantsets.mergeVariants", - "path": "variantsets/{variantSetId}/mergeVariants", - "httpMethod": "POST", - "description": "Merges the given variants with existing variants. Each variant will be merged with an existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant is added to the existing variant, and other fields (such as key/value pairs) are discarded.", - "parameters": { - "variantSetId": { - "type": "string", - "description": "The destination variant set.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "variantSetId" - ], - "request": { - "$ref": "MergeVariantsRequest" - } - }, - "patch": { - "id": "genomics.variantsets.patch", - "path": "variantsets/{variantSetId}", - "httpMethod": "PATCH", - "description": "Updates a variant set's metadata. All other modifications are silently ignored. This method supports patch semantics.", - "parameters": { - "variantSetId": { - "type": "string", - "description": "The ID of the variant to be updated.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "variantSetId" - ], - "request": { - "$ref": "VariantSet" - }, - "response": { - "$ref": "VariantSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - }, - "search": { - "id": "genomics.variantsets.search", - "path": "variantsets/search", - "httpMethod": "POST", - "description": "Returns a list of all variant sets matching search criteria.\n\nImplements GlobalAllianceApi.searchVariantSets.", - "request": { - "$ref": "SearchVariantSetsRequest" - }, - "response": { - "$ref": "SearchVariantSetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ] - }, - "update": { - "id": "genomics.variantsets.update", - "path": "variantsets/{variantSetId}", - "httpMethod": "PUT", - "description": "Updates a variant set's metadata. All other modifications are silently ignored.", - "parameters": { - "variantSetId": { - "type": "string", - "description": "The ID of the variant to be updated.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "variantSetId" - ], - "request": { - "$ref": "VariantSet" - }, - "response": { - "$ref": "VariantSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/genomics" - ] - } - } - } - } -} diff --git a/etc/api/genomics/v1beta2/genomics-api.json b/etc/api/genomics/v1beta2/genomics-api.json index 06236f6420..4638c68e3d 100644 --- a/etc/api/genomics/v1beta2/genomics-api.json +++ b/etc/api/genomics/v1beta2/genomics-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/l-JZ2zxsTgnudDIWYa_zcN3dEbw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/bPOvNJ-TScJWjZAQGjSpdLC3xoY\"", "discoveryVersion": "v1", "id": "genomics:v1beta2", "name": "genomics", "version": "v1beta2", - "revision": "20160127", + "revision": "20160225", "title": "Genomics API", "description": "Provides access to Genomics data.", "ownerDomain": "google.com", @@ -636,7 +636,7 @@ "properties": { "format": { "type": "string", - "description": "The format of the variant data being imported. If unspecified, defaults to to \"VCF\".", + "description": "The format of the variant data being imported. If unspecified, defaults to \"VCF\".", "enum": [ "COMPLETE_GENOMICS", "VCF" @@ -902,6 +902,7 @@ "MergeVariantsRequest": { "id": "MergeVariantsRequest", "type": "object", + "description": "", "properties": { "variants": { "type": "array", @@ -1352,7 +1353,7 @@ "properties": { "referenceName": { "type": "string", - "description": "The name of the reference associated with this ReferenceBound." + "description": "The name of the reference associated with this reference bound." }, "upperBound": { "type": "string", @@ -1904,7 +1905,7 @@ }, "maxCalls": { "type": "integer", - "description": "The maximum number of calls to return in a single page. Note that this limit may be exceeded; at least one variant is always returned per page, even if it has more calls than this limit. If unspecified, defaults to 5000. The maximum value is 10000.", + "description": "The maximum number of calls to return in a single page. Note that this limit may be exceeded in the event that a matching variant contains more calls than the requested maximum. If unspecified, defaults to 5000. The maximum value is 10000.", "format": "int32" }, "pageSize": { @@ -3489,7 +3490,7 @@ "id": "genomics.variantsets.delete", "path": "variantsets/{variantSetId}", "httpMethod": "DELETE", - "description": "Deletes the contents of a variant set. The variant set object is not deleted.", + "description": "Deletes a variant set including all variants, call sets, and calls within. This is not reversible.", "parameters": { "variantSetId": { "type": "string", @@ -3563,7 +3564,7 @@ "id": "genomics.variantsets.importVariants", "path": "variantsets/{variantSetId}/importVariants", "httpMethod": "POST", - "description": "Creates variant data by asynchronously importing the provided information.\n\nThe variants for import will be merged with any existing data and each other according to the behavior of mergeVariants. In particular, this means for merged VCF variants that have conflicting INFO fields, some data will be arbitrarily discarded. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set.", + "description": "Creates variant data by asynchronously importing the provided information.\n\nThe variants for import will be merged with any existing data and each other according to the behavior of mergeVariants. In particular, this means for merged VCF variants that have conflicting info fields, some data will be arbitrarily discarded. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set.", "parameters": { "variantSetId": { "type": "string", diff --git a/etc/api/gmail/v1/gmail-api.json b/etc/api/gmail/v1/gmail-api.json index 6f206396f9..34916a5b06 100644 --- a/etc/api/gmail/v1/gmail-api.json +++ b/etc/api/gmail/v1/gmail-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1eGVJtSLrCxEfcwj3vC77SuvvyE\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/o-i_EQ3AewMJPACv-srQz117MuQ\"", "discoveryVersion": "v1", "id": "gmail:v1", "name": "gmail", "version": "v1", - "revision": "20151214", + "revision": "20160216", "title": "Gmail API", "description": "The Gmail REST API.", "ownerDomain": "google.com", @@ -94,6 +94,19 @@ } }, "schemas": { + "BatchDeleteMessagesRequest": { + "id": "BatchDeleteMessagesRequest", + "type": "object", + "properties": { + "ids": { + "type": "array", + "description": "The IDs of the messages to delete.", + "items": { + "type": "string" + } + } + } + }, "Draft": { "id": "Draft", "type": "object", @@ -899,6 +912,12 @@ "httpMethod": "GET", "description": "Lists the drafts in the user's mailbox.", "parameters": { + "includeSpamTrash": { + "type": "boolean", + "description": "Include drafts from SPAM and TRASH in the results.", + "default": "false", + "location": "query" + }, "maxResults": { "type": "integer", "description": "Maximum number of drafts to return.", @@ -1284,6 +1303,30 @@ }, "messages": { "methods": { + "batchDelete": { + "id": "gmail.users.messages.batchDelete", + "path": "{userId}/messages/batchDelete", + "httpMethod": "POST", + "description": "Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.", + "parameters": { + "userId": { + "type": "string", + "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "default": "me", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "userId" + ], + "request": { + "$ref": "BatchDeleteMessagesRequest" + }, + "scopes": [ + "https://mail.google.com/" + ] + }, "delete": { "id": "gmail.users.messages.delete", "path": "{userId}/messages/{id}", diff --git a/etc/api/groupsmigration/v1/groupsmigration-api.json b/etc/api/groupsmigration/v1/groupsmigration-api.json index 424a490736..35969088fb 100644 --- a/etc/api/groupsmigration/v1/groupsmigration-api.json +++ b/etc/api/groupsmigration/v1/groupsmigration-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/NXF48xxc_A1ceOTiCWkcvs6o72I\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/HWdr3QolTxcnkwueTlDTCxOXBdE\"", "discoveryVersion": "v1", "id": "groupsmigration:v1", "name": "groupsmigration", diff --git a/etc/api/groupssettings/v1/groupssettings-api.json b/etc/api/groupssettings/v1/groupssettings-api.json index ae8814239a..561ca0012a 100644 --- a/etc/api/groupssettings/v1/groupssettings-api.json +++ b/etc/api/groupssettings/v1/groupssettings-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/p2kveOh6Jafd08hxkUBX0mImbNQ\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/LB7tBnj-DijcSgrB8b68OQtvDh0\"", "discoveryVersion": "v1", "id": "groupssettings:v1", "name": "groupssettings", diff --git a/etc/api/identitytoolkit/v3/identitytoolkit-api.json b/etc/api/identitytoolkit/v3/identitytoolkit-api.json index 09eca6de4a..8ec72f993d 100644 --- a/etc/api/identitytoolkit/v3/identitytoolkit-api.json +++ b/etc/api/identitytoolkit/v3/identitytoolkit-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/xPOEaVu3pXCyFCLJNoRrVds6kh4\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/SoW4IfHxlJosFzXZJhzy3m0A7CE\"", "discoveryVersion": "v1", "id": "identitytoolkit:v3", "name": "identitytoolkit", "canonicalName": "Identity Toolkit", "version": "v3", - "revision": "20160125", + "revision": "20160216", "title": "Google Identity Toolkit API", "description": "Help the third party sites to implement federated login.", "ownerDomain": "google.com", @@ -425,6 +425,10 @@ "type": "string", "description": "The new password of the user." }, + "photoUrl": { + "type": "string", + "description": "The photo url of the user." + }, "provider": { "type": "array", "description": "The associated IDPs of the user.", @@ -469,6 +473,41 @@ } } }, + "IdentitytoolkitRelyingpartySignupNewUserRequest": { + "id": "IdentitytoolkitRelyingpartySignupNewUserRequest", + "type": "object", + "description": "Request to signup new user, create anonymous user or anonymous user reauth.", + "properties": { + "captchaChallenge": { + "type": "string", + "description": "The captcha challenge." + }, + "captchaResponse": { + "type": "string", + "description": "Response to the captcha." + }, + "displayName": { + "type": "string", + "description": "The name of the user." + }, + "email": { + "type": "string", + "description": "The email of the user." + }, + "idToken": { + "type": "string", + "description": "The GITKit token of the authenticated user." + }, + "instanceId": { + "type": "string", + "description": "Instance id token of the app." + }, + "password": { + "type": "string", + "description": "The new password of the user." + } + } + }, "IdentitytoolkitRelyingpartyUploadAccountRequest": { "id": "IdentitytoolkitRelyingpartyUploadAccountRequest", "type": "object", @@ -522,6 +561,10 @@ "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.", "format": "int64" }, + "idToken": { + "type": "string", + "description": "The GITKit token of the authenticated user." + }, "instanceId": { "type": "string", "description": "Instance id token of the app." @@ -585,6 +628,10 @@ "type": "string", "description": "The email of the user." }, + "idToken": { + "type": "string", + "description": "The GITKit token of the authenticated user." + }, "instanceId": { "type": "string", "description": "Instance id token of the app." @@ -705,6 +752,10 @@ "type": "string", "description": "The new email the user attempts to change to." }, + "photoUrl": { + "type": "string", + "description": "The photo url of the user." + }, "providerUserInfo": { "type": "array", "description": "The user's profiles at the associated IdPs.", @@ -728,6 +779,30 @@ } } }, + "SignupNewUserResponse": { + "id": "SignupNewUserResponse", + "type": "object", + "description": "Response of signing up new user, creating anonymous user or anonymous user reauth.", + "properties": { + "displayName": { + "type": "string", + "description": "The name of the user." + }, + "email": { + "type": "string", + "description": "The email of the user." + }, + "idToken": { + "type": "string", + "description": "The Gitkit id token to login the newly sign up user." + }, + "kind": { + "type": "string", + "description": "The fixed string \"identitytoolkit#SignupNewUserResponse\".", + "default": "identitytoolkit#SignupNewUserResponse" + } + } + }, "UploadAccountResponse": { "id": "UploadAccountResponse", "type": "object", @@ -807,6 +882,10 @@ "type": "string", "description": "The user's display name at the IDP." }, + "email": { + "type": "string", + "description": "User's email at IDP." + }, "federatedId": { "type": "string", "description": "User's identifier at IDP." @@ -1167,6 +1246,18 @@ "$ref": "IdentitytoolkitRelyingpartySignOutUserResponse" } }, + "signupNewUser": { + "id": "identitytoolkit.relyingparty.signupNewUser", + "path": "signupNewUser", + "httpMethod": "POST", + "description": "Signup new user.", + "request": { + "$ref": "IdentitytoolkitRelyingpartySignupNewUserRequest" + }, + "response": { + "$ref": "SignupNewUserResponse" + } + }, "uploadAccount": { "id": "identitytoolkit.relyingparty.uploadAccount", "path": "uploadAccount", diff --git a/etc/api/licensing/v1/licensing-api.json b/etc/api/licensing/v1/licensing-api.json index 936f5591d8..a83bb6a490 100644 --- a/etc/api/licensing/v1/licensing-api.json +++ b/etc/api/licensing/v1/licensing-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/x8MCcPZaYu1oW0xMwyS4ljqoX-E\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/e3DwUYJq7cR8DMYb0b0rJ8XCL6k\"", "discoveryVersion": "v1", "id": "licensing:v1", "name": "licensing", diff --git a/etc/api/logging/v1beta3/logging-api.json b/etc/api/logging/v1beta3/logging-api.json deleted file mode 100644 index 477e51b107..0000000000 --- a/etc/api/logging/v1beta3/logging-api.json +++ /dev/null @@ -1,1691 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/l7KAWGWj5NIeNmaEXus4dk2p56U\"", - "discoveryVersion": "v1", - "id": "logging:v1beta3", - "name": "logging", - "version": "v1beta3", - "revision": "20151007", - "title": "Google Cloud Logging API", - "description": "Google Cloud Logging API lets you create logs, ingest log entries, and manage log sinks.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "https://cloud.google.com/logging/docs/", - "protocol": "rest", - "baseUrl": "https://logging.googleapis.com/", - "basePath": "/", - "rootUrl": "https://logging.googleapis.com/", - "servicePath": "", - "batchPath": "batch", - "parameters": { - "access_token": { - "type": "string", - "description": "OAuth access token.", - "location": "query" - }, - "alt": { - "type": "string", - "description": "Data format for response.", - "default": "json", - "enumDescriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ], - "location": "query" - }, - "bearer_token": { - "type": "string", - "description": "OAuth bearer token.", - "location": "query" - }, - "callback": { - "type": "string", - "description": "JSONP", - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "pp": { - "type": "boolean", - "description": "Pretty-print response.", - "default": "true", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", - "location": "query" - }, - "upload_protocol": { - "type": "string", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query" - }, - "uploadType": { - "type": "string", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query" - }, - "$.xgafv": { - "type": "string", - "description": "V1 error format.", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/logging.admin": { - "description": "Administrate log data for your projects" - }, - "https://www.googleapis.com/auth/logging.read": { - "description": "View log data for your projects" - }, - "https://www.googleapis.com/auth/logging.write": { - "description": "Submit log data for your projects" - } - } - } - }, - "schemas": { - "ListLogsResponse": { - "id": "ListLogsResponse", - "type": "object", - "description": "Result returned from ListLogs.", - "properties": { - "logs": { - "type": "array", - "description": "A list of log descriptions matching the criteria.", - "items": { - "$ref": "Log" - } - }, - "nextPageToken": { - "type": "string", - "description": "If there are more results, then `nextPageToken` is returned in the response. To get the next batch of logs, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogs`. If `nextPageToken` is empty, then there are no more results." - } - } - }, - "Log": { - "id": "Log", - "type": "object", - "description": "_Output only._ Describes a log, which is a named stream of log entries.", - "properties": { - "name": { - "type": "string", - "description": "The resource name of the log. Example: `\"/projects/my-gcp-project-id/logs/LOG_NAME\"`, where `LOG_NAME` is the URL-encoded given name of the log. The log includes those log entries whose `LogEntry.log` field contains this given name. To avoid name collisions, it is a best practice to prefix the given log name with the service name, but this is not required. Examples of log given names: `\"appengine.googleapis.com/request_log\"`, `\"apache-access\"`." - }, - "displayName": { - "type": "string", - "description": "_Optional._ The common name of the log. Example: `\"request_log\"`." - }, - "payloadType": { - "type": "string", - "description": "_Optional_. A URI representing the expected payload type for log entries." - } - } - }, - "Empty": { - "id": "Empty", - "type": "object", - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`." - }, - "WriteLogEntriesRequest": { - "id": "WriteLogEntriesRequest", - "type": "object", - "description": "The parameters to WriteLogEntries.", - "properties": { - "commonLabels": { - "type": "object", - "description": "Metadata labels that apply to all log entries in this request, so that you don't have to repeat them in each log entry's `metadata.labels` field. If any of the log entries contains a (key, value) with the same key that is in `commonLabels`, then the entry's (key, value) overrides the one in `commonLabels`.", - "additionalProperties": { - "type": "string" - } - }, - "entries": { - "type": "array", - "description": "Log entries to insert.", - "items": { - "$ref": "LogEntry" - } - } - } - }, - "LogEntry": { - "id": "LogEntry", - "type": "object", - "description": "An individual entry in a log.", - "properties": { - "metadata": { - "$ref": "LogEntryMetadata", - "description": "Information about the log entry." - }, - "protoPayload": { - "type": "object", - "description": "The log entry payload, represented as a protocol buffer that is expressed as a JSON object. You can only pass `protoPayload` values that belong to a set of approved types.", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @ype with type URL." - } - }, - "textPayload": { - "type": "string", - "description": "The log entry payload, represented as a text string." - }, - "structPayload": { - "type": "object", - "description": "The log entry payload, represented as a structure that is expressed as a JSON object.", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } - }, - "insertId": { - "type": "string", - "description": "A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same log with the same ID as duplicates which can be removed." - }, - "log": { - "type": "string", - "description": "The log to which this entry belongs. When a log entry is ingested, the value of this field is set by the logging system." - }, - "httpRequest": { - "$ref": "HttpRequest", - "description": "Information about the HTTP request associated with this log entry, if applicable." - } - } - }, - "LogEntryMetadata": { - "id": "LogEntryMetadata", - "type": "object", - "description": "Additional data that is associated with a log entry, set by the service creating the log entry.", - "properties": { - "timestamp": { - "type": "string", - "description": "The time the event described by the log entry occurred. Timestamps must be later than January 1, 1970." - }, - "severity": { - "type": "string", - "description": "The severity of the log entry.", - "enum": [ - "DEFAULT", - "DEBUG", - "INFO", - "NOTICE", - "WARNING", - "ERROR", - "CRITICAL", - "ALERT", - "EMERGENCY" - ] - }, - "projectId": { - "type": "string", - "description": "The project ID of the Google Cloud Platform service that created the log entry." - }, - "serviceName": { - "type": "string", - "description": "The API name of the Google Cloud Platform service that created the log entry. For example, `\"compute.googleapis.com\"`." - }, - "region": { - "type": "string", - "description": "The region name of the Google Cloud Platform service that created the log entry. For example, `\"us-central1\"`." - }, - "zone": { - "type": "string", - "description": "The zone of the Google Cloud Platform service that created the log entry. For example, `\"us-central1-a\"`." - }, - "userId": { - "type": "string", - "description": "The fully-qualified email address of the authenticated user that performed or requested the action represented by the log entry. If the log entry does not apply to an action taken by an authenticated user, then the field should be empty." - }, - "labels": { - "type": "object", - "description": "A set of (key, value) data that provides additional information about the log entry. If the log entry is from one of the Google Cloud Platform sources listed below, the indicated (key, value) information must be provided: Google App Engine, service_name `appengine.googleapis.com`: \"appengine.googleapis.com/module_id\", \"appengine.googleapis.com/version_id\", and one of: \"appengine.googleapis.com/replica_index\", \"appengine.googleapis.com/clone_id\", or else provide the following Compute Engine labels: Google Compute Engine, service_name `compute.googleapis.com`: \"compute.googleapis.com/resource_type\", \"instance\" \"compute.googleapis.com/resource_id\",", - "additionalProperties": { - "type": "string" - } - } - } - }, - "HttpRequest": { - "id": "HttpRequest", - "type": "object", - "description": "A common proto for logging HTTP requests.", - "properties": { - "requestMethod": { - "type": "string", - "description": "Request method, such as `GET`, `HEAD`, `PUT` or `POST`." - }, - "requestUrl": { - "type": "string", - "description": "Contains the scheme (http|https), the host name, the path and the query portion of the URL that was requested." - }, - "requestSize": { - "type": "string", - "description": "Size of the HTTP request message in bytes, including request headers and the request body.", - "format": "int64" - }, - "status": { - "type": "integer", - "description": "A response code indicates the status of response, e.g., 200.", - "format": "int32" - }, - "responseSize": { - "type": "string", - "description": "Size of the HTTP response message in bytes sent back to the client, including response headers and response body.", - "format": "int64" - }, - "userAgent": { - "type": "string", - "description": "User agent sent by the client, e.g., \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"." - }, - "remoteIp": { - "type": "string", - "description": "IP address of the client who issues the HTTP request. Could be either IPv4 or IPv6." - }, - "referer": { - "type": "string", - "description": "Referer (a.k.a. referrer) URL of request, as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html." - }, - "cacheHit": { - "type": "boolean", - "description": "Whether or not an entity was served from cache (with or without validation)." - }, - "validatedWithOriginServer": { - "type": "boolean", - "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True." - } - } - }, - "WriteLogEntriesResponse": { - "id": "WriteLogEntriesResponse", - "type": "object", - "description": "Result returned from WriteLogEntries. empty" - }, - "ListLogServicesResponse": { - "id": "ListLogServicesResponse", - "type": "object", - "description": "Result returned from `ListLogServicesRequest`.", - "properties": { - "logServices": { - "type": "array", - "description": "A list of log services.", - "items": { - "$ref": "LogService" - } - }, - "nextPageToken": { - "type": "string", - "description": "If there are more results, then `nextPageToken` is returned in the response. To get the next batch of services, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogServices`. If `nextPageToken` is empty, then there are no more results." - } - } - }, - "LogService": { - "id": "LogService", - "type": "object", - "description": "_Output only._ Describes a service that writes log entries.", - "properties": { - "name": { - "type": "string", - "description": "The service's name. Example: `\"appengine.googleapis.com\"`. Log names beginning with this string are reserved for this service. This value can appear in the `LogEntry.metadata.serviceName` field of log entries associated with this log service." - }, - "indexKeys": { - "type": "array", - "description": "A list of the names of the keys used to index and label individual log entries from this service. The first two keys are used as the primary and secondary index, respectively. Additional keys may be used to label the entries. For example, App Engine indexes its entries by module and by version, so its `indexKeys` field is the following: [ \"appengine.googleapis.com/module_id\", \"appengine.googleapis.com/version_id\" ]", - "items": { - "type": "string" - } - } - } - }, - "ListLogServiceIndexesResponse": { - "id": "ListLogServiceIndexesResponse", - "type": "object", - "description": "Result returned from ListLogServiceIndexesRequest.", - "properties": { - "serviceIndexPrefixes": { - "type": "array", - "description": "A list of log service index values. Each index value has the form `\"/value1/value2/...\"`, where `value1` is a value in the primary index, `value2` is a value in the secondary index, and so forth.", - "items": { - "type": "string" - } - }, - "nextPageToken": { - "type": "string", - "description": "If there are more results, then `nextPageToken` is returned in the response. To get the next batch of indexes, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogServiceIndexes`. If `nextPageToken` is empty, then there are no more results." - } - } - }, - "ListLogSinksResponse": { - "id": "ListLogSinksResponse", - "type": "object", - "description": "Result returned from `ListLogSinks`.", - "properties": { - "sinks": { - "type": "array", - "description": "The requested log sinks. If a returned `LogSink` object has an empty `destination` field, the client can retrieve the complete `LogSink` object by calling `log.sinks.get`.", - "items": { - "$ref": "LogSink" - } - } - } - }, - "LogSink": { - "id": "LogSink", - "type": "object", - "description": "Describes where log entries are written outside of Cloud Logging.", - "properties": { - "name": { - "type": "string", - "description": "The client-assigned name of this sink. For example, `\"my-syslog-sink\"`. The name must be unique among the sinks of a similar kind in the project." - }, - "destination": { - "type": "string", - "description": "The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `\"storage.googleapis.com/my-output-bucket\"`." - }, - "filter": { - "type": "string", - "description": "An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter." - }, - "errors": { - "type": "array", - "description": "_Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.", - "items": { - "$ref": "LogError" - } - } - } - }, - "LogError": { - "id": "LogError", - "type": "object", - "description": "Describes a problem with a logging resource or operation.", - "properties": { - "resource": { - "type": "string", - "description": "A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries." - }, - "status": { - "$ref": "Status", - "description": "The error description, including a classification code, an error message, and other details." - }, - "timeNanos": { - "type": "string", - "description": "The time the error was observed, in nanoseconds since the Unix epoch.", - "format": "int64" - } - } - }, - "Status": { - "id": "Status", - "type": "object", - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.", - "properties": { - "code": { - "type": "integer", - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32" - }, - "message": { - "type": "string", - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." - }, - "details": { - "type": "array", - "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.", - "items": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @ype with type URL." - } - } - } - } - }, - "ListLogServiceSinksResponse": { - "id": "ListLogServiceSinksResponse", - "type": "object", - "description": "Result returned from `ListLogServiceSinks`.", - "properties": { - "sinks": { - "type": "array", - "description": "The requested log service sinks. If a returned `LogSink` object has an empty `destination` field, the client can retrieve the complete `LogSink` object by calling `logServices.sinks.get`.", - "items": { - "$ref": "LogSink" - } - } - } - }, - "ListSinksResponse": { - "id": "ListSinksResponse", - "type": "object", - "description": "Result returned from `ListSinks`.", - "properties": { - "sinks": { - "type": "array", - "description": "The requested sinks. If a returned `LogSink` object has an empty `destination` field, the client can retrieve the complete `LogSink` object by calling `projects.sinks.get`.", - "items": { - "$ref": "LogSink" - } - } - } - }, - "ListLogMetricsResponse": { - "id": "ListLogMetricsResponse", - "type": "object", - "description": "Result returned from ListLogMetrics.", - "properties": { - "metrics": { - "type": "array", - "description": "The list of metrics that was requested.", - "items": { - "$ref": "LogMetric" - } - }, - "nextPageToken": { - "type": "string", - "description": "If there are more results, then `nextPageToken` is returned in the response. To get the next batch of entries, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogMetrics`. If `nextPageToken` is empty, then there are no more results." - } - } - }, - "LogMetric": { - "id": "LogMetric", - "type": "object", - "description": "Describes a collected, logs-based metric. The value of the metric is the number of log entries in the project that match the advanced logs filter in the `filter` field.", - "properties": { - "name": { - "type": "string", - "description": "The client-assigned name for this metric, such as `\"severe_errors\"`. Metric names are limited to 1000 characters and can include only the following characters: `-A-Za-z0-9_.,+!*',()%/\\`. The slash character `/` implies a hierarchy of name pieces, and cannot be the first character of the name." - }, - "description": { - "type": "string", - "description": "A description of this metric." - }, - "filter": { - "type": "string", - "description": "An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `\"log:syslog AND metadata.severity\u003e=ERROR\"`." - } - } - }, - "RequestLog": { - "id": "RequestLog", - "type": "object", - "description": "Complete log information about a single request to an application.", - "properties": { - "appId": { - "type": "string", - "description": "Identifies the application that handled this request." - }, - "moduleId": { - "type": "string", - "description": "Identifies the module of the application that handled this request." - }, - "versionId": { - "type": "string", - "description": "Version of the application that handled this request." - }, - "requestId": { - "type": "string", - "description": "Globally unique identifier for a request, based on request start time. Request IDs for requests which started later will compare greater as binary strings than those for requests which started earlier.", - "format": "byte" - }, - "ip": { - "type": "string", - "description": "Origin IP address." - }, - "startTime": { - "type": "string", - "description": "Time at which request was known to have begun processing." - }, - "endTime": { - "type": "string", - "description": "Time at which request was known to end processing." - }, - "latency": { - "type": "string", - "description": "Latency of the request." - }, - "megaCycles": { - "type": "string", - "description": "Number of CPU megacycles used to process request.", - "format": "int64" - }, - "method": { - "type": "string", - "description": "Request method, such as `GET`, `HEAD`, `PUT`, `POST`, or `DELETE`." - }, - "resource": { - "type": "string", - "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". Any trailing fragment (separated by a '#' character) will not be included." - }, - "httpVersion": { - "type": "string", - "description": "HTTP version of request." - }, - "status": { - "type": "integer", - "description": "Response status of request.", - "format": "int32" - }, - "responseSize": { - "type": "string", - "description": "Size in bytes sent back to client by request.", - "format": "int64" - }, - "referrer": { - "type": "string", - "description": "Referrer URL of request." - }, - "userAgent": { - "type": "string", - "description": "User agent used for making request." - }, - "nickname": { - "type": "string", - "description": "A string that identifies a logged-in user who made this request, or empty if the user is not logged in. Most likely, this is the part of the user's email before the '@' sign. The field value is the same for different requests from the same user, but different users may have a similar name. This information is also available to the application via Users API. This field will be populated starting with App Engine 1.9.21." - }, - "urlMapEntry": { - "type": "string", - "description": "File or class within URL mapping used for request. Useful for tracking down the source code which was responsible for managing request. Especially for multiply mapped handlers." - }, - "host": { - "type": "string", - "description": "The Internet host and port number of the resource being requested." - }, - "cost": { - "type": "number", - "description": "An indication of the relative cost of serving this request.", - "format": "double" - }, - "taskQueueName": { - "type": "string", - "description": "Queue name of the request (for an offline request)." - }, - "taskName": { - "type": "string", - "description": "Task name of the request (for an offline request)." - }, - "wasLoadingRequest": { - "type": "boolean", - "description": "Was this request a loading request for this instance?" - }, - "pendingTime": { - "type": "string", - "description": "Time this request spent in the pending request queue, if it was pending at all." - }, - "instanceIndex": { - "type": "integer", - "description": "If the instance that processed this request was individually addressable (i.e. belongs to a manually scaled module), this is the index of the instance.", - "format": "int32" - }, - "finished": { - "type": "boolean", - "description": "If true, represents a finished request. Otherwise, the request is active." - }, - "instanceId": { - "type": "string", - "description": "An opaque identifier for the instance that handled the request.", - "format": "byte" - }, - "line": { - "type": "array", - "description": "List of log lines emitted by the application while serving this request, if requested.", - "items": { - "$ref": "LogLine" - } - }, - "appEngineRelease": { - "type": "string", - "description": "App Engine release version string." - }, - "traceId": { - "type": "string", - "description": "Cloud Trace identifier of the trace for this request." - }, - "sourceReference": { - "type": "array", - "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.", - "items": { - "$ref": "SourceReference" - } - } - } - }, - "LogLine": { - "id": "LogLine", - "type": "object", - "description": "Application log line emitted while processing a request.", - "properties": { - "time": { - "type": "string", - "description": "Time when log entry was made. May be inaccurate." - }, - "severity": { - "type": "string", - "description": "Severity of log.", - "enum": [ - "DEFAULT", - "DEBUG", - "INFO", - "NOTICE", - "WARNING", - "ERROR", - "CRITICAL", - "ALERT", - "EMERGENCY" - ] - }, - "logMessage": { - "type": "string", - "description": "App provided log message." - }, - "sourceLocation": { - "$ref": "SourceLocation", - "description": "Line of code that generated this log message." - } - } - }, - "SourceLocation": { - "id": "SourceLocation", - "type": "object", - "description": "Specifies a location in a source file.", - "properties": { - "file": { - "type": "string", - "description": "Source file name. May or may not be a fully qualified name, depending on the runtime environment." - }, - "line": { - "type": "string", - "description": "Line within the source file.", - "format": "int64" - }, - "functionName": { - "type": "string", - "description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name, for use in contexts such as the logs viewer where file:line number is less meaningful. This may vary by language, for example: in Java: qual.if.ied.Class.method in Go: dir/package.func in Python: function ..." - } - } - }, - "SourceReference": { - "id": "SourceReference", - "type": "object", - "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.", - "properties": { - "repository": { - "type": "string", - "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"" - }, - "revisionId": { - "type": "string", - "description": "The canonical (and persistent) identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"" - } - } - } - }, - "resources": { - "projects": { - "resources": { - "logs": { - "methods": { - "list": { - "id": "logging.projects.logs.list", - "path": "v1beta3/projects/{projectsId}/logs", - "httpMethod": "GET", - "description": "Lists the logs in the project. Only logs that have entries are listed.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `projectName`. The resource name of the project whose logs are requested. If both `serviceName` and `serviceIndexPrefix` are empty, then all logs with entries in this project are listed.", - "required": true, - "location": "path" - }, - "serviceName": { - "type": "string", - "description": "If not empty, this field must be a log service name such as `\"compute.googleapis.com\"`. Only logs associated with that that log service are listed.", - "location": "query" - }, - "serviceIndexPrefix": { - "type": "string", - "description": "The purpose of this field is to restrict the listed logs to those with entries of a certain kind. If `serviceName` is the name of a log service, then this field may contain values for the log service's indexes. Only logs that have entries whose indexes include the values are listed. The format for this field is `\"/val1/val2.../valN\"`, where `val1` is a value for the first index, `val2` for the second index, etc. An empty value (a single slash) for an index matches all values, and you can omit values for later indexes entirely.", - "location": "query" - }, - "pageSize": { - "type": "integer", - "description": "The maximum number of results to return.", - "format": "int32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "An opaque token, returned as `nextPageToken` by a prior `ListLogs` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogs` operation is continued.", - "location": "query" - } - }, - "parameterOrder": [ - "projectsId" - ], - "response": { - "$ref": "ListLogsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - }, - "delete": { - "id": "logging.projects.logs.delete", - "path": "v1beta3/projects/{projectsId}/logs/{logsId}", - "httpMethod": "DELETE", - "description": "Deletes a log and all its log entries. The log will reappear if it receives new entries.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `logName`. The resource name of the log to be deleted.", - "required": true, - "location": "path" - }, - "logsId": { - "type": "string", - "description": "Part of `logName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logsId" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - } - }, - "resources": { - "entries": { - "methods": { - "write": { - "id": "logging.projects.logs.entries.write", - "path": "v1beta3/projects/{projectsId}/logs/{logsId}/entries:write", - "httpMethod": "POST", - "description": "Writes log entries to Cloud Logging. Each entry consists of a `LogEntry` object. You must fill in all the fields of the object, including one of the payload fields. You may supply a map, `commonLabels`, that holds default (key, value) data for the `entries[].metadata.labels` map in each entry, saving you the trouble of creating identical copies for each entry.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `logName`. The resource name of the log that will receive the log entries.", - "required": true, - "location": "path" - }, - "logsId": { - "type": "string", - "description": "Part of `logName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logsId" - ], - "request": { - "$ref": "WriteLogEntriesRequest" - }, - "response": { - "$ref": "WriteLogEntriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.write" - ] - } - } - }, - "sinks": { - "methods": { - "list": { - "id": "logging.projects.logs.sinks.list", - "path": "v1beta3/projects/{projectsId}/logs/{logsId}/sinks", - "httpMethod": "GET", - "description": "Lists log sinks associated with a log.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `logName`. The log whose sinks are wanted. For example, `\"compute.google.com/syslog\"`.", - "required": true, - "location": "path" - }, - "logsId": { - "type": "string", - "description": "Part of `logName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logsId" - ], - "response": { - "$ref": "ListLogSinksResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - }, - "get": { - "id": "logging.projects.logs.sinks.get", - "path": "v1beta3/projects/{projectsId}/logs/{logsId}/sinks/{sinksId}", - "httpMethod": "GET", - "description": "Gets a log sink.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `sinkName`. The resource name of the log sink to return.", - "required": true, - "location": "path" - }, - "logsId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - }, - "sinksId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logsId", - "sinksId" - ], - "response": { - "$ref": "LogSink" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - }, - "create": { - "id": "logging.projects.logs.sinks.create", - "path": "v1beta3/projects/{projectsId}/logs/{logsId}/sinks", - "httpMethod": "POST", - "description": "Creates a log sink. All log entries for a specified log are written to the destination.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `logName`. The resource name of the log to which to the sink is bound.", - "required": true, - "location": "path" - }, - "logsId": { - "type": "string", - "description": "Part of `logName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logsId" - ], - "request": { - "$ref": "LogSink" - }, - "response": { - "$ref": "LogSink" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - }, - "update": { - "id": "logging.projects.logs.sinks.update", - "path": "v1beta3/projects/{projectsId}/logs/{logsId}/sinks/{sinksId}", - "httpMethod": "PUT", - "description": "Updates a log sink. If the sink does not exist, it is created.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `sinkName`. The resource name of the sink to update.", - "required": true, - "location": "path" - }, - "logsId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - }, - "sinksId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logsId", - "sinksId" - ], - "request": { - "$ref": "LogSink" - }, - "response": { - "$ref": "LogSink" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - }, - "delete": { - "id": "logging.projects.logs.sinks.delete", - "path": "v1beta3/projects/{projectsId}/logs/{logsId}/sinks/{sinksId}", - "httpMethod": "DELETE", - "description": "Deletes a log sink. After deletion, no new log entries are written to the destination.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `sinkName`. The resource name of the log sink to delete.", - "required": true, - "location": "path" - }, - "logsId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - }, - "sinksId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logsId", - "sinksId" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - } - } - } - } - }, - "logServices": { - "methods": { - "list": { - "id": "logging.projects.logServices.list", - "path": "v1beta3/projects/{projectsId}/logServices", - "httpMethod": "GET", - "description": "Lists the log services that have log entries in this project.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `projectName`. The resource name of the project whose services are to be listed.", - "required": true, - "location": "path" - }, - "pageSize": { - "type": "integer", - "description": "The maximum number of `LogService` objects to return in one operation.", - "format": "int32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "An opaque token, returned as `nextPageToken` by a prior `ListLogServices` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogServices` operation is continued.", - "location": "query" - } - }, - "parameterOrder": [ - "projectsId" - ], - "response": { - "$ref": "ListLogServicesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - } - }, - "resources": { - "indexes": { - "methods": { - "list": { - "id": "logging.projects.logServices.indexes.list", - "path": "v1beta3/projects/{projectsId}/logServices/{logServicesId}/indexes", - "httpMethod": "GET", - "description": "Lists the current index values for a log service.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `serviceName`. The resource name of a log service whose service indexes are requested. Example: `\"projects/my-project-id/logServices/appengine.googleapis.com\"`.", - "required": true, - "location": "path" - }, - "logServicesId": { - "type": "string", - "description": "Part of `serviceName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - }, - "indexPrefix": { - "type": "string", - "description": "Restricts the index values returned to be those with a specified prefix for each index key. This field has the form `\"/prefix1/prefix2/...\"`, in order corresponding to the `LogService indexKeys`. Non-empty prefixes must begin with `/`. For example, App Engine's two keys are the module ID and the version ID. Following is the effect of using various values for `indexPrefix`: + `\"/Mod/\"` retrieves `/Mod/10` and `/Mod/11` but not `/ModA/10`. + `\"/Mod` retrieves `/Mod/10`, `/Mod/11` and `/ModA/10` but not `/XXX/33`. + `\"/Mod/1\"` retrieves `/Mod/10` and `/Mod/11` but not `/ModA/10`. + `\"/Mod/10/\"` retrieves `/Mod/10` only. + An empty prefix or `\"/\"` retrieves all values.", - "location": "query" - }, - "depth": { - "type": "integer", - "description": "A non-negative integer that limits the number of levels of the index hierarchy that are returned. If `depth` is 1 (default), only the first index key value is returned. If `depth` is 2, both primary and secondary key values are returned. If `depth` is 0, the depth is the number of slash-separators in the `indexPrefix` field, not counting a slash appearing as the last character of the prefix. If the `indexPrefix` field is empty, the default depth is 1. It is an error for `depth` to be any positive value less than the number of components in `indexPrefix`.", - "format": "int32", - "location": "query" - }, - "pageSize": { - "type": "integer", - "description": "The maximum number of log service index resources to return in one operation.", - "format": "int32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "An opaque token, returned as `nextPageToken` by a prior `ListLogServiceIndexes` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogServiceIndexes` operation is continued.", - "location": "query" - } - }, - "parameterOrder": [ - "projectsId", - "logServicesId" - ], - "response": { - "$ref": "ListLogServiceIndexesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - } - } - }, - "sinks": { - "methods": { - "list": { - "id": "logging.projects.logServices.sinks.list", - "path": "v1beta3/projects/{projectsId}/logServices/{logServicesId}/sinks", - "httpMethod": "GET", - "description": "Lists log service sinks associated with a log service.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `serviceName`. The log service whose sinks are wanted.", - "required": true, - "location": "path" - }, - "logServicesId": { - "type": "string", - "description": "Part of `serviceName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logServicesId" - ], - "response": { - "$ref": "ListLogServiceSinksResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - }, - "get": { - "id": "logging.projects.logServices.sinks.get", - "path": "v1beta3/projects/{projectsId}/logServices/{logServicesId}/sinks/{sinksId}", - "httpMethod": "GET", - "description": "Gets a log service sink.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `sinkName`. The resource name of the log service sink to return.", - "required": true, - "location": "path" - }, - "logServicesId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - }, - "sinksId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logServicesId", - "sinksId" - ], - "response": { - "$ref": "LogSink" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - }, - "create": { - "id": "logging.projects.logServices.sinks.create", - "path": "v1beta3/projects/{projectsId}/logServices/{logServicesId}/sinks", - "httpMethod": "POST", - "description": "Creates a log service sink. All log entries from a specified log service are written to the destination.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `serviceName`. The resource name of the log service to which the sink is bound.", - "required": true, - "location": "path" - }, - "logServicesId": { - "type": "string", - "description": "Part of `serviceName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logServicesId" - ], - "request": { - "$ref": "LogSink" - }, - "response": { - "$ref": "LogSink" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - }, - "update": { - "id": "logging.projects.logServices.sinks.update", - "path": "v1beta3/projects/{projectsId}/logServices/{logServicesId}/sinks/{sinksId}", - "httpMethod": "PUT", - "description": "Updates a log service sink. If the sink does not exist, it is created.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `sinkName`. The resource name of the log service sink to update.", - "required": true, - "location": "path" - }, - "logServicesId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - }, - "sinksId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logServicesId", - "sinksId" - ], - "request": { - "$ref": "LogSink" - }, - "response": { - "$ref": "LogSink" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - }, - "delete": { - "id": "logging.projects.logServices.sinks.delete", - "path": "v1beta3/projects/{projectsId}/logServices/{logServicesId}/sinks/{sinksId}", - "httpMethod": "DELETE", - "description": "Deletes a log service sink. After deletion, no new log entries are written to the destination.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `sinkName`. The resource name of the log service sink to delete.", - "required": true, - "location": "path" - }, - "logServicesId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - }, - "sinksId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "logServicesId", - "sinksId" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - } - } - } - } - }, - "sinks": { - "methods": { - "list": { - "id": "logging.projects.sinks.list", - "path": "v1beta3/projects/{projectsId}/sinks", - "httpMethod": "GET", - "description": "Lists project sinks associated with a project.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `projectName`. The project whose sinks are wanted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId" - ], - "response": { - "$ref": "ListSinksResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - }, - "get": { - "id": "logging.projects.sinks.get", - "path": "v1beta3/projects/{projectsId}/sinks/{sinksId}", - "httpMethod": "GET", - "description": "Gets a project sink.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `sinkName`. The resource name of the project sink to return.", - "required": true, - "location": "path" - }, - "sinksId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "sinksId" - ], - "response": { - "$ref": "LogSink" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - }, - "create": { - "id": "logging.projects.sinks.create", - "path": "v1beta3/projects/{projectsId}/sinks", - "httpMethod": "POST", - "description": "Creates a project sink. A logs filter determines which log entries are written to the destination.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `projectName`. The resource name of the project to which the sink is bound.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId" - ], - "request": { - "$ref": "LogSink" - }, - "response": { - "$ref": "LogSink" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - }, - "update": { - "id": "logging.projects.sinks.update", - "path": "v1beta3/projects/{projectsId}/sinks/{sinksId}", - "httpMethod": "PUT", - "description": "Updates a project sink. If the sink does not exist, it is created. The destination, filter, or both may be updated.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `sinkName`. The resource name of the project sink to update.", - "required": true, - "location": "path" - }, - "sinksId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "sinksId" - ], - "request": { - "$ref": "LogSink" - }, - "response": { - "$ref": "LogSink" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - }, - "delete": { - "id": "logging.projects.sinks.delete", - "path": "v1beta3/projects/{projectsId}/sinks/{sinksId}", - "httpMethod": "DELETE", - "description": "Deletes a project sink. After deletion, no new log entries are written to the destination.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `sinkName`. The resource name of the project sink to delete.", - "required": true, - "location": "path" - }, - "sinksId": { - "type": "string", - "description": "Part of `sinkName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "sinksId" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - } - } - }, - "metrics": { - "methods": { - "list": { - "id": "logging.projects.metrics.list", - "path": "v1beta3/projects/{projectsId}/metrics", - "httpMethod": "GET", - "description": "List log metrics associated with the specified project.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `projectName`. The resource name for the project whose metrics are wanted.", - "required": true, - "location": "path" - }, - "pageToken": { - "type": "string", - "description": "An opaque token, returned as `nextPageToken` by a prior `ListLogMetrics` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogMetrics` operation is continued.", - "location": "query" - }, - "pageSize": { - "type": "integer", - "description": "The maximum number of `LogMetric` objects to return in one operation.", - "format": "int32", - "location": "query" - } - }, - "parameterOrder": [ - "projectsId" - ], - "response": { - "$ref": "ListLogMetricsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - }, - "get": { - "id": "logging.projects.metrics.get", - "path": "v1beta3/projects/{projectsId}/metrics/{metricsId}", - "httpMethod": "GET", - "description": "Get the specified log metric resource.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `metricName`. The resource name of the desired metric.", - "required": true, - "location": "path" - }, - "metricsId": { - "type": "string", - "description": "Part of `metricName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "metricsId" - ], - "response": { - "$ref": "LogMetric" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ] - }, - "create": { - "id": "logging.projects.metrics.create", - "path": "v1beta3/projects/{projectsId}/metrics", - "httpMethod": "POST", - "description": "Create the specified log metric resource.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `projectName`. The resource name of the project in which to create the metric.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId" - ], - "request": { - "$ref": "LogMetric" - }, - "response": { - "$ref": "LogMetric" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - }, - "update": { - "id": "logging.projects.metrics.update", - "path": "v1beta3/projects/{projectsId}/metrics/{metricsId}", - "httpMethod": "PUT", - "description": "Create or update the specified log metric resource.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `metricName`. The resource name of the metric to update.", - "required": true, - "location": "path" - }, - "metricsId": { - "type": "string", - "description": "Part of `metricName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "metricsId" - ], - "request": { - "$ref": "LogMetric" - }, - "response": { - "$ref": "LogMetric" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - }, - "delete": { - "id": "logging.projects.metrics.delete", - "path": "v1beta3/projects/{projectsId}/metrics/{metricsId}", - "httpMethod": "DELETE", - "description": "Deletes the specified log metric.", - "parameters": { - "projectsId": { - "type": "string", - "description": "Part of `metricName`. The resource name of the metric to delete.", - "required": true, - "location": "path" - }, - "metricsId": { - "type": "string", - "description": "Part of `metricName`. See documentation of `projectsId`.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectsId", - "metricsId" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] - } - } - } - } - } - } -} diff --git a/etc/api/manager/v1beta2/manager-api.json b/etc/api/manager/v1beta2/manager-api.json index 7830957ba4..b770df78c2 100644 --- a/etc/api/manager/v1beta2/manager-api.json +++ b/etc/api/manager/v1beta2/manager-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/0hdZNaD3e39rRIfommkGgaxUovo\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/nOALRz0E4Hp0xgTBfcCk7nuPZ4A\"", "discoveryVersion": "v1", "id": "manager:v1beta2", "name": "manager", diff --git a/etc/api/mapsengine/exp2/mapsengine-api.json b/etc/api/mapsengine/exp2/mapsengine-api.json deleted file mode 100644 index eace8fc91d..0000000000 --- a/etc/api/mapsengine/exp2/mapsengine-api.json +++ /dev/null @@ -1,5375 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/e5pX7j8DrCgbvJVxikS82XVUB4c\"", - "discoveryVersion": "v1", - "id": "mapsengine:exp2", - "name": "mapsengine", - "canonicalName": "Maps Engine", - "version": "exp2", - "revision": "20151202", - "title": "Google Maps Engine API", - "description": "The Google Maps Engine API allows developers to store and query geospatial vector and raster data.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "https://www.google.com/images/icons/product/maps_engine-16.png", - "x32": "https://www.google.com/images/icons/product/maps_engine-32.png" - }, - "documentationLink": "https://developers.google.com/maps-engine/", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/mapsengine/exp2/", - "basePath": "/mapsengine/exp2/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "mapsengine/exp2/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/mapsengine": { - "description": "View and manage your Google My Maps data" - }, - "https://www.googleapis.com/auth/mapsengine.readonly": { - "description": "View your Google My Maps data" - } - } - } - }, - "schemas": { - "AcquisitionTime": { - "id": "AcquisitionTime", - "type": "object", - "description": "Acquisition time represents acquired time of a raster.", - "properties": { - "end": { - "type": "string", - "description": "The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "precision": { - "type": "string", - "description": "The precision of acquisition time.", - "enum": [ - "day", - "hour", - "minute", - "month", - "second", - "year" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" - ] - }, - "start": { - "type": "string", - "description": "The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).", - "format": "date-time" - } - } - }, - "Asset": { - "id": "Asset", - "type": "object", - "description": "An asset is any Google Maps Engine resource that has a globally unique ID. Assets include maps, layers, vector tables, raster collections, and rasters. Projects and features are not considered assets.\n\nMore detailed information about an asset can be obtained by querying the asset's particular endpoint.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this asset. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this asset. This is only returned on GET requests and not LIST requests." - }, - "description": { - "type": "string", - "description": "The asset's description." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "id": { - "type": "string", - "description": "The asset's globally unique ID." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this asset. This is only returned on GET requests and not LIST requests." - }, - "name": { - "type": "string", - "description": "The asset's name." - }, - "projectId": { - "type": "string", - "description": "The ID of the project to which the asset belongs." - }, - "resource": { - "type": "string", - "description": "The URL to query to retrieve the asset's complete object. The assets endpoint only returns high-level information about a resource." - }, - "tags": { - "type": "array", - "description": "An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "description": "The type of asset. One of raster, rasterCollection, table, map, or layer.", - "enum": [ - "layer", - "map", - "raster", - "rasterCollection", - "table" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "AssetsListResponse": { - "id": "AssetsListResponse", - "type": "object", - "description": "The response returned by a call to resources.List.", - "properties": { - "assets": { - "type": "array", - "description": "Assets returned.", - "items": { - "$ref": "Asset" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "Border": { - "id": "Border", - "type": "object", - "description": "Border in line style. Both color and width are required.", - "properties": { - "color": { - "type": "string", - "description": "Color of the border.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "opacity": { - "type": "number", - "description": "Opacity of the border.", - "format": "double" - }, - "width": { - "type": "number", - "description": "Width of the border, in pixels.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "Color": { - "id": "Color", - "type": "object", - "description": "Basic color used in styling.", - "properties": { - "color": { - "type": "string", - "description": "The CSS style color, can be in format of \"red\" or \"#7733EE\".", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "opacity": { - "type": "number", - "description": "Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.", - "format": "double" - } - } - }, - "Datasource": { - "id": "Datasource", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of a datasource." - } - } - }, - "Datasources": { - "id": "Datasources", - "type": "array", - "items": { - "$ref": "Datasource" - } - }, - "DisplayRule": { - "id": "DisplayRule", - "type": "object", - "description": "A display rule of the vector style.", - "properties": { - "filters": { - "type": "array", - "description": "This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.", - "items": { - "$ref": "Filter" - } - }, - "lineOptions": { - "$ref": "LineStyle", - "description": "Style applied to lines. Required for LineString Geometry." - }, - "name": { - "type": "string", - "description": "Display rule name. Name is not unique and cannot be used for identification purpose." - }, - "pointOptions": { - "$ref": "PointStyle", - "description": "Style applied to points. Required for Point Geometry." - }, - "polygonOptions": { - "$ref": "PolygonStyle", - "description": "Style applied to polygons. Required for Polygon Geometry." - }, - "zoomLevels": { - "$ref": "ZoomLevels", - "description": "The zoom levels that this display rule apply.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "Feature": { - "id": "Feature", - "type": "object", - "description": "A feature within a table.", - "properties": { - "geometry": { - "$ref": "GeoJsonGeometry", - "description": "The geometry member of this Feature." - }, - "properties": { - "$ref": "GeoJsonProperties", - "description": "Key/value pairs of this Feature." - }, - "type": { - "type": "string", - "description": "Identifies this object as a feature.", - "default": "Feature" - } - } - }, - "FeatureInfo": { - "id": "FeatureInfo", - "type": "object", - "description": "A feature info contains information about individual feature.", - "properties": { - "content": { - "type": "string", - "description": "HTML template of the info window. If not provided, a default template with all attributes will be generated." - } - } - }, - "FeaturesBatchDeleteRequest": { - "id": "FeaturesBatchDeleteRequest", - "type": "object", - "description": "The request sent to features.BatchDelete.", - "properties": { - "gx_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "primaryKeys": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "FeaturesBatchInsertRequest": { - "id": "FeaturesBatchInsertRequest", - "type": "object", - "description": "The request sent to features.Insert.", - "properties": { - "features": { - "type": "array", - "items": { - "$ref": "Feature" - } - }, - "normalizeGeometries": { - "type": "boolean", - "description": "If true, the server will normalize feature geometries. It is assumed that the South Pole is exterior to any polygons given. See here for a list of normalizations. If false, all feature geometries must be given already normalized. The points in all LinearRings must be listed in counter-clockwise order, and LinearRings may not intersect.", - "default": "true" - } - } - }, - "FeaturesBatchPatchRequest": { - "id": "FeaturesBatchPatchRequest", - "type": "object", - "description": "The request sent to features.BatchPatch.", - "properties": { - "features": { - "type": "array", - "items": { - "$ref": "Feature" - } - }, - "normalizeGeometries": { - "type": "boolean", - "description": "If true, the server will normalize feature geometries. It is assumed that the South Pole is exterior to any polygons given. See here for a list of normalizations. If false, all feature geometries must be given already normalized. The points in all LinearRings must be listed in counter-clockwise order, and LinearRings may not intersect.", - "default": "true" - } - } - }, - "FeaturesListResponse": { - "id": "FeaturesListResponse", - "type": "object", - "description": "The response returned by a call to features.List.", - "properties": { - "allowedQueriesPerSecond": { - "type": "number", - "description": "An indicator of the maximum rate at which queries may be made, if all queries were as expensive as this query.", - "format": "double" - }, - "features": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Feature" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token." - }, - "schema": { - "$ref": "Schema", - "description": "The feature schema." - }, - "type": { - "type": "string", - "default": "FeatureCollection" - } - } - }, - "File": { - "id": "File", - "type": "object", - "description": "A single File, which is a component of an Asset.", - "properties": { - "filename": { - "type": "string", - "description": "The name of the file.", - "annotations": { - "required": [ - "mapsengine.rasters.upload", - "mapsengine.tables.upload" - ] - } - }, - "size": { - "type": "string", - "description": "The size of the file in bytes.", - "format": "int64" - }, - "uploadStatus": { - "type": "string", - "description": "The upload status of the file.", - "enum": [ - "canceled", - "complete", - "failed", - "inProgress" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ] - } - } - }, - "Filter": { - "id": "Filter", - "type": "object", - "description": "Conditions for filtering features.", - "properties": { - "column": { - "type": "string", - "description": "The column name to filter on.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "operator": { - "type": "string", - "description": "Operation used to evaluate the filter.", - "enum": [ - "!=", - "\u003c", - "\u003c=", - "==", - "\u003e", - "\u003e=", - "contains", - "endsWith", - "startsWith" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "value": { - "type": "any", - "description": "Value to be evaluated against attribute.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "GeoJsonGeometry": { - "id": "GeoJsonGeometry", - "type": "object", - "variant": { - "discriminant": "type", - "map": [ - { - "type_value": "GeometryCollection", - "$ref": "GeoJsonGeometryCollection" - }, - { - "type_value": "LineString", - "$ref": "GeoJsonLineString" - }, - { - "type_value": "MultiLineString", - "$ref": "GeoJsonMultiLineString" - }, - { - "type_value": "MultiPoint", - "$ref": "GeoJsonMultiPoint" - }, - { - "type_value": "MultiPolygon", - "$ref": "GeoJsonMultiPolygon" - }, - { - "type_value": "Point", - "$ref": "GeoJsonPoint" - }, - { - "type_value": "Polygon", - "$ref": "GeoJsonPolygon" - } - ] - } - }, - "GeoJsonGeometryCollection": { - "id": "GeoJsonGeometryCollection", - "type": "object", - "description": "A heterogenous collection of GeoJsonGeometry objects.", - "properties": { - "geometries": { - "type": "array", - "description": "An array of geometry objects. There must be at least 2 different types of geometries in the array.", - "items": { - "$ref": "GeoJsonGeometry" - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonGeometryCollection.", - "enum": [ - "GeometryCollection" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonLineString": { - "id": "GeoJsonLineString", - "type": "object", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of two or more positions, representing a line.", - "items": { - "$ref": "GeoJsonPosition" - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonLineString.", - "enum": [ - "LineString" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonMultiLineString": { - "id": "GeoJsonMultiLineString", - "type": "object", - "description": "Multi Line String", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of at least two GeoJsonLineString coordinate arrays.", - "items": { - "type": "array", - "items": { - "$ref": "GeoJsonPosition" - } - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonMultiLineString.", - "enum": [ - "MultiLineString" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonMultiPoint": { - "id": "GeoJsonMultiPoint", - "type": "object", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of at least two GeoJsonPoint coordinate arrays.", - "items": { - "$ref": "GeoJsonPosition" - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonMultiPoint.", - "enum": [ - "MultiPoint" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonMultiPolygon": { - "id": "GeoJsonMultiPolygon", - "type": "object", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of at least two GeoJsonPolygon coordinate arrays.", - "items": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "GeoJsonPosition" - } - } - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonMultiPolygon.", - "enum": [ - "MultiPolygon" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonPoint": { - "id": "GeoJsonPoint", - "type": "object", - "properties": { - "coordinates": { - "$ref": "GeoJsonPosition", - "description": "A single GeoJsonPosition, specifying the location of the point." - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonPoint.", - "enum": [ - "Point" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonPolygon": { - "id": "GeoJsonPolygon", - "type": "object", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of LinearRings. A LinearRing is a GeoJsonLineString which is closed (that is, the first and last GeoJsonPositions are equal), and which contains at least four GeoJsonPositions. For polygons with multiple rings, the first LinearRing is the exterior ring, and any subsequent rings are interior rings (that is, holes).", - "items": { - "type": "array", - "items": { - "$ref": "GeoJsonPosition" - } - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonPolygon.", - "enum": [ - "Polygon" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonPosition": { - "id": "GeoJsonPosition", - "type": "array", - "description": "A position represents a geographical position as an array containing a longitude and a latitude, and optionally an altitude, in that order. All Geometry objects make use of positions to represent geometries as nested arrays. The structure of the array is governed by the type of the geometry.", - "items": { - "type": "number", - "format": "double" - } - }, - "GeoJsonProperties": { - "id": "GeoJsonProperties", - "type": "object", - "description": "The properties associated with a feature.", - "additionalProperties": { - "type": "any", - "description": "An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema." - } - }, - "Icon": { - "id": "Icon", - "type": "object", - "description": "An icon is a user-uploaded image that can be used to style point geometries.", - "properties": { - "description": { - "type": "string", - "description": "The description of this Icon, supplied by the author." - }, - "id": { - "type": "string", - "description": "An ID used to refer to this Icon." - }, - "name": { - "type": "string", - "description": "The name of this Icon, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.projects.icons.create" - ] - } - } - } - }, - "IconStyle": { - "id": "IconStyle", - "type": "object", - "description": "Style for icon, this is part of point style.", - "properties": { - "id": { - "type": "string", - "description": "Custom icon id." - }, - "name": { - "type": "string", - "description": "Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'." - }, - "scaledShape": { - "$ref": "ScaledShape", - "description": "A scalable shape." - }, - "scalingFunction": { - "$ref": "ScalingFunction", - "description": "The function used to scale shapes. Required when a scaledShape is specified." - } - } - }, - "IconsListResponse": { - "id": "IconsListResponse", - "type": "object", - "description": "The response returned by a call to icons.List.", - "properties": { - "icons": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Icon" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token." - } - } - }, - "LabelStyle": { - "id": "LabelStyle", - "type": "object", - "description": "Text label style.", - "properties": { - "color": { - "type": "string", - "description": "Color of the text. If not provided, default to black." - }, - "column": { - "type": "string", - "description": "The column value of the feature to be displayed.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "fontStyle": { - "type": "string", - "description": "Font style of the label, defaults to 'normal'.", - "enum": [ - "italic", - "normal" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "fontWeight": { - "type": "string", - "description": "Font weight of the label, defaults to 'normal'.", - "enum": [ - "bold", - "normal" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "opacity": { - "type": "number", - "description": "Opacity of the text.", - "format": "double" - }, - "outline": { - "$ref": "Color", - "description": "Outline color of the text." - }, - "size": { - "type": "number", - "description": "Font size of the label, in pixels. 8 \u003c= size \u003c= 15. If not provided, a default size will be provided.", - "format": "double" - } - } - }, - "LatLngBox": { - "id": "LatLngBox", - "type": "array", - "description": "A rectangular geographic bounds.", - "items": { - "type": "number", - "format": "double" - } - }, - "Layer": { - "id": "Layer", - "type": "object", - "description": "A Layer combines multiple datasources, with styling information, for presentation on a map.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this layer. This is only returned on GET requests and not LIST requests." - }, - "datasourceType": { - "type": "string", - "description": "Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.", - "enum": [ - "image", - "table" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "datasources": { - "$ref": "Datasources", - "description": "An array of datasources used to build this layer. If layerType is \"image\", or layerType is not specified and datasourceType is \"image\", then each element in this array is a reference to an Image or RasterCollection. If layerType is \"vector\", or layerType is not specified and datasourceType is \"table\" then each element in this array is a reference to a Vector Table. Note: Datasources are returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the datasources for each layer." - }, - "description": { - "type": "string", - "description": "The description of this Layer, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Layer." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests." - }, - "layerType": { - "type": "string", - "description": "The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.", - "enum": [ - "image", - "vector" - ], - "enumDescriptions": [ - "", - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.create" - ] - } - }, - "name": { - "type": "string", - "description": "The name of this Layer, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.layers.create" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this layer.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Layer is in.", - "annotations": { - "required": [ - "mapsengine.layers.create" - ] - } - }, - "publishedAccessList": { - "type": "string", - "description": "Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "publishingStatus": { - "type": "string", - "description": "The publishing status of this layer.", - "enum": [ - "notPublished", - "published" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "style": { - "$ref": "VectorStyle", - "description": "The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer." - }, - "tags": { - "$ref": "Tags", - "description": "Tags of this Layer." - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "LayersListResponse": { - "id": "LayersListResponse", - "type": "object", - "description": "The response returned by a call to layers.List. Note: The list response does not include all the fields available in a layer. Refer to the layer resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each layer.", - "properties": { - "layers": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Layer" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "LineStyle": { - "id": "LineStyle", - "type": "object", - "description": "Style for lines.", - "properties": { - "border": { - "$ref": "Border", - "description": "Border of the line. 0 \u003c border.width \u003c= 5." - }, - "dash": { - "type": "array", - "description": "Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.", - "items": { - "type": "number", - "format": "double" - } - }, - "label": { - "$ref": "LabelStyle", - "description": "Label style for the line." - }, - "stroke": { - "type": "object", - "description": "Stroke of the line.", - "properties": { - "color": { - "type": "string", - "description": "Color of the line.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "opacity": { - "type": "number", - "description": "Opacity of the line.", - "format": "double" - }, - "width": { - "type": "number", - "description": "Width of the line, in pixels. 0 \u003c= width \u003c= 10. If width is set to 0, the line will be invisible.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - } - } - }, - "Map": { - "id": "Map", - "type": "object", - "description": "A Map is a collection of Layers, optionally contained within folders.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Map. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "contents": { - "$ref": "MapContents", - "description": "The contents of this Map." - }, - "creationTime": { - "type": "string", - "description": "The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this map. This is only returned on GET requests and not LIST requests." - }, - "defaultViewport": { - "$ref": "LatLngBox", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees." - }, - "description": { - "type": "string", - "description": "The description of this Map, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Map." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests." - }, - "name": { - "type": "string", - "description": "The name of this Map, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.maps.create" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this map. Map processing is automatically started once a map becomes ready for processing.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Map is in.", - "annotations": { - "required": [ - "mapsengine.maps.create" - ] - } - }, - "publishedAccessList": { - "type": "string", - "description": "Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. This is an input field only. It is not returned in response to a list or get request." - }, - "publishingStatus": { - "type": "string", - "description": "The publishing status of this map.", - "enum": [ - "notPublished", - "published" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "tags": { - "$ref": "Tags", - "description": "Tags of this Map." - }, - "versions": { - "type": "array", - "description": "Deprecated: An array containing the available versions of this Map. Currently may only contain \"published\". The publishingStatus field should be used instead.", - "items": { - "type": "string", - "default": "published" - } - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "MapContents": { - "id": "MapContents", - "type": "array", - "items": { - "$ref": "MapItem" - } - }, - "MapFolder": { - "id": "MapFolder", - "type": "object", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "MapItem" - } - }, - "defaultViewport": { - "type": "array", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "expandable": { - "type": "boolean", - "description": "The expandability setting of this MapFolder. If true, the folder can be expanded." - }, - "key": { - "type": "string", - "description": "A user defined alias for this MapFolder, specific to this Map." - }, - "name": { - "type": "string", - "description": "The name of this MapFolder.", - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a MapFolder.", - "enum": [ - "folder" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "visibility": { - "type": "string", - "description": "The visibility setting of this MapFolder. One of \"defaultOn\" or \"defaultOff\"." - } - } - }, - "MapItem": { - "id": "MapItem", - "type": "object", - "variant": { - "discriminant": "type", - "map": [ - { - "type_value": "folder", - "$ref": "MapFolder" - }, - { - "type_value": "kmlLink", - "$ref": "MapKmlLink" - }, - { - "type_value": "layer", - "$ref": "MapLayer" - } - ] - } - }, - "MapKmlLink": { - "id": "MapKmlLink", - "type": "object", - "properties": { - "defaultViewport": { - "type": "array", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "kmlUrl": { - "type": "string", - "description": "The URL to the KML file represented by this MapKmlLink.", - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "name": { - "type": "string", - "description": "The name of this MapKmlLink.", - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a MapKmlLink.", - "enum": [ - "kmlLink" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "visibility": { - "type": "string", - "description": "The visibility setting of this MapKmlLink. One of \"defaultOn\" or \"defaultOff\"." - } - } - }, - "MapLayer": { - "id": "MapLayer", - "type": "object", - "properties": { - "defaultViewport": { - "type": "array", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "id": { - "type": "string", - "description": "The ID of this MapLayer. This ID can be used to request more details about the layer.", - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "key": { - "type": "string", - "description": "A user defined alias for this MapLayer, specific to this Map." - }, - "name": { - "type": "string", - "description": "The name of this MapLayer." - }, - "type": { - "type": "string", - "description": "Identifies this object as a MapLayer.", - "enum": [ - "layer" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "visibility": { - "type": "string", - "description": "The visibility setting of this MapLayer. One of \"defaultOn\" or \"defaultOff\"." - } - } - }, - "MapsListResponse": { - "id": "MapsListResponse", - "type": "object", - "description": "The response returned by a call to maps.List.", - "properties": { - "maps": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Map" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "Parent": { - "id": "Parent", - "type": "object", - "description": "A list of the parents of an asset.", - "properties": { - "id": { - "type": "string", - "description": "The ID of this parent." - } - } - }, - "ParentsListResponse": { - "id": "ParentsListResponse", - "type": "object", - "description": "The response returned by a call to parents.List.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token." - }, - "parents": { - "type": "array", - "description": "The parent assets.", - "items": { - "$ref": "Parent" - } - } - } - }, - "Permission": { - "id": "Permission", - "type": "object", - "description": "A permission defines the user or group that has access to an asset, and the type of access they have.", - "properties": { - "discoverable": { - "type": "boolean", - "description": "Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false)." - }, - "id": { - "type": "string", - "description": "The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string \"anyone\" for public permissions.", - "annotations": { - "required": [ - "mapsengine.layers.permissions.batchUpdate", - "mapsengine.maps.permissions.batchUpdate", - "mapsengine.rasterCollections.permissions.batchUpdate", - "mapsengine.tables.permissions.batchUpdate" - ] - } - }, - "role": { - "type": "string", - "description": "The type of access granted to this user or group.", - "enum": [ - "owner", - "reader", - "viewer", - "writer" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.permissions.batchUpdate", - "mapsengine.maps.permissions.batchUpdate", - "mapsengine.rasterCollections.permissions.batchUpdate", - "mapsengine.tables.permissions.batchUpdate" - ] - } - }, - "type": { - "type": "string", - "description": "The account type.", - "enum": [ - "anyone", - "group", - "user" - ], - "enumDescriptions": [ - "", - "", - "" - ] - } - } - }, - "PermissionsBatchDeleteRequest": { - "id": "PermissionsBatchDeleteRequest", - "type": "object", - "description": "The request sent to mapsengine.permissions.batchDelete.", - "properties": { - "ids": { - "type": "array", - "description": "An array of permission ids to be removed. This could be the email address of the user or group this permission refers to, or the string \"anyone\" for public permissions.", - "items": { - "type": "string" - }, - "annotations": { - "required": [ - "mapsengine.layers.permissions.batchDelete", - "mapsengine.maps.permissions.batchDelete", - "mapsengine.rasterCollections.permissions.batchDelete", - "mapsengine.tables.permissions.batchDelete" - ] - } - } - } - }, - "PermissionsBatchDeleteResponse": { - "id": "PermissionsBatchDeleteResponse", - "type": "object", - "description": "The response returned by a call to mapsengine.permissions.batchDelete." - }, - "PermissionsBatchUpdateRequest": { - "id": "PermissionsBatchUpdateRequest", - "type": "object", - "description": "The request sent to mapsengine.permissions.batchUpdate.", - "properties": { - "permissions": { - "type": "array", - "description": "The permissions to be inserted or updated.", - "items": { - "$ref": "Permission" - }, - "annotations": { - "required": [ - "mapsengine.layers.permissions.batchUpdate", - "mapsengine.maps.permissions.batchUpdate", - "mapsengine.rasterCollections.permissions.batchUpdate", - "mapsengine.tables.permissions.batchUpdate" - ] - } - } - } - }, - "PermissionsBatchUpdateResponse": { - "id": "PermissionsBatchUpdateResponse", - "type": "object", - "description": "The response returned by a call to mapsengine.permissions.batchUpdate." - }, - "PermissionsListResponse": { - "id": "PermissionsListResponse", - "type": "object", - "properties": { - "permissions": { - "type": "array", - "description": "The set of permissions associated with this asset.", - "items": { - "$ref": "Permission" - } - } - } - }, - "PointStyle": { - "id": "PointStyle", - "type": "object", - "description": "Style for points.", - "properties": { - "icon": { - "$ref": "IconStyle", - "description": "Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "label": { - "$ref": "LabelStyle", - "description": "Label style for the point." - } - } - }, - "PolygonStyle": { - "id": "PolygonStyle", - "type": "object", - "description": "Style for polygons.", - "properties": { - "fill": { - "$ref": "Color", - "description": "Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border." - }, - "label": { - "$ref": "LabelStyle", - "description": "Label style for the polygon." - }, - "stroke": { - "$ref": "Border", - "description": "Border of the polygon. 0 \u003c border.width \u003c= 10." - } - } - }, - "ProcessResponse": { - "id": "ProcessResponse", - "type": "object", - "description": "The response returned by a call to any asset's Process method." - }, - "Project": { - "id": "Project", - "type": "object", - "description": "A project groups a collection of resources.", - "properties": { - "id": { - "type": "string", - "description": "An ID used to refer to this project." - }, - "name": { - "type": "string", - "description": "A user provided name for this project." - } - } - }, - "ProjectsListResponse": { - "id": "ProjectsListResponse", - "type": "object", - "description": "The response returned by a call to projects.List.", - "properties": { - "projects": { - "type": "array", - "description": "Projects returned.", - "items": { - "$ref": "Project" - } - } - } - }, - "PublishResponse": { - "id": "PublishResponse", - "type": "object", - "description": "The response returned by a call to any asset's Publish method." - }, - "PublishedLayer": { - "id": "PublishedLayer", - "type": "object", - "description": "The published version of a layer.", - "properties": { - "description": { - "type": "string", - "description": "The description of this Layer, supplied by the author." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Layer." - }, - "layerType": { - "type": "string", - "description": "The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.", - "enum": [ - "image", - "vector" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "name": { - "type": "string", - "description": "The name of this Layer, supplied by the author." - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Layer is in." - } - } - }, - "PublishedLayersListResponse": { - "id": "PublishedLayersListResponse", - "type": "object", - "description": "The response returned by a call to layers.List.published.", - "properties": { - "layers": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "PublishedLayer" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "PublishedMap": { - "id": "PublishedMap", - "type": "object", - "description": "The published version of a map asset.", - "properties": { - "contents": { - "$ref": "MapContents", - "description": "The contents of this Map." - }, - "defaultViewport": { - "$ref": "LatLngBox", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees." - }, - "description": { - "type": "string", - "description": "The description of this Map, supplied by the author." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Map." - }, - "name": { - "type": "string", - "description": "The name of this Map, supplied by the author." - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Map is in." - } - } - }, - "PublishedMapsListResponse": { - "id": "PublishedMapsListResponse", - "type": "object", - "description": "The response returned by a call to maps.List.published.", - "properties": { - "maps": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "PublishedMap" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "Raster": { - "id": "Raster", - "type": "object", - "description": "A geo-referenced raster.", - "properties": { - "acquisitionTime": { - "$ref": "AcquisitionTime", - "description": "The acquisition time of this Raster." - }, - "attribution": { - "type": "string", - "description": "The name of the attribution to be used for this Raster." - }, - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitudes and longitudes in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this raster. This is only returned on GET requests and not LIST requests." - }, - "description": { - "type": "string", - "description": "The description of this Raster, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "files": { - "type": "array", - "description": "The files associated with this Raster.", - "items": { - "$ref": "File" - }, - "annotations": { - "required": [ - "mapsengine.rasters.upload" - ] - } - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Raster." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests." - }, - "maskType": { - "type": "string", - "description": "The mask processing type of this Raster.", - "default": "autoMask" - }, - "name": { - "type": "string", - "description": "The name of this Raster, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.rasters.upload" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this Raster.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Raster is in.", - "annotations": { - "required": [ - "mapsengine.rasters.upload" - ] - } - }, - "rasterType": { - "type": "string", - "description": "The type of this Raster. Always \"image\" today.", - "enum": [ - "image" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.rasters.upload" - ] - } - }, - "tags": { - "$ref": "Tags", - "description": "Tags of this Raster." - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "RasterCollection": { - "id": "RasterCollection", - "type": "object", - "description": "A raster collection groups multiple Raster resources for inclusion in a Layer.", - "properties": { - "attribution": { - "type": "string", - "description": "The name of the attribution to be used for this RasterCollection. Note: Attribution is returned in response to a get request but not a list request. After requesting a list of raster collections, you'll need to send a get request to retrieve the attribution for each raster collection." - }, - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this RasterCollection. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this raster collection. This is only returned on GET requests and not LIST requests." - }, - "description": { - "type": "string", - "description": "The description of this RasterCollection, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this RasterCollection." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this raster collection. This is only returned on GET requests and not LIST requests." - }, - "mosaic": { - "type": "boolean", - "description": "True if this RasterCollection is a mosaic.", - "annotations": { - "required": [ - "mapsengine.rasterCollections.create" - ] - } - }, - "name": { - "type": "string", - "description": "The name of this RasterCollection, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.rasterCollections.create" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this RasterCollection.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this RasterCollection is in.", - "annotations": { - "required": [ - "mapsengine.rasterCollections.create" - ] - } - }, - "rasterType": { - "type": "string", - "description": "The type of rasters contained within this RasterCollection.", - "enum": [ - "image" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.rasterCollections.create" - ] - } - }, - "tags": { - "$ref": "Tags", - "description": "Tags of this RasterCollection." - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "RasterCollectionsListResponse": { - "id": "RasterCollectionsListResponse", - "type": "object", - "description": "The response returned by a call to raster_collections.List. Note: The list response does not include all the fields available in a raster collection. Refer to the RasterCollection resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each raster collection.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - }, - "rasterCollections": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "RasterCollection" - } - } - } - }, - "RasterCollectionsRaster": { - "id": "RasterCollectionsRaster", - "type": "object", - "description": "A raster resource.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitudes and longitudes in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "description": { - "type": "string", - "description": "The description of this Raster, supplied by the author." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Raster." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "name": { - "type": "string", - "description": "The name of this Raster, supplied by the author." - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Raster is in." - }, - "rasterType": { - "type": "string", - "description": "The type of this Raster. Always \"image\" today.", - "default": "image" - }, - "tags": { - "type": "array", - "description": "Tags of this Raster.", - "items": { - "type": "string" - } - } - } - }, - "RasterCollectionsRasterBatchDeleteRequest": { - "id": "RasterCollectionsRasterBatchDeleteRequest", - "type": "object", - "description": "The request sent to rasterCollections.Rasters.BatchDelete.", - "properties": { - "ids": { - "type": "array", - "description": "An array of Raster asset IDs to be removed from this RasterCollection.", - "items": { - "type": "string" - } - } - } - }, - "RasterCollectionsRastersBatchDeleteResponse": { - "id": "RasterCollectionsRastersBatchDeleteResponse", - "type": "object", - "description": "The response returned by a call to rasterCollections.rasters.batchDelete." - }, - "RasterCollectionsRastersBatchInsertRequest": { - "id": "RasterCollectionsRastersBatchInsertRequest", - "type": "object", - "description": "The request sent to rasterCollections.Rasters.BatchInsert.", - "properties": { - "ids": { - "type": "array", - "description": "An array of Raster asset IDs to be added to this RasterCollection.", - "items": { - "type": "string" - } - } - } - }, - "RasterCollectionsRastersBatchInsertResponse": { - "id": "RasterCollectionsRastersBatchInsertResponse", - "type": "object", - "description": "The response returned by a call to rasterCollections.rasters.batchInsert." - }, - "RasterCollectionsRastersListResponse": { - "id": "RasterCollectionsRastersListResponse", - "type": "object", - "description": "The response returned by a call to rasterCollections.rasters.List.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token." - }, - "rasters": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "RasterCollectionsRaster" - } - } - } - }, - "RastersListResponse": { - "id": "RastersListResponse", - "type": "object", - "description": "The response returned by a call to rasters.List.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token." - }, - "rasters": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Raster" - } - } - } - }, - "ScaledShape": { - "id": "ScaledShape", - "type": "object", - "description": "Parameters for styling points as scaled shapes.", - "properties": { - "border": { - "$ref": "Border", - "description": "Border color/width of the shape. If not specified the shape won't have a border." - }, - "fill": { - "$ref": "Color", - "description": "The fill color of the shape. If not specified the shape will be transparent (although the borders may not be)." - }, - "shape": { - "type": "string", - "description": "Name of the shape.", - "enum": [ - "circle" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "ScalingFunction": { - "id": "ScalingFunction", - "type": "object", - "description": "Parameters for scaling scaled shapes.", - "properties": { - "column": { - "type": "string", - "description": "Name of the numeric column used to scale a shape.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "scalingType": { - "type": "string", - "description": "The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.", - "enum": [ - "linear", - "sqrt" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "sizeRange": { - "$ref": "SizeRange", - "description": "The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "valueRange": { - "$ref": "ValueRange", - "description": "The range of values to display across the size range.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "Schema": { - "id": "Schema", - "type": "object", - "description": "A schema indicating the properties which may be associated with features within a Table, and the types of those properties.", - "properties": { - "columns": { - "type": "array", - "description": "An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.", - "items": { - "$ref": "TableColumn" - }, - "annotations": { - "required": [ - "mapsengine.tables.create" - ] - } - }, - "primaryGeometry": { - "type": "string", - "description": "The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array." - }, - "primaryKey": { - "type": "string", - "description": "The name of the column that contains the unique identifier of a Feature." - } - } - }, - "SizeRange": { - "id": "SizeRange", - "type": "object", - "description": "Scaled shape size range in pixels. For circles, size corresponds to diameter.", - "properties": { - "max": { - "type": "number", - "description": "Maximum size, in pixels.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "min": { - "type": "number", - "description": "Minimum size, in pixels.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "Table": { - "id": "Table", - "type": "object", - "description": "A collection of geographic features, and associated metadata.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Table. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this table. This is only returned on GET requests and not LIST requests." - }, - "description": { - "type": "string", - "description": "The description of this table, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "files": { - "type": "array", - "description": "The files associated with this table.", - "items": { - "$ref": "File" - }, - "annotations": { - "required": [ - "mapsengine.tables.upload" - ] - } - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this table." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests." - }, - "name": { - "type": "string", - "description": "The name of this table, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.tables.create", - "mapsengine.tables.upload" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this table.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project to which the table belongs.", - "annotations": { - "required": [ - "mapsengine.tables.create", - "mapsengine.tables.upload" - ] - } - }, - "publishedAccessList": { - "type": "string", - "description": "Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "schema": { - "$ref": "Schema", - "description": "The schema for this table. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.", - "annotations": { - "required": [ - "mapsengine.tables.create" - ] - } - }, - "sourceEncoding": { - "type": "string", - "description": "Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.", - "default": "UTF-8" - }, - "tags": { - "$ref": "Tags", - "description": "An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center." - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "TableColumn": { - "id": "TableColumn", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The column name.", - "annotations": { - "required": [ - "mapsengine.tables.create" - ] - } - }, - "type": { - "type": "string", - "description": "The type of data stored in this column.", - "enum": [ - "datetime", - "double", - "integer", - "lineStrings", - "mixedGeometry", - "points", - "polygons", - "string" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "" - ], - "annotations": { - "required": [ - "mapsengine.tables.create" - ] - } - } - } - }, - "TablesListResponse": { - "id": "TablesListResponse", - "type": "object", - "description": "The response returned by a call to tables.List. Note: The list response does not include all the fields available in a table. Refer to the table resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each table.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - }, - "tables": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Table" - } - } - } - }, - "Tags": { - "id": "Tags", - "type": "array", - "items": { - "type": "string" - } - }, - "ValueRange": { - "id": "ValueRange", - "type": "object", - "description": "Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size.", - "properties": { - "max": { - "type": "number", - "description": "Maximum value.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "min": { - "type": "number", - "description": "Minimum value.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "VectorStyle": { - "id": "VectorStyle", - "type": "object", - "description": "A vector style contains styling information for vector layer.", - "properties": { - "displayRules": { - "type": "array", - "items": { - "$ref": "DisplayRule" - } - }, - "featureInfo": { - "$ref": "FeatureInfo", - "description": "Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated." - }, - "type": { - "type": "string", - "description": "The type of the vector style. Currently, only displayRule is supported.", - "enum": [ - "displayRule" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "ZoomLevels": { - "id": "ZoomLevels", - "type": "object", - "description": "Zoom level range. Zoom levels are restricted between 0 and 24, inclusive.", - "properties": { - "max": { - "type": "integer", - "description": "Maximum zoom level.", - "format": "int32", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "min": { - "type": "integer", - "description": "Minimum zoom level.", - "format": "int32", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - } - }, - "resources": { - "assets": { - "methods": { - "get": { - "id": "mapsengine.assets.get", - "path": "assets/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Asset" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.assets.list", - "path": "assets", - "httpMethod": "GET", - "description": "Return all assets readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - }, - "type": { - "type": "string", - "description": "A comma separated list of asset types. Returned assets will have one of the types from the provided list. Supported values are 'map', 'layer', 'rasterCollection' and 'table'.", - "location": "query" - } - }, - "response": { - "$ref": "AssetsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - }, - "resources": { - "parents": { - "methods": { - "list": { - "id": "mapsengine.assets.parents.list", - "path": "assets/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "list": { - "id": "mapsengine.assets.permissions.list", - "path": "assets/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "layers": { - "methods": { - "cancelProcessing": { - "id": "mapsengine.layers.cancelProcessing", - "path": "layers/{id}/cancelProcessing", - "httpMethod": "POST", - "description": "Cancel processing on a layer asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "create": { - "id": "mapsengine.layers.create", - "path": "layers", - "httpMethod": "POST", - "description": "Create a layer asset.", - "parameters": { - "process": { - "type": "boolean", - "description": "Whether to queue the created layer for processing.", - "location": "query" - } - }, - "request": { - "$ref": "Layer" - }, - "response": { - "$ref": "Layer" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "delete": { - "id": "mapsengine.layers.delete", - "path": "layers/{id}", - "httpMethod": "DELETE", - "description": "Delete a layer.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer. Only the layer creator or project owner are permitted to delete. If the layer is published, or included in a map, the request will fail. Unpublish the layer, and remove it from all maps prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.layers.get", - "path": "layers/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular layer.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - }, - "version": { - "type": "string", - "description": "Deprecated: The version parameter indicates which version of the layer should be returned. When version is set to published, the published version of the layer will be returned. Please use the layers.getPublished endpoint instead.", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Layer" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "getPublished": { - "id": "mapsengine.layers.getPublished", - "path": "layers/{id}/published", - "httpMethod": "GET", - "description": "Return the published metadata for a particular layer.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishedLayer" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.layers.list", - "path": "layers", - "httpMethod": "GET", - "description": "Return all layers readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "The layer has completed processing.", - "The layer has failed processing.", - "The layer is not ready for processing.", - "The layer is processing.", - "The layer is ready for processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "response": { - "$ref": "LayersListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "listPublished": { - "id": "mapsengine.layers.listPublished", - "path": "layers/published", - "httpMethod": "GET", - "description": "Return all published layers readable by the current user.", - "parameters": { - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - } - }, - "response": { - "$ref": "PublishedLayersListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.layers.patch", - "path": "layers/{id}", - "httpMethod": "PATCH", - "description": "Mutate a layer asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "Layer" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "process": { - "id": "mapsengine.layers.process", - "path": "layers/{id}/process", - "httpMethod": "POST", - "description": "Process a layer asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "publish": { - "id": "mapsengine.layers.publish", - "path": "layers/{id}/publish", - "httpMethod": "POST", - "description": "Publish a layer asset.", - "parameters": { - "force": { - "type": "boolean", - "description": "If set to true, the API will allow publication of the layer even if it's out of date. If not true, you'll need to reprocess any out-of-date layer before publishing.", - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "unpublish": { - "id": "mapsengine.layers.unpublish", - "path": "layers/{id}/unpublish", - "httpMethod": "POST", - "description": "Unpublish a layer asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "parents": { - "methods": { - "list": { - "id": "mapsengine.layers.parents.list", - "path": "layers/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified layer.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.layers.permissions.batchDelete", - "path": "layers/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.layers.permissions.batchUpdate", - "path": "layers/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.layers.permissions.list", - "path": "layers/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "maps": { - "methods": { - "create": { - "id": "mapsengine.maps.create", - "path": "maps", - "httpMethod": "POST", - "description": "Create a map asset.", - "request": { - "$ref": "Map" - }, - "response": { - "$ref": "Map" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "delete": { - "id": "mapsengine.maps.delete", - "path": "maps/{id}", - "httpMethod": "DELETE", - "description": "Delete a map.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map. Only the map creator or project owner are permitted to delete. If the map is published the request will fail. Unpublish the map prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.maps.get", - "path": "maps/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular map.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - }, - "version": { - "type": "string", - "description": "Deprecated: The version parameter indicates which version of the map should be returned. When version is set to published, the published version of the map will be returned. Please use the maps.getPublished endpoint instead.", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Map" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "getPublished": { - "id": "mapsengine.maps.getPublished", - "path": "maps/{id}/published", - "httpMethod": "GET", - "description": "Return the published metadata for a particular map.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishedMap" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.maps.list", - "path": "maps", - "httpMethod": "GET", - "description": "Return all maps readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing" - ], - "enumDescriptions": [ - "The map has completed processing.", - "The map has failed processing.", - "The map is not ready for processing.", - "The map is processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - }, - "version": { - "type": "string", - "description": "Deprecated: The version parameter indicates which version of the maps should be returned. When version is set to published this parameter will filter the result set to include only maps that are published. Please use the maps.listPublished endpoint instead.", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - } - }, - "response": { - "$ref": "MapsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "listPublished": { - "id": "mapsengine.maps.listPublished", - "path": "maps/published", - "httpMethod": "GET", - "description": "Return all published maps readable by the current user.", - "parameters": { - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - } - }, - "response": { - "$ref": "PublishedMapsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.maps.patch", - "path": "maps/{id}", - "httpMethod": "PATCH", - "description": "Mutate a map asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "Map" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "publish": { - "id": "mapsengine.maps.publish", - "path": "maps/{id}/publish", - "httpMethod": "POST", - "description": "Publish a map asset.", - "parameters": { - "force": { - "type": "boolean", - "description": "If set to true, the API will allow publication of the map even if it's out of date. If false, the map must have a processingStatus of complete before publishing.", - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "unpublish": { - "id": "mapsengine.maps.unpublish", - "path": "maps/{id}/unpublish", - "httpMethod": "POST", - "description": "Unpublish a map asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.maps.permissions.batchDelete", - "path": "maps/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.maps.permissions.batchUpdate", - "path": "maps/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.maps.permissions.list", - "path": "maps/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "projects": { - "methods": { - "list": { - "id": "mapsengine.projects.list", - "path": "projects", - "httpMethod": "GET", - "description": "Return all projects readable by the current user.", - "response": { - "$ref": "ProjectsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - }, - "resources": { - "icons": { - "methods": { - "create": { - "id": "mapsengine.projects.icons.create", - "path": "projects/{projectId}/icons", - "httpMethod": "POST", - "description": "Create an icon.", - "parameters": { - "projectId": { - "type": "string", - "description": "The ID of the project.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "Icon" - }, - "response": { - "$ref": "Icon" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ], - "supportsMediaUpload": true, - "mediaUpload": { - "accept": [ - "*/*" - ], - "maxSize": "100KB", - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/mapsengine/exp2/projects/{projectId}/icons" - }, - "resumable": { - "multipart": true, - "path": "/resumable/upload/mapsengine/exp2/projects/{projectId}/icons" - } - } - } - }, - "get": { - "id": "mapsengine.projects.icons.get", - "path": "projects/{projectId}/icons/{id}", - "httpMethod": "GET", - "description": "Return an icon or its associated metadata", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the icon.", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "description": "The ID of the project.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "id" - ], - "response": { - "$ref": "Icon" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ], - "supportsMediaDownload": true - }, - "list": { - "id": "mapsengine.projects.icons.list", - "path": "projects/{projectId}/icons", - "httpMethod": "GET", - "description": "Return all icons in the current project", - "parameters": { - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of the project.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "IconsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "rasterCollections": { - "methods": { - "cancelProcessing": { - "id": "mapsengine.rasterCollections.cancelProcessing", - "path": "rasterCollections/{id}/cancelProcessing", - "httpMethod": "POST", - "description": "Cancel processing on a raster collection asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "create": { - "id": "mapsengine.rasterCollections.create", - "path": "rasterCollections", - "httpMethod": "POST", - "description": "Create a raster collection asset.", - "request": { - "$ref": "RasterCollection" - }, - "response": { - "$ref": "RasterCollection" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "delete": { - "id": "mapsengine.rasterCollections.delete", - "path": "rasterCollections/{id}", - "httpMethod": "DELETE", - "description": "Delete a raster collection.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection. Only the raster collection creator or project owner are permitted to delete. If the rastor collection is included in a layer, the request will fail. Remove the raster collection from all layers prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.rasterCollections.get", - "path": "rasterCollections/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular raster collection.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "RasterCollection" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.rasterCollections.list", - "path": "rasterCollections", - "httpMethod": "GET", - "description": "Return all raster collections readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "The raster collection has completed processing.", - "The raster collection has failed processing.", - "The raster collection is not ready for processing.", - "The raster collection is processing.", - "The raster collection is ready for processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "response": { - "$ref": "RasterCollectionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.rasterCollections.patch", - "path": "rasterCollections/{id}", - "httpMethod": "PATCH", - "description": "Mutate a raster collection asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "RasterCollection" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "process": { - "id": "mapsengine.rasterCollections.process", - "path": "rasterCollections/{id}/process", - "httpMethod": "POST", - "description": "Process a raster collection asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "parents": { - "methods": { - "list": { - "id": "mapsengine.rasterCollections.parents.list", - "path": "rasterCollections/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified raster collection.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.rasterCollections.permissions.batchDelete", - "path": "rasterCollections/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.rasterCollections.permissions.batchUpdate", - "path": "rasterCollections/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.rasterCollections.permissions.list", - "path": "rasterCollections/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "rasters": { - "methods": { - "batchDelete": { - "id": "mapsengine.rasterCollections.rasters.batchDelete", - "path": "rasterCollections/{id}/rasters/batchDelete", - "httpMethod": "POST", - "description": "Remove rasters from an existing raster collection.\n\nUp to 50 rasters can be included in a single batchDelete request. Each batchDelete request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection to which these rasters belong.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "RasterCollectionsRasterBatchDeleteRequest" - }, - "response": { - "$ref": "RasterCollectionsRastersBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchInsert": { - "id": "mapsengine.rasterCollections.rasters.batchInsert", - "path": "rasterCollections/{id}/rasters/batchInsert", - "httpMethod": "POST", - "description": "Add rasters to an existing raster collection. Rasters must be successfully processed in order to be added to a raster collection.\n\nUp to 50 rasters can be included in a single batchInsert request. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection to which these rasters belong.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "RasterCollectionsRastersBatchInsertRequest" - }, - "response": { - "$ref": "RasterCollectionsRastersBatchInsertResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.rasterCollections.rasters.list", - "path": "rasterCollections/{id}/rasters", - "httpMethod": "GET", - "description": "Return all rasters within a raster collection.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the raster collection to which these rasters belong.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "RasterCollectionsRastersListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "rasters": { - "methods": { - "delete": { - "id": "mapsengine.rasters.delete", - "path": "rasters/{id}", - "httpMethod": "DELETE", - "description": "Delete a raster.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster. Only the raster creator or project owner are permitted to delete. If the raster is included in a layer or mosaic, the request will fail. Remove it from all parents prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.rasters.get", - "path": "rasters/{id}", - "httpMethod": "GET", - "description": "Return metadata for a single raster.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Raster" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.rasters.list", - "path": "rasters", - "httpMethod": "GET", - "description": "Return all rasters readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "The raster has completed processing.", - "The raster has failed processing.", - "The raster is not ready for processing.", - "The raster is processing.", - "The raster is ready for processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "required": true, - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "RastersListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.rasters.patch", - "path": "rasters/{id}", - "httpMethod": "PATCH", - "description": "Mutate a raster asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "Raster" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "process": { - "id": "mapsengine.rasters.process", - "path": "rasters/{id}/process", - "httpMethod": "POST", - "description": "Process a raster asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "upload": { - "id": "mapsengine.rasters.upload", - "path": "rasters/upload", - "httpMethod": "POST", - "description": "Create a skeleton raster asset for upload.", - "request": { - "$ref": "Raster" - }, - "response": { - "$ref": "Raster" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "files": { - "methods": { - "insert": { - "id": "mapsengine.rasters.files.insert", - "path": "rasters/{id}/files", - "httpMethod": "POST", - "description": "Upload a file to a raster asset.", - "parameters": { - "filename": { - "type": "string", - "description": "The file name of this uploaded file.", - "required": true, - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the raster asset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id", - "filename" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ], - "supportsMediaUpload": true, - "mediaUpload": { - "accept": [ - "*/*" - ], - "maxSize": "10GB", - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/mapsengine/exp2/rasters/{id}/files" - }, - "resumable": { - "multipart": true, - "path": "/resumable/upload/mapsengine/exp2/rasters/{id}/files" - } - } - } - } - } - }, - "parents": { - "methods": { - "list": { - "id": "mapsengine.rasters.parents.list", - "path": "rasters/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified rasters.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the rasters whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.rasters.permissions.batchDelete", - "path": "rasters/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.rasters.permissions.batchUpdate", - "path": "rasters/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.rasters.permissions.list", - "path": "rasters/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "tables": { - "methods": { - "create": { - "id": "mapsengine.tables.create", - "path": "tables", - "httpMethod": "POST", - "description": "Create a table asset.", - "request": { - "$ref": "Table" - }, - "response": { - "$ref": "Table" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "delete": { - "id": "mapsengine.tables.delete", - "path": "tables/{id}", - "httpMethod": "DELETE", - "description": "Delete a table.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table. Only the table creator or project owner are permitted to delete. If the table is included in a layer, the request will fail. Remove it from all layers prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.tables.get", - "path": "tables/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular table, including the schema.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table.", - "required": true, - "location": "path" - }, - "version": { - "type": "string", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Table" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.tables.list", - "path": "tables", - "httpMethod": "GET", - "description": "Return all tables readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "The table has completed processing.", - "The table has failed processing.", - "The table is not ready for processing.", - "The table is processing.", - "The table is ready for processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "response": { - "$ref": "TablesListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.tables.patch", - "path": "tables/{id}", - "httpMethod": "PATCH", - "description": "Mutate a table asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "Table" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "process": { - "id": "mapsengine.tables.process", - "path": "tables/{id}/process", - "httpMethod": "POST", - "description": "Process a table asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "upload": { - "id": "mapsengine.tables.upload", - "path": "tables/upload", - "httpMethod": "POST", - "description": "Create a placeholder table asset to which table files can be uploaded.\nOnce the placeholder has been created, files are uploaded to the https://www.googleapis.com/upload/mapsengine/v1/tables/table_id/files endpoint.\nSee Table Upload in the Developer's Guide or Table.files: insert in the reference documentation for more information.", - "request": { - "$ref": "Table" - }, - "response": { - "$ref": "Table" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "features": { - "methods": { - "batchDelete": { - "id": "mapsengine.tables.features.batchDelete", - "path": "tables/{id}/features/batchDelete", - "httpMethod": "POST", - "description": "Delete all features matching the given IDs.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table that contains the features to be deleted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "FeaturesBatchDeleteRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchInsert": { - "id": "mapsengine.tables.features.batchInsert", - "path": "tables/{id}/features/batchInsert", - "httpMethod": "POST", - "description": "Append features to an existing table.\n\nA single batchInsert request can create:\n\n- Up to 50 features.\n- A combined total of 10 000 vertices.\nFeature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.\n\nFor more information about inserting features, read Creating features in the Google Maps Engine developer's guide.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table to append the features to.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "FeaturesBatchInsertRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchPatch": { - "id": "mapsengine.tables.features.batchPatch", - "path": "tables/{id}/features/batchPatch", - "httpMethod": "POST", - "description": "Update the supplied features.\n\nA single batchPatch request can update:\n\n- Up to 50 features.\n- A combined total of 10 000 vertices.\nFeature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.\n\nFeature updates use HTTP PATCH semantics:\n\n- A supplied value replaces an existing value (if any) in that field.\n- Omitted fields remain unchanged.\n- Complex values in geometries and properties must be replaced as atomic units. For example, providing just the coordinates of a geometry is not allowed; the complete geometry, including type, must be supplied.\n- Setting a property's value to null deletes that property.\nFor more information about updating features, read Updating features in the Google Maps Engine developer's guide.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table containing the features to be patched.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "FeaturesBatchPatchRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.tables.features.get", - "path": "tables/{tableId}/features/{id}", - "httpMethod": "GET", - "description": "Return a single feature, given its ID.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the feature to get.", - "required": true, - "location": "path" - }, - "select": { - "type": "string", - "description": "A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.", - "location": "query" - }, - "tableId": { - "type": "string", - "description": "The ID of the table.", - "required": true, - "location": "path" - }, - "version": { - "type": "string", - "description": "The table version to access. See Accessing Public Data for information.", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - } - }, - "parameterOrder": [ - "tableId", - "id" - ], - "response": { - "$ref": "Feature" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.tables.features.list", - "path": "tables/{id}/features", - "httpMethod": "GET", - "description": "Return all features readable by the current user.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table to which these features belong.", - "required": true, - "location": "path" - }, - "include": { - "type": "string", - "description": "A comma separated list of optional data to include. Optional data available: schema.", - "location": "query" - }, - "intersects": { - "type": "string", - "description": "A geometry literal that specifies the spatial restriction of the query.", - "location": "query" - }, - "limit": { - "type": "integer", - "description": "The total number of features to return from the query, irrespective of the number of pages.", - "format": "uint32", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in the response, used for paging. The maximum supported value is 1000.", - "format": "uint32", - "location": "query" - }, - "orderBy": { - "type": "string", - "description": "An SQL-like order by clause used to sort results. If this parameter is not included, the order of features is undefined.", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "select": { - "type": "string", - "description": "A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.", - "location": "query" - }, - "version": { - "type": "string", - "description": "The table version to access. See Accessing Public Data for information.", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - }, - "where": { - "type": "string", - "description": "An SQL-like predicate used to filter results.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "FeaturesListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "files": { - "methods": { - "insert": { - "id": "mapsengine.tables.files.insert", - "path": "tables/{id}/files", - "httpMethod": "POST", - "description": "Upload a file to a placeholder table asset. See Table Upload in the Developer's Guide for more information.\nSupported file types are listed in the Supported data formats and limits article of the Google Maps Engine help center.", - "parameters": { - "filename": { - "type": "string", - "description": "The file name of this uploaded file.", - "required": true, - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the table asset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id", - "filename" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ], - "supportsMediaUpload": true, - "mediaUpload": { - "accept": [ - "*/*" - ], - "maxSize": "1GB", - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/mapsengine/exp2/tables/{id}/files" - }, - "resumable": { - "multipart": true, - "path": "/resumable/upload/mapsengine/exp2/tables/{id}/files" - } - } - } - } - } - }, - "parents": { - "methods": { - "list": { - "id": "mapsengine.tables.parents.list", - "path": "tables/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified table.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.tables.permissions.batchDelete", - "path": "tables/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.tables.permissions.batchUpdate", - "path": "tables/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.tables.permissions.list", - "path": "tables/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - } - } -} diff --git a/etc/api/mapsengine/v1/mapsengine-api.json b/etc/api/mapsengine/v1/mapsengine-api.json deleted file mode 100644 index dc22714edb..0000000000 --- a/etc/api/mapsengine/v1/mapsengine-api.json +++ /dev/null @@ -1,5352 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/qDLbK5i69rWQX322GWuXjzMZYho\"", - "discoveryVersion": "v1", - "id": "mapsengine:v1", - "name": "mapsengine", - "canonicalName": "Maps Engine", - "version": "v1", - "revision": "20151202", - "title": "Google Maps Engine API", - "description": "The Google Maps Engine API allows developers to store and query geospatial vector and raster data.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "https://www.google.com/images/icons/product/maps_engine-16.png", - "x32": "https://www.google.com/images/icons/product/maps_engine-32.png" - }, - "documentationLink": "https://developers.google.com/maps-engine/", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/mapsengine/v1/", - "basePath": "/mapsengine/v1/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "mapsengine/v1/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/mapsengine": { - "description": "View and manage your Google My Maps data" - }, - "https://www.googleapis.com/auth/mapsengine.readonly": { - "description": "View your Google My Maps data" - } - } - } - }, - "schemas": { - "AcquisitionTime": { - "id": "AcquisitionTime", - "type": "object", - "description": "Acquisition time represents acquired time of a raster.", - "properties": { - "end": { - "type": "string", - "description": "The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "precision": { - "type": "string", - "description": "The precision of acquisition time.", - "enum": [ - "day", - "hour", - "minute", - "month", - "second", - "year" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" - ] - }, - "start": { - "type": "string", - "description": "The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).", - "format": "date-time" - } - } - }, - "Asset": { - "id": "Asset", - "type": "object", - "description": "An asset is any Google Maps Engine resource that has a globally unique ID. Assets include maps, layers, vector tables, raster collections, and rasters. Projects and features are not considered assets.\n\nMore detailed information about an asset can be obtained by querying the asset's particular endpoint.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this asset. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this asset. This is only returned on GET requests and not LIST requests." - }, - "description": { - "type": "string", - "description": "The asset's description." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "id": { - "type": "string", - "description": "The asset's globally unique ID." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this asset. This is only returned on GET requests and not LIST requests." - }, - "name": { - "type": "string", - "description": "The asset's name." - }, - "projectId": { - "type": "string", - "description": "The ID of the project to which the asset belongs." - }, - "resource": { - "type": "string", - "description": "The URL to query to retrieve the asset's complete object. The assets endpoint only returns high-level information about a resource." - }, - "tags": { - "type": "array", - "description": "An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "description": "The type of asset. One of raster, rasterCollection, table, map, or layer.", - "enum": [ - "layer", - "map", - "raster", - "rasterCollection", - "table" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "AssetsListResponse": { - "id": "AssetsListResponse", - "type": "object", - "description": "The response returned by a call to resources.List.", - "properties": { - "assets": { - "type": "array", - "description": "Assets returned.", - "items": { - "$ref": "Asset" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "Border": { - "id": "Border", - "type": "object", - "description": "Border in line style. Both color and width are required.", - "properties": { - "color": { - "type": "string", - "description": "Color of the border.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "opacity": { - "type": "number", - "description": "Opacity of the border.", - "format": "double" - }, - "width": { - "type": "number", - "description": "Width of the border, in pixels.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "Color": { - "id": "Color", - "type": "object", - "description": "Basic color used in styling.", - "properties": { - "color": { - "type": "string", - "description": "The CSS style color, can be in format of \"red\" or \"#7733EE\".", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "opacity": { - "type": "number", - "description": "Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.", - "format": "double" - } - } - }, - "Datasource": { - "id": "Datasource", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of a datasource." - } - } - }, - "Datasources": { - "id": "Datasources", - "type": "array", - "items": { - "$ref": "Datasource" - } - }, - "DisplayRule": { - "id": "DisplayRule", - "type": "object", - "description": "A display rule of the vector style.", - "properties": { - "filters": { - "type": "array", - "description": "This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.", - "items": { - "$ref": "Filter" - } - }, - "lineOptions": { - "$ref": "LineStyle", - "description": "Style applied to lines. Required for LineString Geometry." - }, - "name": { - "type": "string", - "description": "Display rule name. Name is not unique and cannot be used for identification purpose." - }, - "pointOptions": { - "$ref": "PointStyle", - "description": "Style applied to points. Required for Point Geometry." - }, - "polygonOptions": { - "$ref": "PolygonStyle", - "description": "Style applied to polygons. Required for Polygon Geometry." - }, - "zoomLevels": { - "$ref": "ZoomLevels", - "description": "The zoom levels that this display rule apply.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "Feature": { - "id": "Feature", - "type": "object", - "description": "A feature within a table.", - "properties": { - "geometry": { - "$ref": "GeoJsonGeometry", - "description": "The geometry member of this Feature." - }, - "properties": { - "$ref": "GeoJsonProperties", - "description": "Key/value pairs of this Feature." - }, - "type": { - "type": "string", - "description": "Identifies this object as a feature.", - "default": "Feature" - } - } - }, - "FeatureInfo": { - "id": "FeatureInfo", - "type": "object", - "description": "A feature info contains information about individual feature.", - "properties": { - "content": { - "type": "string", - "description": "HTML template of the info window. If not provided, a default template with all attributes will be generated." - } - } - }, - "FeaturesBatchDeleteRequest": { - "id": "FeaturesBatchDeleteRequest", - "type": "object", - "description": "The request sent to features.BatchDelete.", - "properties": { - "gx_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "primaryKeys": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "FeaturesBatchInsertRequest": { - "id": "FeaturesBatchInsertRequest", - "type": "object", - "description": "The request sent to features.Insert.", - "properties": { - "features": { - "type": "array", - "items": { - "$ref": "Feature" - } - }, - "normalizeGeometries": { - "type": "boolean", - "description": "If true, the server will normalize feature geometries. It is assumed that the South Pole is exterior to any polygons given. See here for a list of normalizations. If false, all feature geometries must be given already normalized. The points in all LinearRings must be listed in counter-clockwise order, and LinearRings may not intersect.", - "default": "true" - } - } - }, - "FeaturesBatchPatchRequest": { - "id": "FeaturesBatchPatchRequest", - "type": "object", - "description": "The request sent to features.BatchPatch.", - "properties": { - "features": { - "type": "array", - "items": { - "$ref": "Feature" - } - }, - "normalizeGeometries": { - "type": "boolean", - "description": "If true, the server will normalize feature geometries. It is assumed that the South Pole is exterior to any polygons given. See here for a list of normalizations. If false, all feature geometries must be given already normalized. The points in all LinearRings must be listed in counter-clockwise order, and LinearRings may not intersect.", - "default": "true" - } - } - }, - "FeaturesListResponse": { - "id": "FeaturesListResponse", - "type": "object", - "description": "The response returned by a call to features.List.", - "properties": { - "allowedQueriesPerSecond": { - "type": "number", - "description": "An indicator of the maximum rate at which queries may be made, if all queries were as expensive as this query.", - "format": "double" - }, - "features": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Feature" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token." - }, - "schema": { - "$ref": "Schema", - "description": "The feature schema." - }, - "type": { - "type": "string", - "default": "FeatureCollection" - } - } - }, - "File": { - "id": "File", - "type": "object", - "description": "A single File, which is a component of an Asset.", - "properties": { - "filename": { - "type": "string", - "description": "The name of the file.", - "annotations": { - "required": [ - "mapsengine.rasters.upload", - "mapsengine.tables.upload" - ] - } - }, - "size": { - "type": "string", - "description": "The size of the file in bytes.", - "format": "int64" - }, - "uploadStatus": { - "type": "string", - "description": "The upload status of the file.", - "enum": [ - "canceled", - "complete", - "failed", - "inProgress" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ] - } - } - }, - "Filter": { - "id": "Filter", - "type": "object", - "description": "Conditions for filtering features.", - "properties": { - "column": { - "type": "string", - "description": "The column name to filter on.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "operator": { - "type": "string", - "description": "Operation used to evaluate the filter.", - "enum": [ - "!=", - "\u003c", - "\u003c=", - "==", - "\u003e", - "\u003e=", - "contains", - "endsWith", - "startsWith" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "value": { - "type": "any", - "description": "Value to be evaluated against attribute.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "GeoJsonGeometry": { - "id": "GeoJsonGeometry", - "type": "object", - "variant": { - "discriminant": "type", - "map": [ - { - "type_value": "GeometryCollection", - "$ref": "GeoJsonGeometryCollection" - }, - { - "type_value": "LineString", - "$ref": "GeoJsonLineString" - }, - { - "type_value": "MultiLineString", - "$ref": "GeoJsonMultiLineString" - }, - { - "type_value": "MultiPoint", - "$ref": "GeoJsonMultiPoint" - }, - { - "type_value": "MultiPolygon", - "$ref": "GeoJsonMultiPolygon" - }, - { - "type_value": "Point", - "$ref": "GeoJsonPoint" - }, - { - "type_value": "Polygon", - "$ref": "GeoJsonPolygon" - } - ] - } - }, - "GeoJsonGeometryCollection": { - "id": "GeoJsonGeometryCollection", - "type": "object", - "description": "A heterogenous collection of GeoJsonGeometry objects.", - "properties": { - "geometries": { - "type": "array", - "description": "An array of geometry objects. There must be at least 2 different types of geometries in the array.", - "items": { - "$ref": "GeoJsonGeometry" - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonGeometryCollection.", - "enum": [ - "GeometryCollection" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonLineString": { - "id": "GeoJsonLineString", - "type": "object", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of two or more positions, representing a line.", - "items": { - "$ref": "GeoJsonPosition" - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonLineString.", - "enum": [ - "LineString" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonMultiLineString": { - "id": "GeoJsonMultiLineString", - "type": "object", - "description": "Multi Line String", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of at least two GeoJsonLineString coordinate arrays.", - "items": { - "type": "array", - "items": { - "$ref": "GeoJsonPosition" - } - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonMultiLineString.", - "enum": [ - "MultiLineString" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonMultiPoint": { - "id": "GeoJsonMultiPoint", - "type": "object", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of at least two GeoJsonPoint coordinate arrays.", - "items": { - "$ref": "GeoJsonPosition" - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonMultiPoint.", - "enum": [ - "MultiPoint" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonMultiPolygon": { - "id": "GeoJsonMultiPolygon", - "type": "object", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of at least two GeoJsonPolygon coordinate arrays.", - "items": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "GeoJsonPosition" - } - } - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonMultiPolygon.", - "enum": [ - "MultiPolygon" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonPoint": { - "id": "GeoJsonPoint", - "type": "object", - "properties": { - "coordinates": { - "$ref": "GeoJsonPosition", - "description": "A single GeoJsonPosition, specifying the location of the point." - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonPoint.", - "enum": [ - "Point" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonPolygon": { - "id": "GeoJsonPolygon", - "type": "object", - "properties": { - "coordinates": { - "type": "array", - "description": "An array of LinearRings. A LinearRing is a GeoJsonLineString which is closed (that is, the first and last GeoJsonPositions are equal), and which contains at least four GeoJsonPositions. For polygons with multiple rings, the first LinearRing is the exterior ring, and any subsequent rings are interior rings (that is, holes).", - "items": { - "type": "array", - "items": { - "$ref": "GeoJsonPosition" - } - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a GeoJsonPolygon.", - "enum": [ - "Polygon" - ], - "enumDescriptions": [ - "" - ] - } - } - }, - "GeoJsonPosition": { - "id": "GeoJsonPosition", - "type": "array", - "description": "A position represents a geographical position as an array containing a longitude and a latitude, and optionally an altitude, in that order. All Geometry objects make use of positions to represent geometries as nested arrays. The structure of the array is governed by the type of the geometry.", - "items": { - "type": "number", - "format": "double" - } - }, - "GeoJsonProperties": { - "id": "GeoJsonProperties", - "type": "object", - "description": "The properties associated with a feature.", - "additionalProperties": { - "type": "any", - "description": "An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema." - } - }, - "Icon": { - "id": "Icon", - "type": "object", - "description": "An icon is a user-uploaded image that can be used to style point geometries.", - "properties": { - "description": { - "type": "string", - "description": "The description of this Icon, supplied by the author." - }, - "id": { - "type": "string", - "description": "An ID used to refer to this Icon." - }, - "name": { - "type": "string", - "description": "The name of this Icon, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.projects.icons.create" - ] - } - } - } - }, - "IconStyle": { - "id": "IconStyle", - "type": "object", - "description": "Style for icon, this is part of point style.", - "properties": { - "id": { - "type": "string", - "description": "Custom icon id." - }, - "name": { - "type": "string", - "description": "Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'." - }, - "scaledShape": { - "$ref": "ScaledShape", - "description": "A scalable shape." - }, - "scalingFunction": { - "$ref": "ScalingFunction", - "description": "The function used to scale shapes. Required when a scaledShape is specified." - } - } - }, - "IconsListResponse": { - "id": "IconsListResponse", - "type": "object", - "description": "The response returned by a call to icons.List.", - "properties": { - "icons": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Icon" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token." - } - } - }, - "LabelStyle": { - "id": "LabelStyle", - "type": "object", - "description": "Text label style.", - "properties": { - "color": { - "type": "string", - "description": "Color of the text. If not provided, default to black." - }, - "column": { - "type": "string", - "description": "The column value of the feature to be displayed.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "fontStyle": { - "type": "string", - "description": "Font style of the label, defaults to 'normal'.", - "enum": [ - "italic", - "normal" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "fontWeight": { - "type": "string", - "description": "Font weight of the label, defaults to 'normal'.", - "enum": [ - "bold", - "normal" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "opacity": { - "type": "number", - "description": "Opacity of the text.", - "format": "double" - }, - "outline": { - "$ref": "Color", - "description": "Outline color of the text." - }, - "size": { - "type": "number", - "description": "Font size of the label, in pixels. 8 \u003c= size \u003c= 15. If not provided, a default size will be provided.", - "format": "double" - } - } - }, - "LatLngBox": { - "id": "LatLngBox", - "type": "array", - "description": "A rectangular geographic bounds.", - "items": { - "type": "number", - "format": "double" - } - }, - "Layer": { - "id": "Layer", - "type": "object", - "description": "A Layer combines multiple datasources, with styling information, for presentation on a map.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this layer. This is only returned on GET requests and not LIST requests." - }, - "datasourceType": { - "type": "string", - "description": "Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.", - "enum": [ - "image", - "table" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "datasources": { - "$ref": "Datasources", - "description": "An array of datasources used to build this layer. If layerType is \"image\", or layerType is not specified and datasourceType is \"image\", then each element in this array is a reference to an Image or RasterCollection. If layerType is \"vector\", or layerType is not specified and datasourceType is \"table\" then each element in this array is a reference to a Vector Table." - }, - "description": { - "type": "string", - "description": "The description of this Layer, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Layer." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests." - }, - "layerType": { - "type": "string", - "description": "The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.", - "enum": [ - "image", - "vector" - ], - "enumDescriptions": [ - "", - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.create" - ] - } - }, - "name": { - "type": "string", - "description": "The name of this Layer, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.layers.create" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this layer.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Layer is in.", - "annotations": { - "required": [ - "mapsengine.layers.create" - ] - } - }, - "publishedAccessList": { - "type": "string", - "description": "Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "publishingStatus": { - "type": "string", - "description": "The publishing status of this layer.", - "enum": [ - "notPublished", - "published" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "style": { - "$ref": "VectorStyle", - "description": "The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer." - }, - "tags": { - "$ref": "Tags", - "description": "Tags of this Layer." - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "LayersListResponse": { - "id": "LayersListResponse", - "type": "object", - "description": "The response returned by a call to layers.List. Note: The list response does not include all the fields available in a layer. Refer to the layer resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each layer.", - "properties": { - "layers": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Layer" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "LineStyle": { - "id": "LineStyle", - "type": "object", - "description": "Style for lines.", - "properties": { - "border": { - "$ref": "Border", - "description": "Border of the line. 0 \u003c border.width \u003c= 5." - }, - "dash": { - "type": "array", - "description": "Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.", - "items": { - "type": "number", - "format": "double" - } - }, - "label": { - "$ref": "LabelStyle", - "description": "Label style for the line." - }, - "stroke": { - "type": "object", - "description": "Stroke of the line.", - "properties": { - "color": { - "type": "string", - "description": "Color of the line.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "opacity": { - "type": "number", - "description": "Opacity of the line.", - "format": "double" - }, - "width": { - "type": "number", - "description": "Width of the line, in pixels. 0 \u003c= width \u003c= 10. If width is set to 0, the line will be invisible.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - } - } - }, - "Map": { - "id": "Map", - "type": "object", - "description": "A Map is a collection of Layers, optionally contained within folders.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Map. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "contents": { - "$ref": "MapContents", - "description": "The contents of this Map." - }, - "creationTime": { - "type": "string", - "description": "The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this map. This is only returned on GET requests and not LIST requests." - }, - "defaultViewport": { - "$ref": "LatLngBox", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees." - }, - "description": { - "type": "string", - "description": "The description of this Map, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Map." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests." - }, - "name": { - "type": "string", - "description": "The name of this Map, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.maps.create" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this map. Map processing is automatically started once a map becomes ready for processing.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Map is in.", - "annotations": { - "required": [ - "mapsengine.maps.create" - ] - } - }, - "publishedAccessList": { - "type": "string", - "description": "Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. This is an input field only. It is not returned in response to a list or get request." - }, - "publishingStatus": { - "type": "string", - "description": "The publishing status of this map.", - "enum": [ - "notPublished", - "published" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "tags": { - "$ref": "Tags", - "description": "Tags of this Map." - }, - "versions": { - "type": "array", - "description": "Deprecated: An array containing the available versions of this Map. Currently may only contain \"published\". The publishingStatus field should be used instead.", - "items": { - "type": "string", - "default": "published" - } - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "MapContents": { - "id": "MapContents", - "type": "array", - "items": { - "$ref": "MapItem" - } - }, - "MapFolder": { - "id": "MapFolder", - "type": "object", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "MapItem" - } - }, - "defaultViewport": { - "type": "array", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "expandable": { - "type": "boolean", - "description": "The expandability setting of this MapFolder. If true, the folder can be expanded." - }, - "key": { - "type": "string", - "description": "A user defined alias for this MapFolder, specific to this Map." - }, - "name": { - "type": "string", - "description": "The name of this MapFolder.", - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a MapFolder.", - "enum": [ - "folder" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "visibility": { - "type": "string", - "description": "The visibility setting of this MapFolder. One of \"defaultOn\" or \"defaultOff\"." - } - } - }, - "MapItem": { - "id": "MapItem", - "type": "object", - "variant": { - "discriminant": "type", - "map": [ - { - "type_value": "folder", - "$ref": "MapFolder" - }, - { - "type_value": "kmlLink", - "$ref": "MapKmlLink" - }, - { - "type_value": "layer", - "$ref": "MapLayer" - } - ] - } - }, - "MapKmlLink": { - "id": "MapKmlLink", - "type": "object", - "properties": { - "defaultViewport": { - "type": "array", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "kmlUrl": { - "type": "string", - "description": "The URL to the KML file represented by this MapKmlLink.", - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "name": { - "type": "string", - "description": "The name of this MapKmlLink.", - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "type": { - "type": "string", - "description": "Identifies this object as a MapKmlLink.", - "enum": [ - "kmlLink" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "visibility": { - "type": "string", - "description": "The visibility setting of this MapKmlLink. One of \"defaultOn\" or \"defaultOff\"." - } - } - }, - "MapLayer": { - "id": "MapLayer", - "type": "object", - "properties": { - "defaultViewport": { - "type": "array", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "id": { - "type": "string", - "description": "The ID of this MapLayer. This ID can be used to request more details about the layer.", - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "key": { - "type": "string", - "description": "A user defined alias for this MapLayer, specific to this Map." - }, - "name": { - "type": "string", - "description": "The name of this MapLayer." - }, - "type": { - "type": "string", - "description": "Identifies this object as a MapLayer.", - "enum": [ - "layer" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.maps.create", - "mapsengine.maps.patch" - ] - } - }, - "visibility": { - "type": "string", - "description": "The visibility setting of this MapLayer. One of \"defaultOn\" or \"defaultOff\"." - } - } - }, - "MapsListResponse": { - "id": "MapsListResponse", - "type": "object", - "description": "The response returned by a call to maps.List.", - "properties": { - "maps": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Map" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "Parent": { - "id": "Parent", - "type": "object", - "description": "A list of the parents of an asset.", - "properties": { - "id": { - "type": "string", - "description": "The ID of this parent." - } - } - }, - "ParentsListResponse": { - "id": "ParentsListResponse", - "type": "object", - "description": "The response returned by a call to parents.List.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token." - }, - "parents": { - "type": "array", - "description": "The parent assets.", - "items": { - "$ref": "Parent" - } - } - } - }, - "Permission": { - "id": "Permission", - "type": "object", - "description": "A permission defines the user or group that has access to an asset, and the type of access they have.", - "properties": { - "discoverable": { - "type": "boolean", - "description": "Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false)." - }, - "id": { - "type": "string", - "description": "The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string \"anyone\" for public permissions.", - "annotations": { - "required": [ - "mapsengine.layers.permissions.batchUpdate", - "mapsengine.maps.permissions.batchUpdate", - "mapsengine.rasterCollections.permissions.batchUpdate", - "mapsengine.tables.permissions.batchUpdate" - ] - } - }, - "role": { - "type": "string", - "description": "The type of access granted to this user or group.", - "enum": [ - "owner", - "reader", - "viewer", - "writer" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.permissions.batchUpdate", - "mapsengine.maps.permissions.batchUpdate", - "mapsengine.rasterCollections.permissions.batchUpdate", - "mapsengine.tables.permissions.batchUpdate" - ] - } - }, - "type": { - "type": "string", - "description": "The account type.", - "enum": [ - "anyone", - "group", - "user" - ], - "enumDescriptions": [ - "", - "", - "" - ] - } - } - }, - "PermissionsBatchDeleteRequest": { - "id": "PermissionsBatchDeleteRequest", - "type": "object", - "description": "The request sent to mapsengine.permissions.batchDelete.", - "properties": { - "ids": { - "type": "array", - "description": "An array of permission ids to be removed. This could be the email address of the user or group this permission refers to, or the string \"anyone\" for public permissions.", - "items": { - "type": "string" - }, - "annotations": { - "required": [ - "mapsengine.layers.permissions.batchDelete", - "mapsengine.maps.permissions.batchDelete", - "mapsengine.rasterCollections.permissions.batchDelete", - "mapsengine.tables.permissions.batchDelete" - ] - } - } - } - }, - "PermissionsBatchDeleteResponse": { - "id": "PermissionsBatchDeleteResponse", - "type": "object", - "description": "The response returned by a call to mapsengine.permissions.batchDelete." - }, - "PermissionsBatchUpdateRequest": { - "id": "PermissionsBatchUpdateRequest", - "type": "object", - "description": "The request sent to mapsengine.permissions.batchUpdate.", - "properties": { - "permissions": { - "type": "array", - "description": "The permissions to be inserted or updated.", - "items": { - "$ref": "Permission" - }, - "annotations": { - "required": [ - "mapsengine.layers.permissions.batchUpdate", - "mapsengine.maps.permissions.batchUpdate", - "mapsengine.rasterCollections.permissions.batchUpdate", - "mapsengine.tables.permissions.batchUpdate" - ] - } - } - } - }, - "PermissionsBatchUpdateResponse": { - "id": "PermissionsBatchUpdateResponse", - "type": "object", - "description": "The response returned by a call to mapsengine.permissions.batchUpdate." - }, - "PermissionsListResponse": { - "id": "PermissionsListResponse", - "type": "object", - "properties": { - "permissions": { - "type": "array", - "description": "The set of permissions associated with this asset.", - "items": { - "$ref": "Permission" - } - } - } - }, - "PointStyle": { - "id": "PointStyle", - "type": "object", - "description": "Style for points.", - "properties": { - "icon": { - "$ref": "IconStyle", - "description": "Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "label": { - "$ref": "LabelStyle", - "description": "Label style for the point." - } - } - }, - "PolygonStyle": { - "id": "PolygonStyle", - "type": "object", - "description": "Style for polygons.", - "properties": { - "fill": { - "$ref": "Color", - "description": "Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border." - }, - "label": { - "$ref": "LabelStyle", - "description": "Label style for the polygon." - }, - "stroke": { - "$ref": "Border", - "description": "Border of the polygon. 0 \u003c border.width \u003c= 10." - } - } - }, - "ProcessResponse": { - "id": "ProcessResponse", - "type": "object", - "description": "The response returned by a call to any asset's Process method." - }, - "Project": { - "id": "Project", - "type": "object", - "description": "A Maps Engine project groups a collection of resources.", - "properties": { - "id": { - "type": "string", - "description": "An ID used to refer to this Maps Engine project." - }, - "name": { - "type": "string", - "description": "A user provided name for this Maps Engine project." - } - } - }, - "ProjectsListResponse": { - "id": "ProjectsListResponse", - "type": "object", - "description": "The response returned by a call to projects.List.", - "properties": { - "projects": { - "type": "array", - "description": "Projects returned.", - "items": { - "$ref": "Project" - } - } - } - }, - "PublishResponse": { - "id": "PublishResponse", - "type": "object", - "description": "The response returned by a call to any asset's Publish method." - }, - "PublishedLayer": { - "id": "PublishedLayer", - "type": "object", - "description": "The published version of a layer.", - "properties": { - "description": { - "type": "string", - "description": "The description of this Layer, supplied by the author." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Layer." - }, - "layerType": { - "type": "string", - "description": "The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.", - "enum": [ - "image", - "vector" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "name": { - "type": "string", - "description": "The name of this Layer, supplied by the author." - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Layer is in." - } - } - }, - "PublishedLayersListResponse": { - "id": "PublishedLayersListResponse", - "type": "object", - "description": "The response returned by a call to layers.List.published.", - "properties": { - "layers": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "PublishedLayer" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "PublishedMap": { - "id": "PublishedMap", - "type": "object", - "description": "The published version of a map asset.", - "properties": { - "contents": { - "$ref": "MapContents", - "description": "The contents of this Map." - }, - "defaultViewport": { - "$ref": "LatLngBox", - "description": "An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees." - }, - "description": { - "type": "string", - "description": "The description of this Map, supplied by the author." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Map." - }, - "name": { - "type": "string", - "description": "The name of this Map, supplied by the author." - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Map is in." - } - } - }, - "PublishedMapsListResponse": { - "id": "PublishedMapsListResponse", - "type": "object", - "description": "The response returned by a call to maps.List.published.", - "properties": { - "maps": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "PublishedMap" - } - }, - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - } - } - }, - "Raster": { - "id": "Raster", - "type": "object", - "description": "A geo-referenced raster.", - "properties": { - "acquisitionTime": { - "$ref": "AcquisitionTime", - "description": "The acquisition time of this Raster." - }, - "attribution": { - "type": "string", - "description": "The name of the attribution to be used for this Raster." - }, - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitudes and longitudes in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this raster. This is only returned on GET requests and not LIST requests." - }, - "description": { - "type": "string", - "description": "The description of this Raster, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "files": { - "type": "array", - "description": "The files associated with this Raster.", - "items": { - "$ref": "File" - }, - "annotations": { - "required": [ - "mapsengine.rasters.upload" - ] - } - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Raster." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests." - }, - "maskType": { - "type": "string", - "description": "The mask processing type of this Raster.", - "default": "autoMask" - }, - "name": { - "type": "string", - "description": "The name of this Raster, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.rasters.upload" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this Raster.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Raster is in.", - "annotations": { - "required": [ - "mapsengine.rasters.upload" - ] - } - }, - "rasterType": { - "type": "string", - "description": "The type of this Raster. Always \"image\" today.", - "enum": [ - "image" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.rasters.upload" - ] - } - }, - "tags": { - "$ref": "Tags", - "description": "Tags of this Raster." - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "RasterCollection": { - "id": "RasterCollection", - "type": "object", - "description": "A raster collection groups multiple Raster resources for inclusion in a Layer.", - "properties": { - "attribution": { - "type": "string", - "description": "The name of the attribution to be used for this RasterCollection. Note: Attribution is returned in response to a get request but not a list request. After requesting a list of raster collections, you'll need to send a get request to retrieve the attribution for each raster collection." - }, - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this RasterCollection. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this raster collection. This is only returned on GET requests and not LIST requests." - }, - "description": { - "type": "string", - "description": "The description of this RasterCollection, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this RasterCollection." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this raster collection. This is only returned on GET requests and not LIST requests." - }, - "mosaic": { - "type": "boolean", - "description": "True if this RasterCollection is a mosaic.", - "annotations": { - "required": [ - "mapsengine.rasterCollections.create" - ] - } - }, - "name": { - "type": "string", - "description": "The name of this RasterCollection, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.rasterCollections.create" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this RasterCollection.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this RasterCollection is in.", - "annotations": { - "required": [ - "mapsengine.rasterCollections.create" - ] - } - }, - "rasterType": { - "type": "string", - "description": "The type of rasters contained within this RasterCollection.", - "enum": [ - "image" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.rasterCollections.create" - ] - } - }, - "tags": { - "$ref": "Tags", - "description": "Tags of this RasterCollection." - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "RasterCollectionsListResponse": { - "id": "RasterCollectionsListResponse", - "type": "object", - "description": "The response returned by a call to raster_collections.List. Note: The list response does not include all the fields available in a raster collection. Refer to the RasterCollection resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each raster collection.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - }, - "rasterCollections": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "RasterCollection" - } - } - } - }, - "RasterCollectionsRaster": { - "id": "RasterCollectionsRaster", - "type": "object", - "description": "A raster resource.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitudes and longitudes in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "description": { - "type": "string", - "description": "The description of this Raster, supplied by the author." - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this Raster." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "name": { - "type": "string", - "description": "The name of this Raster, supplied by the author." - }, - "projectId": { - "type": "string", - "description": "The ID of the project that this Raster is in." - }, - "rasterType": { - "type": "string", - "description": "The type of this Raster. Always \"image\" today.", - "default": "image" - }, - "tags": { - "type": "array", - "description": "Tags of this Raster.", - "items": { - "type": "string" - } - } - } - }, - "RasterCollectionsRasterBatchDeleteRequest": { - "id": "RasterCollectionsRasterBatchDeleteRequest", - "type": "object", - "description": "The request sent to rasterCollections.Rasters.BatchDelete.", - "properties": { - "ids": { - "type": "array", - "description": "An array of Raster asset IDs to be removed from this RasterCollection.", - "items": { - "type": "string" - } - } - } - }, - "RasterCollectionsRastersBatchDeleteResponse": { - "id": "RasterCollectionsRastersBatchDeleteResponse", - "type": "object", - "description": "The response returned by a call to rasterCollections.rasters.batchDelete." - }, - "RasterCollectionsRastersBatchInsertRequest": { - "id": "RasterCollectionsRastersBatchInsertRequest", - "type": "object", - "description": "The request sent to rasterCollections.Rasters.BatchInsert.", - "properties": { - "ids": { - "type": "array", - "description": "An array of Raster asset IDs to be added to this RasterCollection.", - "items": { - "type": "string" - } - } - } - }, - "RasterCollectionsRastersBatchInsertResponse": { - "id": "RasterCollectionsRastersBatchInsertResponse", - "type": "object", - "description": "The response returned by a call to rasterCollections.rasters.batchInsert." - }, - "RasterCollectionsRastersListResponse": { - "id": "RasterCollectionsRastersListResponse", - "type": "object", - "description": "The response returned by a call to rasterCollections.rasters.List.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token." - }, - "rasters": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "RasterCollectionsRaster" - } - } - } - }, - "RastersListResponse": { - "id": "RastersListResponse", - "type": "object", - "description": "The response returned by a call to rasters.List.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token." - }, - "rasters": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Raster" - } - } - } - }, - "ScaledShape": { - "id": "ScaledShape", - "type": "object", - "description": "Parameters for styling points as scaled shapes.", - "properties": { - "border": { - "$ref": "Border", - "description": "Border color/width of the shape. If not specified the shape won't have a border." - }, - "fill": { - "$ref": "Color", - "description": "The fill color of the shape. If not specified the shape will be transparent (although the borders may not be)." - }, - "shape": { - "type": "string", - "description": "Name of the shape.", - "enum": [ - "circle" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "ScalingFunction": { - "id": "ScalingFunction", - "type": "object", - "description": "Parameters for scaling scaled shapes.", - "properties": { - "column": { - "type": "string", - "description": "Name of the numeric column used to scale a shape.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "scalingType": { - "type": "string", - "description": "The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.", - "enum": [ - "linear", - "sqrt" - ], - "enumDescriptions": [ - "", - "" - ] - }, - "sizeRange": { - "$ref": "SizeRange", - "description": "The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "valueRange": { - "$ref": "ValueRange", - "description": "The range of values to display across the size range.", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "Schema": { - "id": "Schema", - "type": "object", - "description": "A schema indicating the properties which may be associated with features within a Table, and the types of those properties.", - "properties": { - "columns": { - "type": "array", - "description": "An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.", - "items": { - "$ref": "TableColumn" - }, - "annotations": { - "required": [ - "mapsengine.tables.create" - ] - } - }, - "primaryGeometry": { - "type": "string", - "description": "The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array." - }, - "primaryKey": { - "type": "string", - "description": "The name of the column that contains the unique identifier of a Feature." - } - } - }, - "SizeRange": { - "id": "SizeRange", - "type": "object", - "description": "Scaled shape size range in pixels. For circles, size corresponds to diameter.", - "properties": { - "max": { - "type": "number", - "description": "Maximum size, in pixels.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "min": { - "type": "number", - "description": "Minimum size, in pixels.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "Table": { - "id": "Table", - "type": "object", - "description": "A collection of geographic features, and associated metadata.", - "properties": { - "bbox": { - "type": "array", - "description": "A rectangular bounding box which contains all of the data in this Table. The box is expressed as \\\"west, south, east, north\\\". The numbers represent latitude and longitude in decimal degrees.", - "items": { - "type": "number", - "format": "double" - } - }, - "creationTime": { - "type": "string", - "description": "The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "creatorEmail": { - "type": "string", - "description": "The email address of the creator of this table. This is only returned on GET requests and not LIST requests." - }, - "description": { - "type": "string", - "description": "The description of this table, supplied by the author." - }, - "draftAccessList": { - "type": "string", - "description": "Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "etag": { - "type": "string", - "description": "The ETag, used to refer to the current version of the asset." - }, - "files": { - "type": "array", - "description": "The files associated with this table.", - "items": { - "$ref": "File" - }, - "annotations": { - "required": [ - "mapsengine.tables.upload" - ] - } - }, - "id": { - "type": "string", - "description": "A globally unique ID, used to refer to this table." - }, - "lastModifiedTime": { - "type": "string", - "description": "The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).", - "format": "date-time" - }, - "lastModifierEmail": { - "type": "string", - "description": "The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests." - }, - "name": { - "type": "string", - "description": "The name of this table, supplied by the author.", - "annotations": { - "required": [ - "mapsengine.tables.create", - "mapsengine.tables.upload" - ] - } - }, - "processingStatus": { - "type": "string", - "description": "The processing status of this table.", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "" - ] - }, - "projectId": { - "type": "string", - "description": "The ID of the project to which the table belongs.", - "annotations": { - "required": [ - "mapsengine.tables.create", - "mapsengine.tables.upload" - ] - } - }, - "publishedAccessList": { - "type": "string", - "description": "Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request." - }, - "schema": { - "$ref": "Schema", - "description": "The schema for this table. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.", - "annotations": { - "required": [ - "mapsengine.tables.create" - ] - } - }, - "sourceEncoding": { - "type": "string", - "description": "Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.", - "default": "UTF-8" - }, - "tags": { - "$ref": "Tags", - "description": "An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center." - }, - "writersCanEditPermissions": { - "type": "boolean", - "description": "If true, WRITERs of the asset are able to edit the asset permissions." - } - } - }, - "TableColumn": { - "id": "TableColumn", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The column name.", - "annotations": { - "required": [ - "mapsengine.tables.create" - ] - } - }, - "type": { - "type": "string", - "description": "The type of data stored in this column.", - "enum": [ - "datetime", - "double", - "integer", - "lineStrings", - "mixedGeometry", - "points", - "polygons", - "string" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "" - ], - "annotations": { - "required": [ - "mapsengine.tables.create" - ] - } - } - } - }, - "TablesListResponse": { - "id": "TablesListResponse", - "type": "object", - "description": "The response returned by a call to tables.List. Note: The list response does not include all the fields available in a table. Refer to the table resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each table.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Next page token.", - "format": "byte" - }, - "tables": { - "type": "array", - "description": "Resources returned.", - "items": { - "$ref": "Table" - } - } - } - }, - "Tags": { - "id": "Tags", - "type": "array", - "items": { - "type": "string" - } - }, - "ValueRange": { - "id": "ValueRange", - "type": "object", - "description": "Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size.", - "properties": { - "max": { - "type": "number", - "description": "Maximum value.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "min": { - "type": "number", - "description": "Minimum value.", - "format": "double", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "VectorStyle": { - "id": "VectorStyle", - "type": "object", - "description": "A vector style contains styling information for vector layer.", - "properties": { - "displayRules": { - "type": "array", - "items": { - "$ref": "DisplayRule" - } - }, - "featureInfo": { - "$ref": "FeatureInfo", - "description": "Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated." - }, - "type": { - "type": "string", - "description": "The type of the vector style. Currently, only displayRule is supported.", - "enum": [ - "displayRule" - ], - "enumDescriptions": [ - "" - ], - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - }, - "ZoomLevels": { - "id": "ZoomLevels", - "type": "object", - "description": "Zoom level range. Zoom levels are restricted between 0 and 24, inclusive.", - "properties": { - "max": { - "type": "integer", - "description": "Maximum zoom level.", - "format": "int32", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - }, - "min": { - "type": "integer", - "description": "Minimum zoom level.", - "format": "int32", - "annotations": { - "required": [ - "mapsengine.layers.create", - "mapsengine.layers.patch" - ] - } - } - } - } - }, - "resources": { - "assets": { - "methods": { - "get": { - "id": "mapsengine.assets.get", - "path": "assets/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Asset" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.assets.list", - "path": "assets", - "httpMethod": "GET", - "description": "Return all assets readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - }, - "type": { - "type": "string", - "description": "A comma separated list of asset types. Returned assets will have one of the types from the provided list. Supported values are 'map', 'layer', 'rasterCollection' and 'table'.", - "location": "query" - } - }, - "response": { - "$ref": "AssetsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - }, - "resources": { - "parents": { - "methods": { - "list": { - "id": "mapsengine.assets.parents.list", - "path": "assets/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "list": { - "id": "mapsengine.assets.permissions.list", - "path": "assets/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "layers": { - "methods": { - "cancelProcessing": { - "id": "mapsengine.layers.cancelProcessing", - "path": "layers/{id}/cancelProcessing", - "httpMethod": "POST", - "description": "Cancel processing on a layer asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "create": { - "id": "mapsengine.layers.create", - "path": "layers", - "httpMethod": "POST", - "description": "Create a layer asset.", - "parameters": { - "process": { - "type": "boolean", - "description": "Whether to queue the created layer for processing.", - "location": "query" - } - }, - "request": { - "$ref": "Layer" - }, - "response": { - "$ref": "Layer" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "delete": { - "id": "mapsengine.layers.delete", - "path": "layers/{id}", - "httpMethod": "DELETE", - "description": "Delete a layer.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer. Only the layer creator or project owner are permitted to delete. If the layer is published, or included in a map, the request will fail. Unpublish the layer, and remove it from all maps prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.layers.get", - "path": "layers/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular layer.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - }, - "version": { - "type": "string", - "description": "Deprecated: The version parameter indicates which version of the layer should be returned. When version is set to published, the published version of the layer will be returned. Please use the layers.getPublished endpoint instead.", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Layer" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "getPublished": { - "id": "mapsengine.layers.getPublished", - "path": "layers/{id}/published", - "httpMethod": "GET", - "description": "Return the published metadata for a particular layer.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishedLayer" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.layers.list", - "path": "layers", - "httpMethod": "GET", - "description": "Return all layers readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "The layer has completed processing.", - "The layer has failed processing.", - "The layer is not ready for processing.", - "The layer is processing.", - "The layer is ready for processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "response": { - "$ref": "LayersListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "listPublished": { - "id": "mapsengine.layers.listPublished", - "path": "layers/published", - "httpMethod": "GET", - "description": "Return all published layers readable by the current user.", - "parameters": { - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - } - }, - "response": { - "$ref": "PublishedLayersListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.layers.patch", - "path": "layers/{id}", - "httpMethod": "PATCH", - "description": "Mutate a layer asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "Layer" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "process": { - "id": "mapsengine.layers.process", - "path": "layers/{id}/process", - "httpMethod": "POST", - "description": "Process a layer asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "publish": { - "id": "mapsengine.layers.publish", - "path": "layers/{id}/publish", - "httpMethod": "POST", - "description": "Publish a layer asset.", - "parameters": { - "force": { - "type": "boolean", - "description": "If set to true, the API will allow publication of the layer even if it's out of date. If not true, you'll need to reprocess any out-of-date layer before publishing.", - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "unpublish": { - "id": "mapsengine.layers.unpublish", - "path": "layers/{id}/unpublish", - "httpMethod": "POST", - "description": "Unpublish a layer asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "parents": { - "methods": { - "list": { - "id": "mapsengine.layers.parents.list", - "path": "layers/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified layer.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the layer whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.layers.permissions.batchDelete", - "path": "layers/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.layers.permissions.batchUpdate", - "path": "layers/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.layers.permissions.list", - "path": "layers/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "maps": { - "methods": { - "create": { - "id": "mapsengine.maps.create", - "path": "maps", - "httpMethod": "POST", - "description": "Create a map asset.", - "request": { - "$ref": "Map" - }, - "response": { - "$ref": "Map" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "delete": { - "id": "mapsengine.maps.delete", - "path": "maps/{id}", - "httpMethod": "DELETE", - "description": "Delete a map.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map. Only the map creator or project owner are permitted to delete. If the map is published the request will fail. Unpublish the map prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.maps.get", - "path": "maps/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular map.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - }, - "version": { - "type": "string", - "description": "Deprecated: The version parameter indicates which version of the map should be returned. When version is set to published, the published version of the map will be returned. Please use the maps.getPublished endpoint instead.", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Map" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "getPublished": { - "id": "mapsengine.maps.getPublished", - "path": "maps/{id}/published", - "httpMethod": "GET", - "description": "Return the published metadata for a particular map.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishedMap" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.maps.list", - "path": "maps", - "httpMethod": "GET", - "description": "Return all maps readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing" - ], - "enumDescriptions": [ - "The map has completed processing.", - "The map has failed processing.", - "The map is not ready for processing.", - "The map is processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "response": { - "$ref": "MapsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "listPublished": { - "id": "mapsengine.maps.listPublished", - "path": "maps/published", - "httpMethod": "GET", - "description": "Return all published maps readable by the current user.", - "parameters": { - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - } - }, - "response": { - "$ref": "PublishedMapsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.maps.patch", - "path": "maps/{id}", - "httpMethod": "PATCH", - "description": "Mutate a map asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "Map" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "publish": { - "id": "mapsengine.maps.publish", - "path": "maps/{id}/publish", - "httpMethod": "POST", - "description": "Publish a map asset.", - "parameters": { - "force": { - "type": "boolean", - "description": "If set to true, the API will allow publication of the map even if it's out of date. If false, the map must have a processingStatus of complete before publishing.", - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "unpublish": { - "id": "mapsengine.maps.unpublish", - "path": "maps/{id}/unpublish", - "httpMethod": "POST", - "description": "Unpublish a map asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the map.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PublishResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.maps.permissions.batchDelete", - "path": "maps/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.maps.permissions.batchUpdate", - "path": "maps/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.maps.permissions.list", - "path": "maps/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "projects": { - "methods": { - "list": { - "id": "mapsengine.projects.list", - "path": "projects", - "httpMethod": "GET", - "description": "Return all projects readable by the current user.", - "response": { - "$ref": "ProjectsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - }, - "resources": { - "icons": { - "methods": { - "create": { - "id": "mapsengine.projects.icons.create", - "path": "projects/{projectId}/icons", - "httpMethod": "POST", - "description": "Create an icon.", - "parameters": { - "projectId": { - "type": "string", - "description": "The ID of the project.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "Icon" - }, - "response": { - "$ref": "Icon" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ], - "supportsMediaUpload": true, - "mediaUpload": { - "accept": [ - "*/*" - ], - "maxSize": "100KB", - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/mapsengine/v1/projects/{projectId}/icons" - }, - "resumable": { - "multipart": true, - "path": "/resumable/upload/mapsengine/v1/projects/{projectId}/icons" - } - } - } - }, - "get": { - "id": "mapsengine.projects.icons.get", - "path": "projects/{projectId}/icons/{id}", - "httpMethod": "GET", - "description": "Return an icon or its associated metadata", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the icon.", - "required": true, - "location": "path" - }, - "projectId": { - "type": "string", - "description": "The ID of the project.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId", - "id" - ], - "response": { - "$ref": "Icon" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ], - "supportsMediaDownload": true - }, - "list": { - "id": "mapsengine.projects.icons.list", - "path": "projects/{projectId}/icons", - "httpMethod": "GET", - "description": "Return all icons in the current project", - "parameters": { - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of the project.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "IconsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "rasterCollections": { - "methods": { - "cancelProcessing": { - "id": "mapsengine.rasterCollections.cancelProcessing", - "path": "rasterCollections/{id}/cancelProcessing", - "httpMethod": "POST", - "description": "Cancel processing on a raster collection asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "create": { - "id": "mapsengine.rasterCollections.create", - "path": "rasterCollections", - "httpMethod": "POST", - "description": "Create a raster collection asset.", - "request": { - "$ref": "RasterCollection" - }, - "response": { - "$ref": "RasterCollection" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "delete": { - "id": "mapsengine.rasterCollections.delete", - "path": "rasterCollections/{id}", - "httpMethod": "DELETE", - "description": "Delete a raster collection.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection. Only the raster collection creator or project owner are permitted to delete. If the rastor collection is included in a layer, the request will fail. Remove the raster collection from all layers prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.rasterCollections.get", - "path": "rasterCollections/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular raster collection.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "RasterCollection" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.rasterCollections.list", - "path": "rasterCollections", - "httpMethod": "GET", - "description": "Return all raster collections readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "The raster collection has completed processing.", - "The raster collection has failed processing.", - "The raster collection is not ready for processing.", - "The raster collection is processing.", - "The raster collection is ready for processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "response": { - "$ref": "RasterCollectionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.rasterCollections.patch", - "path": "rasterCollections/{id}", - "httpMethod": "PATCH", - "description": "Mutate a raster collection asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "RasterCollection" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "process": { - "id": "mapsengine.rasterCollections.process", - "path": "rasterCollections/{id}/process", - "httpMethod": "POST", - "description": "Process a raster collection asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "parents": { - "methods": { - "list": { - "id": "mapsengine.rasterCollections.parents.list", - "path": "rasterCollections/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified raster collection.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.rasterCollections.permissions.batchDelete", - "path": "rasterCollections/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.rasterCollections.permissions.batchUpdate", - "path": "rasterCollections/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.rasterCollections.permissions.list", - "path": "rasterCollections/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "rasters": { - "methods": { - "batchDelete": { - "id": "mapsengine.rasterCollections.rasters.batchDelete", - "path": "rasterCollections/{id}/rasters/batchDelete", - "httpMethod": "POST", - "description": "Remove rasters from an existing raster collection.\n\nUp to 50 rasters can be included in a single batchDelete request. Each batchDelete request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection to which these rasters belong.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "RasterCollectionsRasterBatchDeleteRequest" - }, - "response": { - "$ref": "RasterCollectionsRastersBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchInsert": { - "id": "mapsengine.rasterCollections.rasters.batchInsert", - "path": "rasterCollections/{id}/rasters/batchInsert", - "httpMethod": "POST", - "description": "Add rasters to an existing raster collection. Rasters must be successfully processed in order to be added to a raster collection.\n\nUp to 50 rasters can be included in a single batchInsert request. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster collection to which these rasters belong.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "RasterCollectionsRastersBatchInsertRequest" - }, - "response": { - "$ref": "RasterCollectionsRastersBatchInsertResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.rasterCollections.rasters.list", - "path": "rasterCollections/{id}/rasters", - "httpMethod": "GET", - "description": "Return all rasters within a raster collection.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the raster collection to which these rasters belong.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "RasterCollectionsRastersListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "rasters": { - "methods": { - "delete": { - "id": "mapsengine.rasters.delete", - "path": "rasters/{id}", - "httpMethod": "DELETE", - "description": "Delete a raster.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster. Only the raster creator or project owner are permitted to delete. If the raster is included in a layer or mosaic, the request will fail. Remove it from all parents prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.rasters.get", - "path": "rasters/{id}", - "httpMethod": "GET", - "description": "Return metadata for a single raster.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Raster" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.rasters.list", - "path": "rasters", - "httpMethod": "GET", - "description": "Return all rasters readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "The raster has completed processing.", - "The raster has failed processing.", - "The raster is not ready for processing.", - "The raster is processing.", - "The raster is ready for processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "required": true, - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "RastersListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.rasters.patch", - "path": "rasters/{id}", - "httpMethod": "PATCH", - "description": "Mutate a raster asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "Raster" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "process": { - "id": "mapsengine.rasters.process", - "path": "rasters/{id}/process", - "httpMethod": "POST", - "description": "Process a raster asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the raster.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "upload": { - "id": "mapsengine.rasters.upload", - "path": "rasters/upload", - "httpMethod": "POST", - "description": "Create a skeleton raster asset for upload.", - "request": { - "$ref": "Raster" - }, - "response": { - "$ref": "Raster" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "files": { - "methods": { - "insert": { - "id": "mapsengine.rasters.files.insert", - "path": "rasters/{id}/files", - "httpMethod": "POST", - "description": "Upload a file to a raster asset.", - "parameters": { - "filename": { - "type": "string", - "description": "The file name of this uploaded file.", - "required": true, - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the raster asset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id", - "filename" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ], - "supportsMediaUpload": true, - "mediaUpload": { - "accept": [ - "*/*" - ], - "maxSize": "10GB", - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/mapsengine/v1/rasters/{id}/files" - }, - "resumable": { - "multipart": true, - "path": "/resumable/upload/mapsengine/v1/rasters/{id}/files" - } - } - } - } - } - }, - "parents": { - "methods": { - "list": { - "id": "mapsengine.rasters.parents.list", - "path": "rasters/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified rasters.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the rasters whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.rasters.permissions.batchDelete", - "path": "rasters/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.rasters.permissions.batchUpdate", - "path": "rasters/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.rasters.permissions.list", - "path": "rasters/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - }, - "tables": { - "methods": { - "create": { - "id": "mapsengine.tables.create", - "path": "tables", - "httpMethod": "POST", - "description": "Create a table asset.", - "request": { - "$ref": "Table" - }, - "response": { - "$ref": "Table" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "delete": { - "id": "mapsengine.tables.delete", - "path": "tables/{id}", - "httpMethod": "DELETE", - "description": "Delete a table.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table. Only the table creator or project owner are permitted to delete. If the table is included in a layer, the request will fail. Remove it from all layers prior to deleting.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.tables.get", - "path": "tables/{id}", - "httpMethod": "GET", - "description": "Return metadata for a particular table, including the schema.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table.", - "required": true, - "location": "path" - }, - "version": { - "type": "string", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Table" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.tables.list", - "path": "tables", - "httpMethod": "GET", - "description": "Return all tables readable by the current user.", - "parameters": { - "bbox": { - "type": "string", - "description": "A bounding box, expressed as \"west,south,east,north\". If set, only assets which intersect this bounding box will be returned.", - "location": "query" - }, - "createdAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.", - "format": "date-time", - "location": "query" - }, - "createdBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.", - "format": "date-time", - "location": "query" - }, - "creatorEmail": { - "type": "string", - "description": "An email address representing a user. Returned assets that have been created by the user associated with the provided email address.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 100.", - "format": "uint32", - "location": "query" - }, - "modifiedAfter": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.", - "format": "date-time", - "location": "query" - }, - "modifiedBefore": { - "type": "string", - "description": "An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.", - "format": "date-time", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "processingStatus": { - "type": "string", - "enum": [ - "complete", - "failed", - "notReady", - "processing", - "ready" - ], - "enumDescriptions": [ - "The table has completed processing.", - "The table has failed processing.", - "The table is not ready for processing.", - "The table is processing.", - "The table is ready for processing." - ], - "location": "query" - }, - "projectId": { - "type": "string", - "description": "The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.", - "location": "query" - }, - "role": { - "type": "string", - "description": "The role parameter indicates that the response should only contain assets where the current user has the specified level of access.", - "enum": [ - "owner", - "reader", - "writer" - ], - "enumDescriptions": [ - "The user can read, write and administer the asset.", - "The user can read the asset.", - "The user can read and write the asset." - ], - "location": "query" - }, - "search": { - "type": "string", - "description": "An unstructured search string used to filter the set of results based on asset metadata.", - "location": "query" - }, - "tags": { - "type": "string", - "description": "A comma separated list of tags. Returned assets will contain all the tags from the list.", - "location": "query" - } - }, - "response": { - "$ref": "TablesListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "patch": { - "id": "mapsengine.tables.patch", - "path": "tables/{id}", - "httpMethod": "PATCH", - "description": "Mutate a table asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "Table" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "process": { - "id": "mapsengine.tables.process", - "path": "tables/{id}/process", - "httpMethod": "POST", - "description": "Process a table asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ProcessResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "upload": { - "id": "mapsengine.tables.upload", - "path": "tables/upload", - "httpMethod": "POST", - "description": "Create a placeholder table asset to which table files can be uploaded.\nOnce the placeholder has been created, files are uploaded to the https://www.googleapis.com/upload/mapsengine/v1/tables/table_id/files endpoint.\nSee Table Upload in the Developer's Guide or Table.files: insert in the reference documentation for more information.", - "request": { - "$ref": "Table" - }, - "response": { - "$ref": "Table" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - } - }, - "resources": { - "features": { - "methods": { - "batchDelete": { - "id": "mapsengine.tables.features.batchDelete", - "path": "tables/{id}/features/batchDelete", - "httpMethod": "POST", - "description": "Delete all features matching the given IDs.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table that contains the features to be deleted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "FeaturesBatchDeleteRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchInsert": { - "id": "mapsengine.tables.features.batchInsert", - "path": "tables/{id}/features/batchInsert", - "httpMethod": "POST", - "description": "Append features to an existing table.\n\nA single batchInsert request can create:\n\n- Up to 50 features.\n- A combined total of 10 000 vertices.\nFeature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.\n\nFor more information about inserting features, read Creating features in the Google Maps Engine developer's guide.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table to append the features to.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "FeaturesBatchInsertRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchPatch": { - "id": "mapsengine.tables.features.batchPatch", - "path": "tables/{id}/features/batchPatch", - "httpMethod": "POST", - "description": "Update the supplied features.\n\nA single batchPatch request can update:\n\n- Up to 50 features.\n- A combined total of 10 000 vertices.\nFeature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.\n\nFeature updates use HTTP PATCH semantics:\n\n- A supplied value replaces an existing value (if any) in that field.\n- Omitted fields remain unchanged.\n- Complex values in geometries and properties must be replaced as atomic units. For example, providing just the coordinates of a geometry is not allowed; the complete geometry, including type, must be supplied.\n- Setting a property's value to null deletes that property.\nFor more information about updating features, read Updating features in the Google Maps Engine developer's guide.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table containing the features to be patched.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "FeaturesBatchPatchRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "get": { - "id": "mapsengine.tables.features.get", - "path": "tables/{tableId}/features/{id}", - "httpMethod": "GET", - "description": "Return a single feature, given its ID.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the feature to get.", - "required": true, - "location": "path" - }, - "select": { - "type": "string", - "description": "A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.", - "location": "query" - }, - "tableId": { - "type": "string", - "description": "The ID of the table.", - "required": true, - "location": "path" - }, - "version": { - "type": "string", - "description": "The table version to access. See Accessing Public Data for information.", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - } - }, - "parameterOrder": [ - "tableId", - "id" - ], - "response": { - "$ref": "Feature" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - }, - "list": { - "id": "mapsengine.tables.features.list", - "path": "tables/{id}/features", - "httpMethod": "GET", - "description": "Return all features readable by the current user.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table to which these features belong.", - "required": true, - "location": "path" - }, - "include": { - "type": "string", - "description": "A comma separated list of optional data to include. Optional data available: schema.", - "location": "query" - }, - "intersects": { - "type": "string", - "description": "A geometry literal that specifies the spatial restriction of the query.", - "location": "query" - }, - "limit": { - "type": "integer", - "description": "The total number of features to return from the query, irrespective of the number of pages.", - "format": "uint32", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in the response, used for paging. The maximum supported value is 1000.", - "format": "uint32", - "location": "query" - }, - "orderBy": { - "type": "string", - "description": "An SQL-like order by clause used to sort results. If this parameter is not included, the order of features is undefined.", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - }, - "select": { - "type": "string", - "description": "A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.", - "location": "query" - }, - "version": { - "type": "string", - "description": "The table version to access. See Accessing Public Data for information.", - "enum": [ - "draft", - "published" - ], - "enumDescriptions": [ - "The draft version.", - "The published version." - ], - "location": "query" - }, - "where": { - "type": "string", - "description": "An SQL-like predicate used to filter results.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "FeaturesListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "files": { - "methods": { - "insert": { - "id": "mapsengine.tables.files.insert", - "path": "tables/{id}/files", - "httpMethod": "POST", - "description": "Upload a file to a placeholder table asset. See Table Upload in the Developer's Guide for more information.\nSupported file types are listed in the Supported data formats and limits article of the Google Maps Engine help center.", - "parameters": { - "filename": { - "type": "string", - "description": "The file name of this uploaded file.", - "required": true, - "location": "query" - }, - "id": { - "type": "string", - "description": "The ID of the table asset.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id", - "filename" - ], - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ], - "supportsMediaUpload": true, - "mediaUpload": { - "accept": [ - "*/*" - ], - "maxSize": "1GB", - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/mapsengine/v1/tables/{id}/files" - }, - "resumable": { - "multipart": true, - "path": "/resumable/upload/mapsengine/v1/tables/{id}/files" - } - } - } - } - } - }, - "parents": { - "methods": { - "list": { - "id": "mapsengine.tables.parents.list", - "path": "tables/{id}/parents", - "httpMethod": "GET", - "description": "Return all parent ids of the specified table.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the table whose parents will be listed.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "The maximum number of items to include in a single response page. The maximum supported value is 50.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.", - "location": "query" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "ParentsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - }, - "permissions": { - "methods": { - "batchDelete": { - "id": "mapsengine.tables.permissions.batchDelete", - "path": "tables/{id}/permissions/batchDelete", - "httpMethod": "POST", - "description": "Remove permission entries from an already existing asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset from which permissions will be removed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchDeleteRequest" - }, - "response": { - "$ref": "PermissionsBatchDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "batchUpdate": { - "id": "mapsengine.tables.permissions.batchUpdate", - "path": "tables/{id}/permissions/batchUpdate", - "httpMethod": "POST", - "description": "Add or update permission entries to an already existing asset.\n\nAn asset can hold up to 20 different permission entries. Each batchInsert request is atomic.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset to which permissions will be added.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "request": { - "$ref": "PermissionsBatchUpdateRequest" - }, - "response": { - "$ref": "PermissionsBatchUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine" - ] - }, - "list": { - "id": "mapsengine.tables.permissions.list", - "path": "tables/{id}/permissions", - "httpMethod": "GET", - "description": "Return all of the permissions for the specified asset.", - "parameters": { - "id": { - "type": "string", - "description": "The ID of the asset whose permissions will be listed.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "PermissionsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/mapsengine", - "https://www.googleapis.com/auth/mapsengine.readonly" - ] - } - } - } - } - } - } -} diff --git a/etc/api/mirror/v1/mirror-api.json b/etc/api/mirror/v1/mirror-api.json index 2d4b6ffa33..c41c587b17 100644 --- a/etc/api/mirror/v1/mirror-api.json +++ b/etc/api/mirror/v1/mirror-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/hIasiAOyHnf-RHM3ojoildcrZRA\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/22GY9K9VtYhN_tb0gpdw_zDH1Gg\"", "discoveryVersion": "v1", "id": "mirror:v1", "name": "mirror", diff --git a/etc/api/oauth2/v1/oauth2-api.json b/etc/api/oauth2/v1/oauth2-api.json index 3abc6e44a5..31f02861e9 100644 --- a/etc/api/oauth2/v1/oauth2-api.json +++ b/etc/api/oauth2/v1/oauth2-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/S1iII2neZnMEoav5IQpmCUn2s7A\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/4JDZ62MhN4YOflSJ_PcU8BbcPPg\"", "discoveryVersion": "v1", "id": "oauth2:v1", "name": "oauth2", "version": "v1", - "revision": "20160122", + "revision": "20160217", "title": "Google OAuth2 API", "description": "Lets you access OAuth2 protocol related APIs.", "ownerDomain": "google.com", @@ -70,7 +70,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/plus.login": { - "description": "Know your basic profile info and list of people in your circles." + "description": "Know the list of people in your circles, your age range, and language" }, "https://www.googleapis.com/auth/plus.me": { "description": "Know who you are on Google" diff --git a/etc/api/oauth2/v2/oauth2-api.json b/etc/api/oauth2/v2/oauth2-api.json index 2ea224a1fb..9588fd2e9c 100644 --- a/etc/api/oauth2/v2/oauth2-api.json +++ b/etc/api/oauth2/v2/oauth2-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/4RstFlFPreel0Xs7QsU89CQYKUc\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/x_XzcmeoKnijhPh0Qy2TxVp6WB4\"", "discoveryVersion": "v1", "id": "oauth2:v2", "name": "oauth2", "version": "v2", - "revision": "20160122", + "revision": "20160217", "title": "Google OAuth2 API", "description": "Lets you access OAuth2 protocol related APIs.", "ownerDomain": "google.com", @@ -70,7 +70,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/plus.login": { - "description": "Know your basic profile info and list of people in your circles." + "description": "Know the list of people in your circles, your age range, and language" }, "https://www.googleapis.com/auth/plus.me": { "description": "Know who you are on Google" diff --git a/etc/api/pagespeedonline/v1/pagespeedonline-api.json b/etc/api/pagespeedonline/v1/pagespeedonline-api.json index 86f507ac22..87bb734ae3 100644 --- a/etc/api/pagespeedonline/v1/pagespeedonline-api.json +++ b/etc/api/pagespeedonline/v1/pagespeedonline-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7fHGVeFPBpI1nlNJMwAmwuomK2I\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/BukGAprNRptNiZfFq1zx1Gn3Fhs\"", "discoveryVersion": "v1", "id": "pagespeedonline:v1", "name": "pagespeedonline", diff --git a/etc/api/pagespeedonline/v2/pagespeedonline-api.json b/etc/api/pagespeedonline/v2/pagespeedonline-api.json index 16b02afdd1..53ed1b08a6 100644 --- a/etc/api/pagespeedonline/v2/pagespeedonline-api.json +++ b/etc/api/pagespeedonline/v2/pagespeedonline-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/dMoBIg1XhfokqjOL5v93aX6wCyo\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/GZCsO1AHQNW3s7om8yb-wxZmYlo\"", "discoveryVersion": "v1", "id": "pagespeedonline:v2", "name": "pagespeedonline", diff --git a/etc/api/people/v1/people-api.json b/etc/api/people/v1/people-api.json new file mode 100644 index 0000000000..07fbc1b51c --- /dev/null +++ b/etc/api/people/v1/people-api.json @@ -0,0 +1,1256 @@ +{ + "kind": "discovery#restDescription", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/tzwJjoO4XDFgwNQjmiM8lPsFMzA\"", + "discoveryVersion": "v1", + "id": "people:v1", + "name": "people", + "version": "v1", + "revision": "20160210", + "title": "Google People API", + "description": "The Google People API service gives access to information about profiles and contacts.", + "ownerDomain": "google.com", + "ownerName": "Google", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "documentationLink": "https://developers.google.com/people/", + "protocol": "rest", + "baseUrl": "https://people.googleapis.com/", + "basePath": "", + "rootUrl": "https://people.googleapis.com/", + "servicePath": "", + "batchPath": "batch", + "version_module": true, + "parameters": { + "access_token": { + "type": "string", + "description": "OAuth access token.", + "location": "query" + }, + "alt": { + "type": "string", + "description": "Data format for response.", + "default": "json", + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query" + }, + "bearer_token": { + "type": "string", + "description": "OAuth bearer token.", + "location": "query" + }, + "callback": { + "type": "string", + "description": "JSONP", + "location": "query" + }, + "fields": { + "type": "string", + "description": "Selector specifying which fields to include in a partial response.", + "location": "query" + }, + "key": { + "type": "string", + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query" + }, + "oauth_token": { + "type": "string", + "description": "OAuth 2.0 token for the current user.", + "location": "query" + }, + "pp": { + "type": "boolean", + "description": "Pretty-print response.", + "default": "true", + "location": "query" + }, + "prettyPrint": { + "type": "boolean", + "description": "Returns response with indentations and line breaks.", + "default": "true", + "location": "query" + }, + "quotaUser": { + "type": "string", + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query" + }, + "upload_protocol": { + "type": "string", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query" + }, + "uploadType": { + "type": "string", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query" + }, + "$.xgafv": { + "type": "string", + "description": "V1 error format.", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + } + }, + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/contacts": { + "description": "Manage your contacts" + }, + "https://www.googleapis.com/auth/contacts.readonly": { + "description": "View your contacts" + }, + "https://www.googleapis.com/auth/plus.login": { + "description": "Know your basic profile info and list of people in your circles." + }, + "https://www.googleapis.com/auth/user.addresses.read": { + "description": "View your street addresses" + }, + "https://www.googleapis.com/auth/user.birthday.read": { + "description": "View your complete date of birth" + }, + "https://www.googleapis.com/auth/user.emails.read": { + "description": "View your email addresses" + }, + "https://www.googleapis.com/auth/user.phonenumbers.read": { + "description": "View your phone numbers" + }, + "https://www.googleapis.com/auth/userinfo.email": { + "description": "View your email address" + }, + "https://www.googleapis.com/auth/userinfo.profile": { + "description": "View your basic profile info" + } + } + } + }, + "schemas": { + "Person": { + "id": "Person", + "type": "object", + "description": "Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.", + "properties": { + "resourceName": { + "type": "string", + "description": "The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`." + }, + "etag": { + "type": "string", + "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation." + }, + "metadata": { + "$ref": "PersonMetadata", + "description": "Metadata about the person." + }, + "locales": { + "type": "array", + "description": "The person's locale preferences.", + "items": { + "$ref": "Locale" + } + }, + "names": { + "type": "array", + "description": "The person's names.", + "items": { + "$ref": "Name" + } + }, + "nicknames": { + "type": "array", + "description": "The person's nicknames.", + "items": { + "$ref": "Nickname" + } + }, + "coverPhotos": { + "type": "array", + "description": "The person's cover photos.", + "items": { + "$ref": "CoverPhoto" + } + }, + "photos": { + "type": "array", + "description": "The person's photos.", + "items": { + "$ref": "Photo" + } + }, + "genders": { + "type": "array", + "description": "The person's genders.", + "items": { + "$ref": "Gender" + } + }, + "ageRange": { + "type": "string", + "description": "The person's age range.", + "enum": [ + "AGE_RANGE_UNSPECIFIED", + "LESS_THAN_EIGHTEEN", + "EIGHTEEN_TO_TWENTY", + "TWENTY_ONE_OR_OLDER" + ] + }, + "birthdays": { + "type": "array", + "description": "The person's birthdays.", + "items": { + "$ref": "Birthday" + } + }, + "events": { + "type": "array", + "description": "The person's events.", + "items": { + "$ref": "Event" + } + }, + "addresses": { + "type": "array", + "description": "The person's street addresses.", + "items": { + "$ref": "Address" + } + }, + "residences": { + "type": "array", + "description": "The person's residences.", + "items": { + "$ref": "Residence" + } + }, + "emailAddresses": { + "type": "array", + "description": "The person's email addresses.", + "items": { + "$ref": "EmailAddress" + } + }, + "phoneNumbers": { + "type": "array", + "description": "The person's phone numbers.", + "items": { + "$ref": "PhoneNumber" + } + }, + "imClients": { + "type": "array", + "description": "The person's instant messaging clients.", + "items": { + "$ref": "ImClient" + } + }, + "taglines": { + "type": "array", + "description": "The person's taglines.", + "items": { + "$ref": "Tagline" + } + }, + "biographies": { + "type": "array", + "description": "The person's biographies.", + "items": { + "$ref": "Biography" + } + }, + "urls": { + "type": "array", + "description": "The person's associated URLs.", + "items": { + "$ref": "Url" + } + }, + "organizations": { + "type": "array", + "description": "The person's past or current organizations.", + "items": { + "$ref": "Organization" + } + }, + "occupations": { + "type": "array", + "description": "The person's occupations.", + "items": { + "$ref": "Occupation" + } + }, + "interests": { + "type": "array", + "description": "The person's interests.", + "items": { + "$ref": "Interest" + } + }, + "skills": { + "type": "array", + "description": "The person's skills.", + "items": { + "$ref": "Skill" + } + }, + "braggingRights": { + "type": "array", + "description": "The person's bragging rights.", + "items": { + "$ref": "BraggingRights" + } + }, + "relations": { + "type": "array", + "description": "The person's relations.", + "items": { + "$ref": "Relation" + } + }, + "relationshipInterests": { + "type": "array", + "description": "The kind of relationship the person is looking for.", + "items": { + "$ref": "RelationshipInterest" + } + }, + "relationshipStatuses": { + "type": "array", + "description": "The person's relationship statuses.", + "items": { + "$ref": "RelationshipStatus" + } + }, + "memberships": { + "type": "array", + "description": "The person's group memberships.", + "items": { + "$ref": "Membership" + } + } + } + }, + "PersonMetadata": { + "id": "PersonMetadata", + "type": "object", + "description": "Metadata about a person.", + "properties": { + "sources": { + "type": "array", + "description": "The sources of data for the person.", + "items": { + "$ref": "Source" + } + }, + "previousResourceNames": { + "type": "array", + "description": "Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.", + "items": { + "type": "string" + } + }, + "deleted": { + "type": "boolean", + "description": "True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token." + }, + "objectType": { + "type": "string", + "description": "The type of the person object.", + "enum": [ + "OBJECT_TYPE_UNSPECIFIED", + "PERSON", + "PAGE" + ] + } + } + }, + "Source": { + "id": "Source", + "type": "object", + "description": "The source of a field.", + "properties": { + "type": { + "type": "string", + "description": "The source type.", + "enum": [ + "OTHER", + "ACCOUNT", + "PROFILE", + "DOMAIN_PROFILE", + "CONTACT" + ] + }, + "id": { + "type": "string", + "description": "A unique identifier within the source type generated by the server." + } + } + }, + "Locale": { + "id": "Locale", + "type": "object", + "description": "A person's locale preference.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the locale." + }, + "value": { + "type": "string", + "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale." + } + } + }, + "FieldMetadata": { + "id": "FieldMetadata", + "type": "object", + "description": "Metadata about a field.", + "properties": { + "primary": { + "type": "boolean", + "description": "True if the field is the primary field; false if the field is a secondary field." + }, + "verified": { + "type": "boolean", + "description": "True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person." + }, + "source": { + "$ref": "Source", + "description": "The source of the field." + } + } + }, + "Name": { + "id": "Name", + "type": "object", + "description": "A person's name. If the name is a mononym, the family name is empty.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the name." + }, + "displayName": { + "type": "string", + "description": "The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header." + }, + "familyName": { + "type": "string", + "description": "The family name." + }, + "givenName": { + "type": "string", + "description": "The given name." + }, + "middleName": { + "type": "string", + "description": "The middle name(s)." + }, + "honorificPrefix": { + "type": "string", + "description": "The honorific prefixes, such as `Mrs.` or `Dr.`" + }, + "honorificSuffix": { + "type": "string", + "description": "The honorific suffixes, such as `Jr.`" + }, + "phoneticFamilyName": { + "type": "string", + "description": "The family name spelled as it sounds." + }, + "phoneticGivenName": { + "type": "string", + "description": "The given name spelled as it sounds." + }, + "phoneticMiddleName": { + "type": "string", + "description": "The middle name(s) spelled as they sound." + }, + "phoneticHonorificPrefix": { + "type": "string", + "description": "The honorific prefixes spelled as they sound." + }, + "phoneticHonorificSuffix": { + "type": "string", + "description": "The honorific suffixes spelled as they sound." + } + } + }, + "Nickname": { + "id": "Nickname", + "type": "object", + "description": "A person's nickname.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the nickname." + }, + "value": { + "type": "string", + "description": "The nickname." + }, + "type": { + "type": "string", + "description": "The type of the nickname.", + "enum": [ + "DEFAULT", + "MAIDEN_NAME", + "INITIALS", + "GPLUS", + "OTHER_NAME" + ] + } + } + }, + "CoverPhoto": { + "id": "CoverPhoto", + "type": "object", + "description": "A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the cover photo." + }, + "url": { + "type": "string", + "description": "The URL of the cover photo." + }, + "default": { + "type": "boolean", + "description": "True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo." + } + } + }, + "Photo": { + "id": "Photo", + "type": "object", + "description": "A person's photo. A picture shown next to the person's name to help others recognize the person.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the photo." + }, + "url": { + "type": "string", + "description": "The URL of the photo." + } + } + }, + "Gender": { + "id": "Gender", + "type": "object", + "description": "A person's gender.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the gender." + }, + "value": { + "type": "string", + "description": "The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`" + }, + "formattedValue": { + "type": "string", + "description": "The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + } + } + }, + "Birthday": { + "id": "Birthday", + "type": "object", + "description": "A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the birthday." + }, + "date": { + "$ref": "Date", + "description": "The date of the birthday." + }, + "text": { + "type": "string", + "description": "A free-form string representing the user's birthday." + } + } + }, + "Date": { + "id": "Date", + "type": "object", + "description": "Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date.", + "properties": { + "year": { + "type": "integer", + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "format": "int32" + }, + "month": { + "type": "integer", + "description": "Month of year. Must be from 1 to 12.", + "format": "int32" + }, + "day": { + "type": "integer", + "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.", + "format": "int32" + } + } + }, + "Event": { + "id": "Event", + "type": "object", + "description": "An event related to the person.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the event." + }, + "date": { + "$ref": "Date", + "description": "The date of the event." + }, + "type": { + "type": "string", + "description": "The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`" + }, + "formattedType": { + "type": "string", + "description": "The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + } + } + }, + "Address": { + "id": "Address", + "type": "object", + "description": "A person's physical address. May be a P.O. box or street address. All fields are optional.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the address." + }, + "formattedValue": { + "type": "string", + "description": "The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + }, + "type": { + "type": "string", + "description": "The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`" + }, + "formattedType": { + "type": "string", + "description": "The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + }, + "poBox": { + "type": "string", + "description": "The P.O. box of the address." + }, + "streetAddress": { + "type": "string", + "description": "The street address." + }, + "extendedAddress": { + "type": "string", + "description": "The extended address of the address; for example, the apartment number." + }, + "city": { + "type": "string", + "description": "The city of the address." + }, + "region": { + "type": "string", + "description": "The region of the address; for example, the state or province." + }, + "postalCode": { + "type": "string", + "description": "The postal code of the address." + }, + "country": { + "type": "string", + "description": "The country of the address." + }, + "countryCode": { + "type": "string", + "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address." + } + } + }, + "Residence": { + "id": "Residence", + "type": "object", + "description": "A person's past or current residence.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the residence." + }, + "value": { + "type": "string", + "description": "The address of the residence." + }, + "current": { + "type": "boolean", + "description": "True if the residence is the person's current residence; false if the residence is a past residence." + } + } + }, + "EmailAddress": { + "id": "EmailAddress", + "type": "object", + "description": "A person's email address.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the email address." + }, + "value": { + "type": "string", + "description": "The email address." + }, + "type": { + "type": "string", + "description": "The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`" + }, + "formattedType": { + "type": "string", + "description": "The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + } + } + }, + "PhoneNumber": { + "id": "PhoneNumber", + "type": "object", + "description": "A person's phone number.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the phone number." + }, + "value": { + "type": "string", + "description": "The phone number." + }, + "canonicalForm": { + "type": "string", + "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number." + }, + "type": { + "type": "string", + "description": "The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`" + }, + "formattedType": { + "type": "string", + "description": "The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale." + } + } + }, + "ImClient": { + "id": "ImClient", + "type": "object", + "description": "A person's instant messaging client.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the IM client." + }, + "username": { + "type": "string", + "description": "The user name used in the IM client." + }, + "type": { + "type": "string", + "description": "The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`" + }, + "formattedType": { + "type": "string", + "description": "The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + }, + "protocol": { + "type": "string", + "description": "The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`" + }, + "formattedProtocol": { + "type": "string", + "description": "The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + } + } + }, + "Tagline": { + "id": "Tagline", + "type": "object", + "description": "A brief one-line description of the person.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the tagline." + }, + "value": { + "type": "string", + "description": "The tagline." + } + } + }, + "Biography": { + "id": "Biography", + "type": "object", + "description": "A person's short biography.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the biography." + }, + "value": { + "type": "string", + "description": "The short biography." + } + } + }, + "Url": { + "id": "Url", + "type": "object", + "description": "A person's associated URLs.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the URL." + }, + "value": { + "type": "string", + "description": "The URL." + }, + "type": { + "type": "string", + "description": "The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`" + }, + "formattedType": { + "type": "string", + "description": "The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + } + } + }, + "Organization": { + "id": "Organization", + "type": "object", + "description": "A person's past or current organization. Overlapping date ranges are permitted.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the organization." + }, + "type": { + "type": "string", + "description": "The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`" + }, + "formattedType": { + "type": "string", + "description": "The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + }, + "startDate": { + "$ref": "Date", + "description": "The start date when the person joined the organization." + }, + "endDate": { + "$ref": "Date", + "description": "The end date when the person left the organization." + }, + "current": { + "type": "boolean", + "description": "True if the organization is the person's current organization; false if the organization is a past organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + }, + "phoneticName": { + "type": "string", + "description": "The phonetic name of the organization." + }, + "department": { + "type": "string", + "description": "The person's department at the organization." + }, + "title": { + "type": "string", + "description": "The person's job title at the organization." + }, + "jobDescription": { + "type": "string", + "description": "The person's job description at the organization." + }, + "symbol": { + "type": "string", + "description": "The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym." + }, + "domain": { + "type": "string", + "description": "The domain name associated with the organization; for example, `google.com`." + }, + "location": { + "type": "string", + "description": "The location of the organization office the person works at." + } + } + }, + "Occupation": { + "id": "Occupation", + "type": "object", + "description": "A person's occupation.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the occupation." + }, + "value": { + "type": "string", + "description": "The occupation; for example, `carpenter`." + } + } + }, + "Interest": { + "id": "Interest", + "type": "object", + "description": "One of the person's interests.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the interest." + }, + "value": { + "type": "string", + "description": "The interest; for example, `stargazing`." + } + } + }, + "Skill": { + "id": "Skill", + "type": "object", + "description": "A skill that the person has.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the skill." + }, + "value": { + "type": "string", + "description": "The skill; for example, `underwater basket weaving`." + } + } + }, + "BraggingRights": { + "id": "BraggingRights", + "type": "object", + "description": "A person's bragging rights.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the bragging rights." + }, + "value": { + "type": "string", + "description": "The bragging rights; for example, `climbed mount everest`." + } + } + }, + "Relation": { + "id": "Relation", + "type": "object", + "description": "A person's relation to another person.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the relation." + }, + "person": { + "type": "string", + "description": "The name of the other person this relation refers to." + }, + "type": { + "type": "string", + "description": "The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`" + }, + "formattedType": { + "type": "string", + "description": "The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header." + } + } + }, + "RelationshipInterest": { + "id": "RelationshipInterest", + "type": "object", + "description": "The kind of relationship the person is looking for.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the relationship interest." + }, + "value": { + "type": "string", + "description": "The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`" + }, + "formattedValue": { + "type": "string", + "description": "The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header." + } + } + }, + "RelationshipStatus": { + "id": "RelationshipStatus", + "type": "object", + "description": "A person's relationship status.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the relationship status." + }, + "value": { + "type": "string", + "description": "The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`" + }, + "formattedValue": { + "type": "string", + "description": "The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale." + } + } + }, + "Membership": { + "id": "Membership", + "type": "object", + "description": "A person's membership in a group.", + "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the membership." + }, + "contactGroupMembership": { + "$ref": "ContactGroupMembership", + "description": "The contact group membership." + }, + "domainMembership": { + "$ref": "DomainMembership", + "description": "The domain membership." + } + } + }, + "ContactGroupMembership": { + "id": "ContactGroupMembership", + "type": "object", + "description": "A Google contact group membership.", + "properties": { + "contactGroupId": { + "type": "string", + "description": "The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups." + } + } + }, + "DomainMembership": { + "id": "DomainMembership", + "type": "object", + "description": "A Google Apps Domain membership.", + "properties": { + "inViewerDomain": { + "type": "boolean", + "description": "True if the person is in the viewer's Google Apps domain." + } + } + }, + "GetPeopleResponse": { + "id": "GetPeopleResponse", + "type": "object", + "properties": { + "responses": { + "type": "array", + "description": "The response for each requested resource name.", + "items": { + "$ref": "PersonResponse" + } + } + } + }, + "PersonResponse": { + "id": "PersonResponse", + "type": "object", + "description": "The response for a single person", + "properties": { + "httpStatusCode": { + "type": "integer", + "description": "[HTTP 1.1 status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).", + "format": "int32" + }, + "person": { + "$ref": "Person", + "description": "The person." + }, + "requestedResourceName": { + "type": "string", + "description": "The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL." + } + } + }, + "ListConnectionsResponse": { + "id": "ListConnectionsResponse", + "type": "object", + "properties": { + "connections": { + "type": "array", + "description": "The list of people that the requestor is connected to.", + "items": { + "$ref": "Person" + } + }, + "nextPageToken": { + "type": "string", + "description": "The token that can be used to retrieve the next page of results." + }, + "nextSyncToken": { + "type": "string", + "description": "The token that can be used to retrieve changes since the last request." + } + } + } + }, + "resources": { + "people": { + "methods": { + "get": { + "id": "people.people.get", + "path": "v1/{+resourceName}", + "httpMethod": "GET", + "description": "Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user.", + "parameters": { + "resourceName": { + "type": "string", + "description": "The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about any user, specify the resource name that identifies the user, such as the resource names returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list).", + "required": true, + "pattern": "^people/[^/]*$", + "location": "path" + }, + "requestMask.includeField": { + "type": "string", + "description": "Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.", + "location": "query" + } + }, + "parameterOrder": [ + "resourceName" + ], + "response": { + "$ref": "Person" + }, + "scopes": [ + "https://www.googleapis.com/auth/contacts", + "https://www.googleapis.com/auth/contacts.readonly", + "https://www.googleapis.com/auth/plus.login", + "https://www.googleapis.com/auth/user.addresses.read", + "https://www.googleapis.com/auth/user.birthday.read", + "https://www.googleapis.com/auth/user.emails.read", + "https://www.googleapis.com/auth/user.phonenumbers.read", + "https://www.googleapis.com/auth/userinfo.email", + "https://www.googleapis.com/auth/userinfo.profile" + ] + }, + "getBatchGet": { + "id": "people.people.getBatchGet", + "path": "v1/people:batchGet", + "httpMethod": "GET", + "description": "Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.", + "parameters": { + "resourceNames": { + "type": "string", + "description": "The resource name, such as one returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list), of one of the people to provide information about. You can include this parameter up to 50 times in one request.", + "repeated": true, + "location": "query" + }, + "requestMask.includeField": { + "type": "string", + "description": "Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.", + "location": "query" + } + }, + "response": { + "$ref": "GetPeopleResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/contacts", + "https://www.googleapis.com/auth/contacts.readonly", + "https://www.googleapis.com/auth/plus.login", + "https://www.googleapis.com/auth/user.addresses.read", + "https://www.googleapis.com/auth/user.birthday.read", + "https://www.googleapis.com/auth/user.emails.read", + "https://www.googleapis.com/auth/user.phonenumbers.read", + "https://www.googleapis.com/auth/userinfo.email", + "https://www.googleapis.com/auth/userinfo.profile" + ] + } + }, + "resources": { + "connections": { + "methods": { + "list": { + "id": "people.people.connections.list", + "path": "v1/{+resourceName}/connections", + "httpMethod": "GET", + "description": "Provides a list of the authenticated user's contacts merged with any linked profiles.", + "parameters": { + "resourceName": { + "type": "string", + "description": "The resource name to return connections for. Only `people/me` is valid.", + "required": true, + "pattern": "^people/[^/]*$", + "location": "path" + }, + "pageToken": { + "type": "string", + "description": "The token of the page to be returned.", + "location": "query" + }, + "pageSize": { + "type": "integer", + "description": "The number of connections to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100.", + "format": "int32", + "location": "query" + }, + "sortOrder": { + "type": "string", + "description": "The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.", + "enum": [ + "LAST_MODIFIED_ASCENDING", + "FIRST_NAME_ASCENDING", + "LAST_NAME_ASCENDING" + ], + "location": "query" + }, + "syncToken": { + "type": "string", + "description": "A sync token, returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created are returned.", + "location": "query" + }, + "requestMask.includeField": { + "type": "string", + "description": "Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.", + "location": "query" + } + }, + "parameterOrder": [ + "resourceName" + ], + "response": { + "$ref": "ListConnectionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/contacts", + "https://www.googleapis.com/auth/contacts.readonly" + ] + } + } + } + } + } + } +} diff --git a/etc/api/plus/v1/plus-api.json b/etc/api/plus/v1/plus-api.json index d4bee834aa..f74dc13a68 100644 --- a/etc/api/plus/v1/plus-api.json +++ b/etc/api/plus/v1/plus-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/YXB_V5C4Fkqp2K2OwxvEljJTMb4\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/bMK4HDuMxZCglZimId2SHixJJ1U\"", "discoveryVersion": "v1", "id": "plus:v1", "name": "plus", "version": "v1", - "revision": "20160127", + "revision": "20160223", "title": "Google+ API", "description": "The Google+ API enables developers to build on top of the Google+ platform.", "ownerDomain": "google.com", @@ -70,7 +70,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/plus.login": { - "description": "Know your basic profile info and list of people in your circles." + "description": "Know the list of people in your circles, your age range, and language" }, "https://www.googleapis.com/auth/plus.me": { "description": "Know who you are on Google" diff --git a/etc/api/plusdomains/v1/plusdomains-api.json b/etc/api/plusdomains/v1/plusdomains-api.json index fe043cd8b0..cd483901da 100644 --- a/etc/api/plusdomains/v1/plusdomains-api.json +++ b/etc/api/plusdomains/v1/plusdomains-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/2S1MuNBMW16Wngcj6eFXJ-vpYKs\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/JRdppZMB2jDawAN9d9uTwBcbPSU\"", "discoveryVersion": "v1", "id": "plusDomains:v1", "name": "plusDomains", "version": "v1", - "revision": "20160127", + "revision": "20160223", "title": "Google+ Domains API", "description": "The Google+ API enables developers to build on top of the Google+ platform.", "ownerDomain": "google.com", @@ -76,7 +76,7 @@ "description": "Manage your circles and add people and pages. People and pages you add to your circles will be notified. Others may see this information publicly. People you add to circles can use Hangouts with you." }, "https://www.googleapis.com/auth/plus.login": { - "description": "Know your basic profile info and list of people in your circles." + "description": "Know the list of people in your circles, your age range, and language" }, "https://www.googleapis.com/auth/plus.me": { "description": "Know who you are on Google" diff --git a/etc/api/prediction/v1.2/prediction-api.json b/etc/api/prediction/v1.2/prediction-api.json index 3731ec0e88..9b81e41035 100644 --- a/etc/api/prediction/v1.2/prediction-api.json +++ b/etc/api/prediction/v1.2/prediction-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/m4MFtFbcU_TWnq3vsQaqCOKdY70\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/utsLXLo_baRB5gCmP4liFP80RTs\"", "discoveryVersion": "v1", "id": "prediction:v1.2", "name": "prediction", diff --git a/etc/api/prediction/v1.3/prediction-api.json b/etc/api/prediction/v1.3/prediction-api.json index 6ece0c81e6..2d370da71b 100644 --- a/etc/api/prediction/v1.3/prediction-api.json +++ b/etc/api/prediction/v1.3/prediction-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/OaSeXRtI2ApQEGfatqk0_2rNByg\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/E9FnjCwoMqxTk9RpZ1wB6ZhkIes\"", "discoveryVersion": "v1", "id": "prediction:v1.3", "name": "prediction", diff --git a/etc/api/prediction/v1.4/prediction-api.json b/etc/api/prediction/v1.4/prediction-api.json index 71226c1b28..5ab944911b 100644 --- a/etc/api/prediction/v1.4/prediction-api.json +++ b/etc/api/prediction/v1.4/prediction-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/nSBDCVWNtowGyy6gUENg3p121g4\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/GvPRJFNKC6lOkPLP7j67r_oY_l4\"", "discoveryVersion": "v1", "id": "prediction:v1.4", "name": "prediction", diff --git a/etc/api/prediction/v1.5/prediction-api.json b/etc/api/prediction/v1.5/prediction-api.json index e3d234fbb6..855e7ff9ba 100644 --- a/etc/api/prediction/v1.5/prediction-api.json +++ b/etc/api/prediction/v1.5/prediction-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/djLEBqSz_lJwuAu1fdOzB3SZHfw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/S6Qe32sEfkDM7uWZBxUvVowSzs0\"", "discoveryVersion": "v1", "id": "prediction:v1.5", "name": "prediction", diff --git a/etc/api/prediction/v1.6/prediction-api.json b/etc/api/prediction/v1.6/prediction-api.json index 29f8b4a2ba..726d96d33d 100644 --- a/etc/api/prediction/v1.6/prediction-api.json +++ b/etc/api/prediction/v1.6/prediction-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/LbUVMm5M0SIU0CpFTD5sSORsvts\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/HYxQmWzK4tWCV6pRcVcSPHPB5zI\"", "discoveryVersion": "v1", "id": "prediction:v1.6", "name": "prediction", diff --git a/etc/api/pubsub/v1beta1/pubsub-api.json b/etc/api/pubsub/v1beta1/pubsub-api.json deleted file mode 100644 index 78188f8a52..0000000000 --- a/etc/api/pubsub/v1beta1/pubsub-api.json +++ /dev/null @@ -1,699 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/WREiw9MY3aTruirkUtn50QBMhss\"", - "discoveryVersion": "v1", - "id": "pubsub:v1beta1", - "name": "pubsub", - "version": "v1beta1", - "revision": "20150813", - "title": "Google Cloud Pub/Sub API", - "description": "Provides reliable, many-to-many, asynchronous messaging between applications.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "https://www.google.com/images/icons/product/search-16.gif", - "x32": "https://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "https://developers.google.com/pubsub/v1beta1", - "labels": [ - "limited_availability" - ], - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/pubsub/v1beta1/", - "basePath": "/pubsub/v1beta1/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "pubsub/v1beta1/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/pubsub": { - "description": "View and manage Pub/Sub topics and subscriptions" - } - } - } - }, - "schemas": { - "AcknowledgeRequest": { - "id": "AcknowledgeRequest", - "type": "object", - "description": "Request for the Acknowledge method.", - "properties": { - "ackId": { - "type": "array", - "description": "The acknowledgment ID for the message being acknowledged. This was returned by the Pub/Sub system in the Pull response.", - "items": { - "type": "string" - } - }, - "subscription": { - "type": "string", - "description": "The subscription whose message is being acknowledged." - } - } - }, - "Label": { - "id": "Label", - "type": "object", - "description": "A key-value pair applied to a given object.", - "properties": { - "key": { - "type": "string", - "description": "The key of a label is a syntactically valid URL (as per RFC 1738) with the \"scheme\" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The \"host\" portion is called the \"namespace\" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated.\n\nKeys are defined by the following grammar:\n\nkey = hostname \"/\" kpath kpath = ksegment *[ \"/\" ksegment ] ksegment = alphadigit | *[ alphadigit | \"-\" | \"_\" | \".\" ]\n\nwhere \"hostname\" and \"alphadigit\" are defined as in RFC 1738.\n\nExample key: spanner.google.com/universe" - }, - "numValue": { - "type": "string", - "description": "An integer value.", - "format": "int64" - }, - "strValue": { - "type": "string", - "description": "A string value." - } - } - }, - "ListSubscriptionsResponse": { - "id": "ListSubscriptionsResponse", - "type": "object", - "description": "Response for the ListSubscriptions method.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "If not empty, indicates that there are more subscriptions that match the request and this value should be passed to the next ListSubscriptionsRequest to continue." - }, - "subscription": { - "type": "array", - "description": "The subscriptions that match the request.", - "items": { - "$ref": "Subscription" - } - } - } - }, - "ListTopicsResponse": { - "id": "ListTopicsResponse", - "type": "object", - "description": "Response for the ListTopics method.", - "properties": { - "nextPageToken": { - "type": "string", - "description": "If not empty, indicates that there are more topics that match the request, and this value should be passed to the next ListTopicsRequest to continue." - }, - "topic": { - "type": "array", - "description": "The resulting topics.", - "items": { - "$ref": "Topic" - } - } - } - }, - "ModifyAckDeadlineRequest": { - "id": "ModifyAckDeadlineRequest", - "type": "object", - "description": "Request for the ModifyAckDeadline method.", - "properties": { - "ackDeadlineSeconds": { - "type": "integer", - "description": "The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request.", - "format": "int32" - }, - "ackId": { - "type": "string", - "description": "The acknowledgment ID. Either this or ack_ids must be populated, not both." - }, - "ackIds": { - "type": "array", - "description": "List of acknowledgment IDs. Either this field or ack_id should be populated, not both.", - "items": { - "type": "string" - } - }, - "subscription": { - "type": "string", - "description": "Next Index: 5 The name of the subscription from which messages are being pulled." - } - } - }, - "ModifyPushConfigRequest": { - "id": "ModifyPushConfigRequest", - "type": "object", - "description": "Request for the ModifyPushConfig method.", - "properties": { - "pushConfig": { - "$ref": "PushConfig", - "description": "An empty push_config indicates that the Pub/Sub system should pause pushing messages from the given subscription." - }, - "subscription": { - "type": "string", - "description": "The name of the subscription." - } - } - }, - "PublishBatchRequest": { - "id": "PublishBatchRequest", - "type": "object", - "description": "Request for the PublishBatch method.", - "properties": { - "messages": { - "type": "array", - "description": "The messages to publish.", - "items": { - "$ref": "PubsubMessage" - } - }, - "topic": { - "type": "string", - "description": "The messages in the request will be published on this topic." - } - } - }, - "PublishBatchResponse": { - "id": "PublishBatchResponse", - "type": "object", - "description": "Response for the PublishBatch method.", - "properties": { - "messageIds": { - "type": "array", - "description": "The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.", - "items": { - "type": "string" - } - } - } - }, - "PublishRequest": { - "id": "PublishRequest", - "type": "object", - "description": "Request for the Publish method.", - "properties": { - "message": { - "$ref": "PubsubMessage", - "description": "The message to publish." - }, - "topic": { - "type": "string", - "description": "The message in the request will be published on this topic." - } - } - }, - "PubsubEvent": { - "id": "PubsubEvent", - "type": "object", - "description": "An event indicating a received message or truncation event.", - "properties": { - "deleted": { - "type": "boolean", - "description": "Indicates that this subscription has been deleted. (Note that pull subscribers will always receive NOT_FOUND in response in their pull request on the subscription, rather than seeing this boolean.)" - }, - "message": { - "$ref": "PubsubMessage", - "description": "A received message." - }, - "subscription": { - "type": "string", - "description": "The subscription that received the event." - }, - "truncated": { - "type": "boolean", - "description": "Indicates that this subscription has been truncated." - } - } - }, - "PubsubMessage": { - "id": "PubsubMessage", - "type": "object", - "description": "A message data and its labels.", - "properties": { - "data": { - "type": "string", - "description": "The message payload.", - "format": "byte" - }, - "label": { - "type": "array", - "description": "Optional list of labels for this message. Keys in this collection must be unique.", - "items": { - "$ref": "Label" - } - }, - "messageId": { - "type": "string", - "description": "ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call." - } - } - }, - "PullBatchRequest": { - "id": "PullBatchRequest", - "type": "object", - "description": "Request for the PullBatch method.", - "properties": { - "maxEvents": { - "type": "integer", - "description": "The maximum number of PubsubEvents returned for this request. The Pub/Sub system may return fewer than the number of events specified.", - "format": "int32" - }, - "returnImmediately": { - "type": "boolean", - "description": "If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response." - }, - "subscription": { - "type": "string", - "description": "The subscription from which messages should be pulled." - } - } - }, - "PullBatchResponse": { - "id": "PullBatchResponse", - "type": "object", - "description": "Response for the PullBatch method.", - "properties": { - "pullResponses": { - "type": "array", - "description": "Received Pub/Sub messages or status events. The Pub/Sub system will return zero messages if there are no more messages available in the backlog. The Pub/Sub system may return fewer than the max_events requested even if there are more messages available in the backlog.", - "items": { - "$ref": "PullResponse" - } - } - } - }, - "PullRequest": { - "id": "PullRequest", - "type": "object", - "description": "Request for the Pull method.", - "properties": { - "returnImmediately": { - "type": "boolean", - "description": "If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning FAILED_PRECONDITION. The client may cancel the request if it does not wish to wait any longer for the response." - }, - "subscription": { - "type": "string", - "description": "The subscription from which a message should be pulled." - } - } - }, - "PullResponse": { - "id": "PullResponse", - "type": "object", - "description": "Either a PubsubMessage or a truncation event. One of these two must be populated.", - "properties": { - "ackId": { - "type": "string", - "description": "This ID must be used to acknowledge the received event or message." - }, - "pubsubEvent": { - "$ref": "PubsubEvent", - "description": "A pubsub message or truncation event." - } - } - }, - "PushConfig": { - "id": "PushConfig", - "type": "object", - "description": "Configuration for a push delivery endpoint.", - "properties": { - "pushEndpoint": { - "type": "string", - "description": "A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use \"https://example.com/push\"." - } - } - }, - "Subscription": { - "id": "Subscription", - "type": "object", - "description": "A subscription resource.", - "properties": { - "ackDeadlineSeconds": { - "type": "integer", - "description": "For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed.\n\nFor push delivery, this value is used to set the request timeout for the call to the push endpoint.\n\nFor pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).", - "format": "int32" - }, - "name": { - "type": "string", - "description": "Name of the subscription." - }, - "pushConfig": { - "$ref": "PushConfig", - "description": "If push delivery is used with this subscription, this field is used to configure it." - }, - "topic": { - "type": "string", - "description": "The name of the topic from which this subscription is receiving messages." - } - } - }, - "Topic": { - "id": "Topic", - "type": "object", - "description": "A topic resource.", - "properties": { - "name": { - "type": "string", - "description": "Name of the topic." - } - } - } - }, - "resources": { - "subscriptions": { - "methods": { - "acknowledge": { - "id": "pubsub.subscriptions.acknowledge", - "path": "subscriptions/acknowledge", - "httpMethod": "POST", - "description": "Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull.", - "request": { - "$ref": "AcknowledgeRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "create": { - "id": "pubsub.subscriptions.create", - "path": "subscriptions", - "httpMethod": "POST", - "description": "Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND.\n\nIf the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.", - "request": { - "$ref": "Subscription" - }, - "response": { - "$ref": "Subscription" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "delete": { - "id": "pubsub.subscriptions.delete", - "path": "subscriptions/{+subscription}", - "httpMethod": "DELETE", - "description": "Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND.", - "parameters": { - "subscription": { - "type": "string", - "description": "The subscription to delete.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "subscription" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "get": { - "id": "pubsub.subscriptions.get", - "path": "subscriptions/{+subscription}", - "httpMethod": "GET", - "description": "Gets the configuration details of a subscription.", - "parameters": { - "subscription": { - "type": "string", - "description": "The name of the subscription to get.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "subscription" - ], - "response": { - "$ref": "Subscription" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "list": { - "id": "pubsub.subscriptions.list", - "path": "subscriptions", - "httpMethod": "GET", - "description": "Lists matching subscriptions.", - "parameters": { - "maxResults": { - "type": "integer", - "description": "Maximum number of subscriptions to return.", - "format": "int32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The value obtained in the last ListSubscriptionsResponse for continuation.", - "location": "query" - }, - "query": { - "type": "string", - "description": "A valid label query expression.", - "location": "query" - } - }, - "response": { - "$ref": "ListSubscriptionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "modifyAckDeadline": { - "id": "pubsub.subscriptions.modifyAckDeadline", - "path": "subscriptions/modifyAckDeadline", - "httpMethod": "POST", - "description": "Modifies the Ack deadline for a message received from a pull request.", - "request": { - "$ref": "ModifyAckDeadlineRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "modifyPushConfig": { - "id": "pubsub.subscriptions.modifyPushConfig", - "path": "subscriptions/modifyPushConfig", - "httpMethod": "POST", - "description": "Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified.", - "request": { - "$ref": "ModifyPushConfigRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "pull": { - "id": "pubsub.subscriptions.pull", - "path": "subscriptions/pull", - "httpMethod": "POST", - "description": "Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load).", - "request": { - "$ref": "PullRequest" - }, - "response": { - "$ref": "PullResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "pullBatch": { - "id": "pubsub.subscriptions.pullBatch", - "path": "subscriptions/pullBatch", - "httpMethod": "POST", - "description": "Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription.", - "request": { - "$ref": "PullBatchRequest" - }, - "response": { - "$ref": "PullBatchResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - } - } - }, - "topics": { - "methods": { - "create": { - "id": "pubsub.topics.create", - "path": "topics", - "httpMethod": "POST", - "description": "Creates the given topic with the given name.", - "request": { - "$ref": "Topic" - }, - "response": { - "$ref": "Topic" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "delete": { - "id": "pubsub.topics.delete", - "path": "topics/{+topic}", - "httpMethod": "DELETE", - "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.", - "parameters": { - "topic": { - "type": "string", - "description": "Name of the topic to delete.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "topic" - ], - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "get": { - "id": "pubsub.topics.get", - "path": "topics/{+topic}", - "httpMethod": "GET", - "description": "Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.", - "parameters": { - "topic": { - "type": "string", - "description": "The name of the topic to get.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "topic" - ], - "response": { - "$ref": "Topic" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "list": { - "id": "pubsub.topics.list", - "path": "topics", - "httpMethod": "GET", - "description": "Lists matching topics.", - "parameters": { - "maxResults": { - "type": "integer", - "description": "Maximum number of topics to return.", - "format": "int32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "The value obtained in the last ListTopicsResponse for continuation.", - "location": "query" - }, - "query": { - "type": "string", - "description": "A valid label query expression.", - "location": "query" - } - }, - "response": { - "$ref": "ListTopicsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "publish": { - "id": "pubsub.topics.publish", - "path": "topics/publish", - "httpMethod": "POST", - "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.", - "request": { - "$ref": "PublishRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "publishBatch": { - "id": "pubsub.topics.publishBatch", - "path": "topics/publishBatch", - "httpMethod": "POST", - "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.", - "request": { - "$ref": "PublishBatchRequest" - }, - "response": { - "$ref": "PublishBatchResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - } - } - } - } -} diff --git a/etc/api/qpxexpress/v1/qpxexpress-api.json b/etc/api/qpxexpress/v1/qpxexpress-api.json index b592bc138a..8a9faf6bac 100644 --- a/etc/api/qpxexpress/v1/qpxexpress-api.json +++ b/etc/api/qpxexpress/v1/qpxexpress-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/O-Owr0QHQ33wTflOcm7DRKIFEQM\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/StW58-Tr7fPYuJhxtPUkc-L2PGM\"", "discoveryVersion": "v1", "id": "qpxExpress:v1", "name": "qpxExpress", diff --git a/etc/api/replicapool/v1beta1/replicapool-api.json b/etc/api/replicapool/v1beta1/replicapool-api.json index 2b9f8f5fb3..6ca01db480 100644 --- a/etc/api/replicapool/v1beta1/replicapool-api.json +++ b/etc/api/replicapool/v1beta1/replicapool-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/npAP5Wh0KWE_0IJ-5w_S9UfQ5f8\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/XplNMf3n1mBwmu3vRjwQEjJpoaQ\"", "discoveryVersion": "v1", "id": "replicapool:v1beta1", "name": "replicapool", diff --git a/etc/api/replicapool/v1beta2/replicapool-api.json b/etc/api/replicapool/v1beta2/replicapool-api.json index 0fbfa69572..80f046e1e2 100644 --- a/etc/api/replicapool/v1beta2/replicapool-api.json +++ b/etc/api/replicapool/v1beta2/replicapool-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/3bWksYETEVs-FgA1_TuLiiZz5D0\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/nIENWv8MwO8oklMOHa14Ara4Ygw\"", "discoveryVersion": "v1", "id": "replicapool:v1beta2", "name": "replicapool", diff --git a/etc/api/replicapoolupdater/v1beta1/replicapoolupdater-api.json b/etc/api/replicapoolupdater/v1beta1/replicapoolupdater-api.json index f916059be3..e9756f20b0 100644 --- a/etc/api/replicapoolupdater/v1beta1/replicapoolupdater-api.json +++ b/etc/api/replicapoolupdater/v1beta1/replicapoolupdater-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/9r2Awa7hyJ-O6xj5Zgxp82y_u1k\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/YuIMI_aCa8aogA59H4jyEZS09RQ\"", "discoveryVersion": "v1", "id": "replicapoolupdater:v1beta1", "name": "replicapoolupdater", diff --git a/etc/api/reseller/v1/reseller-api.json b/etc/api/reseller/v1/reseller-api.json index 8eff8f1ce8..eb347b77a7 100644 --- a/etc/api/reseller/v1/reseller-api.json +++ b/etc/api/reseller/v1/reseller-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Vfj6rONwWLvfIG4-Ml4mUBsQqJ0\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/yL30z3C9YHBf-lvM-9oMs2T8Dhc\"", "discoveryVersion": "v1", "id": "reseller:v1", "name": "reseller", "version": "v1", - "revision": "20151110", + "revision": "20160218", "title": "Enterprise Apps Reseller API", "description": "Lets you create and manage your customers and their subscriptions.", "ownerDomain": "google.com", @@ -251,6 +251,10 @@ "description": "Creation time of this subscription in milliseconds since Unix epoch.", "format": "int64" }, + "customerDomain": { + "type": "string", + "description": "Primary domain name of the customer" + }, "customerId": { "type": "string", "description": "The id of the customer to whom the subscription belongs." @@ -416,7 +420,7 @@ "parameters": { "customerAuthToken": { "type": "string", - "description": "An auth token needed for inserting a customer for which domain already exists. Can be generated at https://www.google.com/a/cpanel//TransferToken. Optional.", + "description": "An auth token needed for inserting a customer for which domain already exists. Can be generated at https://admin.google.com/TransferToken. Optional.", "location": "query" } }, diff --git a/etc/api/reseller/v1sandbox/reseller-api.json b/etc/api/reseller/v1sandbox/reseller-api.json index fad7ff1c9f..58f9729507 100644 --- a/etc/api/reseller/v1sandbox/reseller-api.json +++ b/etc/api/reseller/v1sandbox/reseller-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Ag4zMYdufSwB5RSGx6O4s86wiiE\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/hNu-Nus6SKWU6_S5x4KRk5Cik8I\"", "discoveryVersion": "v1", "id": "reseller:v1sandbox", "name": "reseller", "version": "v1sandbox", - "revision": "20151110", + "revision": "20160218", "title": "Enterprise Apps Reseller API", "description": "Lets you create and manage your customers and their subscriptions.", "ownerDomain": "google.com", @@ -251,6 +251,10 @@ "description": "Creation time of this subscription in milliseconds since Unix epoch.", "format": "int64" }, + "customerDomain": { + "type": "string", + "description": "Primary domain name of the customer" + }, "customerId": { "type": "string", "description": "The id of the customer to whom the subscription belongs." @@ -416,7 +420,7 @@ "parameters": { "customerAuthToken": { "type": "string", - "description": "An auth token needed for inserting a customer for which domain already exists. Can be generated at https://www.google.com/a/cpanel//TransferToken. Optional.", + "description": "An auth token needed for inserting a customer for which domain already exists. Can be generated at https://admin.google.com/TransferToken. Optional.", "location": "query" } }, diff --git a/etc/api/resourceviews/v1beta1/resourceviews-api.json b/etc/api/resourceviews/v1beta1/resourceviews-api.json index c67d819fd6..229f702dd2 100644 --- a/etc/api/resourceviews/v1beta1/resourceviews-api.json +++ b/etc/api/resourceviews/v1beta1/resourceviews-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/tNLfRnsqb2CzlFZjOq71wt8sQWI\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/WC-I5Gj0W79mm5nRFOZcndhVFk0\"", "discoveryVersion": "v1", "id": "resourceviews:v1beta1", "name": "resourceviews", diff --git a/etc/api/resourceviews/v1beta2/resourceviews-api.json b/etc/api/resourceviews/v1beta2/resourceviews-api.json index 6d1c03eabd..3a81ee012e 100644 --- a/etc/api/resourceviews/v1beta2/resourceviews-api.json +++ b/etc/api/resourceviews/v1beta2/resourceviews-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/uqKsLsqR0k-T4xiwRVB48IuB3HM\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/OS-yQ-jHk3rvVHe8L_LYfUrBR50\"", "discoveryVersion": "v1", "id": "resourceviews:v1beta2", "name": "resourceviews", diff --git a/etc/api/serviceregistry/alpha/serviceregistry-api.json b/etc/api/serviceregistry/alpha/serviceregistry-api.json index 10a7edc341..2388e64970 100644 --- a/etc/api/serviceregistry/alpha/serviceregistry-api.json +++ b/etc/api/serviceregistry/alpha/serviceregistry-api.json @@ -1,13 +1,13 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/UUOA682lycm5flg9DSEhitNOrPU\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/0fXgArWlo2qaFZ4FRbwHwQJZMfg\"", "discoveryVersion": "v1", "id": "serviceregistry:alpha", "name": "serviceregistry", "canonicalName": "Service Registry", "version": "alpha", - "revision": "20160111", - "title": "Google Cloud Service Registry API V1", + "revision": "20160225", + "title": "Google Cloud Service Registry API", "description": "The Service Registry API allows users to manage service endpoints in Service Registry and use DNS-based service discovery / name resolution.", "ownerDomain": "google.com", "ownerName": "Google", @@ -148,20 +148,13 @@ "items": { "type": "string" } - }, - "projects": { - "type": "array", - "description": "Google Cloud projects for which the name of this endpoint should be resolvable through DNS.", - "items": { - "type": "string" - } } } }, "EndpointsListResponse": { "id": "EndpointsListResponse", "type": "object", - "description": "A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 5", + "description": "A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6", "properties": { "endpoints": { "type": "array", @@ -183,7 +176,7 @@ "properties": { "clientOperationId": { "type": "string", - "description": "[Output Only] A unique client ID generated by the server." + "description": "[Output Only] Reserved for future use." }, "creationTimestamp": { "type": "string", @@ -213,7 +206,7 @@ }, "location": { "type": "string", - "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional." + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional." }, "message": { "type": "string", @@ -244,7 +237,7 @@ }, "kind": { "type": "string", - "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.", + "description": "[Output Only] Type of the resource. Always compute#operation for operation resources.", "default": "serviceregistry#operation" }, "name": { @@ -253,7 +246,7 @@ }, "operationType": { "type": "string", - "description": "[Output Only] The type of operation, which can be insert, update, or delete." + "description": "[Output Only] The type of operation, such as insert, update, or delete, and so on." }, "progress": { "type": "integer", @@ -262,7 +255,7 @@ }, "region": { "type": "string", - "description": "[Output Only] 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." }, "selfLink": { "type": "string", @@ -287,7 +280,7 @@ }, "targetLink": { "type": "string", - "description": "[Output Only] The URL of the resource that the operation is modifying." + "description": "[Output Only] The URL of the resource that the operation modifies." }, "user": { "type": "string", @@ -311,7 +304,7 @@ "properties": { "key": { "type": "string", - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)." }, "value": { "type": "string", @@ -329,7 +322,7 @@ }, "zone": { "type": "string", - "description": "[Output Only] 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." } } }, @@ -456,12 +449,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", @@ -614,12 +607,12 @@ "parameters": { "filter": { "type": "string", - "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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, filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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": "Sets a filter expression for filtering listed resources, in the form filter={expression}. 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 filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.", "location": "query" }, "maxResults": { "type": "integer", - "description": "The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.", "default": "500", "format": "uint32", "minimum": "0", diff --git a/etc/api/siteverification/v1/siteverification-api.json b/etc/api/siteverification/v1/siteverification-api.json index 8834a5c814..3892557d7f 100644 --- a/etc/api/siteverification/v1/siteverification-api.json +++ b/etc/api/siteverification/v1/siteverification-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1vTYvQHrYJnWnVmofN4gOMXqjH0\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Cjm5hmgjW1rn6VFfCZ9yc8i4_oM\"", "discoveryVersion": "v1", "id": "siteVerification:v1", "name": "siteVerification", diff --git a/etc/api/spectrum/v1explorer/spectrum-api.json b/etc/api/spectrum/v1explorer/spectrum-api.json index e023f5b083..5c328cdc42 100644 --- a/etc/api/spectrum/v1explorer/spectrum-api.json +++ b/etc/api/spectrum/v1explorer/spectrum-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/h9SeMb9af14jujXCgDxlUbKMPx4\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/SkteIUms8M7yTfg8BLnJI_jjb7g\"", "discoveryVersion": "v1", "id": "spectrum:v1explorer", "name": "spectrum", "version": "v1explorer", - "revision": "20151209", + "revision": "20160206", "title": "Google Spectrum Database API", "description": "API for spectrum-management functions.", "ownerDomain": "google.com", diff --git a/etc/api/sqladmin/v1beta1/sqladmin-api.json b/etc/api/sqladmin/v1beta1/sqladmin-api.json deleted file mode 100644 index bb7d0f9274..0000000000 --- a/etc/api/sqladmin/v1beta1/sqladmin-api.json +++ /dev/null @@ -1,1197 +0,0 @@ -{ - "kind": "discovery#restDescription", - "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/uGJC5NYbVRLny002-SwPOTx9yOE\"", - "discoveryVersion": "v1", - "id": "sqladmin:v1beta1", - "name": "sqladmin", - "canonicalName": "SQL Admin", - "version": "v1beta1", - "revision": "20150305", - "title": "Cloud SQL Administration API", - "description": "API for Cloud SQL database instance management.", - "ownerDomain": "google.com", - "ownerName": "Google", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "documentationLink": "https://developers.google.com/cloud-sql/docs/admin-api/", - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/sql/v1beta1/", - "basePath": "/sql/v1beta1/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "sql/v1beta1/", - "batchPath": "batch", - "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/sqlservice.admin": { - "description": "Manage your Google SQL Service instances" - } - } - } - }, - "schemas": { - "BackupConfiguration": { - "id": "BackupConfiguration", - "type": "object", - "description": "Database instance backup configuration.", - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether this configuration is enabled." - }, - "id": { - "type": "string", - "description": "Identifier for this configuration. This gets generated automatically when a backup configuration is created." - }, - "kind": { - "type": "string", - "description": "This is always sql#backupConfiguration.", - "default": "sql#backupConfiguration" - }, - "startTime": { - "type": "string", - "description": "Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM." - } - } - }, - "BackupRun": { - "id": "BackupRun", - "type": "object", - "description": "A database instance backup run resource.", - "properties": { - "backupConfiguration": { - "type": "string", - "description": "Backup Configuration identifier." - }, - "dueTime": { - "type": "string", - "description": "The due time of this run in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.", - "format": "date-time" - }, - "endTime": { - "type": "string", - "description": "The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.", - "format": "date-time" - }, - "enqueuedTime": { - "type": "string", - "description": "The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.", - "format": "date-time" - }, - "error": { - "$ref": "OperationError", - "description": "Information about why the backup operation failed. This is only present if the run has the FAILED status." - }, - "instance": { - "type": "string", - "description": "Name of the database instance." - }, - "kind": { - "type": "string", - "description": "This is always sql#backupRun.", - "default": "sql#backupRun" - }, - "startTime": { - "type": "string", - "description": "The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.", - "format": "date-time" - }, - "status": { - "type": "string", - "description": "The status of this run." - } - } - }, - "BackupRunsListResponse": { - "id": "BackupRunsListResponse", - "type": "object", - "description": "Backup run list results.", - "properties": { - "items": { - "type": "array", - "description": "A list of backup runs in reverse chronological order of the enqueued time.", - "items": { - "$ref": "BackupRun" - } - }, - "kind": { - "type": "string", - "description": "This is always sql#backupRunsList.", - "default": "sql#backupRunsList" - }, - "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." - } - } - }, - "DatabaseInstance": { - "id": "DatabaseInstance", - "type": "object", - "description": "A Cloud SQL instance resource.", - "properties": { - "currentDiskSize": { - "type": "string", - "description": "The current disk usage of the instance in bytes.", - "format": "int64" - }, - "databaseVersion": { - "type": "string", - "description": "The database engine type and version, for example MYSQL_5_5 for MySQL 5.5." - }, - "etag": { - "type": "string", - "description": "Etag for this resource - a version number for the settings object in this resource. This field has no effect when passed as a request parameter. Instead, the contents of this field should be passed in an 'If-Match' http header for use in optimistic locking.", - "annotations": { - "required": [ - "sql.instances.update" - ] - } - }, - "instance": { - "type": "string", - "description": "Name of the Cloud SQL instance. This does not include the project ID.", - "annotations": { - "required": [ - "sql.instances.insert", - "sql.instances.update" - ] - } - }, - "kind": { - "type": "string", - "description": "This is always sql#instance.", - "default": "sql#instance" - }, - "maxDiskSize": { - "type": "string", - "description": "The maximum disk size of the instance in bytes.", - "format": "int64" - }, - "project": { - "type": "string", - "description": "The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.", - "annotations": { - "required": [ - "sql.instances.insert", - "sql.instances.update" - ] - } - }, - "region": { - "type": "string", - "description": "The geographical region. Can be us-central or europe-west1. Defaults to us-central. The region can not be changed after instance creation." - }, - "settings": { - "$ref": "Settings", - "description": "The user settings." - }, - "state": { - "type": "string", - "description": "The current serving state of the Cloud SQL instance. This can be one of the following.\nRUNNABLE: The instance is running, or is ready to run when accessed.\nSUSPENDED: The instance is not available, for example due to problems with billing.\nPENDING_CREATE: The instance is being created.\nMAINTENANCE: The instance is down for maintenance.\nUNKNOWN_STATE: The state of the instance is unknown." - } - } - }, - "ExportContext": { - "id": "ExportContext", - "type": "object", - "description": "Database instance export context.", - "properties": { - "database": { - "type": "array", - "description": "Databases (for example, guestbook) from which the export is made. If unspecified, all databases are exported.", - "items": { - "type": "string" - } - }, - "kind": { - "type": "string", - "description": "This is always sql#exportContext.", - "default": "sql#exportContext" - }, - "table": { - "type": "array", - "description": "Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.", - "items": { - "type": "string" - } - }, - "uri": { - "type": "string", - "description": "The path to the file in Google Cloud Storage where the export will be stored, or where it was already stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If the filename ends with .gz, the contents are compressed." - } - } - }, - "ImportContext": { - "id": "ImportContext", - "type": "object", - "description": "Database instance import context.", - "properties": { - "database": { - "type": "string", - "description": "The database (for example, guestbook) to which the import is made. If not set, it is assumed that the database is specified in the file to be imported." - }, - "kind": { - "type": "string", - "description": "This is always sql#importContext.", - "default": "sql#importContext" - }, - "uri": { - "type": "array", - "description": "A path to the MySQL dump file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported.", - "items": { - "type": "string" - } - } - } - }, - "InstanceOperation": { - "id": "InstanceOperation", - "type": "object", - "description": "An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly.", - "properties": { - "endTime": { - "type": "string", - "description": "The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.", - "format": "date-time" - }, - "enqueuedTime": { - "type": "string", - "description": "The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.", - "format": "date-time" - }, - "error": { - "type": "array", - "description": "The error(s) encountered by this operation. Only set if the operation results in an error.", - "items": { - "$ref": "OperationError" - } - }, - "exportContext": { - "$ref": "ExportContext", - "description": "The context for export operation, if applicable." - }, - "importContext": { - "$ref": "ImportContext", - "description": "The context for import operation, if applicable." - }, - "instance": { - "type": "string", - "description": "Name of the database instance." - }, - "kind": { - "type": "string", - "description": "This is always sql#instanceOperation.", - "default": "sql#instanceOperation" - }, - "operation": { - "type": "string", - "description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation." - }, - "operationType": { - "type": "string", - "description": "The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME." - }, - "startTime": { - "type": "string", - "description": "The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.", - "format": "date-time" - }, - "state": { - "type": "string", - "description": "The state of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN." - }, - "userEmailAddress": { - "type": "string", - "description": "The email address of the user who initiated this operation." - } - } - }, - "InstancesDeleteResponse": { - "id": "InstancesDeleteResponse", - "type": "object", - "description": "Database instance delete response.", - "properties": { - "kind": { - "type": "string", - "description": "This is always sql#instancesDelete.", - "default": "sql#instancesDelete" - }, - "operation": { - "type": "string", - "description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation." - } - } - }, - "InstancesExportRequest": { - "id": "InstancesExportRequest", - "type": "object", - "description": "Database instance export request.", - "properties": { - "exportContext": { - "$ref": "ExportContext", - "description": "Contains details about the export operation." - } - } - }, - "InstancesExportResponse": { - "id": "InstancesExportResponse", - "type": "object", - "description": "Database instance export response.", - "properties": { - "kind": { - "type": "string", - "description": "This is always sql#instancesExport.", - "default": "sql#instancesExport" - }, - "operation": { - "type": "string", - "description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation." - } - } - }, - "InstancesImportRequest": { - "id": "InstancesImportRequest", - "type": "object", - "description": "Database instance import request.", - "properties": { - "importContext": { - "$ref": "ImportContext", - "description": "Contains details about the import operation." - } - } - }, - "InstancesImportResponse": { - "id": "InstancesImportResponse", - "type": "object", - "description": "Database instance import response.", - "properties": { - "kind": { - "type": "string", - "description": "This is always sql#instancesImport.", - "default": "sql#instancesImport" - }, - "operation": { - "type": "string", - "description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation." - } - } - }, - "InstancesInsertResponse": { - "id": "InstancesInsertResponse", - "type": "object", - "description": "Database instance insert response.", - "properties": { - "kind": { - "type": "string", - "description": "This is always sql#instancesInsert.", - "default": "sql#instancesInsert" - }, - "operation": { - "type": "string", - "description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation." - } - } - }, - "InstancesListResponse": { - "id": "InstancesListResponse", - "type": "object", - "description": "Database instances list response.", - "properties": { - "items": { - "type": "array", - "description": "List of database instance resources.", - "items": { - "$ref": "DatabaseInstance" - } - }, - "kind": { - "type": "string", - "description": "This is always sql#instancesList.", - "default": "sql#instancesList" - }, - "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." - } - } - }, - "InstancesRestartResponse": { - "id": "InstancesRestartResponse", - "type": "object", - "description": "Database instance restart response.", - "properties": { - "kind": { - "type": "string", - "description": "This is always sql#instancesRestart.", - "default": "sql#instancesRestart" - }, - "operation": { - "type": "string", - "description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation." - } - } - }, - "InstancesRestoreBackupResponse": { - "id": "InstancesRestoreBackupResponse", - "type": "object", - "description": "Database instance restore backup response.", - "properties": { - "kind": { - "type": "string", - "description": "This is always sql#instancesRestoreBackup.", - "default": "sql#instancesRestoreBackup" - }, - "operation": { - "type": "string", - "description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation." - } - } - }, - "InstancesUpdateResponse": { - "id": "InstancesUpdateResponse", - "type": "object", - "description": "Database instance update response.", - "properties": { - "kind": { - "type": "string", - "description": "This is always sql#instancesUpdate.", - "default": "sql#instancesUpdate" - }, - "operation": { - "type": "string", - "description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve information about the operation." - } - } - }, - "OperationError": { - "id": "OperationError", - "type": "object", - "description": "Database instance operation error.", - "properties": { - "code": { - "type": "string", - "description": "Identifies the specific error that occurred." - }, - "kind": { - "type": "string", - "description": "This is always sql#operationError.", - "default": "sql#operationError" - } - } - }, - "OperationsListResponse": { - "id": "OperationsListResponse", - "type": "object", - "description": "Database instance list operations response.", - "properties": { - "items": { - "type": "array", - "description": "List of operation resources.", - "items": { - "$ref": "InstanceOperation" - } - }, - "kind": { - "type": "string", - "description": "This is always sql#operationsList.", - "default": "sql#operationsList" - }, - "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." - } - } - }, - "Settings": { - "id": "Settings", - "type": "object", - "description": "Database instance settings.", - "properties": { - "activationPolicy": { - "type": "string", - "description": "The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.\nALWAYS: The instance should always be active.\nNEVER: The instance should never be activated.\nON_DEMAND: The instance is activated upon receiving requests." - }, - "authorizedGaeApplications": { - "type": "array", - "description": "The AppEngine app ids that can access this instance.", - "items": { - "type": "string" - } - }, - "backupConfiguration": { - "type": "array", - "description": "The daily backup configuration for the instance.", - "items": { - "$ref": "BackupConfiguration" - } - }, - "kind": { - "type": "string", - "description": "This is always sql#settings.", - "default": "sql#settings" - }, - "pricingPlan": { - "type": "string", - "description": "The pricing plan for this instance. This can be either PER_USE or PACKAGE." - }, - "replicationType": { - "type": "string", - "description": "The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS." - }, - "tier": { - "type": "string", - "description": "The tier of service for this instance, for example D1, D2. For more information, see pricing.", - "annotations": { - "required": [ - "sql.instances.insert", - "sql.instances.update" - ] - } - } - } - }, - "Tier": { - "id": "Tier", - "type": "object", - "description": "A Google Cloud SQL service tier resource.", - "properties": { - "DiskQuota": { - "type": "string", - "description": "The maximum disk size of this tier in bytes.", - "format": "int64" - }, - "RAM": { - "type": "string", - "description": "The maximum RAM usage of this tier in bytes.", - "format": "int64" - }, - "kind": { - "type": "string", - "description": "This is always sql#tier.", - "default": "sql#tier" - }, - "region": { - "type": "array", - "description": "The applicable regions for this tier. Can be us-east1 and europe-west1.", - "items": { - "type": "string" - } - }, - "tier": { - "type": "string", - "description": "An identifier for the service tier, for example D1, D2 etc. For related information, see Pricing." - } - } - }, - "TiersListResponse": { - "id": "TiersListResponse", - "type": "object", - "description": "Tiers list response.", - "properties": { - "items": { - "type": "array", - "description": "List of tiers.", - "items": { - "$ref": "Tier" - } - }, - "kind": { - "type": "string", - "description": "This is always sql#tiersList.", - "default": "sql#tiersList" - } - } - } - }, - "resources": { - "backupRuns": { - "methods": { - "get": { - "id": "sql.backupRuns.get", - "path": "projects/{project}/instances/{instance}/backupRuns/{backupConfiguration}", - "httpMethod": "GET", - "description": "Retrieves a resource containing information about a backup run.", - "parameters": { - "backupConfiguration": { - "type": "string", - "description": "Identifier for the backup configuration. This gets generated automatically when a backup configuration is created.", - "required": true, - "location": "path" - }, - "dueTime": { - "type": "string", - "description": "The start time of the four-hour backup window. The backup can occur any time in the window. The time is in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.", - "required": true, - "location": "query" - }, - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance", - "backupConfiguration", - "dueTime" - ], - "response": { - "$ref": "BackupRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - }, - "list": { - "id": "sql.backupRuns.list", - "path": "projects/{project}/instances/{instance}/backupRuns", - "httpMethod": "GET", - "description": "Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.", - "parameters": { - "backupConfiguration": { - "type": "string", - "description": "Identifier for the backup configuration. This gets generated automatically when a backup configuration is created.", - "required": true, - "location": "query" - }, - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "Maximum number of backup runs per response.", - "format": "int32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance", - "backupConfiguration" - ], - "response": { - "$ref": "BackupRunsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - } - } - }, - "instances": { - "methods": { - "delete": { - "id": "sql.instances.delete", - "path": "projects/{project}/instances/{instance}", - "httpMethod": "DELETE", - "description": "Deletes a Cloud SQL instance.", - "parameters": { - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance to be deleted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance" - ], - "response": { - "$ref": "InstancesDeleteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - }, - "export": { - "id": "sql.instances.export", - "path": "projects/{project}/instances/{instance}/export", - "httpMethod": "POST", - "description": "Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.", - "parameters": { - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance to be exported.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance" - ], - "request": { - "$ref": "InstancesExportRequest" - }, - "response": { - "$ref": "InstancesExportResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "id": "sql.instances.get", - "path": "projects/{project}/instances/{instance}", - "httpMethod": "GET", - "description": "Retrieves a resource containing information about a Cloud SQL instance.", - "parameters": { - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance" - ], - "response": { - "$ref": "DatabaseInstance" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - }, - "import": { - "id": "sql.instances.import", - "path": "projects/{project}/instances/{instance}/import", - "httpMethod": "POST", - "description": "Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud Storage.", - "parameters": { - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance" - ], - "request": { - "$ref": "InstancesImportRequest" - }, - "response": { - "$ref": "InstancesImportResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "insert": { - "id": "sql.instances.insert", - "path": "projects/{project}/instances", - "httpMethod": "POST", - "description": "Creates a new Cloud SQL instance.", - "parameters": { - "project": { - "type": "string", - "description": "Project ID of the project to which the newly created Cloud SQL instances should belong.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project" - ], - "request": { - "$ref": "DatabaseInstance" - }, - "response": { - "$ref": "InstancesInsertResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - }, - "list": { - "id": "sql.instances.list", - "path": "projects/{project}/instances", - "httpMethod": "GET", - "description": "Lists instances under a given project in the alphabetical order of the instance name.", - "parameters": { - "maxResults": { - "type": "integer", - "description": "The maximum number of results to return per response.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" - }, - "project": { - "type": "string", - "description": "Project ID of the project for which to list Cloud SQL instances.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project" - ], - "response": { - "$ref": "InstancesListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - }, - "patch": { - "id": "sql.instances.patch", - "path": "projects/{project}/instances/{instance}", - "httpMethod": "PATCH", - "description": "Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics.", - "parameters": { - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance" - ], - "request": { - "$ref": "DatabaseInstance" - }, - "response": { - "$ref": "InstancesUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - }, - "restart": { - "id": "sql.instances.restart", - "path": "projects/{project}/instances/{instance}/restart", - "httpMethod": "POST", - "description": "Restarts a Cloud SQL instance.", - "parameters": { - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance to be restarted.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance" - ], - "response": { - "$ref": "InstancesRestartResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - }, - "restoreBackup": { - "id": "sql.instances.restoreBackup", - "path": "projects/{project}/instances/{instance}/restoreBackup", - "httpMethod": "POST", - "description": "Restores a backup of a Cloud SQL instance.", - "parameters": { - "backupConfiguration": { - "type": "string", - "description": "The identifier of the backup configuration. This gets generated automatically when a backup configuration is created.", - "required": true, - "location": "query" - }, - "dueTime": { - "type": "string", - "description": "The start time of the four-hour backup window. The backup can occur any time in the window. The time is in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.", - "required": true, - "location": "query" - }, - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance", - "backupConfiguration", - "dueTime" - ], - "response": { - "$ref": "InstancesRestoreBackupResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - }, - "update": { - "id": "sql.instances.update", - "path": "projects/{project}/instances/{instance}", - "httpMethod": "PUT", - "description": "Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.", - "parameters": { - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance" - ], - "etagRequired": true, - "request": { - "$ref": "DatabaseInstance" - }, - "response": { - "$ref": "InstancesUpdateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - } - } - }, - "operations": { - "methods": { - "get": { - "id": "sql.operations.get", - "path": "projects/{project}/instances/{instance}/operations/{operation}", - "httpMethod": "GET", - "description": "Retrieves an instance operation that has been performed on an instance.", - "parameters": { - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "operation": { - "type": "string", - "description": "Instance operation ID.", - "required": true, - "location": "path" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance", - "operation" - ], - "response": { - "$ref": "InstanceOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - }, - "list": { - "id": "sql.operations.list", - "path": "projects/{project}/instances/{instance}/operations", - "httpMethod": "GET", - "description": "Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.", - "parameters": { - "instance": { - "type": "string", - "description": "Cloud SQL instance ID. This does not include the project ID.", - "required": true, - "location": "path" - }, - "maxResults": { - "type": "integer", - "description": "Maximum number of operations per response.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "A previously-returned page token representing part of the larger set of results to view.", - "location": "query" - }, - "project": { - "type": "string", - "description": "Project ID of the project that contains the instance.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "project", - "instance" - ], - "response": { - "$ref": "OperationsListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - } - } - }, - "tiers": { - "methods": { - "list": { - "id": "sql.tiers.list", - "path": "tiers", - "httpMethod": "GET", - "description": "Lists all available service tiers for Google Cloud SQL, for example D1, D2. For related information, see Pricing.", - "response": { - "$ref": "TiersListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/sqlservice.admin" - ] - } - } - } - } -} diff --git a/etc/api/sqladmin/v1beta3/sqladmin-api.json b/etc/api/sqladmin/v1beta3/sqladmin-api.json index eb1a5dc2d0..cb337fb2f5 100644 --- a/etc/api/sqladmin/v1beta3/sqladmin-api.json +++ b/etc/api/sqladmin/v1beta3/sqladmin-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/0dO3nS417oJ15G_fy9FmXtP2oNc\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/aZQ0aXsmAhNDAeFcsfFvnGiC3G8\"", "discoveryVersion": "v1", "id": "sqladmin:v1beta3", "name": "sqladmin", "canonicalName": "SQL Admin", "version": "v1beta3", - "revision": "20151201", + "revision": "20160222", "title": "Cloud SQL Administration API", "description": "API for Cloud SQL database instance management.", "ownerDomain": "google.com", diff --git a/etc/api/sqladmin/v1beta4/sqladmin-api.json b/etc/api/sqladmin/v1beta4/sqladmin-api.json index a1cda57b86..c6672c2f10 100644 --- a/etc/api/sqladmin/v1beta4/sqladmin-api.json +++ b/etc/api/sqladmin/v1beta4/sqladmin-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/qz0bCady5PYvTHNrLWveHwsYJ6Q\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/OLx7eYKI1NQCi-ys96oQ7ZJUHE8\"", "discoveryVersion": "v1", "id": "sqladmin:v1beta4", "name": "sqladmin", "canonicalName": "SQL Admin", "version": "v1beta4", - "revision": "20151201", + "revision": "20160222", "title": "Cloud SQL Administration API", "description": "API for Cloud SQL database instance management.", "ownerDomain": "google.com", @@ -321,14 +321,18 @@ "type": "object", "description": "A Cloud SQL instance resource.", "properties": { + "backendType": { + "type": "string", + "description": "FIRST_GEN: Basic Cloud SQL instance that runs in a Google-managed container.\nSECOND_GEN: A newer Cloud SQL backend that runs in a Compute Engine VM.\nEXTERNAL: A MySQL server that is not managed by Google." + }, "currentDiskSize": { "type": "string", - "description": "The current disk usage of the instance in bytes.", + "description": "The current disk usage of the instance in bytes. This property has been deprecated. Users should use the \"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud Monitoring API instead. Please see https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ for details.", "format": "int64" }, "databaseVersion": { "type": "string", - "description": "The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion can not be changed after instance creation." + "description": "The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_6. The databaseVersion can not be changed after instance creation." }, "etag": { "type": "string", @@ -336,13 +340,15 @@ }, "failoverReplica": { "type": "object", - "description": "The name and status of the failover replica. Only applies to Second Generation instances.", + "description": "The name and status of the failover replica. This property is applicable only to Second Generation instances.", "properties": { "available": { - "type": "boolean" + "type": "boolean", + "description": "The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the falover replica when the status is true." }, "name": { - "type": "string" + "type": "string", + "description": "The name of the failover replica." } } }, @@ -359,7 +365,7 @@ }, "ipv6Address": { "type": "string", - "description": "The IPv6 address assigned to the instance." + "description": "The IPv6 address assigned to the instance. This property is applicable only to First Generation instances." }, "kind": { "type": "string", @@ -394,7 +400,7 @@ }, "region": { "type": "string", - "description": "The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation." + "description": "The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation." }, "replicaConfiguration": { "$ref": "ReplicaConfiguration", @@ -417,7 +423,7 @@ }, "serviceAccountEmailAddress": { "type": "string", - "description": "The service account email address assigned to the instance." + "description": "The service account email address assigned to the instance. This property is applicable only to Second Generation instances." }, "settings": { "$ref": "Settings", @@ -432,6 +438,13 @@ "state": { "type": "string", "description": "The current serving state of the Cloud SQL instance. This can be one of the following.\nRUNNABLE: The instance is running, or is ready to run when accessed.\nSUSPENDED: The instance is not available, for example due to problems with billing.\nPENDING_CREATE: The instance is being created.\nMAINTENANCE: The instance is down for maintenance.\nFAILED: The instance creation failed.\nUNKNOWN_STATE: The state of the instance is unknown." + }, + "suspensionReason": { + "type": "array", + "description": "If the instance state is SUSPENDED, the reason for the suspension.", + "items": { + "type": "string" + } } } }, @@ -1050,11 +1063,11 @@ "properties": { "activationPolicy": { "type": "string", - "description": "The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.\nALWAYS: The instance should always be active.\nNEVER: The instance should never be activated.\nON_DEMAND: The instance is activated upon receiving requests." + "description": "The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.\nALWAYS: The instance should always be active.\nNEVER: The instance should never be activated.\nON_DEMAND: The instance is activated upon receiving requests; only applicable to First Generation instances." }, "authorizedGaeApplications": { "type": "array", - "description": "The App Engine app IDs that can access this instance.", + "description": "The App Engine app IDs that can access this instance. This property is only applicable to First Generation instances.", "items": { "type": "string" } @@ -1065,16 +1078,16 @@ }, "crashSafeReplicationEnabled": { "type": "boolean", - "description": "Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled." + "description": "Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances." }, "dataDiskSizeGb": { "type": "string", - "description": "The size of data disk, in GB. Only supported for 2nd Generation instances. The data disk size minimum is 10GB.", + "description": "The size of data disk, in GB. The data disk size minimum is 10GB. This property is only applicable to Second Generation instances.", "format": "int64" }, "dataDiskType": { "type": "string", - "description": "The type of data disk. Only supported for 2nd Generation instances. The default type is SSD." + "description": "The type of data disk. Only supported for Second Generation instances. The default type is PD_SSD. This property is only applicable to Second Generation instances." }, "databaseFlags": { "type": "array", @@ -1089,7 +1102,7 @@ }, "ipConfiguration": { "$ref": "IpConfiguration", - "description": "The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance." + "description": "The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances." }, "kind": { "type": "string", @@ -1098,19 +1111,19 @@ }, "locationPreference": { "$ref": "LocationPreference", - "description": "The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance." + "description": "The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance. App Engine co-location is only applicable to First Generation instances." }, "maintenanceWindow": { "$ref": "MaintenanceWindow", - "description": "The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes." + "description": "The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. This property is only applicable to Second Generation instances." }, "pricingPlan": { "type": "string", - "description": "The pricing plan for this instance. This can be either PER_USE or PACKAGE." + "description": "The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances." }, "replicationType": { "type": "string", - "description": "The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS." + "description": "The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances." }, "settingsVersion": { "type": "string", @@ -1319,7 +1332,7 @@ }, "host": { "type": "string", - "description": "The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name is not mutable with this API." + "description": "The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion." }, "instance": { "type": "string", @@ -1499,7 +1512,7 @@ "id": "sql.databases.delete", "path": "projects/{project}/instances/{instance}/databases/{database}", "httpMethod": "DELETE", - "description": "Deletes a resource containing information about a database inside a Cloud SQL instance.", + "description": "Deletes a database from a Cloud SQL instance.", "parameters": { "database": { "type": "string", @@ -1743,7 +1756,7 @@ "id": "sql.instances.clone", "path": "projects/{project}/instances/{instance}/clone", "httpMethod": "POST", - "description": "Creates a Cloud SQL instance as a clone of the source instance.", + "description": "Creates a Cloud SQL instance as a clone of the source instance. The API is not ready for Second Generation instances yet.", "parameters": { "instance": { "type": "string", diff --git a/etc/api/storage/v1/storage-api.json b/etc/api/storage/v1/storage-api.json index 439d42afd1..b6e636bd2e 100644 --- a/etc/api/storage/v1/storage-api.json +++ b/etc/api/storage/v1/storage-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/iW6lW-fzl_pGlxeRN7h4J2G0OTQ\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ku_ywallhiDnwLLrgaS2pSJTLQQ\"", "discoveryVersion": "v1", "id": "storage:v1", "name": "storage", "version": "v1", - "revision": "20151229", + "revision": "20160210", "title": "Cloud Storage JSON API", "description": "Lets you store and retrieve potentially-large, immutable data objects.", "ownerDomain": "google.com", @@ -574,13 +574,7 @@ }, "contentType": { "type": "string", - "description": "Content-Type of the object data.", - "annotations": { - "required": [ - "storage.objects.insert", - "storage.objects.update" - ] - } + "description": "Content-Type of the object data." }, "crc32c": { "type": "string", diff --git a/etc/api/storage/v1beta1/storage-api.json b/etc/api/storage/v1beta1/storage-api.json index 4a64b88022..943cd03354 100644 --- a/etc/api/storage/v1beta1/storage-api.json +++ b/etc/api/storage/v1beta1/storage-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/vmkH9hWnJ1HV8XiuFIp4WnDISYY\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/wHrP9YW4hU3AbG-pup9P6DwMYQU\"", "discoveryVersion": "v1", "id": "storage:v1beta1", "name": "storage", "version": "v1beta1", - "revision": "20151229", + "revision": "20160210", "title": "Cloud Storage JSON API", "description": "Lets you store and retrieve potentially-large, immutable data objects.", "ownerDomain": "google.com", diff --git a/etc/api/storage/v1beta2/storage-api.json b/etc/api/storage/v1beta2/storage-api.json index 7b8e0eba1a..d406dd996e 100644 --- a/etc/api/storage/v1beta2/storage-api.json +++ b/etc/api/storage/v1beta2/storage-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/QV3_I23RH_FhQpwHuRVrSME9Nqk\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7e9AEE6nMvl8ls54aDLLtTvMSL8\"", "discoveryVersion": "v1", "id": "storage:v1beta2", "name": "storage", "version": "v1beta2", - "revision": "20151229", + "revision": "20160210", "title": "Cloud Storage JSON API", "description": "Lets you store and retrieve potentially-large, immutable data objects.", "ownerDomain": "google.com", diff --git a/etc/api/tagmanager/v1/tagmanager-api.json b/etc/api/tagmanager/v1/tagmanager-api.json index cf8b24bc67..912ae507b9 100644 --- a/etc/api/tagmanager/v1/tagmanager-api.json +++ b/etc/api/tagmanager/v1/tagmanager-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ENW6RgyJRIPbzJWbwbvhgwIQ4VI\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/pnXlM7y29o5LG03NvN8ZSd6TmA4\"", "discoveryVersion": "v1", "id": "tagmanager:v1", "name": "tagmanager", "canonicalName": "Tag Manager", "version": "v1", - "revision": "20151112", + "revision": "20160209", "title": "Tag Manager API", "description": "API for accessing Tag Manager accounts and containers.", "ownerDomain": "google.com", @@ -249,6 +249,7 @@ "containerVersion", "debugMode", "deviceName", + "environmentName", "errorLine", "errorMessage", "errorUrl", @@ -318,6 +319,7 @@ "", "", "", + "", "" ] } @@ -583,6 +585,79 @@ } } }, + "Environment": { + "id": "Environment", + "type": "object", + "description": "Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.", + "properties": { + "accountId": { + "type": "string", + "description": "GTM Account ID." + }, + "authorizationCode": { + "type": "string", + "description": "The environment authorization code." + }, + "authorizationTimestampMs": { + "type": "string", + "description": "The last update time-stamp for the authorization code.", + "format": "int64" + }, + "containerId": { + "type": "string", + "description": "GTM Container ID." + }, + "containerVersionId": { + "type": "string", + "description": "" + }, + "description": { + "type": "string", + "description": "The environment description. Can be set or changed only on USER type environments." + }, + "enableDebug": { + "type": "boolean", + "description": "Whether or not to enable debug by default on for the environment." + }, + "environmentId": { + "type": "string", + "description": "GTM Environment ID uniquely identifies the GTM Environment." + }, + "fingerprint": { + "type": "string", + "description": "The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified." + }, + "name": { + "type": "string", + "description": "The environment display name. Can be set or changed only on USER type environments.", + "annotations": { + "required": [ + "tagmanager.accounts.containers.environments.create" + ] + } + }, + "type": { + "type": "string", + "description": "The type of this environment.", + "enum": [ + "draft", + "latest", + "live", + "user" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "url": { + "type": "string", + "description": "Default preview page url for the environment." + } + } + }, "Folder": { "id": "Folder", "type": "object", @@ -706,6 +781,20 @@ } } }, + "ListEnvironmentsResponse": { + "id": "ListEnvironmentsResponse", + "type": "object", + "description": "List Environments Response.", + "properties": { + "environments": { + "type": "array", + "description": "All Environments of a GTM Container.", + "items": { + "$ref": "Environment" + } + } + } + }, "ListFoldersResponse": { "id": "ListFoldersResponse", "type": "object", @@ -1579,6 +1668,236 @@ } }, "resources": { + "environments": { + "methods": { + "create": { + "id": "tagmanager.accounts.containers.environments.create", + "path": "accounts/{accountId}/containers/{containerId}/environments", + "httpMethod": "POST", + "description": "Creates a GTM Environment.", + "parameters": { + "accountId": { + "type": "string", + "description": "The GTM Account ID.", + "required": true, + "location": "path" + }, + "containerId": { + "type": "string", + "description": "The GTM Container ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "accountId", + "containerId" + ], + "request": { + "$ref": "Environment" + }, + "response": { + "$ref": "Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/tagmanager.edit.containers" + ] + }, + "delete": { + "id": "tagmanager.accounts.containers.environments.delete", + "path": "accounts/{accountId}/containers/{containerId}/environments/{environmentId}", + "httpMethod": "DELETE", + "description": "Deletes a GTM Environment.", + "parameters": { + "accountId": { + "type": "string", + "description": "The GTM Account ID.", + "required": true, + "location": "path" + }, + "containerId": { + "type": "string", + "description": "The GTM Container ID.", + "required": true, + "location": "path" + }, + "environmentId": { + "type": "string", + "description": "The GTM Environment ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "accountId", + "containerId", + "environmentId" + ], + "scopes": [ + "https://www.googleapis.com/auth/tagmanager.edit.containers" + ] + }, + "get": { + "id": "tagmanager.accounts.containers.environments.get", + "path": "accounts/{accountId}/containers/{containerId}/environments/{environmentId}", + "httpMethod": "GET", + "description": "Gets a GTM Environment.", + "parameters": { + "accountId": { + "type": "string", + "description": "The GTM Account ID.", + "required": true, + "location": "path" + }, + "containerId": { + "type": "string", + "description": "The GTM Container ID.", + "required": true, + "location": "path" + }, + "environmentId": { + "type": "string", + "description": "The GTM Environment ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "accountId", + "containerId", + "environmentId" + ], + "response": { + "$ref": "Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/tagmanager.edit.containers", + "https://www.googleapis.com/auth/tagmanager.readonly" + ] + }, + "list": { + "id": "tagmanager.accounts.containers.environments.list", + "path": "accounts/{accountId}/containers/{containerId}/environments", + "httpMethod": "GET", + "description": "Lists all GTM Environments of a GTM Container.", + "parameters": { + "accountId": { + "type": "string", + "description": "The GTM Account ID.", + "required": true, + "location": "path" + }, + "containerId": { + "type": "string", + "description": "The GTM Container ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "accountId", + "containerId" + ], + "response": { + "$ref": "ListEnvironmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/tagmanager.edit.containers", + "https://www.googleapis.com/auth/tagmanager.readonly" + ] + }, + "patch": { + "id": "tagmanager.accounts.containers.environments.patch", + "path": "accounts/{accountId}/containers/{containerId}/environments/{environmentId}", + "httpMethod": "PATCH", + "description": "Updates a GTM Environment. This method supports patch semantics.", + "parameters": { + "accountId": { + "type": "string", + "description": "The GTM Account ID.", + "required": true, + "location": "path" + }, + "containerId": { + "type": "string", + "description": "The GTM Container ID.", + "required": true, + "location": "path" + }, + "environmentId": { + "type": "string", + "description": "The GTM Environment ID.", + "required": true, + "location": "path" + }, + "fingerprint": { + "type": "string", + "description": "When provided, this fingerprint must match the fingerprint of the environment in storage.", + "location": "query" + } + }, + "parameterOrder": [ + "accountId", + "containerId", + "environmentId" + ], + "request": { + "$ref": "Environment" + }, + "response": { + "$ref": "Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/tagmanager.edit.containers" + ] + }, + "update": { + "id": "tagmanager.accounts.containers.environments.update", + "path": "accounts/{accountId}/containers/{containerId}/environments/{environmentId}", + "httpMethod": "PUT", + "description": "Updates a GTM Environment.", + "parameters": { + "accountId": { + "type": "string", + "description": "The GTM Account ID.", + "required": true, + "location": "path" + }, + "containerId": { + "type": "string", + "description": "The GTM Container ID.", + "required": true, + "location": "path" + }, + "environmentId": { + "type": "string", + "description": "The GTM Environment ID.", + "required": true, + "location": "path" + }, + "fingerprint": { + "type": "string", + "description": "When provided, this fingerprint must match the fingerprint of the environment in storage.", + "location": "query" + } + }, + "parameterOrder": [ + "accountId", + "containerId", + "environmentId" + ], + "request": { + "$ref": "Environment" + }, + "response": { + "$ref": "Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/tagmanager.edit.containers" + ] + } + } + }, "folders": { "methods": { "create": { @@ -1857,6 +2176,56 @@ "accountId", "containerId", "folderId" + ], + "request": { + "$ref": "Folder" + }, + "scopes": [ + "https://www.googleapis.com/auth/tagmanager.edit.containers" + ] + } + } + }, + "reauthorize_environments": { + "methods": { + "update": { + "id": "tagmanager.accounts.containers.reauthorize_environments.update", + "path": "accounts/{accountId}/containers/{containerId}/reauthorize_environments/{environmentId}", + "httpMethod": "PUT", + "description": "Re-generates the authorization code for a GTM Environment.", + "parameters": { + "accountId": { + "type": "string", + "description": "The GTM Account ID.", + "required": true, + "location": "path" + }, + "containerId": { + "type": "string", + "description": "The GTM Container ID.", + "required": true, + "location": "path" + }, + "environmentId": { + "type": "string", + "description": "The GTM Environment ID.", + "required": true, + "location": "path" + } + }, + "parameterOrder": [ + "accountId", + "containerId", + "environmentId" + ], + "request": { + "$ref": "Environment" + }, + "response": { + "$ref": "Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/tagmanager.publish" ] } } diff --git a/etc/api/taskqueue/v1beta1/taskqueue-api.json b/etc/api/taskqueue/v1beta1/taskqueue-api.json index d191449843..0c6e8e2b9e 100644 --- a/etc/api/taskqueue/v1beta1/taskqueue-api.json +++ b/etc/api/taskqueue/v1beta1/taskqueue-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/HCbIp-fIdTkFERYdk9w5J-MmPIE\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/iec_1EzjRBpSw3YhZsugdy5H7Iw\"", "discoveryVersion": "v1", "id": "taskqueue:v1beta1", "name": "taskqueue", diff --git a/etc/api/taskqueue/v1beta2/taskqueue-api.json b/etc/api/taskqueue/v1beta2/taskqueue-api.json index b7adc96ecc..74f48cb2ff 100644 --- a/etc/api/taskqueue/v1beta2/taskqueue-api.json +++ b/etc/api/taskqueue/v1beta2/taskqueue-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/5_q0EX1JPBprRGcQUlX4oRhCEaQ\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ZYZLjVjjgsEVx0SqYDULDA5kB2A\"", "discoveryVersion": "v1", "id": "taskqueue:v1beta2", "name": "taskqueue", diff --git a/etc/api/tasks/v1/tasks-api.json b/etc/api/tasks/v1/tasks-api.json index 7713633480..4d1e208107 100644 --- a/etc/api/tasks/v1/tasks-api.json +++ b/etc/api/tasks/v1/tasks-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/JZ1Vv13vpUDi19AUaiFfQixJ4Fw\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/NWN6zUXbR398dbL3sE_mMEw339M\"", "discoveryVersion": "v1", "id": "tasks:v1", "name": "tasks", diff --git a/etc/api/translate/v2/translate-api.json b/etc/api/translate/v2/translate-api.json index 6443e6fad7..5fe543c7bf 100644 --- a/etc/api/translate/v2/translate-api.json +++ b/etc/api/translate/v2/translate-api.json @@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Y41IPHxKqibvoyf5Er8zc-4DHtg\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/5diaINFMRdfdVpea1Q3SR6qOOW4\"", "discoveryVersion": "v1", "id": "translate:v2", "name": "translate", "version": "v2", - "revision": "20141123", + "revision": "20160217", "title": "Translate API", "description": "Lets you translate text from one language to another", "ownerDomain": "google.com", diff --git a/etc/api/urlshortener/v1/urlshortener-api.json b/etc/api/urlshortener/v1/urlshortener-api.json index af0e8fa382..d9140b9f2a 100644 --- a/etc/api/urlshortener/v1/urlshortener-api.json +++ b/etc/api/urlshortener/v1/urlshortener-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/49125EL6IkDeWMfbXEwfaTl5xvA\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1HSXgVbkO3Z5Y9cbiE9dhFdbqxk\"", "discoveryVersion": "v1", "id": "urlshortener:v1", "name": "urlshortener", diff --git a/etc/api/vision/v1/vision-api.json b/etc/api/vision/v1/vision-api.json new file mode 100644 index 0000000000..e69de29bb2 diff --git a/etc/api/webfonts/v1/webfonts-api.json b/etc/api/webfonts/v1/webfonts-api.json index 61a919e5bd..dbab88bdd0 100644 --- a/etc/api/webfonts/v1/webfonts-api.json +++ b/etc/api/webfonts/v1/webfonts-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7CX45lHrekGHtXfo8oTzp_aszgg\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/g4uYoMy9XgF6f50jnkNXIWBoFUw\"", "discoveryVersion": "v1", "id": "webfonts:v1", "name": "webfonts", diff --git a/etc/api/webmasters/v3/webmasters-api.json b/etc/api/webmasters/v3/webmasters-api.json index 8693c116a5..608d0a50fd 100644 --- a/etc/api/webmasters/v3/webmasters-api.json +++ b/etc/api/webmasters/v3/webmasters-api.json @@ -1,6 +1,6 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/_-_fgDtuWae3hK6puWhbAWmziB0\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ik6t4leMi4molj3h1DobZhP-feU\"", "discoveryVersion": "v1", "id": "webmasters:v3", "name": "webmasters", diff --git a/etc/api/youtube/v3/youtube-api.json b/etc/api/youtube/v3/youtube-api.json index 766a60b90d..1be4530e85 100644 --- a/etc/api/youtube/v3/youtube-api.json +++ b/etc/api/youtube/v3/youtube-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/f6mRIQ8wrr0OUFAXPVNFOEqXrFQ\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/emwdUwZj4z8Lfj39vjO3dsDdRpA\"", "discoveryVersion": "v1", "id": "youtube:v3", "name": "youtube", "canonicalName": "YouTube", "version": "v3", - "revision": "20160111", + "revision": "20160222", "title": "YouTube Data API", "description": "Programmatic access to YouTube features.", "ownerDomain": "google.com", @@ -974,15 +974,6 @@ } } }, - "ChannelId": { - "id": "ChannelId", - "type": "object", - "properties": { - "value": { - "type": "string" - } - } - }, "ChannelListResponse": { "id": "ChannelListResponse", "type": "object", @@ -1345,12 +1336,16 @@ "ChannelSnippet": { "id": "ChannelSnippet", "type": "object", - "description": "Basic details about a channel, including title, description and thumbnails.", + "description": "Basic details about a channel, including title, description and thumbnails. Next available id: 15.", "properties": { "country": { "type": "string", "description": "The country of the channel." }, + "customUrl": { + "type": "string", + "description": "The custom url of the channel." + }, "defaultLanguage": { "type": "string", "description": "The language of the channel's default title and description." @@ -1534,7 +1529,7 @@ "description": "Basic details about a comment, such as its author and text.", "properties": { "authorChannelId": { - "$ref": "ChannelId", + "type": "any", "description": "The id of the author's YouTube channel, if any." }, "authorChannelUrl": { @@ -2364,6 +2359,7 @@ "type": "string", "description": "The video's rating from South Africa's Film and Publication Board.", "enum": [ + "fpb10", "fpb1012Pg", "fpb13", "fpb16", @@ -2385,6 +2381,7 @@ "", "", "", + "", "" ] }, @@ -5353,6 +5350,9 @@ "type": "string", "description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set." }, + "regionCode": { + "type": "string" + }, "tokenPagination": { "$ref": "TokenPagination" }, @@ -6781,6 +6781,7 @@ "copyright", "duplicate", "inappropriate", + "legal", "length", "termsOfUse", "trademark", @@ -6796,6 +6797,7 @@ "", "", "", + "", "" ] }, @@ -8667,7 +8669,7 @@ "maxResults": { "type": "integer", "description": "The maxResults parameter specifies the maximum number of messages that should be returned in the result set.", - "default": "200", + "default": "500", "format": "uint32", "minimum": "200", "maximum": "2000", diff --git a/etc/api/youtubeanalytics/v1/youtubeanalytics-api.json b/etc/api/youtubeanalytics/v1/youtubeanalytics-api.json index edb89adcc1..d3cbad2734 100644 --- a/etc/api/youtubeanalytics/v1/youtubeanalytics-api.json +++ b/etc/api/youtubeanalytics/v1/youtubeanalytics-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/qTdacm8QE7OiGFUkJAQ_Ce035gg\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/X9BsPo2WfOoxifneb4ohU1JftMc\"", "discoveryVersion": "v1", "id": "youtubeAnalytics:v1", "name": "youtubeAnalytics", "canonicalName": "YouTube Analytics", "version": "v1", - "revision": "20151211", + "revision": "20160204", "title": "YouTube Analytics API", "description": "Retrieve your YouTube Analytics reports.", "ownerDomain": "google.com", diff --git a/etc/api/youtubeanalytics/v1beta1/youtubeanalytics-api.json b/etc/api/youtubeanalytics/v1beta1/youtubeanalytics-api.json index 593e3a555c..08519f8135 100644 --- a/etc/api/youtubeanalytics/v1beta1/youtubeanalytics-api.json +++ b/etc/api/youtubeanalytics/v1beta1/youtubeanalytics-api.json @@ -1,12 +1,12 @@ { "kind": "discovery#restDescription", - "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7ECiQwmb5lMWjvWOlU1Q-3D7osI\"", + "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/vkTkjcNNnD8GFnQCKJ3_EPvhr7A\"", "discoveryVersion": "v1", "id": "youtubeAnalytics:v1beta1", "name": "youtubeAnalytics", "canonicalName": "YouTube Analytics", "version": "v1beta1", - "revision": "20151211", + "revision": "20160204", "title": "YouTube Analytics API", "description": "Retrieve your YouTube Analytics reports.", "ownerDomain": "google.com",