diff --git a/changelog.md b/changelog.md
index 1870382e59..ad94693e21 100644
--- a/changelog.md
+++ b/changelog.md
@@ -1,3 +1,15 @@
+
+## api-v0.1.13:cli-v0.3.4 (2016-04-10)
+
+
+#### Bug Fixes
+
+* **cargo:** choose serde-version which works ([33f28136](https://github.com/Byron/google-apis-rs/commit/33f281360a0a5dfa93cd7e6f4f345689e86bcc3f))
+* **cli:** compatibility with serde 0.6 ([9e8a047e](https://github.com/Byron/google-apis-rs/commit/9e8a047ebfddd7a94226b8d559b03325abf7ab54))
+* **lib:** use hyper Bearer header style ([065cfdd2](https://github.com/Byron/google-apis-rs/commit/065cfdd22f974afe9d8071e0227929464c1df796))
+
+
+
## api-v0.1.12 (2016-02-28)
diff --git a/etc/api/adexchangebuyer/v1.2/adexchangebuyer-api.json b/etc/api/adexchangebuyer/v1.2/adexchangebuyer-api.json
index 0f50b4bf95..88a94ca298 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/2MOB7UocvnNx2RsEkZnyXaWuXHI\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/XHuj955Esjr7rkdIbc7SdaIn1Og\"",
"discoveryVersion": "v1",
"id": "adexchangebuyer:v1.2",
"name": "adexchangebuyer",
"canonicalName": "Ad Exchange Buyer",
"version": "v1.2",
- "revision": "20160222",
+ "revision": "20160405",
"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 070bcabcab..f9f2500d87 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/VXepic53Yi7a5nl5bTfBrOL42qg\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7OomBdgZ3z0QMRgoMqlMLp6fRlA\"",
"discoveryVersion": "v1",
"id": "adexchangebuyer:v1.3",
"name": "adexchangebuyer",
"canonicalName": "Ad Exchange Buyer",
"version": "v1.3",
- "revision": "20160222",
+ "revision": "20160405",
"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,10 +88,6 @@
"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.",
@@ -604,6 +600,11 @@
"type": "boolean",
"description": "Whether the publisher for this deal is eligible for alcohol ads."
},
+ "buyerAccountId": {
+ "type": "string",
+ "description": "The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of.",
+ "format": "int64"
+ },
"currencyCode": {
"type": "string",
"description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD."
@@ -802,7 +803,7 @@
"PerformanceReportList": {
"id": "PerformanceReportList",
"type": "object",
- "description": "The configuration data for an Ad Exchange performance report list. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py",
+ "description": "The configuration data for an Ad Exchange performance report list.",
"properties": {
"kind": {
"type": "string",
diff --git a/etc/api/adexchangebuyer/v1.4/adexchangebuyer-api.json b/etc/api/adexchangebuyer/v1.4/adexchangebuyer-api.json
index a6134553a6..b46cfb0aae 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/URFS8nFLzISc5jlgQq2A7Yy8-38\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/9WukAPmA5ytP1PY2pa6ISyUv5a0\"",
"discoveryVersion": "v1",
"id": "adexchangebuyer:v1.4",
"name": "adexchangebuyer",
"canonicalName": "Ad Exchange Buyer",
"version": "v1.4",
- "revision": "20160222",
+ "revision": "20160405",
"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",
@@ -811,6 +811,10 @@
"nonGuaranteedFixedPriceTerms": {
"$ref": "DealTermsNonGuaranteedFixedPriceTerms",
"description": "The terms for non-guaranteed fixed price deals."
+ },
+ "sellerTimeZone": {
+ "type": "string",
+ "description": "For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)"
}
}
},
@@ -941,6 +945,38 @@
}
}
},
+ "Dimension": {
+ "id": "Dimension",
+ "type": "object",
+ "description": "This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}",
+ "properties": {
+ "dimensionType": {
+ "type": "string"
+ },
+ "dimensionValues": {
+ "type": "array",
+ "items": {
+ "$ref": "DimensionDimensionValue"
+ }
+ }
+ }
+ },
+ "DimensionDimensionValue": {
+ "id": "DimensionDimensionValue",
+ "type": "object",
+ "description": "Value of the dimension.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "Id of the dimension.",
+ "format": "int32"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the dimension mainly for debugging purposes."
+ }
+ }
+ },
"EditAllOrderDealsRequest": {
"id": "EditAllOrderDealsRequest",
"type": "object",
@@ -1365,7 +1401,7 @@
"PerformanceReportList": {
"id": "PerformanceReportList",
"type": "object",
- "description": "The configuration data for an Ad Exchange performance report list. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py",
+ "description": "The configuration data for an Ad Exchange performance report list.",
"properties": {
"kind": {
"type": "string",
@@ -1740,6 +1776,10 @@
"type": "string",
"description": "The unique id for the product (readonly)"
},
+ "publisherProfileId": {
+ "type": "string",
+ "description": "Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller."
+ },
"revisionNumber": {
"type": "string",
"description": "The revision number of the product. (readonly)",
@@ -1769,7 +1809,8 @@
"description": "The negotiable terms of the deal (buyer-readonly)"
},
"webPropertyCode": {
- "type": "string"
+ "type": "string",
+ "description": "The web property code for the seller. This field is meant to be copied over as is when creating deals."
}
}
},
@@ -1887,10 +1928,26 @@
"id": "PublisherProfileApiProto",
"type": "object",
"properties": {
+ "accountId": {
+ "type": "string",
+ "description": "The account id of the seller."
+ },
+ "audience": {
+ "type": "string",
+ "description": "Publisher provided info on its audience."
+ },
"buyerPitchStatement": {
"type": "string",
"description": "A pitch statement for the buyer"
},
+ "directContact": {
+ "$ref": "ContactInformation",
+ "description": "Direct contact for the publisher profile."
+ },
+ "exchange": {
+ "type": "string",
+ "description": "Exchange where this publisher profile is from. E.g. AdX, Rubicon etc..."
+ },
"googlePlusLink": {
"type": "string",
"description": "Link to publisher's Google+ page."
@@ -1899,6 +1956,10 @@
"type": "boolean",
"description": "True, if this is the parent profile, which represents all domains owned by the publisher."
},
+ "isPublished": {
+ "type": "boolean",
+ "description": "True, if this profile is published. Deprecated for state."
+ },
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#publisherProfileApiProto\".",
@@ -1921,9 +1982,13 @@
},
"profileId": {
"type": "integer",
- "description": "Unique id for the publisher profile",
+ "description": "The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher.",
"format": "int32"
},
+ "programmaticContact": {
+ "$ref": "ContactInformation",
+ "description": "Programmatic contact for the publisher profile."
+ },
"publisherDomains": {
"type": "array",
"description": "The list of domains represented in this publisher profile. Empty if this is a parent profile.",
@@ -1931,6 +1996,14 @@
"type": "string"
}
},
+ "publisherProfileId": {
+ "type": "string",
+ "description": "Unique Id for publisher profile."
+ },
+ "publisherProvidedForecast": {
+ "$ref": "PublisherProvidedForecast",
+ "description": "Publisher provided forecasting information."
+ },
"rateCardInfoLink": {
"type": "string",
"description": "Link to publisher rate card"
@@ -1939,6 +2012,14 @@
"type": "string",
"description": "Link for a sample content page."
},
+ "seller": {
+ "$ref": "Seller",
+ "description": "Seller of the publisher profile."
+ },
+ "state": {
+ "type": "string",
+ "description": "State of the publisher profile."
+ },
"topHeadlines": {
"type": "array",
"description": "Publisher provided key metrics and rankings.",
@@ -1948,6 +2029,30 @@
}
}
},
+ "PublisherProvidedForecast": {
+ "id": "PublisherProvidedForecast",
+ "type": "object",
+ "description": "This message carries publisher provided forecasting information.",
+ "properties": {
+ "dimensions": {
+ "type": "array",
+ "description": "Publisher provided dimensions. E.g. geo, sizes etc...",
+ "items": {
+ "$ref": "Dimension"
+ }
+ },
+ "weeklyImpressions": {
+ "type": "string",
+ "description": "Publisher provided weekly impressions.",
+ "format": "int64"
+ },
+ "weeklyUniques": {
+ "type": "string",
+ "description": "Publisher provided weekly uniques.",
+ "format": "int64"
+ }
+ }
+ },
"Seller": {
"id": "Seller",
"type": "object",
@@ -2085,6 +2190,29 @@
"format": "int32"
}
}
+ },
+ "UpdatePrivateAuctionProposalRequest": {
+ "id": "UpdatePrivateAuctionProposalRequest",
+ "type": "object",
+ "properties": {
+ "externalDealId": {
+ "type": "string",
+ "description": "The externalDealId of the deal to be updated."
+ },
+ "note": {
+ "$ref": "MarketplaceNote",
+ "description": "Optional note to be added."
+ },
+ "proposalRevisionNumber": {
+ "type": "string",
+ "description": "The current revision number of the proposal to be updated.",
+ "format": "int64"
+ },
+ "updateAction": {
+ "type": "string",
+ "description": "The proposed action on the private auction proposal."
+ }
+ }
}
},
"resources": {
@@ -2682,6 +2810,33 @@
}
}
},
+ "marketplaceprivateauction": {
+ "methods": {
+ "updateproposal": {
+ "id": "adexchangebuyer.marketplaceprivateauction.updateproposal",
+ "path": "privateauction/{privateAuctionId}/updateproposal",
+ "httpMethod": "POST",
+ "description": "Update a given private auction proposal",
+ "parameters": {
+ "privateAuctionId": {
+ "type": "string",
+ "description": "The private auction id to be updated.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "privateAuctionId"
+ ],
+ "request": {
+ "$ref": "UpdatePrivateAuctionProposalRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
"performanceReport": {
"methods": {
"list": {
diff --git a/etc/api/admin/directory_v1/admin-api.json b/etc/api/admin/directory_v1/admin-api.json
index 04d54393c4..fbe0776453 100644
--- a/etc/api/admin/directory_v1/admin-api.json
+++ b/etc/api/admin/directory_v1/admin-api.json
@@ -1,12 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/xS4037BUKAt0D_L9mKpD-MebHg4\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Bj5fQ_zHjihg0GNq6kcI72CKzds\"",
"discoveryVersion": "v1",
"id": "admin:directory_v1",
"name": "admin",
"canonicalName": "directory",
"version": "directory_v1",
- "revision": "20151208",
+ "revision": "20160323",
"title": "Admin Directory API",
"description": "The Admin SDK Directory API lets you view and manage enterprise resources such as users and groups, administrative notifications, security features, and more.",
"ownerDomain": "google.com",
diff --git a/etc/api/adsense/v1.2/adsense-api.json b/etc/api/adsense/v1.2/adsense-api.json
index 16ac9dd897..d50321f38b 100644
--- a/etc/api/adsense/v1.2/adsense-api.json
+++ b/etc/api/adsense/v1.2/adsense-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Mut-plOrR6DSpBJ9WCFiUmkHDwE\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/LJDKT2Ga8SuCOV3aCbVYZ-8VPzY\"",
"discoveryVersion": "v1",
"id": "adsense:v1.2",
"name": "adsense",
"canonicalName": "AdSense",
"version": "v1.2",
- "revision": "20160223",
+ "revision": "20160405",
"title": "AdSense Management API",
- "description": "Gives AdSense publishers access to their inventory and the ability to generate reports",
+ "description": "Accesses AdSense publishers' inventory and generates performance reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/adsense/v1.3/adsense-api.json b/etc/api/adsense/v1.3/adsense-api.json
index 3c221e84c2..98f1b7461d 100644
--- a/etc/api/adsense/v1.3/adsense-api.json
+++ b/etc/api/adsense/v1.3/adsense-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Bo70Gu875eIJ0r6fszypcRcE6IQ\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1xMNid9XS36JD5TH8R14NGfkUqs\"",
"discoveryVersion": "v1",
"id": "adsense:v1.3",
"name": "adsense",
"canonicalName": "AdSense",
"version": "v1.3",
- "revision": "20160223",
+ "revision": "20160405",
"title": "AdSense Management API",
- "description": "Gives AdSense publishers access to their inventory and the ability to generate reports",
+ "description": "Accesses AdSense publishers' inventory and generates performance reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/adsense/v1.4/adsense-api.json b/etc/api/adsense/v1.4/adsense-api.json
index 659eca1ac5..6155e40abd 100644
--- a/etc/api/adsense/v1.4/adsense-api.json
+++ b/etc/api/adsense/v1.4/adsense-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Nx2iomi3ve-zx6tBzpFu3QAueM4\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/mTfrCyAXMjNrBAG-6jjjVEMJJ4M\"",
"discoveryVersion": "v1",
"id": "adsense:v1.4",
"name": "adsense",
"canonicalName": "AdSense",
"version": "v1.4",
- "revision": "20160223",
+ "revision": "20160405",
"title": "AdSense Management API",
- "description": "Gives AdSense publishers access to their inventory and the ability to generate reports",
+ "description": "Accesses AdSense publishers' inventory and generates performance reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/adsensehost/v4.1/adsensehost-api.json b/etc/api/adsensehost/v4.1/adsensehost-api.json
index 6d51622f79..e9ed84caf6 100644
--- a/etc/api/adsensehost/v4.1/adsensehost-api.json
+++ b/etc/api/adsensehost/v4.1/adsensehost-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/pnrwWFIfZQX6ZdAsQY5fnMughCs\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/9VyrVB-oyRLagM9vor-DuzpZ4ac\"",
"discoveryVersion": "v1",
"id": "adsensehost:v4.1",
"name": "adsensehost",
"canonicalName": "AdSense Host",
"version": "v4.1",
- "revision": "20160223",
+ "revision": "20160405",
"title": "AdSense Host API",
- "description": "Gives AdSense Hosts access to report generation, ad code generation, and publisher management capabilities.",
+ "description": "Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/analytics/v2.4/analytics-api.json b/etc/api/analytics/v2.4/analytics-api.json
index 75ca8f936a..b5d85ec4f0 100644
--- a/etc/api/analytics/v2.4/analytics-api.json
+++ b/etc/api/analytics/v2.4/analytics-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/HnBbx1CzQq18EMBMTrvfA_7KYrA\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ha01xiJ2F_tfXi994F2t-6KbS0Y\"",
"discoveryVersion": "v1",
"id": "analytics:v2.4",
"name": "analytics",
"version": "v2.4",
- "revision": "20160223",
+ "revision": "20160308",
"title": "Google Analytics API",
- "description": "View and manage your Google Analytics data",
+ "description": "Views and manages your Google Analytics data.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/analytics/v3/analytics-api.json b/etc/api/analytics/v3/analytics-api.json
index be7249e161..047a2bf83e 100644
--- a/etc/api/analytics/v3/analytics-api.json
+++ b/etc/api/analytics/v3/analytics-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/lcxvn8OaVzfbxI4Y934R1xQ9Q74\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/y7JmUhB0GIMusVTZY-o1OGZ6DZQ\"",
"discoveryVersion": "v1",
"id": "analytics:v3",
"name": "analytics",
"version": "v3",
- "revision": "20160223",
+ "revision": "20160308",
"title": "Google Analytics API",
- "description": "View and manage your Google Analytics data",
+ "description": "Views and manages your Google Analytics data.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -147,6 +147,10 @@
"type": "string",
"description": "Link for this account."
},
+ "starred": {
+ "type": "boolean",
+ "description": "Indicates whether this account is starred or not."
+ },
"updated": {
"type": "string",
"description": "Time the account was last modified.",
@@ -242,6 +246,10 @@
"type": "string",
"description": "Account name."
},
+ "starred": {
+ "type": "boolean",
+ "description": "Indicates whether this account is starred or not."
+ },
"webProperties": {
"type": "array",
"description": "List of web properties under this account.",
@@ -2348,6 +2356,10 @@
"type": "string",
"description": "The site search query parameters for this view (profile)."
},
+ "starred": {
+ "type": "boolean",
+ "description": "Indicates whether this view (profile) is starred or not."
+ },
"stripSiteSearchCategoryParameters": {
"type": "boolean",
"description": "Whether or not Analytics will strip search category parameters from the URLs in your reports."
@@ -2516,6 +2528,10 @@
"type": "string",
"description": "View (profile) name."
},
+ "starred": {
+ "type": "boolean",
+ "description": "Indicates whether this view (profile) is starred or not."
+ },
"type": {
"type": "string",
"description": "View (Profile) type. Supported types: WEB or APP."
@@ -3133,6 +3149,10 @@
"$ref": "ProfileSummary"
}
},
+ "starred": {
+ "type": "boolean",
+ "description": "Indicates whether this web property is starred or not."
+ },
"websiteUrl": {
"type": "string",
"description": "Website url for this web property."
@@ -3288,6 +3308,10 @@
"description": "Link for this web property.",
"readOnly": true
},
+ "starred": {
+ "type": "boolean",
+ "description": "Indicates whether this web property is starred or not."
+ },
"updated": {
"type": "string",
"description": "Time this web property was last modified.",
@@ -4878,7 +4902,7 @@
"id": "analytics.management.goals.patch",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
"httpMethod": "PATCH",
- "description": "Updates an existing view (profile). This method supports patch semantics.",
+ "description": "Updates an existing goal. This method supports patch semantics.",
"parameters": {
"accountId": {
"type": "string",
@@ -4925,7 +4949,7 @@
"id": "analytics.management.goals.update",
"path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
"httpMethod": "PUT",
- "description": "Updates an existing view (profile).",
+ "description": "Updates an existing goal.",
"parameters": {
"accountId": {
"type": "string",
diff --git a/etc/api/analyticsreporting/v4/analyticsreporting-api.json b/etc/api/analyticsreporting/v4/analyticsreporting-api.json
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/etc/api/androidenterprise/v1/androidenterprise-api.json b/etc/api/androidenterprise/v1/androidenterprise-api.json
index 053c9b045f..fda2c2219d 100644
--- a/etc/api/androidenterprise/v1/androidenterprise-api.json
+++ b/etc/api/androidenterprise/v1/androidenterprise-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Dx0G8SPg6yJp2LDFLDUMMNNCJBA\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/xo0cuZx80TlOD4lKDwMTBOsYYMo\"",
"discoveryVersion": "v1",
"id": "androidenterprise:v1",
"name": "androidenterprise",
"canonicalName": "Android Enterprise",
"version": "v1",
- "revision": "20160212",
+ "revision": "20160331",
"title": "Google Play EMM API",
- "description": "Allows MDMs/EMMs and enterprises to manage the deployment of apps to Android for Work users.",
+ "description": "Manages the deployment of apps to Android for Work users.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -339,7 +339,7 @@
"Enterprise": {
"id": "Enterprise",
"type": "object",
- "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.",
+ "description": "An enterprise resource represents a binding between an organization 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",
@@ -634,7 +634,7 @@
},
"iconUrl": {
"type": "string",
- "description": "A link to an image that can be used as an icon for the product."
+ "description": "A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px."
},
"kind": {
"type": "string",
@@ -653,6 +653,10 @@
"type": "boolean",
"description": "Whether this app can only be installed on devices using the Android for Work container app."
},
+ "smallIconUrl": {
+ "type": "string",
+ "description": "A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px."
+ },
"title": {
"type": "string",
"description": "The name of the product."
@@ -879,7 +883,7 @@
},
"primaryEmail": {
"type": "string",
- "description": "The user's primary email, e.g. \"jsmith@example.com\". Will always be set for Google managed users and not set for EMM managed users."
+ "description": "The user's primary email, e.g. \"jsmith@example.com\"."
}
}
},
@@ -1689,7 +1693,7 @@
},
"entitlementId": {
"type": "string",
- "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
+ "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
"required": true,
"location": "path"
},
@@ -1723,7 +1727,7 @@
},
"entitlementId": {
"type": "string",
- "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
+ "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
"required": true,
"location": "path"
},
@@ -1790,7 +1794,7 @@
},
"entitlementId": {
"type": "string",
- "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
+ "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
"required": true,
"location": "path"
},
@@ -1835,7 +1839,7 @@
},
"entitlementId": {
"type": "string",
- "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
+ "description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
"required": true,
"location": "path"
},
diff --git a/etc/api/androidpublisher/v1.1/androidpublisher-api.json b/etc/api/androidpublisher/v1.1/androidpublisher-api.json
index 8c5f8388a5..5fce0bdea7 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/f_Ih5rlctQLoYjA79HJRwD_1140\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/oG4KnSYJ6_j0nOlJWiaspUUKZyw\"",
"discoveryVersion": "v1",
"id": "androidpublisher:v1.1",
"name": "androidpublisher",
"canonicalName": "Android Publisher",
"version": "v1.1",
- "revision": "20160221",
+ "revision": "20160324",
"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 8a66febf23..8e6ab48206 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/FYzvitHkIO0WHnHI9t6qknKNpQ0\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/KPYGNNPN5TYGxlm0G5KeZWRpfuM\"",
"discoveryVersion": "v1",
"id": "androidpublisher:v1",
"name": "androidpublisher",
"canonicalName": "Android Publisher",
"version": "v1",
- "revision": "20160221",
+ "revision": "20160324",
"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 a03ea1b343..4681542d6b 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/mQrWIJVnZ-o4oNXFGrclXicilbM\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/wwfdcfcbj_VTedNtsK-mpfGIz58\"",
"discoveryVersion": "v1",
"id": "androidpublisher:v2",
"name": "androidpublisher",
"canonicalName": "Android Publisher",
"version": "v2",
- "revision": "20160221",
+ "revision": "20160324",
"title": "Google Play Developer API",
"description": "Lets Android application developers access their Google Play accounts.",
"ownerDomain": "google.com",
@@ -800,6 +800,19 @@
"type": "boolean",
"description": "Whether the subscription will automatically be renewed when it reaches its current expiry time."
},
+ "cancelReason": {
+ "type": "integer",
+ "description": "The cancel reason of the subscription, if the subscription is not auto renewing. Possible values are: \n- User cancelled the subscription \n- Subscription was cancelled by the system, for example because of a billing problem",
+ "format": "int32"
+ },
+ "countryCode": {
+ "type": "string",
+ "description": "ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted."
+ },
+ "developerPayload": {
+ "type": "string",
+ "description": "A developer-specified string that contains supplemental information about an order."
+ },
"expiryTimeMillis": {
"type": "string",
"description": "Time at which the subscription will expire, in milliseconds since Epoch.",
@@ -810,6 +823,20 @@
"description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
"default": "androidpublisher#subscriptionPurchase"
},
+ "paymentState": {
+ "type": "integer",
+ "description": "The payment state of the subscription. Possible values are: \n- Payment pending \n- Payment received",
+ "format": "int32"
+ },
+ "priceAmountMicros": {
+ "type": "string",
+ "description": "Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units equal one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.",
+ "format": "int64"
+ },
+ "priceCurrencyCode": {
+ "type": "string",
+ "description": "ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is \"GBP\"."
+ },
"startTimeMillis": {
"type": "string",
"description": "Time at which the subscription was granted, in milliseconds since Epoch.",
diff --git a/etc/api/api-list.yaml b/etc/api/api-list.yaml
index 59f92be0f1..80d6c47967 100644
--- a/etc/api/api-list.yaml
+++ b/etc/api/api-list.yaml
@@ -61,6 +61,8 @@ api:
- vm_beta
compute:
- v1
+ consumersurveys:
+ - v2
container:
- v1
content:
@@ -131,6 +133,8 @@ api:
- v1beta2
mirror:
- v1
+ monitoring:
+ - v3
oauth2:
- v2
pagespeedonline:
@@ -182,6 +186,8 @@ api:
- v1beta2
tasks:
- v1
+ toolresults:
+ - v1beta3
translate:
- v2
urlshortener:
diff --git a/etc/api/appengine/v1beta4/appengine-api.json b/etc/api/appengine/v1beta4/appengine-api.json
index 3a4e1fc7f2..c67e5134fc 100644
--- a/etc/api/appengine/v1beta4/appengine-api.json
+++ b/etc/api/appengine/v1beta4/appengine-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/sOTtGIhBrGRLc0_FlU9VkPbZAm0\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Ne9agwVqzB7mhydEKzb51sWzgug\"",
"discoveryVersion": "v1",
"id": "appengine:v1beta4",
"name": "appengine",
"version": "v1beta4",
- "revision": "20160223",
+ "revision": "20160314",
"title": "Google App Engine Admin API",
- "description": "The Google App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "description": "Provisions and manages App Engine applications.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -125,7 +125,7 @@
},
"dispatchRules": {
"type": "array",
- "description": "HTTP path dispatch rules for requests to the app that do not explicitly target a module or version. The rules are order-dependent.",
+ "description": "HTTP path dispatch rules for requests to the app that do not explicitly target a module or version. The rules are order-dependent. @OutputOnly",
"items": {
"$ref": "UrlDispatchRule"
}
@@ -136,7 +136,7 @@
},
"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\"."
+ "description": "The location from which the application will be run. 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. The default is \"us-central\". Choices are: \"us-central\" - Central US \"europe-west\" - Western Europe \"us-east1\" - Eastern US"
},
"codeBucket": {
"type": "string",
@@ -144,7 +144,7 @@
},
"defaultCookieExpiration": {
"type": "string",
- "description": "Determines the cookie expiration policy for the application."
+ "description": "Determines the cookie expiration policy for the application. @OutputOnly"
},
"defaultHostname": {
"type": "string",
@@ -913,7 +913,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",
diff --git a/etc/api/appengine/v1beta5/appengine-api.json b/etc/api/appengine/v1beta5/appengine-api.json
index a52338852e..8b0b6d9fe6 100644
--- a/etc/api/appengine/v1beta5/appengine-api.json
+++ b/etc/api/appengine/v1beta5/appengine-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/tL7xNjyj_kg_Ll9deL7DxZKPLUI\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/IvXIG_T4MYH64EZNcYKT8TBXdac\"",
"discoveryVersion": "v1",
"id": "appengine:v1beta5",
"name": "appengine",
"version": "v1beta5",
- "revision": "20160223",
+ "revision": "20160314",
"title": "Google App Engine Admin API",
- "description": "The Google App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "description": "Provisions and manages App Engine applications.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -117,7 +117,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",
@@ -205,7 +205,7 @@
},
"dispatchRules": {
"type": "array",
- "description": "HTTP path dispatch rules for requests to the app that do not explicitly target a service or version. The rules are order-dependent.",
+ "description": "HTTP path dispatch rules for requests to the app that do not explicitly target a service or version. The rules are order-dependent. @OutputOnly",
"items": {
"$ref": "UrlDispatchRule"
}
@@ -216,7 +216,7 @@
},
"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\"."
+ "description": "The location from which the application will be run. 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. The default is \"us-central\". Choices are: \"us-central\" - Central US \"europe-west\" - Western Europe \"us-east1\" - Eastern US"
},
"codeBucket": {
"type": "string",
@@ -224,7 +224,7 @@
},
"defaultCookieExpiration": {
"type": "string",
- "description": "Determines the cookie expiration policy for the application."
+ "description": "Determines the cookie expiration policy for the application. @OutputOnly"
},
"defaultHostname": {
"type": "string",
@@ -1545,7 +1545,7 @@
"$ref": "Version"
},
"response": {
- "$ref": "Version"
+ "$ref": "Operation"
},
"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 44e2297bb3..72b02c25a0 100644
--- a/etc/api/appsactivity/v1/appsactivity-api.json
+++ b/etc/api/appsactivity/v1/appsactivity-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/lSwCOA9I8RqRLs7NT_M6K7rXf1o\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/oEN2Yz1UYeuuQF-hTipAUfX2Yb8\"",
"discoveryVersion": "v1",
"id": "appsactivity:v1",
"name": "appsactivity",
"version": "v1",
- "revision": "20150723",
+ "revision": "20160129",
"title": "Google Apps Activity API",
"description": "Provides a historical view of activity.",
"ownerDomain": "google.com",
@@ -392,10 +392,18 @@
"type": "object",
"description": "A representation of a user.",
"properties": {
+ "isDeleted": {
+ "type": "boolean",
+ "description": "A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted."
+ },
"name": {
"type": "string",
"description": "The displayable name of the user."
},
+ "permissionId": {
+ "type": "string",
+ "description": "The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource."
+ },
"photo": {
"$ref": "Photo",
"description": "The profile photo of the user. Not present if the user has no profile photo."
diff --git a/etc/api/appstate/v1/appstate-api.json b/etc/api/appstate/v1/appstate-api.json
index ab2da411a9..95f3fe3dcd 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/FfUlPqFpPCwvkVzt3a4SxWWpKoc\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/K6eN4o-EiSpUkE-ew6yjfVfKuII\"",
"discoveryVersion": "v1",
"id": "appstate:v1",
"name": "appstate",
"canonicalName": "App State",
"version": "v1",
- "revision": "20160224",
+ "revision": "20160331",
"title": "Google App State API",
"description": "The Google App State API.",
"ownerDomain": "google.com",
diff --git a/etc/api/bigquery/v2/bigquery-api.json b/etc/api/bigquery/v2/bigquery-api.json
index 77319a4350..bd2bfad7e1 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/yOlQD0XV-M95o1thz-ymKpLxG7I\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/sNb4igYg4wCeulufFNSiGUjvhBU\"",
"discoveryVersion": "v1",
"id": "bigquery:v2",
"name": "bigquery",
"version": "v2",
- "revision": "20160222",
+ "revision": "20160408",
"title": "BigQuery API",
"description": "A data platform for customers to create, manage, share and query data.",
"ownerDomain": "google.com",
@@ -96,6 +96,82 @@
}
},
"schemas": {
+ "BigtableColumn": {
+ "id": "BigtableColumn",
+ "type": "object",
+ "properties": {
+ "encoding": {
+ "type": "string",
+ "description": "[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels."
+ },
+ "fieldName": {
+ "type": "string",
+ "description": "[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries."
+ },
+ "onlyReadLatest": {
+ "type": "boolean",
+ "description": "[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels."
+ },
+ "qualifierEncoded": {
+ "type": "string",
+ "description": "[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.",
+ "format": "byte"
+ },
+ "qualifierString": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "description": "[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Defaut type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels."
+ }
+ }
+ },
+ "BigtableColumnFamily": {
+ "id": "BigtableColumnFamily",
+ "type": "object",
+ "properties": {
+ "columns": {
+ "type": "array",
+ "description": "[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.",
+ "items": {
+ "$ref": "BigtableColumn"
+ }
+ },
+ "encoding": {
+ "type": "string",
+ "description": "[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it."
+ },
+ "familyId": {
+ "type": "string",
+ "description": "Identifier of the column family."
+ },
+ "onlyReadLatest": {
+ "type": "boolean",
+ "description": "[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column."
+ },
+ "type": {
+ "type": "string",
+ "description": "[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Defaut type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it."
+ }
+ }
+ },
+ "BigtableOptions": {
+ "id": "BigtableOptions",
+ "type": "object",
+ "properties": {
+ "columnFamilies": {
+ "type": "array",
+ "description": "[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.",
+ "items": {
+ "$ref": "BigtableColumnFamily"
+ }
+ },
+ "ignoreUnspecifiedColumnFamilies": {
+ "type": "boolean",
+ "description": "[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false."
+ }
+ }
+ },
"CsvOptions": {
"id": "CsvOptions",
"type": "object",
@@ -177,7 +253,7 @@
},
"defaultTableExpirationMs": {
"type": "string",
- "description": "[Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.",
+ "description": "[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.",
"format": "int64"
},
"description": {
@@ -404,9 +480,13 @@
"type": "boolean",
"description": "[Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored."
},
+ "bigtableOptions": {
+ "$ref": "BigtableOptions",
+ "description": "[Optional] Additional options if sourceFormat is set to BIGTABLE."
+ },
"compression": {
"type": "string",
- "description": "[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Datastore backups and Avro."
+ "description": "[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats."
},
"csvOptions": {
"$ref": "CsvOptions",
@@ -414,24 +494,24 @@
},
"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. Avro: 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 Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored."
},
"maxBadRecords": {
"type": "integer",
- "description": "[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Datastore backups and Avro.",
+ "description": "[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.",
"format": "int32"
},
"schema": {
"$ref": "TableSchema",
- "description": "[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups and Avro."
+ "description": "[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats."
},
"sourceFormat": {
"type": "string",
- "description": "[Required] The data format. For CSV files, specify \"CSV\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Google Cloud Datastore backups, specify \"DATASTORE_BACKUP\". For Avro files, specify \"AVRO\"."
+ "description": "[Required] The data format. For CSV files, specify \"CSV\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro files, specify \"AVRO\". For Google Cloud Datastore backups, specify \"DATASTORE_BACKUP\". [Experimental] For Google Cloud Bigtable, specify \"BIGTABLE\". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project."
},
"sourceUris": {
"type": "array",
- "description": "[Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.",
+ "description": "[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.",
"items": {
"type": "string"
}
@@ -497,6 +577,19 @@
}
}
},
+ "IntervalPartitionConfiguration": {
+ "id": "IntervalPartitionConfiguration",
+ "type": "object",
+ "properties": {
+ "expirationMs": {
+ "type": "string",
+ "format": "int64"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
"Job": {
"id": "Job",
"type": "object",
@@ -688,7 +781,7 @@
},
"sourceFormat": {
"type": "string",
- "description": "[Optional] The format of the data files. For CSV files, specify \"CSV\". For datastore backups, specify \"DATASTORE_BACKUP\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". The default value is CSV."
+ "description": "[Optional] The format of the data files. For CSV files, specify \"CSV\". For datastore backups, specify \"DATASTORE_BACKUP\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro, specify \"AVRO\". The default value is CSV."
},
"sourceUris": {
"type": "array",
@@ -1293,6 +1386,13 @@
"description": "[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.",
"format": "uint64"
},
+ "partitionConfigurations": {
+ "type": "array",
+ "description": "[Experimental] List of partition configurations for this table. Currently only one configuration can be specified and it can only be an interval partition with type daily.",
+ "items": {
+ "$ref": "TablePartitionConfiguration"
+ }
+ },
"schema": {
"$ref": "TableSchema",
"description": "[Optional] Describes the schema of this table."
@@ -1456,7 +1556,7 @@
},
"type": {
"type": "string",
- "description": "[Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema)."
+ "description": "[Required] The field data type. Possible values include STRING, BYTES, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema)."
}
}
},
@@ -1514,6 +1614,17 @@
}
}
},
+ "TablePartitionConfiguration": {
+ "id": "TablePartitionConfiguration",
+ "type": "object",
+ "description": "[Required] A partition configuration. Only one type of partition should be configured.",
+ "properties": {
+ "interval": {
+ "$ref": "IntervalPartitionConfiguration",
+ "description": "[Pick one] Configures an interval partition."
+ }
+ }
+ },
"TableReference": {
"id": "TableReference",
"type": "object",
diff --git a/etc/api/books/v1/books-api.json b/etc/api/books/v1/books-api.json
index 8bf6954d13..7b97893a37 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/2Ar_hXPHmnxe2mV6uxVVcPSU_1Y\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/fQ7gMSQqLPLbacQ9HzpdBnMKn-E\"",
"discoveryVersion": "v1",
"id": "books:v1",
"name": "books",
"version": "v1",
- "revision": "20160113",
+ "revision": "20160226",
"title": "Books API",
"description": "Lets you search for books and manage your Google Books library.",
"ownerDomain": "google.com",
@@ -1142,8 +1142,7 @@
"type": "string"
},
"dont_show_notification": {
- "type": "boolean",
- "default": "false"
+ "type": "boolean"
},
"iconUrl": {
"type": "string"
@@ -1159,6 +1158,9 @@
"pcampaign_id": {
"type": "string"
},
+ "reason": {
+ "type": "string"
+ },
"show_notification_settings_action": {
"type": "boolean"
},
@@ -4303,6 +4305,11 @@
"repeated": true,
"location": "query"
},
+ "country": {
+ "type": "string",
+ "description": "ISO-3166-1 code to override the IP-based location.",
+ "location": "query"
+ },
"locale": {
"type": "string",
"description": "ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.",
diff --git a/etc/api/calendar/v3/calendar-api.json b/etc/api/calendar/v3/calendar-api.json
index bfdf7ef9da..7b933467e5 100644
--- a/etc/api/calendar/v3/calendar-api.json
+++ b/etc/api/calendar/v3/calendar-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/WeMLh_6p2zlMBJbL5SsqQ7fFLj4\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/bVW4XkR_BcuuJ80pnL2PPki_lMk\"",
"discoveryVersion": "v1",
"id": "calendar:v3",
"name": "calendar",
"version": "v3",
- "revision": "20160221",
+ "revision": "20160405",
"title": "Calendar API",
- "description": "Lets you manipulate events and other calendar data.",
+ "description": "Manipulates events and other calendar data.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/clouddebugger/v2/clouddebugger-api.json b/etc/api/clouddebugger/v2/clouddebugger-api.json
index ad30eedea8..ba1bf5fbdb 100644
--- a/etc/api/clouddebugger/v2/clouddebugger-api.json
+++ b/etc/api/clouddebugger/v2/clouddebugger-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ADTy4sSpOyGMZnWzo4Bh1noM0eo\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/DyOQnJEJbXYKE7HJJaEpvyi2Ka0\"",
"discoveryVersion": "v1",
"id": "clouddebugger:v2",
"name": "clouddebugger",
"version": "v2",
- "revision": "20151123",
+ "revision": "20160309",
"title": "Google Cloud Debugger API",
- "description": "Lets you examine the stack and variables of your running application without stopping or slowing it down.",
+ "description": "Examines the call stack and variables of a running application without stopping or slowing it down.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -534,10 +534,17 @@
},
"variableTable": {
"type": "array",
- "description": "The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing veariable and the referenced variable.",
+ "description": "The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.",
"items": {
"$ref": "Variable"
}
+ },
+ "labels": {
+ "type": "object",
+ "description": "A set of custom breakpoint properties, populated by the agent, to be displayed to the user.",
+ "additionalProperties": {
+ "type": "string"
+ }
}
}
},
@@ -815,6 +822,11 @@
"type": "boolean",
"description": "When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.",
"location": "query"
+ },
+ "clientVersion": {
+ "type": "string",
+ "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query"
}
},
"response": {
@@ -840,6 +852,11 @@
"description": "ID of the debuggee where the breakpoint is to be set.",
"required": true,
"location": "path"
+ },
+ "clientVersion": {
+ "type": "string",
+ "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query"
}
},
"parameterOrder": [
@@ -873,6 +890,11 @@
"description": "ID of the breakpoint to get.",
"required": true,
"location": "path"
+ },
+ "clientVersion": {
+ "type": "string",
+ "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query"
}
},
"parameterOrder": [
@@ -904,6 +926,11 @@
"description": "ID of the breakpoint to delete.",
"required": true,
"location": "path"
+ },
+ "clientVersion": {
+ "type": "string",
+ "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query"
}
},
"parameterOrder": [
@@ -958,6 +985,11 @@
"type": "string",
"description": "A wait token that, if specified, blocks the call until the breakpoints list has changed, or a server selected timeout has expired. The value should be set from the last response. The error code `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which should be called again with the same `wait_token`.",
"location": "query"
+ },
+ "clientVersion": {
+ "type": "string",
+ "description": "The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "location": "query"
}
},
"parameterOrder": [
diff --git a/etc/api/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/etc/api/clouderrorreporting/v1beta1/clouderrorreporting-api.json
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/etc/api/cloudlatencytest/v2/cloudlatencytest-api.json b/etc/api/cloudlatencytest/v2/cloudlatencytest-api.json
index 583addb6a8..c8cf336fdf 100644
--- a/etc/api/cloudlatencytest/v2/cloudlatencytest-api.json
+++ b/etc/api/cloudlatencytest/v2/cloudlatencytest-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/DOqQD0ztw6kTeWEwsos73hXv2PI\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/FL1d8nurnHWuubBo0LSBB6ZSNaM\"",
"discoveryVersion": "v1",
"id": "cloudlatencytest:v2",
"name": "cloudlatencytest",
"version": "v2",
- "revision": "20150508",
+ "revision": "20160309",
"title": "Google Cloud Network Performance Monitoring API",
- "description": "A Test API to report latency data.",
+ "description": "Reports latency data.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json b/etc/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json
index 245d664196..799753526e 100644
--- a/etc/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json
+++ b/etc/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Ly32PDFAiHCxV9MTTuQr-IdOpS0\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/EqkjD9YlL49SjfTia8GERMML3DM\"",
"discoveryVersion": "v1",
"id": "cloudmonitoring:v2beta2",
"name": "cloudmonitoring",
"canonicalName": "Cloud Monitoring",
"version": "v2beta2",
- "revision": "20160221",
+ "revision": "20160403",
"title": "Cloud Monitoring API",
- "description": "API for accessing Google Cloud and API monitoring data.",
+ "description": "Accesses Google Cloud Monitoring data.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json b/etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json
index 4961a4ba63..7752d17c2b 100644
--- a/etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json
+++ b/etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -1,11 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/8EOgQpr1bAhvZ8Ay5woGZcfT03Y\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/808IeaiUvRpH2AAOyroDUDw0WoY\"",
"discoveryVersion": "v1",
"id": "cloudresourcemanager:v1",
"name": "cloudresourcemanager",
+ "canonicalName": "Cloud Resource Manager",
"version": "v1",
- "revision": "20160225",
+ "revision": "20160316",
"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",
diff --git a/etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
index 7ffbe8d5d1..dc553f48da 100644
--- a/etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ b/etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,11 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/TrvaAIwiWgzGMcf4IeAhPh7OpkA\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7EbyY-VAY04PT8kJyTAvwd_kJKM\"",
"discoveryVersion": "v1",
"id": "cloudresourcemanager:v1beta1",
"name": "cloudresourcemanager",
+ "canonicalName": "Cloud Resource Manager",
"version": "v1beta1",
- "revision": "20160225",
+ "revision": "20160316",
"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",
diff --git a/etc/api/clouduseraccounts/alpha/clouduseraccounts-api.json b/etc/api/clouduseraccounts/alpha/clouduseraccounts-api.json
index c4aa58ec15..9123879eb8 100644
--- a/etc/api/clouduseraccounts/alpha/clouduseraccounts-api.json
+++ b/etc/api/clouduseraccounts/alpha/clouduseraccounts-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ppUUXohfxuRfcvaKvPBvhvlWEhk\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/lOQeocShB0dxGwrtxzB56jZ95Xk\"",
"discoveryVersion": "v1",
"id": "clouduseraccounts:alpha",
"name": "clouduseraccounts",
"canonicalName": "Cloud User Accounts",
"version": "alpha",
- "revision": "20150924",
+ "revision": "20160316",
"title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
+ "description": "Creates and manages users and groups for accessing Google Compute Engine virtual machines.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -86,6 +86,24 @@
}
},
"schemas": {
+ "AuditConfig": {
+ "id": "AuditConfig",
+ "type": "object",
+ "description": "Enables \"data access\" audit logging for a service and specifies a list of members that are log-exempted.",
+ "properties": {
+ "exemptedMembers": {
+ "type": "array",
+ "description": "Specifies the identities that are exempted from \"data access\" audit logging for the `service` specified above. Follows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service": {
+ "type": "string",
+ "description": "Specifies a service that will be enabled for \"data access\" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services."
+ }
+ }
+ },
"AuthorizedKeysView": {
"id": "AuthorizedKeysView",
"type": "object",
@@ -111,7 +129,7 @@
"properties": {
"members": {
"type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
+ "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `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"
}
@@ -433,15 +451,19 @@
"properties": {
"clientOperationId": {
"type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
+ "description": "[Output Only] Reserved for future use."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
+ "description": {
+ "type": "string",
+ "description": "[Output Only] A textual description of the operation, which is set when the operation is created."
+ },
"endTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format."
},
"error": {
"type": "object",
@@ -459,7 +481,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",
@@ -476,17 +498,17 @@
},
"httpErrorStatusCode": {
"type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
+ "description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.",
"format": "int32"
},
"id": {
"type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"insertTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format."
},
"kind": {
"type": "string",
@@ -499,16 +521,16 @@
},
"operationType": {
"type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
+ "description": "[Output Only] The type of operation, such as insert, update, or delete, and so on."
},
"progress": {
"type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
+ "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.",
"format": "int32"
},
"region": {
"type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
+ "description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations."
},
"selfLink": {
"type": "string",
@@ -516,11 +538,11 @@
},
"startTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format."
},
"status": {
"type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
+ "description": "[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.",
"enum": [
"DONE",
"PENDING",
@@ -538,12 +560,12 @@
},
"targetId": {
"type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
+ "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
"format": "uint64"
},
"targetLink": {
"type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
+ "description": "[Output Only] The URL of the resource that the operation modifies."
},
"user": {
"type": "string",
@@ -557,8 +579,9 @@
"properties": {
"code": {
"type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
+ "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",
@@ -588,18 +611,19 @@
"",
"",
"",
+ "",
""
]
},
"data": {
"type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
+ "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 for the warning data."
+ "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",
@@ -610,14 +634,14 @@
},
"message": {
"type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
+ "description": "[Output Only] A human-readable description of the warning code."
}
}
}
},
"zone": {
"type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
+ "description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations."
}
}
},
@@ -628,11 +652,11 @@
"properties": {
"id": {
"type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
- "description": "[Output Only] The Operation resources.",
+ "description": "[Output Only] A list of Operation resources.",
"items": {
"$ref": "Operation"
}
@@ -644,7 +668,7 @@
},
"nextPageToken": {
"type": "string",
- "description": "[Output Only] A token used to continue a truncate."
+ "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",
@@ -655,8 +679,15 @@
"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.\n\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.\n\n**Example**\n\n{ \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.\n\n**Example**\n\n{ \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).",
"properties": {
+ "auditConfigs": {
+ "type": "array",
+ "description": "Specifies audit logging configs for \"data access\". \"data access\": generally refers to data reads/writes and admin reads. \"admin activity\": generally refers to admin writes.\n\nNote: `AuditConfig` doesn't apply to \"admin activity\", which always enables audit logging.",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
"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.",
@@ -666,12 +697,16 @@
},
"etag": {
"type": "string",
- "description": "Can be used to perform a read-modify-write.",
+ "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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.",
"format": "byte"
},
+ "iamOwned": {
+ "type": "boolean",
+ "description": ""
+ },
"rules": {
"type": "array",
- "description": "",
+ "description": "If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.",
"items": {
"$ref": "Rule"
}
@@ -971,12 +1006,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -990,7 +1025,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1193,12 +1228,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -1212,7 +1247,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1415,7 +1450,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 (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.",
+ "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"
},
"instance": {
@@ -1426,7 +1461,7 @@
},
"maxResults": {
"type": "integer",
- "description": "Maximum count of results to be returned.",
+ "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",
@@ -1440,7 +1475,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1652,12 +1687,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -1671,7 +1706,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
diff --git a/etc/api/clouduseraccounts/beta/clouduseraccounts-api.json b/etc/api/clouduseraccounts/beta/clouduseraccounts-api.json
index 469c76bd4d..e6352acafc 100644
--- a/etc/api/clouduseraccounts/beta/clouduseraccounts-api.json
+++ b/etc/api/clouduseraccounts/beta/clouduseraccounts-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/P3UYPKTEgal1uNkI02OYlUoya-A\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/-BiORd5nMN3AbHTR5Pi2H1JslEk\"",
"discoveryVersion": "v1",
"id": "clouduseraccounts:beta",
"name": "clouduseraccounts",
"canonicalName": "Cloud User Accounts",
"version": "beta",
- "revision": "20150924",
+ "revision": "20160316",
"title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
+ "description": "Creates and manages users and groups for accessing Google Compute Engine virtual machines.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -315,15 +315,19 @@
"properties": {
"clientOperationId": {
"type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
+ "description": "[Output Only] Reserved for future use."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
+ "description": {
+ "type": "string",
+ "description": "[Output Only] A textual description of the operation, which is set when the operation is created."
+ },
"endTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format."
},
"error": {
"type": "object",
@@ -341,7 +345,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",
@@ -358,17 +362,17 @@
},
"httpErrorStatusCode": {
"type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
+ "description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.",
"format": "int32"
},
"id": {
"type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"insertTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format."
},
"kind": {
"type": "string",
@@ -381,16 +385,16 @@
},
"operationType": {
"type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
+ "description": "[Output Only] The type of operation, such as insert, update, or delete, and so on."
},
"progress": {
"type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
+ "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.",
"format": "int32"
},
"region": {
"type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
+ "description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations."
},
"selfLink": {
"type": "string",
@@ -398,11 +402,11 @@
},
"startTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format."
},
"status": {
"type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
+ "description": "[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.",
"enum": [
"DONE",
"PENDING",
@@ -420,12 +424,12 @@
},
"targetId": {
"type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
+ "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
"format": "uint64"
},
"targetLink": {
"type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
+ "description": "[Output Only] The URL of the resource that the operation modifies."
},
"user": {
"type": "string",
@@ -439,8 +443,9 @@
"properties": {
"code": {
"type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
+ "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",
@@ -470,18 +475,19 @@
"",
"",
"",
+ "",
""
]
},
"data": {
"type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
+ "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 for the warning data."
+ "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",
@@ -492,14 +498,14 @@
},
"message": {
"type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
+ "description": "[Output Only] A human-readable description of the warning code."
}
}
}
},
"zone": {
"type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
+ "description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations."
}
}
},
@@ -510,11 +516,11 @@
"properties": {
"id": {
"type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
- "description": "[Output Only] The Operation resources.",
+ "description": "[Output Only] A list of Operation resources.",
"items": {
"$ref": "Operation"
}
@@ -526,7 +532,7 @@
},
"nextPageToken": {
"type": "string",
- "description": "[Output Only] A token used to continue a truncate."
+ "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",
@@ -730,12 +736,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -749,7 +755,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -917,12 +923,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -936,7 +942,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1063,7 +1069,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 (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.",
+ "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"
},
"instance": {
@@ -1074,7 +1080,7 @@
},
"maxResults": {
"type": "integer",
- "description": "Maximum count of results to be returned.",
+ "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",
@@ -1088,7 +1094,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1265,12 +1271,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -1284,7 +1290,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
diff --git a/etc/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json b/etc/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json
index 129644618f..797f2097a5 100644
--- a/etc/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json
+++ b/etc/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/8QLRZ5jNksoRAKNza-2WDCbR984\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/DmNFUFGhSh7oLg7RNX5k36KX4oA\"",
"discoveryVersion": "v1",
"id": "clouduseraccounts:vm_alpha",
"name": "clouduseraccounts",
"canonicalName": "Cloud User Accounts",
"version": "vm_alpha",
- "revision": "20150924",
+ "revision": "20160316",
"title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
+ "description": "Creates and manages users and groups for accessing Google Compute Engine virtual machines.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -86,6 +86,24 @@
}
},
"schemas": {
+ "AuditConfig": {
+ "id": "AuditConfig",
+ "type": "object",
+ "description": "Enables \"data access\" audit logging for a service and specifies a list of members that are log-exempted.",
+ "properties": {
+ "exemptedMembers": {
+ "type": "array",
+ "description": "Specifies the identities that are exempted from \"data access\" audit logging for the `service` specified above. Follows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service": {
+ "type": "string",
+ "description": "Specifies a service that will be enabled for \"data access\" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services."
+ }
+ }
+ },
"AuthorizedKeysView": {
"id": "AuthorizedKeysView",
"type": "object",
@@ -111,7 +129,7 @@
"properties": {
"members": {
"type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
+ "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `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"
}
@@ -433,15 +451,19 @@
"properties": {
"clientOperationId": {
"type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
+ "description": "[Output Only] Reserved for future use."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
+ "description": {
+ "type": "string",
+ "description": "[Output Only] A textual description of the operation, which is set when the operation is created."
+ },
"endTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format."
},
"error": {
"type": "object",
@@ -459,7 +481,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",
@@ -476,17 +498,17 @@
},
"httpErrorStatusCode": {
"type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
+ "description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.",
"format": "int32"
},
"id": {
"type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"insertTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format."
},
"kind": {
"type": "string",
@@ -499,16 +521,16 @@
},
"operationType": {
"type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
+ "description": "[Output Only] The type of operation, such as insert, update, or delete, and so on."
},
"progress": {
"type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
+ "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.",
"format": "int32"
},
"region": {
"type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
+ "description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations."
},
"selfLink": {
"type": "string",
@@ -516,11 +538,11 @@
},
"startTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format."
},
"status": {
"type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
+ "description": "[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.",
"enum": [
"DONE",
"PENDING",
@@ -538,12 +560,12 @@
},
"targetId": {
"type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
+ "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
"format": "uint64"
},
"targetLink": {
"type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
+ "description": "[Output Only] The URL of the resource that the operation modifies."
},
"user": {
"type": "string",
@@ -557,8 +579,9 @@
"properties": {
"code": {
"type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
+ "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",
@@ -588,18 +611,19 @@
"",
"",
"",
+ "",
""
]
},
"data": {
"type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
+ "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 for the warning data."
+ "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",
@@ -610,14 +634,14 @@
},
"message": {
"type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
+ "description": "[Output Only] A human-readable description of the warning code."
}
}
}
},
"zone": {
"type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
+ "description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations."
}
}
},
@@ -628,11 +652,11 @@
"properties": {
"id": {
"type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
- "description": "[Output Only] The Operation resources.",
+ "description": "[Output Only] A list of Operation resources.",
"items": {
"$ref": "Operation"
}
@@ -644,7 +668,7 @@
},
"nextPageToken": {
"type": "string",
- "description": "[Output Only] A token used to continue a truncate."
+ "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",
@@ -655,8 +679,15 @@
"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.\n\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.\n\n**Example**\n\n{ \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.\n\n**Example**\n\n{ \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).",
"properties": {
+ "auditConfigs": {
+ "type": "array",
+ "description": "Specifies audit logging configs for \"data access\". \"data access\": generally refers to data reads/writes and admin reads. \"admin activity\": generally refers to admin writes.\n\nNote: `AuditConfig` doesn't apply to \"admin activity\", which always enables audit logging.",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
"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.",
@@ -666,12 +697,16 @@
},
"etag": {
"type": "string",
- "description": "Can be used to perform a read-modify-write.",
+ "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.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.",
"format": "byte"
},
+ "iamOwned": {
+ "type": "boolean",
+ "description": ""
+ },
"rules": {
"type": "array",
- "description": "",
+ "description": "If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.",
"items": {
"$ref": "Rule"
}
@@ -971,12 +1006,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -990,7 +1025,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1193,12 +1228,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -1212,7 +1247,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1415,7 +1450,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 (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.",
+ "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"
},
"instance": {
@@ -1426,7 +1461,7 @@
},
"maxResults": {
"type": "integer",
- "description": "Maximum count of results to be returned.",
+ "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",
@@ -1440,7 +1475,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1652,12 +1687,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -1671,7 +1706,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
diff --git a/etc/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json b/etc/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json
index 32faf500f2..1ce9f4d3a1 100644
--- a/etc/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json
+++ b/etc/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/_YEtikt1V6jQ8uvyDFq2SnsqFzY\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/NOgAExjYfIWiV_BL3FlcslmjncY\"",
"discoveryVersion": "v1",
"id": "clouduseraccounts:vm_beta",
"name": "clouduseraccounts",
"canonicalName": "Cloud User Accounts",
"version": "vm_beta",
- "revision": "20150924",
+ "revision": "20160316",
"title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
+ "description": "Creates and manages users and groups for accessing Google Compute Engine virtual machines.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -315,15 +315,19 @@
"properties": {
"clientOperationId": {
"type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
+ "description": "[Output Only] Reserved for future use."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
+ "description": {
+ "type": "string",
+ "description": "[Output Only] A textual description of the operation, which is set when the operation is created."
+ },
"endTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format."
},
"error": {
"type": "object",
@@ -341,7 +345,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",
@@ -358,17 +362,17 @@
},
"httpErrorStatusCode": {
"type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
+ "description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.",
"format": "int32"
},
"id": {
"type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"insertTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format."
},
"kind": {
"type": "string",
@@ -381,16 +385,16 @@
},
"operationType": {
"type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
+ "description": "[Output Only] The type of operation, such as insert, update, or delete, and so on."
},
"progress": {
"type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
+ "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.",
"format": "int32"
},
"region": {
"type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
+ "description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations."
},
"selfLink": {
"type": "string",
@@ -398,11 +402,11 @@
},
"startTime": {
"type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
+ "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format."
},
"status": {
"type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
+ "description": "[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.",
"enum": [
"DONE",
"PENDING",
@@ -420,12 +424,12 @@
},
"targetId": {
"type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
+ "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
"format": "uint64"
},
"targetLink": {
"type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
+ "description": "[Output Only] The URL of the resource that the operation modifies."
},
"user": {
"type": "string",
@@ -439,8 +443,9 @@
"properties": {
"code": {
"type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
+ "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",
@@ -470,18 +475,19 @@
"",
"",
"",
+ "",
""
]
},
"data": {
"type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
+ "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 for the warning data."
+ "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",
@@ -492,14 +498,14 @@
},
"message": {
"type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
+ "description": "[Output Only] A human-readable description of the warning code."
}
}
}
},
"zone": {
"type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
+ "description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations."
}
}
},
@@ -510,11 +516,11 @@
"properties": {
"id": {
"type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
- "description": "[Output Only] The Operation resources.",
+ "description": "[Output Only] A list of Operation resources.",
"items": {
"$ref": "Operation"
}
@@ -526,7 +532,7 @@
},
"nextPageToken": {
"type": "string",
- "description": "[Output Only] A token used to continue a truncate."
+ "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",
@@ -730,12 +736,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -749,7 +755,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -917,12 +923,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -936,7 +942,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1063,7 +1069,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 (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.",
+ "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"
},
"instance": {
@@ -1074,7 +1080,7 @@
},
"maxResults": {
"type": "integer",
- "description": "Maximum count of results to be returned.",
+ "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",
@@ -1088,7 +1094,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
@@ -1265,12 +1271,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 (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.",
+ "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": "Maximum count of results to be returned.",
+ "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",
@@ -1284,7 +1290,7 @@
},
"pageToken": {
"type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
+ "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": {
diff --git a/etc/api/compute/beta/compute-api.json b/etc/api/compute/beta/compute-api.json
index fd1f030544..287cd063b8 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/pVbZZeEvcu3mq1f_gCZmNGrmIYU\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/vE0JIg_PYjJmE8NwLJpJ5mHAwEQ\"",
"discoveryVersion": "v1",
"id": "compute:beta",
"name": "compute",
"version": "beta",
- "revision": "20160224",
+ "revision": "20160328",
"title": "Compute Engine API",
"description": "API for the Google Compute Engine service.",
"ownerDomain": "google.com",
@@ -449,7 +449,7 @@
},
"sourceImage": {
"type": "string",
- "description": "A source image used to create the disk. You can provide a private (custom) image, 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.\n\nTo create a disk with a private image, specify the image name in the following format:\n\nglobal/images/my-private-image \n\nTo create a disk with a public image, specify the image name and the project that owns the image. For example, you can use a Debian image from the debian-cloud project:\n\nprojects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD \n\nThe vYYYYMMDD value is the image version. The fully-qualified URL also works in both examples."
},
"sourceImageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
@@ -858,6 +858,10 @@
""
]
},
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services."
+ },
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
@@ -1011,12 +1015,12 @@
},
"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.",
+ "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 labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make a get() request to retrieve a 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.",
+ "description": "Labels to apply to this disk. These can be later modified by the setLabels() method. Each label key & value must 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. A label value can also be empty (e.g. \"example-label\": \"\").",
"additionalProperties": {
"type": "string"
}
@@ -1061,7 +1065,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.\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"
+ "description": "The source image used to create this disk. If the source image is deleted, this field will not be set.\n\nTo create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:\n\nprojects/debian-cloud/global/images/family/debian-8 \n\nAlternatively, use a specific version of a public operating system image:\n\nprojects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD \n\nTo create a disk with a private image that you created, specify the image name in the following format:\n\nglobal/images/my-private-image \n\nYou can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:\n\nglobal/images/family/my-private-family"
},
"sourceImageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
@@ -1794,6 +1798,24 @@
}
}
},
+ "GlobalSetLabelsRequest": {
+ "id": "GlobalSetLabelsRequest",
+ "type": "object",
+ "properties": {
+ "labelFingerprint": {
+ "type": "string",
+ "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.",
+ "format": "byte"
+ },
+ "labels": {
+ "type": "object",
+ "description": "The labels to set for this resource.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
"HealthCheckReference": {
"id": "HealthCheckReference",
"type": "object",
@@ -2082,7 +2104,7 @@
},
"family": {
"type": "string",
- "description": "Image family for the resource; provided by the client when the resource is created."
+ "description": "The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated."
},
"id": {
"type": "string",
@@ -2100,12 +2122,12 @@
},
"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.",
+ "description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make a get() request to retrieve an 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.",
+ "description": "Labels to apply to this image. These can be later modified by the setLabels() method. Each label key & value must 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. A label value can also be empty (e.g. \"example-label\": \"\").",
"additionalProperties": {
"type": "string"
}
@@ -3987,7 +4009,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": {
@@ -4317,6 +4339,10 @@
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
+ "defaultServiceAccount": {
+ "type": "string",
+ "description": "[Output Only] Default service account used by VMs running in this project."
+ },
"description": {
"type": "string",
"description": "An optional textual description of the resource."
@@ -4849,7 +4875,7 @@
"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.",
+ "description": "Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. 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"
}
}
@@ -4895,7 +4921,7 @@
"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."
+ "description": "IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface."
},
"linkedVpnTunnel": {
"type": "string",
@@ -4983,7 +5009,7 @@
},
"name": {
"type": "string",
- "description": "Name of this BGP peer. Unique within the routes resource."
+ "description": "Name of this BGP peer. Unique within the Routers resource."
},
"numLearnedRoutes": {
"type": "integer",
@@ -5219,12 +5245,12 @@
},
"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.",
+ "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 labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make a get() request to retrieve a 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.",
+ "description": "Labels to apply to this snapshot. These can be later modified by the setLabels() method. Each label key & value must 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. A label value can also be empty (e.g. \"example-label\": \"\").",
"additionalProperties": {
"type": "string"
}
@@ -6494,6 +6520,32 @@
}
}
},
+ "TestPermissionsRequest": {
+ "id": "TestPermissionsRequest",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "array",
+ "description": "The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TestPermissionsResponse": {
+ "id": "TestPermissionsResponse",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "array",
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
"UrlMap": {
"id": "UrlMap",
"type": "object",
@@ -6964,31 +7016,6 @@
"description": "[Output Only] Type of the resource. Always compute#zone for zones.",
"default": "compute#zone"
},
- "maintenanceWindows": {
- "type": "array",
- "description": "[Output Only] Any scheduled maintenance windows for this zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable. For more information, see Maintenance Windows",
- "items": {
- "type": "object",
- "properties": {
- "beginTime": {
- "type": "string",
- "description": "[Output Only] Starting time of the maintenance window, in RFC3339 format."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Textual description of the maintenance window."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] Ending time of the maintenance window, in RFC3339 format."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the maintenance window."
- }
- }
- }
- },
"name": {
"type": "string",
"description": "[Output Only] Name of the resource."
@@ -7045,6 +7072,24 @@
"description": "[Output Only] Server-defined URL for this resource."
}
}
+ },
+ "ZoneSetLabelsRequest": {
+ "id": "ZoneSetLabelsRequest",
+ "type": "object",
+ "properties": {
+ "labelFingerprint": {
+ "type": "string",
+ "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.",
+ "format": "byte"
+ },
+ "labels": {
+ "type": "object",
+ "description": "The labels to set for this resource.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
}
},
"resources": {
@@ -7276,6 +7321,51 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.addresses.testIamPermissions",
+ "path": "{project}/regions/{region}/addresses/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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": "The name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -7552,6 +7642,51 @@
"https://www.googleapis.com/auth/compute"
]
},
+ "testIamPermissions": {
+ "id": "compute.autoscalers.testIamPermissions",
+ "path": "{project}/zones/{zone}/autoscalers/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"update": {
"id": "compute.autoscalers.update",
"path": "{project}/zones/{zone}/autoscalers",
@@ -7815,6 +7950,43 @@
"https://www.googleapis.com/auth/compute"
]
},
+ "testIamPermissions": {
+ "id": "compute.backendServices.testIamPermissions",
+ "path": "{project}/global/backendServices/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"update": {
"id": "compute.backendServices.update",
"path": "{project}/global/backendServices/{backendService}",
@@ -8190,7 +8362,7 @@
"id": "compute.disks.insert",
"path": "{project}/zones/{zone}/disks",
"httpMethod": "POST",
- "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.",
+ "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 500 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",
@@ -8328,6 +8500,95 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "setLabels": {
+ "id": "compute.disks.setLabels",
+ "path": "{project}/zones/{zone}/disks/{resource}/setLabels",
+ "httpMethod": "POST",
+ "description": "Sets the labels on the target disk.",
+ "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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "ZoneSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "testIamPermissions": {
+ "id": "compute.disks.testIamPermissions",
+ "path": "{project}/zones/{zone}/disks/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -8514,6 +8775,43 @@
"https://www.googleapis.com/auth/compute"
]
},
+ "testIamPermissions": {
+ "id": "compute.firewalls.testIamPermissions",
+ "path": "{project}/global/firewalls/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"update": {
"id": "compute.firewalls.update",
"path": "{project}/global/firewalls/{firewall}",
@@ -8824,6 +9122,51 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.forwardingRules.testIamPermissions",
+ "path": "{project}/regions/{region}/forwardingRules/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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": "The name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -8973,6 +9316,43 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.globalAddresses.testIamPermissions",
+ "path": "{project}/global/addresses/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -9158,6 +9538,43 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.globalForwardingRules.testIamPermissions",
+ "path": "{project}/global/forwardingRules/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -9512,6 +9929,43 @@
"https://www.googleapis.com/auth/compute"
]
},
+ "testIamPermissions": {
+ "id": "compute.httpHealthChecks.testIamPermissions",
+ "path": "{project}/global/httpHealthChecks/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"update": {
"id": "compute.httpHealthChecks.update",
"path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
@@ -9733,6 +10187,43 @@
"https://www.googleapis.com/auth/compute"
]
},
+ "testIamPermissions": {
+ "id": "compute.httpsHealthChecks.testIamPermissions",
+ "path": "{project}/global/httpsHealthChecks/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"update": {
"id": "compute.httpsHealthChecks.update",
"path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
@@ -9880,7 +10371,7 @@
"id": "compute.images.getFromFamily",
"path": "{project}/global/images/family/{family}",
"httpMethod": "GET",
- "description": "Returns the latest undeprecated image for an image family.",
+ "description": "Returns the latest image that is part of an image family and is not deprecated.",
"parameters": {
"family": {
"type": "string",
@@ -9990,6 +10481,79 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "setLabels": {
+ "id": "compute.images.setLabels",
+ "path": "{project}/global/images/{resource}/setLabels",
+ "httpMethod": "POST",
+ "description": "Sets the labels on the target image.",
+ "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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "testIamPermissions": {
+ "id": "compute.images.testIamPermissions",
+ "path": "{project}/global/images/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -10554,6 +11118,51 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.instanceGroupManagers.testIamPermissions",
+ "path": "{project}/zones/{zone}/instanceGroupManagers/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -10972,6 +11581,51 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.instanceGroups.testIamPermissions",
+ "path": "{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -11121,6 +11775,43 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.instanceTemplates.testIamPermissions",
+ "path": "{project}/global/instanceTemplates/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -12007,6 +12698,51 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.instances.testIamPermissions",
+ "path": "{project}/zones/{zone}/instances/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -12348,6 +13084,43 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.networks.testIamPermissions",
+ "path": "{project}/global/networks/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -12985,6 +13758,51 @@
"https://www.googleapis.com/auth/compute"
]
},
+ "testIamPermissions": {
+ "id": "compute.routers.testIamPermissions",
+ "path": "{project}/regions/{region}/routers/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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": "The name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"update": {
"id": "compute.routers.update",
"path": "{project}/regions/{region}/routers/{router}",
@@ -13177,6 +13995,43 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.routes.testIamPermissions",
+ "path": "{project}/global/routes/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -13298,6 +14153,79 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "setLabels": {
+ "id": "compute.snapshots.setLabels",
+ "path": "{project}/global/snapshots/{resource}/setLabels",
+ "httpMethod": "POST",
+ "description": "Sets the labels on the target snapshot.",
+ "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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "testIamPermissions": {
+ "id": "compute.snapshots.testIamPermissions",
+ "path": "{project}/global/snapshots/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -13447,6 +14375,43 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.sslCertificates.testIamPermissions",
+ "path": "{project}/global/sslCertificates/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -13678,6 +14643,51 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.subnetworks.testIamPermissions",
+ "path": "{project}/regions/{region}/subnetworks/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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": "The name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -13863,6 +14873,43 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.targetHttpProxies.testIamPermissions",
+ "path": "{project}/global/targetHttpProxies/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -14084,6 +15131,43 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.targetHttpsProxies.testIamPermissions",
+ "path": "{project}/global/targetHttpsProxies/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -14315,6 +15399,51 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.targetInstances.testIamPermissions",
+ "path": "{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -14817,6 +15946,51 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.targetPools.testIamPermissions",
+ "path": "{project}/regions/{region}/targetPools/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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": "The name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -15048,6 +16222,51 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.targetVpnGateways.testIamPermissions",
+ "path": "{project}/regions/{region}/targetVpnGateways/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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": "The name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
@@ -15270,6 +16489,43 @@
"https://www.googleapis.com/auth/compute"
]
},
+ "testIamPermissions": {
+ "id": "compute.urlMaps.testIamPermissions",
+ "path": "{project}/global/urlMaps/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"update": {
"id": "compute.urlMaps.update",
"path": "{project}/global/urlMaps/{urlMap}",
@@ -15572,6 +16828,51 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "testIamPermissions": {
+ "id": "compute.vpnTunnels.testIamPermissions",
+ "path": "{project}/regions/{region}/vpnTunnels/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified 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": "The name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
diff --git a/etc/api/compute/v1/compute-api.json b/etc/api/compute/v1/compute-api.json
index 3553a72c23..c56a96f1ce 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/20Z2B4pctNFb7ZLU4UgN3SvWELA\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/P9b4dbHBJNvklJYWy1Z1rmeMosc\"",
"discoveryVersion": "v1",
"id": "compute:v1",
"name": "compute",
"version": "v1",
- "revision": "20160224",
+ "revision": "20160328",
"title": "Compute Engine API",
"description": "API for the Google Compute Engine service.",
"ownerDomain": "google.com",
@@ -433,7 +433,7 @@
},
"sourceImage": {
"type": "string",
- "description": "A source image used to create the disk. You can provide a private (custom) image, 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.\n\nTo create a disk with a private image, specify the image name in the following format:\n\nglobal/images/my-private-image \n\nTo create a disk with a public image, specify the image name and the project that owns the image. For example, you can use a Debian image from the debian-cloud project:\n\nprojects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD \n\nThe vYYYYMMDD value is the image version. The fully-qualified URL also works in both examples."
}
}
},
@@ -834,6 +834,10 @@
""
]
},
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services."
+ },
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
@@ -993,7 +997,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.\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"
+ "description": "The source image used to create this disk. If the source image is deleted, this field will not be set.\n\nTo create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:\n\nprojects/debian-cloud/global/images/family/debian-8 \n\nAlternatively, use a specific version of a public operating system image:\n\nprojects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD \n\nTo create a disk with a private image that you created, specify the image name in the following format:\n\nglobal/images/my-private-image \n\nYou can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:\n\nglobal/images/family/my-private-family"
},
"sourceImageId": {
"type": "string",
@@ -1307,6 +1311,17 @@
}
}
},
+ "DisksResizeRequest": {
+ "id": "DisksResizeRequest",
+ "type": "object",
+ "properties": {
+ "sizeGb": {
+ "type": "string",
+ "description": "The new size of the persistent disk, which is specified in GB.",
+ "format": "int64"
+ }
+ }
+ },
"DisksScopedList": {
"id": "DisksScopedList",
"type": "object",
@@ -3847,7 +3862,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": {
@@ -6418,31 +6433,6 @@
"description": "[Output Only] Type of the resource. Always compute#zone for zones.",
"default": "compute#zone"
},
- "maintenanceWindows": {
- "type": "array",
- "description": "[Output Only] Any scheduled maintenance windows for this zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable. For more information, see Maintenance Windows",
- "items": {
- "type": "object",
- "properties": {
- "beginTime": {
- "type": "string",
- "description": "[Output Only] Starting time of the maintenance window, in RFC3339 format."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Textual description of the maintenance window."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] Ending time of the maintenance window, in RFC3339 format."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the maintenance window."
- }
- }
- }
- },
"name": {
"type": "string",
"description": "[Output Only] Name of the resource."
@@ -7604,7 +7594,7 @@
"id": "compute.disks.insert",
"path": "{project}/zones/{zone}/disks",
"httpMethod": "POST",
- "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.",
+ "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 500 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",
@@ -7693,6 +7683,50 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "resize": {
+ "id": "compute.disks.resize",
+ "path": "{project}/zones/{zone}/disks/{disk}/resize",
+ "httpMethod": "POST",
+ "description": "Resizes the specified persistent disk.",
+ "parameters": {
+ "disk": {
+ "type": "string",
+ "description": "The name of the persistent disk.",
+ "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"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "disk"
+ ],
+ "request": {
+ "$ref": "DisksResizeRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
diff --git a/etc/api/consumersurveys/v2/consumersurveys-api.json b/etc/api/consumersurveys/v2/consumersurveys-api.json
new file mode 100644
index 0000000000..e287c892c1
--- /dev/null
+++ b/etc/api/consumersurveys/v2/consumersurveys-api.json
@@ -0,0 +1,647 @@
+{
+ "kind": "discovery#restDescription",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/2ITXfTj3l8aU9YhKDrABM562udw\"",
+ "discoveryVersion": "v1",
+ "id": "consumersurveys:v2",
+ "name": "consumersurveys",
+ "version": "v2",
+ "revision": "20160405",
+ "title": "Consumer Surveys API",
+ "description": "API for Google Consumer Surveys.",
+ "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"
+ },
+ "protocol": "rest",
+ "baseUrl": "https://www.googleapis.com/consumersurveys/v2/",
+ "basePath": "/consumersurveys/v2/",
+ "rootUrl": "https://www.googleapis.com/",
+ "servicePath": "consumersurveys/v2/",
+ "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/consumersurveys": {
+ "description": "View and edit your surveys and results"
+ },
+ "https://www.googleapis.com/auth/consumersurveys.readonly": {
+ "description": "View the results for your surveys"
+ },
+ "https://www.googleapis.com/auth/userinfo.email": {
+ "description": "View your email address"
+ }
+ }
+ }
+ },
+ "schemas": {
+ "FieldMask": {
+ "id": "FieldMask",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "FieldMask"
+ }
+ },
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "PageInfo": {
+ "id": "PageInfo",
+ "type": "object",
+ "properties": {
+ "resultPerPage": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "startIndex": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "totalResults": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "ResultsGetRequest": {
+ "id": "ResultsGetRequest",
+ "type": "object",
+ "properties": {
+ "resultMask": {
+ "$ref": "ResultsMask"
+ }
+ }
+ },
+ "ResultsMask": {
+ "id": "ResultsMask",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "FieldMask"
+ }
+ },
+ "projection": {
+ "type": "string"
+ }
+ }
+ },
+ "Survey": {
+ "id": "Survey",
+ "type": "object",
+ "description": "Representation of an individual survey object.",
+ "properties": {
+ "audience": {
+ "$ref": "SurveyAudience",
+ "description": "Targeting-criteria message containing demographic information"
+ },
+ "cost": {
+ "$ref": "SurveyCost",
+ "description": "Cost to run the survey and collect the necessary number of responses."
+ },
+ "customerData": {
+ "type": "string",
+ "description": "Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.",
+ "format": "byte"
+ },
+ "description": {
+ "type": "string",
+ "description": "Text description of the survey."
+ },
+ "owners": {
+ "type": "array",
+ "description": "List of email addresses for survey owners. Must contain at least the address of the user making the API call.",
+ "items": {
+ "type": "string"
+ },
+ "annotations": {
+ "required": [
+ "consumersurveys.surveys.insert"
+ ]
+ }
+ },
+ "questions": {
+ "type": "array",
+ "description": "List of questions defining the survey.",
+ "items": {
+ "$ref": "SurveyQuestion"
+ },
+ "annotations": {
+ "required": [
+ "consumersurveys.surveys.insert"
+ ]
+ }
+ },
+ "state": {
+ "type": "string",
+ "description": "State that the survey is in. Can be modified to start, stop, or pause survey."
+ },
+ "surveyUrlId": {
+ "type": "string",
+ "description": "Unique survey ID, that is viewable in the URL of the Survey Creator UI"
+ },
+ "title": {
+ "type": "string",
+ "description": "Optional name that will be given to the survey."
+ },
+ "wantedResponseCount": {
+ "type": "integer",
+ "description": "Number of responses desired for the survey.",
+ "format": "int32"
+ }
+ }
+ },
+ "SurveyAudience": {
+ "id": "SurveyAudience",
+ "type": "object",
+ "description": "Specifications for the target audience of a survey run through the API.",
+ "properties": {
+ "ages": {
+ "type": "array",
+ "description": "Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']",
+ "items": {
+ "type": "string"
+ }
+ },
+ "country": {
+ "type": "string",
+ "description": "Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.",
+ "annotations": {
+ "required": [
+ "consumersurveys.surveys.insert"
+ ]
+ }
+ },
+ "countrySubdivision": {
+ "type": "string",
+ "description": "Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England)."
+ },
+ "gender": {
+ "type": "string",
+ "description": "Optional gender to target."
+ },
+ "languages": {
+ "type": "array",
+ "description": "Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.",
+ "items": {
+ "type": "string"
+ },
+ "annotations": {
+ "required": [
+ "consumersurveys.surveys.insert"
+ ]
+ }
+ },
+ "populationSource": {
+ "type": "string",
+ "description": "Online population source where the respondents are sampled from."
+ }
+ }
+ },
+ "SurveyCost": {
+ "id": "SurveyCost",
+ "type": "object",
+ "description": "Message defining the cost to run a given survey through API.",
+ "properties": {
+ "currencyCode": {
+ "type": "string",
+ "description": "Currency code that the cost is given in."
+ },
+ "nanos": {
+ "type": "string",
+ "description": "Cost of survey in nano units of the given currency.",
+ "format": "int64"
+ }
+ }
+ },
+ "SurveyQuestion": {
+ "id": "SurveyQuestion",
+ "type": "object",
+ "description": "Message defining the question specifications.",
+ "properties": {
+ "answerOrder": {
+ "type": "string",
+ "description": "The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize."
+ },
+ "answers": {
+ "type": "array",
+ "description": "Required list of answer options for a question.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "hasOther": {
+ "type": "boolean",
+ "description": "Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types."
+ },
+ "highValueLabel": {
+ "type": "string",
+ "description": "For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response."
+ },
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "SurveyQuestionImage"
+ }
+ },
+ "lastAnswerPositionPinned": {
+ "type": "boolean",
+ "description": "Currently only support pinning an answer option to the last position."
+ },
+ "lowValueLabel": {
+ "type": "string",
+ "description": "For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response."
+ },
+ "mustPickSuggestion": {
+ "type": "boolean",
+ "description": "Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question."
+ },
+ "numStars": {
+ "type": "string",
+ "description": "Number of stars to use for ratings questions."
+ },
+ "openTextPlaceholder": {
+ "type": "string",
+ "description": "Placeholder text for an open text question."
+ },
+ "openTextSuggestions": {
+ "type": "array",
+ "description": "A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "question": {
+ "type": "string",
+ "description": "Required question text shown to the respondent."
+ },
+ "sentimentText": {
+ "type": "string",
+ "description": "Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate."
+ },
+ "singleLineResponse": {
+ "type": "boolean",
+ "description": "Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses."
+ },
+ "thresholdAnswers": {
+ "type": "array",
+ "description": "The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "type": {
+ "type": "string",
+ "description": "Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.",
+ "annotations": {
+ "required": [
+ "consumersurveys.surveys.insert"
+ ]
+ }
+ },
+ "unitOfMeasurementLabel": {
+ "type": "string",
+ "description": "Optional unit of measurement for display (for example: hours, people, miles)."
+ },
+ "videoId": {
+ "type": "string",
+ "description": "The YouTube video ID to be show in video questions."
+ }
+ }
+ },
+ "SurveyQuestionImage": {
+ "id": "SurveyQuestionImage",
+ "type": "object",
+ "description": "Container object for image data and alt_text.",
+ "properties": {
+ "altText": {
+ "type": "string",
+ "description": "The alt text property used in image tags is required for all images."
+ },
+ "data": {
+ "type": "string",
+ "description": "Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.",
+ "format": "byte"
+ },
+ "url": {
+ "type": "string",
+ "description": "The read-only URL for the hosted images."
+ }
+ }
+ },
+ "SurveyResults": {
+ "id": "SurveyResults",
+ "type": "object",
+ "description": "Reference to the current results for a given survey.",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Human readable string describing the status of the request."
+ },
+ "surveyUrlId": {
+ "type": "string",
+ "description": "External survey ID as viewable by survey owners in the editor view."
+ }
+ }
+ },
+ "SurveysListResponse": {
+ "id": "SurveysListResponse",
+ "type": "object",
+ "properties": {
+ "pageInfo": {
+ "$ref": "PageInfo"
+ },
+ "requestId": {
+ "type": "string",
+ "description": "Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests."
+ },
+ "resources": {
+ "type": "array",
+ "description": "An individual survey resource.",
+ "items": {
+ "$ref": "Survey"
+ }
+ },
+ "tokenPagination": {
+ "$ref": "TokenPagination"
+ }
+ }
+ },
+ "SurveysStartResponse": {
+ "id": "SurveysStartResponse",
+ "type": "object",
+ "properties": {
+ "requestId": {
+ "type": "string",
+ "description": "Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests."
+ },
+ "resource": {
+ "$ref": "Survey",
+ "description": "Survey object containing the specification of the started Survey."
+ }
+ }
+ },
+ "SurveysStopResponse": {
+ "id": "SurveysStopResponse",
+ "type": "object",
+ "properties": {
+ "requestId": {
+ "type": "string",
+ "description": "Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests."
+ },
+ "resource": {
+ "$ref": "Survey",
+ "description": "Survey object containing the specification of the stopped Survey."
+ }
+ }
+ },
+ "TokenPagination": {
+ "id": "TokenPagination",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string"
+ },
+ "previousPageToken": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "resources": {
+ "results": {
+ "methods": {
+ "get": {
+ "id": "consumersurveys.results.get",
+ "path": "surveys/{surveyUrlId}/results",
+ "httpMethod": "GET",
+ "description": "Retrieves any survey results that have been produced so far. Results are formatted as an Excel file.",
+ "parameters": {
+ "surveyUrlId": {
+ "type": "string",
+ "description": "External URL ID for the survey.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "surveyUrlId"
+ ],
+ "request": {
+ "$ref": "ResultsGetRequest"
+ },
+ "response": {
+ "$ref": "SurveyResults"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/consumersurveys",
+ "https://www.googleapis.com/auth/consumersurveys.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "supportsMediaDownload": true
+ }
+ }
+ },
+ "surveys": {
+ "methods": {
+ "get": {
+ "id": "consumersurveys.surveys.get",
+ "path": "surveys/{surveyUrlId}",
+ "httpMethod": "GET",
+ "description": "Retrieves information about the specified survey.",
+ "parameters": {
+ "surveyUrlId": {
+ "type": "string",
+ "description": "External URL ID for the survey.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "surveyUrlId"
+ ],
+ "response": {
+ "$ref": "Survey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/consumersurveys",
+ "https://www.googleapis.com/auth/consumersurveys.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ]
+ },
+ "insert": {
+ "id": "consumersurveys.surveys.insert",
+ "path": "surveys",
+ "httpMethod": "POST",
+ "description": "Creates a survey.",
+ "request": {
+ "$ref": "Survey"
+ },
+ "response": {
+ "$ref": "Survey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/consumersurveys",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ]
+ },
+ "list": {
+ "id": "consumersurveys.surveys.list",
+ "path": "surveys",
+ "httpMethod": "GET",
+ "description": "Lists the surveys owned by the authenticated user.",
+ "parameters": {
+ "maxResults": {
+ "type": "integer",
+ "format": "uint32",
+ "location": "query"
+ },
+ "startIndex": {
+ "type": "integer",
+ "format": "uint32",
+ "location": "query"
+ },
+ "token": {
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "SurveysListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/consumersurveys",
+ "https://www.googleapis.com/auth/consumersurveys.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ]
+ },
+ "start": {
+ "id": "consumersurveys.surveys.start",
+ "path": "surveys/{resourceId}/start",
+ "httpMethod": "POST",
+ "description": "Begins running a survey.",
+ "parameters": {
+ "resourceId": {
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "resourceId"
+ ],
+ "response": {
+ "$ref": "SurveysStartResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/consumersurveys",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ]
+ },
+ "stop": {
+ "id": "consumersurveys.surveys.stop",
+ "path": "surveys/{resourceId}/stop",
+ "httpMethod": "POST",
+ "description": "Stops a running survey.",
+ "parameters": {
+ "resourceId": {
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "resourceId"
+ ],
+ "response": {
+ "$ref": "SurveysStopResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/consumersurveys",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ]
+ },
+ "update": {
+ "id": "consumersurveys.surveys.update",
+ "path": "surveys/{surveyUrlId}",
+ "httpMethod": "PUT",
+ "description": "Updates a survey. Currently the only property that can be updated is the owners property.",
+ "parameters": {
+ "surveyUrlId": {
+ "type": "string",
+ "description": "External URL ID for the survey.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "surveyUrlId"
+ ],
+ "request": {
+ "$ref": "Survey"
+ },
+ "response": {
+ "$ref": "Survey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/consumersurveys",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/etc/api/container/v1/container-api.json b/etc/api/container/v1/container-api.json
index 5cbdf13f8f..95dcdfeb5c 100644
--- a/etc/api/container/v1/container-api.json
+++ b/etc/api/container/v1/container-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/-5Ir9-bAl4HnPM8XDQ5ycW_gSZQ\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/OU95LyfeHZcrBJDajlkYXi0P4Wo\"",
"discoveryVersion": "v1",
"id": "container:v1",
"name": "container",
"version": "v1",
- "revision": "20150603",
+ "revision": "20160321",
"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.",
+ "description": "Builds and manages clusters that run container-based applications, powered by open source Kubernetes technology.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -121,6 +121,13 @@
"items": {
"$ref": "Cluster"
}
+ },
+ "missingZones": {
+ "type": "array",
+ "description": "If any zones are listed here, the list of clusters returned may be missing those zones.",
+ "items": {
+ "type": "string"
+ }
}
}
},
@@ -139,33 +146,41 @@
},
"initialNodeCount": {
"type": "integer",
- "description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](/compute/docs/resource-quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.",
+ "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. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time.",
"format": "int32"
},
"nodeConfig": {
"$ref": "NodeConfig",
- "description": "Parameters used in creating the cluster's nodes. See the descriptions of the child properties of `nodeConfig`. If unspecified, the defaults for all child properties are used."
+ "description": "Parameters used in creating the cluster's nodes. See `nodeConfig` for the description of its properties. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. If unspecified, the defaults are used."
},
"masterAuth": {
"$ref": "MasterAuth",
- "description": "The authentication information for accessing the master."
+ "description": "The authentication information for accessing the master endpoint."
},
"loggingService": {
"type": "string",
- "description": "The logging service that the cluster should write logs to. Currently available options: * \"logging.googleapis.com\" - the Google Cloud Logging service * \"none\" - no logs will be exported from the cluster * \"\" - default value; the default is \"logging.googleapis.com\""
+ "description": "The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used."
},
"monitoringService": {
"type": "string",
- "description": "The monitoring service that the cluster should write metrics to. Currently available options: * \"monitoring.googleapis.com\" - the Google Cloud Monitoring service * \"none\" - no metrics will be exported from the cluster * \"\" - default value; the default is \"monitoring.googleapis.com\""
+ "description": "The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used."
},
"network": {
"type": "string",
- "description": "The name of the Google Compute Engine [network](/compute/docs/networking#networks_1) to which the cluster is connected. If left unspecified, the \"default\" network will be used."
+ "description": "The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used."
},
"clusterIpv4Cidr": {
"type": "string",
"description": "The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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`."
},
+ "addonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
+ },
+ "subnetwork": {
+ "type": "string",
+ "description": "The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected."
+ },
"selfLink": {
"type": "string",
"description": "[Output only] Server-defined URL for the resource."
@@ -176,11 +191,11 @@
},
"endpoint": {
"type": "string",
- "description": "[Output only] The IP address of this cluster's Kubernetes master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information."
+ "description": "[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information."
},
"initialClusterVersion": {
"type": "string",
- "description": "[Output only] The software version of Kubernetes master and kubelets used in the cluster when it was first created. The version can be upgraded over time."
+ "description": "[Output only] The software version of the master endpoint and kubelets used in the cluster when it was first created. The version can be upgraded over time."
},
"currentMasterVersion": {
"type": "string",
@@ -188,7 +203,7 @@
},
"currentNodeVersion": {
"type": "string",
- "description": "[Output only] The current version of the node software components. If they are currently at different versions because they're in the process of being upgraded, this reflects the minimum version of any of them."
+ "description": "[Output only] The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes."
},
"createTime": {
"type": "string",
@@ -212,12 +227,12 @@
},
"nodeIpv4CidrSize": {
"type": "integer",
- "description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range.",
+ "description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.",
"format": "int32"
},
"servicesIpv4Cidr": {
"type": "string",
- "description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last /16 from the container CIDR."
+ "description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR."
},
"instanceGroupUrls": {
"type": "array",
@@ -225,13 +240,18 @@
"items": {
"type": "string"
}
+ },
+ "currentNodeCount": {
+ "type": "integer",
+ "description": "[Output only] The number of nodes currently in the cluster.",
+ "format": "int32"
}
}
},
"NodeConfig": {
"id": "NodeConfig",
"type": "object",
- "description": "Per-node parameters.",
+ "description": "Parameters that describe the nodes in a cluster.",
"properties": {
"machineType": {
"type": "string",
@@ -244,10 +264,17 @@
},
"oauthScopes": {
"type": "array",
- "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with *gcr.io*. If unspecified, no scopes are added.",
+ "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.",
"items": {
"type": "string"
}
+ },
+ "metadata": {
+ "type": "object",
+ "description": "The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the four reserved keys: \"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.",
+ "additionalProperties": {
+ "type": "string"
+ }
}
}
},
@@ -258,23 +285,60 @@
"properties": {
"username": {
"type": "string",
- "description": "The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint."
+ "description": "The username to use for HTTP basic authentication to the master endpoint."
},
"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."
+ "description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password."
},
"clusterCaCertificate": {
"type": "string",
- "description": "[Output only] Base64 encoded public certificate that is the root of trust for the cluster."
+ "description": "[Output only] Base64-encoded public certificate that is the root of trust for the cluster."
},
"clientCertificate": {
"type": "string",
- "description": "[Output only] Base64 encoded public certificate used by clients to authenticate to the cluster endpoint."
+ "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."
+ "description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint."
+ }
+ }
+ },
+ "AddonsConfig": {
+ "id": "AddonsConfig",
+ "type": "object",
+ "description": "Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.",
+ "properties": {
+ "httpLoadBalancing": {
+ "$ref": "HttpLoadBalancing",
+ "description": "Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster."
+ },
+ "horizontalPodAutoscaling": {
+ "$ref": "HorizontalPodAutoscaling",
+ "description": "Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods."
+ }
+ }
+ },
+ "HttpLoadBalancing": {
+ "id": "HttpLoadBalancing",
+ "type": "object",
+ "description": "Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.",
+ "properties": {
+ "disabled": {
+ "type": "boolean",
+ "description": "Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers."
+ }
+ }
+ },
+ "HorizontalPodAutoscaling": {
+ "id": "HorizontalPodAutoscaling",
+ "type": "object",
+ "description": "Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.",
+ "properties": {
+ "disabled": {
+ "type": "boolean",
+ "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service."
}
}
},
@@ -292,7 +356,7 @@
"Operation": {
"id": "Operation",
"type": "object",
- "description": "Defines the operation resource. All fields are output only.",
+ "description": "This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.",
"properties": {
"name": {
"type": "string",
@@ -311,7 +375,10 @@
"DELETE_CLUSTER",
"UPGRADE_MASTER",
"UPGRADE_NODES",
- "REPAIR_CLUSTER"
+ "REPAIR_CLUSTER",
+ "UPDATE_CLUSTER",
+ "CREATE_NODE_POOL",
+ "DELETE_NODE_POOL"
]
},
"status": {
@@ -324,6 +391,10 @@
"DONE"
]
},
+ "detail": {
+ "type": "string",
+ "description": "Detailed operation progress, if available."
+ },
"statusMessage": {
"type": "string",
"description": "If an error has occurred, a textual description of the error."
@@ -341,7 +412,7 @@
"UpdateClusterRequest": {
"id": "UpdateClusterRequest",
"type": "object",
- "description": "UpdateClusterRequest updates a cluster.",
+ "description": "UpdateClusterRequest updates the settings of a cluster.",
"properties": {
"update": {
"$ref": "ClusterUpdate",
@@ -352,11 +423,23 @@
"ClusterUpdate": {
"id": "ClusterUpdate",
"type": "object",
- "description": "ClusterUpdate describes an update to the cluster.",
+ "description": "ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.",
"properties": {
"desiredNodeVersion": {
"type": "string",
- "description": "The Kubernetes version to change the nodes to (typically an upgrade). Use \"-\" to upgrade to the latest version supported by the server."
+ "description": "The Kubernetes version to change the nodes to (typically an upgrade). Use `-` to upgrade to the latest version supported by the server."
+ },
+ "desiredMonitoringService": {
+ "type": "string",
+ "description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com\" - the Google Cloud Monitoring service * \"none\" - no metrics will be exported from the cluster"
+ },
+ "desiredAddonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
+ },
+ "desiredMasterVersion": {
+ "type": "string",
+ "description": "The Kubernetes version to change the master to. The only valid value is the latest supported version. Use \"-\" to have the server automatically select the latest version."
}
}
},
@@ -371,17 +454,24 @@
"items": {
"$ref": "Operation"
}
+ },
+ "missingZones": {
+ "type": "array",
+ "description": "If any zones are listed here, the list of operations returned may be missing the operations from those zones.",
+ "items": {
+ "type": "string"
+ }
}
}
},
"ServerConfig": {
"id": "ServerConfig",
"type": "object",
- "description": "Container Engine Server configuration.",
+ "description": "Container Engine service configuration.",
"properties": {
"defaultClusterVersion": {
"type": "string",
- "description": "What version this server deploys by default."
+ "description": "Version of Kubernetes the service deploys by default."
},
"validNodeVersions": {
"type": "array",
@@ -406,13 +496,13 @@
"parameters": {
"projectId": {
"type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"required": true,
"location": "path"
},
"zone": {
"type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or \"-\" for all zones.",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for.",
"required": true,
"location": "path"
}
@@ -440,7 +530,7 @@
"parameters": {
"projectId": {
"type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"required": true,
"location": "path"
},
@@ -466,11 +556,11 @@
"id": "container.projects.zones.clusters.get",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"httpMethod": "GET",
- "description": "Gets a specific cluster.",
+ "description": "Gets the details of a specific cluster.",
"parameters": {
"projectId": {
"type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"required": true,
"location": "path"
},
@@ -503,11 +593,11 @@
"id": "container.projects.zones.clusters.create",
"path": "v1/projects/{projectId}/zones/{zone}/clusters",
"httpMethod": "POST",
- "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master endpoint. By default, the cluster is created in the project's [default network](/compute/docs/networking#networks_1). One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.",
+ "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, 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](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"required": true,
"location": "path"
},
@@ -536,11 +626,11 @@
"id": "container.projects.zones.clusters.update",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"httpMethod": "PUT",
- "description": "Update settings of a specific cluster.",
+ "description": "Updates the settings of a specific cluster.",
"parameters": {
"projectId": {
"type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"required": true,
"location": "path"
},
@@ -576,11 +666,11 @@
"id": "container.projects.zones.clusters.delete",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"httpMethod": "DELETE",
- "description": "Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted.",
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.",
"parameters": {
"projectId": {
"type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"required": true,
"location": "path"
},
@@ -621,13 +711,13 @@
"parameters": {
"projectId": {
"type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"required": true,
"location": "path"
},
"zone": {
"type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or \"-\" for all zones.",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones.",
"required": true,
"location": "path"
}
@@ -651,7 +741,7 @@
"parameters": {
"projectId": {
"type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"required": true,
"location": "path"
},
diff --git a/etc/api/content/v2/content-api.json b/etc/api/content/v2/content-api.json
index 201cf8ece9..7dee0cbc70 100644
--- a/etc/api/content/v2/content-api.json
+++ b/etc/api/content/v2/content-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/1_ZSJu77tRD1CDhwJUBK_00tAPU\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/2jCRejD7TwMcZrBmt-AfB92UN1E\"",
"discoveryVersion": "v1",
"id": "content:v2",
"name": "content",
"canonicalName": "Shopping Content",
"version": "v2",
- "revision": "20160204",
+ "revision": "20160331",
"title": "Content API for Shopping",
- "description": "Manage product items, inventory, and Merchant Center accounts for Google Shopping.",
+ "description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -1234,6 +1234,11 @@
"description": "The hour of the day the feed file should be fetched (0-23).",
"format": "uint32"
},
+ "minuteOfHour": {
+ "type": "integer",
+ "description": "The minute of the hour the feed file should be fetched (0-59). Read-only.",
+ "format": "uint32"
+ },
"password": {
"type": "string",
"description": "An optional password for fetch_url."
diff --git a/etc/api/content/v2sandbox/content-api.json b/etc/api/content/v2sandbox/content-api.json
index b108b8d59f..6684e6b3fd 100644
--- a/etc/api/content/v2sandbox/content-api.json
+++ b/etc/api/content/v2sandbox/content-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/E9Q3WkKQIctkqTCGftuDi6_-ikQ\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Dz8RaMyeGwYEG1L5shQuF50_EkE\"",
"discoveryVersion": "v1",
"id": "content:v2sandbox",
"name": "content",
"canonicalName": "Shopping Content",
"version": "v2sandbox",
- "revision": "20160204",
+ "revision": "20160331",
"title": "Content API for Shopping",
- "description": "Manage product items, inventory, and Merchant Center accounts for Google Shopping.",
+ "description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/dataflow/v1b3/dataflow-api.json b/etc/api/dataflow/v1b3/dataflow-api.json
index df8929f631..84fc35a2ce 100644
--- a/etc/api/dataflow/v1b3/dataflow-api.json
+++ b/etc/api/dataflow/v1b3/dataflow-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/2T7pRfqHiALUVY6zFk7GoMXgWV4\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/-PCQObxeMXLhOncDOKreF3FN9IU\"",
"discoveryVersion": "v1",
"id": "dataflow:v1b3",
"name": "dataflow",
"version": "v1b3",
- "revision": "20160225",
+ "revision": "20160331",
"title": "Google Dataflow API",
- "description": "Google Dataflow API.",
+ "description": "Develops and executes data processing patterns like ETL, batch computation, and continuous computation.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -385,9 +385,18 @@
"type": "string",
"description": "Network to which VMs will be assigned. If empty or unspecified, the service will use the network \"default\"."
},
+ "subnetwork": {
+ "type": "string",
+ "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of the form \"zones/ZONE/subnetworks/SUBNETWORK\"."
+ },
"workerHarnessContainerImage": {
"type": "string",
"description": "Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required."
+ },
+ "numThreadsPerWorker": {
+ "type": "integer",
+ "description": "The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).",
+ "format": "int32"
}
}
},
@@ -1771,6 +1780,11 @@
"type": "integer",
"description": "The size (in bits) of keys that will be assigned to source messages.",
"format": "int32"
+ },
+ "persistentStateVersion": {
+ "type": "integer",
+ "description": "Version number for persistent state.",
+ "format": "int32"
}
}
},
@@ -2397,6 +2411,16 @@
"required": true,
"location": "path"
},
+ "filter": {
+ "type": "string",
+ "description": "The kind of filter to use.",
+ "enum": [
+ "ALL",
+ "TERMINATED",
+ "ACTIVE"
+ ],
+ "location": "query"
+ },
"view": {
"type": "string",
"description": "Level of information requested in response. Default is SUMMARY.",
diff --git a/etc/api/datastore/v1beta1/datastore-api.json b/etc/api/datastore/v1beta1/datastore-api.json
index 3fb2642f07..9692a8f28c 100644
--- a/etc/api/datastore/v1beta1/datastore-api.json
+++ b/etc/api/datastore/v1beta1/datastore-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/F1n0tGKyLEWuABrjDmlIJRood2Q\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/dy6n0rfohZWlTzhdDX3ZUa-EJxE\"",
"discoveryVersion": "v1",
"id": "datastore:v1beta1",
"name": "datastore",
"version": "v1beta1",
- "revision": "20151008",
+ "revision": "20160314",
"title": "Google Cloud Datastore API",
- "description": "API for accessing Google Cloud Datastore.",
+ "description": "Stores and queries data in Google Cloud Datastore.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/datastore/v1beta2/datastore-api.json b/etc/api/datastore/v1beta2/datastore-api.json
index a06d55e1e2..c8b2ef8441 100644
--- a/etc/api/datastore/v1beta2/datastore-api.json
+++ b/etc/api/datastore/v1beta2/datastore-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/KQuWIZOSktBy7VDkAXC6BX3U2II\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/xlRfXybj491s9T9Q90yjlG-attA\"",
"discoveryVersion": "v1",
"id": "datastore:v1beta2",
"name": "datastore",
"version": "v1beta2",
- "revision": "20151008",
+ "revision": "20160314",
"title": "Google Cloud Datastore API",
- "description": "API for accessing Google Cloud Datastore.",
+ "description": "Stores and queries data in Google Cloud Datastore.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/datastore/v1beta3/datastore-api.json b/etc/api/datastore/v1beta3/datastore-api.json
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/etc/api/deploymentmanager/v2/deploymentmanager-api.json b/etc/api/deploymentmanager/v2/deploymentmanager-api.json
index b896379447..ac9e0ad3fd 100644
--- a/etc/api/deploymentmanager/v2/deploymentmanager-api.json
+++ b/etc/api/deploymentmanager/v2/deploymentmanager-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/8TFRfN8VgEkdF-90uBpiqAh_lBs\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/NGZc-wpPOb0oBihA_KbpUbW4F-M\"",
"discoveryVersion": "v1",
"id": "deploymentmanager:v2",
"name": "deploymentmanager",
"canonicalName": "Deployment Manager",
"version": "v2",
- "revision": "20160201",
+ "revision": "20160406",
"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.",
+ "description": "Declares, configures, and deploys complex solutions on Google Cloud Platform.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -139,6 +139,10 @@
"$ref": "Operation",
"description": "[Output Only] The Operation that most recently ran, or is currently running, on this deployment."
},
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Self link for the deployment."
+ },
"target": {
"$ref": "TargetConfiguration",
"description": "[Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates."
@@ -346,7 +350,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",
@@ -444,7 +448,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",
@@ -548,7 +552,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",
@@ -587,7 +591,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",
@@ -636,7 +640,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",
@@ -881,7 +885,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, to filter for instances whose name is not equal to 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.",
+ "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: When 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. Use filtering on nested fields to take advantage of labels to organize and search for 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": {
@@ -1157,7 +1161,7 @@
},
"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 whose name is not equal to 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.",
+ "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: When 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. Use filtering on nested fields to take advantage of labels to organize and search for 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": {
@@ -1242,7 +1246,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, to filter for instances whose name is not equal to 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.",
+ "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: When 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. Use filtering on nested fields to take advantage of labels to organize and search for 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": {
@@ -1341,7 +1345,7 @@
},
"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 whose name is not equal to 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.",
+ "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: When 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. Use filtering on nested fields to take advantage of labels to organize and search for 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": {
@@ -1392,7 +1396,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, to filter for instances whose name is not equal to 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.",
+ "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: When 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. Use filtering on nested fields to take advantage of labels to organize and search for 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": {
diff --git a/etc/api/dfareporting/v1.1/dfareporting-api.json b/etc/api/dfareporting/v1.1/dfareporting-api.json
index fa80ab6114..5f3ee151b3 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/NTg4Aipq2GpzigpSyM5LKh3VxPc\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/IfC_S2agPOHnwdkwfOiNdCZPWyE\"",
"discoveryVersion": "v1",
"id": "dfareporting:v1.1",
"name": "dfareporting",
"version": "v1.1",
- "revision": "20160128",
+ "revision": "20160323",
"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 4f889271ef..2726e26ab0 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/1D6PF7mgkfgc8keSEkZ9h0N001k\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/cclQBQqflh0POPtxHbY50xhVM5I\"",
"discoveryVersion": "v1",
"id": "dfareporting:v1.2",
"name": "dfareporting",
"version": "v1.2",
- "revision": "20160128",
+ "revision": "20160323",
"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 e42a10a185..86b8771054 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/thm1dQ41ieuipIFO1JuNS4--IpY\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/jbpRAx4ZdlKk9UnC-by8qw17RpE\"",
"discoveryVersion": "v1",
"id": "dfareporting:v1.3",
"name": "dfareporting",
"version": "v1.3",
- "revision": "20160128",
+ "revision": "20160323",
"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 1e38645959..b19c56a3e2 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/1CHZrAT_Djr1VGV70ZNF2Qu82mY\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/it-0KmPHaeqryDPdVaJb1yTJHP0\"",
"discoveryVersion": "v1",
"id": "dfareporting:v1",
"name": "dfareporting",
"version": "v1",
- "revision": "20160128",
+ "revision": "20160323",
"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 0777a2e82d..61aae36ec1 100644
--- a/etc/api/dfareporting/v2.0/dfareporting-api.json
+++ b/etc/api/dfareporting/v2.0/dfareporting-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/C6xyLXx3qLxKuqaI4d4FbymlsJc\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Fj2CLE28zbL5UgO7JzpcL_ITvzE\"",
"discoveryVersion": "v1",
"id": "dfareporting:v2.0",
"name": "dfareporting",
"version": "v2.0",
- "revision": "20160128",
+ "revision": "20160323",
"title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
+ "description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -433,9 +433,11 @@
"enum": [
"INTERNAL_ADMINISTRATOR",
"NORMAL_USER",
+ "READ_ONLY_SUPER_USER",
"SUPER_USER"
],
"enumDescriptions": [
+ "",
"",
"",
""
@@ -2769,6 +2771,7 @@
"NOT_SSL_COMPLIANT",
"ORPHANED_ASSET",
"PRIMARY_HTML_MISSING",
+ "SVG_INVALID",
"ZIP_INVALID"
],
"enumDescriptions": [
@@ -2794,6 +2797,7 @@
"",
"",
"",
+ "",
""
]
}
@@ -5402,7 +5406,7 @@
},
"compatibility": {
"type": "string",
- "description": "Placement compatibility. WEB and WEB_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. This field is required on insertion.",
+ "description": "Placement compatibility. WEB and WEB_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. This field is required on insertion.",
"enum": [
"APP",
"APP_INTERSTITIAL",
@@ -13644,7 +13648,7 @@
},
"compatibilities": {
"type": "string",
- "description": "Select only placements that are associated with these compatibilities. WEB and WEB_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.",
+ "description": "Select only placements that are associated with these compatibilities. WEB and WEB_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",
diff --git a/etc/api/dfareporting/v2.1/dfareporting-api.json b/etc/api/dfareporting/v2.1/dfareporting-api.json
index 25b2596116..131dc8dbce 100644
--- a/etc/api/dfareporting/v2.1/dfareporting-api.json
+++ b/etc/api/dfareporting/v2.1/dfareporting-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/zr8FQqQuZPkLoaFvaMhhChb5Bn0\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/c3FXdNU54uoHaWRA6XZxmzoA1vM\"",
"discoveryVersion": "v1",
"id": "dfareporting:v2.1",
"name": "dfareporting",
"version": "v2.1",
- "revision": "20160128",
+ "revision": "20160323",
"title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
+ "description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -433,9 +433,11 @@
"enum": [
"INTERNAL_ADMINISTRATOR",
"NORMAL_USER",
+ "READ_ONLY_SUPER_USER",
"SUPER_USER"
],
"enumDescriptions": [
+ "",
"",
"",
""
@@ -2838,6 +2840,7 @@
"NOT_SSL_COMPLIANT",
"ORPHANED_ASSET",
"PRIMARY_HTML_MISSING",
+ "SVG_INVALID",
"ZIP_INVALID"
],
"enumDescriptions": [
@@ -2863,6 +2866,7 @@
"",
"",
"",
+ "",
""
]
}
@@ -6018,7 +6022,7 @@
},
"compatibility": {
"type": "string",
- "description": "Placement compatibility. WEB and WEB_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. This field is required on insertion.",
+ "description": "Placement compatibility. WEB and WEB_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. This field is required on insertion.",
"enum": [
"APP",
"APP_INTERSTITIAL",
@@ -15358,7 +15362,7 @@
},
"compatibilities": {
"type": "string",
- "description": "Select only placements that are associated with these compatibilities. WEB and WEB_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.",
+ "description": "Select only placements that are associated with these compatibilities. WEB and WEB_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",
diff --git a/etc/api/dfareporting/v2.2/dfareporting-api.json b/etc/api/dfareporting/v2.2/dfareporting-api.json
index 2c678e0159..4b363981ec 100644
--- a/etc/api/dfareporting/v2.2/dfareporting-api.json
+++ b/etc/api/dfareporting/v2.2/dfareporting-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/pe0nuOIqkvSnuqKAY9SdBjfx-IY\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/gVPQK4zBltgLF-WP2KuWChXt6qc\"",
"discoveryVersion": "v1",
"id": "dfareporting:v2.2",
"name": "dfareporting",
"version": "v2.2",
- "revision": "20160128",
+ "revision": "20160323",
"title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
+ "description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -433,9 +433,11 @@
"enum": [
"INTERNAL_ADMINISTRATOR",
"NORMAL_USER",
+ "READ_ONLY_SUPER_USER",
"SUPER_USER"
],
"enumDescriptions": [
+ "",
"",
"",
""
@@ -2850,6 +2852,7 @@
"NOT_SSL_COMPLIANT",
"ORPHANED_ASSET",
"PRIMARY_HTML_MISSING",
+ "SVG_INVALID",
"ZIP_INVALID"
],
"enumDescriptions": [
@@ -2875,6 +2878,7 @@
"",
"",
"",
+ "",
""
]
}
@@ -6053,7 +6057,7 @@
},
"compatibility": {
"type": "string",
- "description": "Placement compatibility. WEB and WEB_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. This field is required on insertion.",
+ "description": "Placement compatibility. WEB and WEB_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. This field is required on insertion.",
"enum": [
"APP",
"APP_INTERSTITIAL",
@@ -15385,7 +15389,7 @@
},
"compatibilities": {
"type": "string",
- "description": "Select only placements that are associated with these compatibilities. WEB and WEB_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.",
+ "description": "Select only placements that are associated with these compatibilities. WEB and WEB_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",
diff --git a/etc/api/dfareporting/v2.3/dfareporting-api.json b/etc/api/dfareporting/v2.3/dfareporting-api.json
index 592e3eb7eb..295733366c 100644
--- a/etc/api/dfareporting/v2.3/dfareporting-api.json
+++ b/etc/api/dfareporting/v2.3/dfareporting-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/D37CYe-AvF4CepcUkE4wi4kuh0A\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/lyO5b9sA89-R9bZya3S2kXUDEmE\"",
"discoveryVersion": "v1",
"id": "dfareporting:v2.3",
"name": "dfareporting",
"version": "v2.3",
- "revision": "20160128",
+ "revision": "20160323",
"title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
+ "description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -433,9 +433,11 @@
"enum": [
"INTERNAL_ADMINISTRATOR",
"NORMAL_USER",
+ "READ_ONLY_SUPER_USER",
"SUPER_USER"
],
"enumDescriptions": [
+ "",
"",
"",
""
@@ -2864,6 +2866,7 @@
"NOT_SSL_COMPLIANT",
"ORPHANED_ASSET",
"PRIMARY_HTML_MISSING",
+ "SVG_INVALID",
"ZIP_INVALID"
],
"enumDescriptions": [
@@ -2889,6 +2892,7 @@
"",
"",
"",
+ "",
""
]
}
@@ -6068,7 +6072,7 @@
},
"compatibility": {
"type": "string",
- "description": "Placement compatibility. WEB and WEB_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. This field is required on insertion.",
+ "description": "Placement compatibility. WEB and WEB_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. This field is required on insertion.",
"enum": [
"APP",
"APP_INTERSTITIAL",
@@ -15375,7 +15379,7 @@
},
"compatibilities": {
"type": "string",
- "description": "Select only placements that are associated with these compatibilities. WEB and WEB_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.",
+ "description": "Select only placements that are associated with these compatibilities. WEB and WEB_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",
diff --git a/etc/api/dfareporting/v2.4/dfareporting-api.json b/etc/api/dfareporting/v2.4/dfareporting-api.json
index de73465ffe..3e3d63e19b 100644
--- a/etc/api/dfareporting/v2.4/dfareporting-api.json
+++ b/etc/api/dfareporting/v2.4/dfareporting-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/5TfNJAYCdpNqfBuYUZWvagnNUsg\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/GMvPIbteso6VJ5xPWVBu0dudXSU\"",
"discoveryVersion": "v1",
"id": "dfareporting:v2.4",
"name": "dfareporting",
"version": "v2.4",
- "revision": "20160128",
+ "revision": "20160323",
"title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
+ "description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -433,9 +433,11 @@
"enum": [
"INTERNAL_ADMINISTRATOR",
"NORMAL_USER",
+ "READ_ONLY_SUPER_USER",
"SUPER_USER"
],
"enumDescriptions": [
+ "",
"",
"",
""
@@ -2864,6 +2866,7 @@
"NOT_SSL_COMPLIANT",
"ORPHANED_ASSET",
"PRIMARY_HTML_MISSING",
+ "SVG_INVALID",
"ZIP_INVALID"
],
"enumDescriptions": [
@@ -2889,6 +2892,7 @@
"",
"",
"",
+ "",
""
]
}
@@ -6080,7 +6084,7 @@
},
"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.",
+ "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",
@@ -15400,7 +15404,7 @@
},
"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.",
+ "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",
diff --git a/etc/api/dfareporting/v2.5beta1/dfareporting-api.json b/etc/api/dfareporting/v2.5beta1/dfareporting-api.json
new file mode 100644
index 0000000000..6753924aa4
--- /dev/null
+++ b/etc/api/dfareporting/v2.5beta1/dfareporting-api.json
@@ -0,0 +1,18248 @@
+{
+ "kind": "discovery#restDescription",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/b0IOUhU53JuSfNae26EQ_3WJUSA\"",
+ "discoveryVersion": "v1",
+ "id": "dfareporting:v2.5beta1",
+ "name": "dfareporting",
+ "version": "v2.5beta1",
+ "revision": "20160323",
+ "title": "DCM/DFA Reporting And Trafficking API",
+ "description": "Manages 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.5beta1/",
+ "basePath": "/dfareporting/v2.5beta1/",
+ "rootUrl": "https://www.googleapis.com/",
+ "servicePath": "dfareporting/v2.5beta1/",
+ "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/ddmconversions": {
+ "description": "Manage DoubleClick Digital Marketing conversions"
+ },
+ "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",
+ "READ_ONLY_SUPER_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."
+ }
+ }
+ },
+ "Conversion": {
+ "id": "Conversion",
+ "type": "object",
+ "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
+ "properties": {
+ "childDirectedTreatment": {
+ "type": "boolean",
+ "description": "Whether the conversion was directed toward children."
+ },
+ "customVariables": {
+ "type": "array",
+ "description": "Custom floodlight variables.",
+ "items": {
+ "$ref": "CustomFloodlightVariable"
+ }
+ },
+ "encryptedUserId": {
+ "type": "string",
+ "description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with mobileDeviceId. This or mobileDeviceId is a required field."
+ },
+ "floodlightActivityId": {
+ "type": "string",
+ "description": "Floodlight Activity ID of this conversion. This is a required field.",
+ "format": "int64"
+ },
+ "floodlightConfigurationId": {
+ "type": "string",
+ "description": "Floodlight Configuration ID of this conversion. This is a required field.",
+ "format": "int64"
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversion\".",
+ "default": "dfareporting#conversion"
+ },
+ "limitAdTracking": {
+ "type": "boolean",
+ "description": "Whether the user has Limit Ad Tracking set."
+ },
+ "mobileDeviceId": {
+ "type": "string",
+ "description": "The mobile device ID. This field is mutually exclusive with encryptedUserId. This or encryptedUserId is a required field."
+ },
+ "ordinal": {
+ "type": "string",
+ "description": "The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field."
+ },
+ "quantity": {
+ "type": "string",
+ "description": "The quantity of the conversion.",
+ "format": "int64"
+ },
+ "timestampMicros": {
+ "type": "string",
+ "description": "The timestamp of conversion, in Unix epoch micros. This is a required field.",
+ "format": "int64"
+ },
+ "value": {
+ "type": "number",
+ "description": "The value of the conversion.",
+ "format": "double"
+ }
+ }
+ },
+ "ConversionError": {
+ "id": "ConversionError",
+ "type": "object",
+ "description": "The error code and description for a conversion that failed to insert.",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "The error code.",
+ "enum": [
+ "INTERNAL",
+ "INVALID_ARGUMENT",
+ "NOT_FOUND",
+ "PERMISSION_DENIED"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionError\".",
+ "default": "dfareporting#conversionError"
+ },
+ "message": {
+ "type": "string",
+ "description": "A description of the error."
+ }
+ }
+ },
+ "ConversionStatus": {
+ "id": "ConversionStatus",
+ "type": "object",
+ "description": "The original conversion that was inserted and whether there were any errors.",
+ "properties": {
+ "conversion": {
+ "$ref": "Conversion",
+ "description": "The original conversion that was inserted."
+ },
+ "errors": {
+ "type": "array",
+ "description": "A list of errors related to this conversion.",
+ "items": {
+ "$ref": "ConversionError"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionStatus\".",
+ "default": "dfareporting#conversionStatus"
+ }
+ }
+ },
+ "ConversionsBatchInsertRequest": {
+ "id": "ConversionsBatchInsertRequest",
+ "type": "object",
+ "description": "Insert Conversions Request.",
+ "properties": {
+ "conversions": {
+ "type": "array",
+ "description": "The set of conversions to insert.",
+ "items": {
+ "$ref": "Conversion"
+ }
+ },
+ "encryptionInfo": {
+ "$ref": "EncryptionInfo",
+ "description": "Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertRequest\".",
+ "default": "dfareporting#conversionsBatchInsertRequest"
+ }
+ }
+ },
+ "ConversionsBatchInsertResponse": {
+ "id": "ConversionsBatchInsertResponse",
+ "type": "object",
+ "description": "Insert Conversions Response.",
+ "properties": {
+ "hasFailures": {
+ "type": "boolean",
+ "description": "Indicates that some or all conversions failed to insert."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversionsBatchInsertResponse\".",
+ "default": "dfareporting#conversionsBatchInsertResponse"
+ },
+ "status": {
+ "type": "array",
+ "description": "The status of each conversion's insertion status. The status is returned in the same order that conversions are inserted.",
+ "items": {
+ "$ref": "ConversionStatus"
+ }
+ }
+ }
+ },
+ "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",
+ "SVG_INVALID",
+ "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"
+ }
+ }
+ }
+ },
+ "CustomFloodlightVariable": {
+ "id": "CustomFloodlightVariable",
+ "type": "object",
+ "description": "A custom floodlight variable.",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#customFloodlightVariable\".",
+ "default": "dfareporting#customFloodlightVariable"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-20]=\" in the tags.",
+ "enum": [
+ "U1",
+ "U10",
+ "U11",
+ "U12",
+ "U13",
+ "U14",
+ "U15",
+ "U16",
+ "U17",
+ "U18",
+ "U19",
+ "U2",
+ "U20",
+ "U3",
+ "U4",
+ "U5",
+ "U6",
+ "U7",
+ "U8",
+ "U9"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the custom floodlight variable. The length of string must not exceed 50 characters."
+ }
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "DynamicTargetingKey": {
+ "id": "DynamicTargetingKey",
+ "type": "object",
+ "description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKey\".",
+ "default": "dfareporting#dynamicTargetingKey"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase."
+ },
+ "objectId": {
+ "type": "string",
+ "description": "ID of the object of this dynamic targeting key. This is a required field.",
+ "format": "int64"
+ },
+ "objectType": {
+ "type": "string",
+ "description": "Type of the object of this dynamic targeting key. This is a required field.",
+ "enum": [
+ "OBJECT_AD",
+ "OBJECT_ADVERTISER",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ },
+ "DynamicTargetingKeysListResponse": {
+ "id": "DynamicTargetingKeysListResponse",
+ "type": "object",
+ "description": "Dynamic Targeting Key List Response",
+ "properties": {
+ "dynamicTargetingKeys": {
+ "type": "array",
+ "description": "Dynamic targeting key collection.",
+ "items": {
+ "$ref": "DynamicTargetingKey"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#dynamicTargetingKeysListResponse\".",
+ "default": "dfareporting#dynamicTargetingKeysListResponse"
+ }
+ }
+ },
+ "EncryptionInfo": {
+ "id": "EncryptionInfo",
+ "type": "object",
+ "description": "A description of how user IDs are encrypted.",
+ "properties": {
+ "encryptionEntityId": {
+ "type": "string",
+ "description": "The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.",
+ "format": "int64"
+ },
+ "encryptionEntityType": {
+ "type": "string",
+ "description": "The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.",
+ "enum": [
+ "ADWORDS_CUSTOMER",
+ "DBM_ADVERTISER",
+ "DBM_PARTNER",
+ "DCM_ACCOUNT",
+ "DCM_ADVERTISER",
+ "ENCRYPTION_ENTITY_TYPE_UNKNOWN"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "encryptionSource": {
+ "type": "string",
+ "description": "Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.",
+ "enum": [
+ "AD_SERVING",
+ "DATA_TRANSFER",
+ "ENCRYPTION_SCOPE_UNKNOWN"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#encryptionInfo\".",
+ "default": "dfareporting#encryptionInfo"
+ }
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ },
+ "conversions": {
+ "methods": {
+ "batchinsert": {
+ "id": "dfareporting.conversions.batchinsert",
+ "path": "userprofiles/{profileId}/conversions/batchinsert",
+ "httpMethod": "POST",
+ "description": "Inserts conversions.",
+ "parameters": {
+ "profileId": {
+ "type": "string",
+ "description": "User profile ID associated with this request.",
+ "required": true,
+ "format": "int64",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "profileId"
+ ],
+ "request": {
+ "$ref": "ConversionsBatchInsertRequest"
+ },
+ "response": {
+ "$ref": "ConversionsBatchInsertResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ddmconversions"
+ ]
+ }
+ }
+ },
+ "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.5beta1/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
+ },
+ "resumable": {
+ "multipart": true,
+ "path": "/resumable/upload/dfareporting/v2.5beta1/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"
+ ]
+ }
+ }
+ },
+ "dynamicTargetingKeys": {
+ "methods": {
+ "delete": {
+ "id": "dfareporting.dynamicTargetingKeys.delete",
+ "path": "userprofiles/{profileId}/dynamicTargetingKeys/{objectId}",
+ "httpMethod": "DELETE",
+ "description": "Deletes an existing dynamic targeting key.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.",
+ "required": true,
+ "location": "query"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "ID of the object of this dynamic targeting key. This is a required field.",
+ "required": true,
+ "format": "int64",
+ "location": "path"
+ },
+ "objectType": {
+ "type": "string",
+ "description": "Type of the object of this dynamic targeting key. This is a required field.",
+ "required": true,
+ "enum": [
+ "OBJECT_AD",
+ "OBJECT_ADVERTISER",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query"
+ },
+ "profileId": {
+ "type": "string",
+ "description": "User profile ID associated with this request.",
+ "required": true,
+ "format": "int64",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "profileId",
+ "objectId",
+ "name",
+ "objectType"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "insert": {
+ "id": "dfareporting.dynamicTargetingKeys.insert",
+ "path": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "httpMethod": "POST",
+ "description": "Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative or placement.",
+ "parameters": {
+ "profileId": {
+ "type": "string",
+ "description": "User profile ID associated with this request.",
+ "required": true,
+ "format": "int64",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "profileId"
+ ],
+ "request": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "response": {
+ "$ref": "DynamicTargetingKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/dfatrafficking"
+ ]
+ },
+ "list": {
+ "id": "dfareporting.dynamicTargetingKeys.list",
+ "path": "userprofiles/{profileId}/dynamicTargetingKeys",
+ "httpMethod": "GET",
+ "description": "Retrieves a list of dynamic targeting keys.",
+ "parameters": {
+ "advertiserId": {
+ "type": "string",
+ "description": "Select only dynamic targeting keys whose object has this advertiser ID.",
+ "format": "int64",
+ "location": "query"
+ },
+ "names": {
+ "type": "string",
+ "description": "Select only dynamic targeting keys exactly matching these names.",
+ "repeated": true,
+ "location": "query"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "Select only dynamic targeting keys with this object ID.",
+ "format": "int64",
+ "location": "query"
+ },
+ "objectType": {
+ "type": "string",
+ "description": "Select only dynamic targeting keys with this object type.",
+ "enum": [
+ "OBJECT_AD",
+ "OBJECT_ADVERTISER",
+ "OBJECT_CREATIVE",
+ "OBJECT_PLACEMENT"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query"
+ },
+ "profileId": {
+ "type": "string",
+ "description": "User profile ID associated with this request.",
+ "required": true,
+ "format": "int64",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "profileId"
+ ],
+ "response": {
+ "$ref": "DynamicTargetingKeysListResponse"
+ },
+ "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/dns/v1/dns-api.json b/etc/api/dns/v1/dns-api.json
index 6c0a65b5cd..d66f09aad5 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/YvTvEjSR_sXxd8XvUihYx8e9Xjo\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/HxGEJa_pLOiBZuN-UORZOmZuoc4\"",
"discoveryVersion": "v1",
"id": "dns:v1",
"name": "dns",
"version": "v1",
- "revision": "20160209",
+ "revision": "20160224",
"title": "Google Cloud DNS API",
"description": "The Google Cloud DNS API provides services for configuring and serving authoritative DNS records.",
"ownerDomain": "google.com",
diff --git a/etc/api/doubleclicksearch/v2/doubleclicksearch-api.json b/etc/api/doubleclicksearch/v2/doubleclicksearch-api.json
index bc0ef57df7..b168848ea1 100644
--- a/etc/api/doubleclicksearch/v2/doubleclicksearch-api.json
+++ b/etc/api/doubleclicksearch/v2/doubleclicksearch-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/GZARS-KMkd3MBeJCdPYZ0gyz7c8\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/mQph4Sf_SMRIA7kCek-g2XOXzv4\"",
"discoveryVersion": "v1",
"id": "doubleclicksearch:v2",
"name": "doubleclicksearch",
"version": "v2",
- "revision": "20160217",
+ "revision": "20160401",
"title": "DoubleClick Search API",
- "description": "Report and modify your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions).",
+ "description": "Reports and modifies your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions).",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -158,7 +158,7 @@
},
"attributionModel": {
"type": "string",
- "description": "This field is ignored."
+ "description": "Available to advertisers only after contacting DoubleClick Search customer support."
},
"campaignId": {
"type": "string",
@@ -199,7 +199,7 @@
},
"countMillis": {
"type": "string",
- "description": "This field is ignored.",
+ "description": "Available to advertisers only after contacting DoubleClick Search customer support.",
"format": "int64"
},
"criterionId": {
@@ -272,7 +272,7 @@
},
"revenueMicros": {
"type": "string",
- "description": "The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000, no decimal). For example, to specify a revenue value of \"10\" enter \"10000\" in your request.",
+ "description": "The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of \"10\" enter \"10000000\" (10 million) in your request.",
"format": "int64"
},
"segmentationId": {
diff --git a/etc/api/drive/v1/drive-api.json b/etc/api/drive/v1/drive-api.json
index 012b0c017e..b6cbf2c461 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/pIjmOx9uYYuW6v2cybFTI7k6ZlE\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7yEwOWXZlI3h8UTsoWMLEQ0OZQg\"",
"discoveryVersion": "v1",
"id": "drive:v1",
"name": "drive",
"version": "v1",
- "revision": "20160222",
+ "revision": "20160331",
"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 31c8ee3ad5..eeadb04d6b 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/y9-bbu1ga5xB61EmZ3HwBhgL63I\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/GTDpaocQE9NwB0Qlbrx8nJ-e_1c\"",
"discoveryVersion": "v1",
"id": "drive:v2",
"name": "drive",
"version": "v2",
- "revision": "20160222",
+ "revision": "20160331",
"title": "Drive API",
"description": "The API to interact with Drive.",
"ownerDomain": "google.com",
@@ -1102,6 +1102,10 @@
}
}
},
+ "isAppAuthorized": {
+ "type": "boolean",
+ "description": "Whether the file was created or opened by the requesting app."
+ },
"kind": {
"type": "string",
"description": "The type of file. This is always drive#file.",
@@ -1178,7 +1182,7 @@
},
"originalFilename": {
"type": "string",
- "description": "The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files."
+ "description": "The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive."
},
"ownedByMe": {
"type": "boolean",
@@ -2640,7 +2644,6 @@
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.appdata",
- "https://www.googleapis.com/auth/drive.apps.readonly",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/drive.metadata",
"https://www.googleapis.com/auth/drive.metadata.readonly",
@@ -3207,7 +3210,6 @@
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.appdata",
- "https://www.googleapis.com/auth/drive.apps.readonly",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/drive.metadata",
"https://www.googleapis.com/auth/drive.metadata.readonly",
diff --git a/etc/api/drive/v3/drive-api.json b/etc/api/drive/v3/drive-api.json
index baab42994d..4698e825b8 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/XHyDUGr4ipCpaFgErXSlgQ1HJ1I\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Pn6xzhnOx8ChFefbzfRCBOEBh_o\"",
"discoveryVersion": "v1",
"id": "drive:v3",
"name": "drive",
"version": "v3",
- "revision": "20160222",
+ "revision": "20160331",
"title": "Drive API",
"description": "The API to interact with Drive.",
"ownerDomain": "google.com",
@@ -609,6 +609,10 @@
}
}
},
+ "isAppAuthorized": {
+ "type": "boolean",
+ "description": "Whether the file was created or opened by the requesting app."
+ },
"kind": {
"type": "string",
"description": "This is always drive#file.",
diff --git a/etc/api/fusiontables/v1/fusiontables-api.json b/etc/api/fusiontables/v1/fusiontables-api.json
index f99f234e0b..348875227c 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/DRDKnNm8-98MUMNMap5uImOcQHM\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/H8bndsg5ucjq1laaWhA4cXUz4Bk\"",
"discoveryVersion": "v1",
"id": "fusiontables:v1",
"name": "fusiontables",
"version": "v1",
- "revision": "20160212",
+ "revision": "20160317",
"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 79594b69d7..29a428e1f7 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/HLmnkQW8dS44Z1Tis905tAoePQ8\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7I476Fm3E4XG346rD0zIQBKmwxU\"",
"discoveryVersion": "v1",
"id": "fusiontables:v2",
"name": "fusiontables",
"version": "v2",
- "revision": "20160212",
+ "revision": "20160317",
"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 e4b09bf466..c91a7674ba 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/Fl2JtinGhCfVFBoiE_KkQ61uWHk\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/0me1AhhPSi-_0UNmNlsuGvzH204\"",
"discoveryVersion": "v1",
"id": "games:v1",
"name": "games",
"canonicalName": "Games",
"version": "v1",
- "revision": "20160224",
+ "revision": "20160401",
"title": "Google Play Game Services API",
"description": "The API for Google Play Game Services.",
"ownerDomain": "google.com",
@@ -185,7 +185,7 @@
},
"newlyUnlocked": {
"type": "boolean",
- "description": "Whether the the current steps for the achievement has reached the number of steps required to unlock."
+ "description": "Whether the current steps for the achievement has reached the number of steps required to unlock."
}
}
},
@@ -490,6 +490,10 @@
"type": "object",
"description": "This is a JSON template for a third party application verification response resource.",
"properties": {
+ "alternate_player_id": {
+ "type": "string",
+ "description": "An alternate ID that was once used for the player that was issued the auth token used in this request. (This field is not normally populated.)"
+ },
"kind": {
"type": "string",
"description": "Uniquely identifies the type of this resource. Value is always the fixed string games#applicationVerifyResponse.",
diff --git a/etc/api/gamesconfiguration/v1configuration/gamesconfiguration-api.json b/etc/api/gamesconfiguration/v1configuration/gamesconfiguration-api.json
index d4957fd43d..8617cd1f60 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/ydL88tNpjuxfU-H47Pet3qzcs1I\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/YdxAcvQY54JlurABUnhriMtrFkQ\"",
"discoveryVersion": "v1",
"id": "gamesConfiguration:v1configuration",
"name": "gamesConfiguration",
"canonicalName": "Games Configuration",
"version": "v1configuration",
- "revision": "20160224",
+ "revision": "20160401",
"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 a1b6ef8906..90af1f61b0 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/zyg1d1q0ZiPsgtBlXjvRMcBLPek\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/D0PegRXiPBwAiHpiH57qWyW0T8A\"",
"discoveryVersion": "v1",
"id": "gamesManagement:v1management",
"name": "gamesManagement",
"canonicalName": "Games Management",
"version": "v1management",
- "revision": "20160224",
+ "revision": "20160401",
"title": "Google Play Game Services Management API",
"description": "The Management API for Google Play Game Services.",
"ownerDomain": "google.com",
diff --git a/etc/api/genomics/v1/genomics-api.json b/etc/api/genomics/v1/genomics-api.json
index 2b26a524b5..127deac0f2 100644
--- a/etc/api/genomics/v1/genomics-api.json
+++ b/etc/api/genomics/v1/genomics-api.json
@@ -1,20 +1,20 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/hALYXo8ybL-2tjJliTY4Rr-Kr5Y\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/nyUO2UOkslUqZUL17-85iW0oVO0\"",
"discoveryVersion": "v1",
"id": "genomics:v1",
"name": "genomics",
"version": "v1",
- "revision": "20160224",
+ "revision": "20160407",
"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.",
+ "description": "Stores, processes, explores and shares genomic data. This API implements the Global Alliance for Genomics and Health (GA4GH) v0.5.1 API as well as several extensions.",
"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": "",
+ "documentationLink": "https://cloud.google.com/genomics/",
"protocol": "rest",
"baseUrl": "https://genomics.googleapis.com/",
"basePath": "",
@@ -122,6 +122,499 @@
}
},
"schemas": {
+ "AnnotationSet": {
+ "id": "AnnotationSet",
+ "type": "object",
+ "description": "An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The server-generated annotation set ID, unique across all annotation sets."
+ },
+ "datasetId": {
+ "type": "string",
+ "description": "The dataset to which this annotation set belongs."
+ },
+ "referenceSetId": {
+ "type": "string",
+ "description": "The ID of the reference set that defines the coordinate space for this set's annotations."
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for this annotation set."
+ },
+ "sourceUri": {
+ "type": "string",
+ "description": "The source URI describing the file from which this annotation set was generated, if any."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of annotations contained within this set.",
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ]
+ },
+ "info": {
+ "type": "object",
+ "description": "A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ }
+ }
+ },
+ "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 `{}`."
+ },
+ "SearchAnnotationSetsRequest": {
+ "id": "SearchAnnotationSetsRequest",
+ "type": "object",
+ "properties": {
+ "datasetIds": {
+ "type": "array",
+ "description": "Required. The dataset IDs to search within. Caller must have `READ` access to these datasets.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "referenceSetId": {
+ "type": "string",
+ "description": "If specified, only annotation sets associated with the given reference set are returned."
+ },
+ "name": {
+ "type": "string",
+ "description": "Only return annotations sets for which a substring of the name matches this string (case insensitive)."
+ },
+ "types": {
+ "type": "array",
+ "description": "If specified, only annotation sets that have any of these types are returned.",
+ "enumDescriptions": [
+ "",
+ "A `GENERIC` annotation type should be used when no other annotation type will suffice. This represents an untyped annotation of the reference genome.",
+ "A `VARIANT` annotation type.",
+ "A `GENE` annotation type represents the existence of a gene at the associated reference coordinates. The start coordinate is typically the gene's transcription start site and the end is typically the end of the gene's last exon.",
+ "A `TRANSCRIPT` annotation type represents the assertion that a particular region of the reference genome may be transcribed as RNA."
+ ],
+ "items": {
+ "type": "string",
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ]
+ }
+ },
+ "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."
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 1024.",
+ "format": "int32"
+ }
+ }
+ },
+ "SearchAnnotationSetsResponse": {
+ "id": "SearchAnnotationSetsResponse",
+ "type": "object",
+ "properties": {
+ "annotationSets": {
+ "type": "array",
+ "description": "The matching annotation sets.",
+ "items": {
+ "$ref": "AnnotationSet"
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "Annotation": {
+ "id": "Annotation",
+ "type": "object",
+ "description": "An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The server-generated annotation ID, unique across all annotations."
+ },
+ "annotationSetId": {
+ "type": "string",
+ "description": "The annotation set to which this annotation belongs."
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name of this annotation."
+ },
+ "referenceId": {
+ "type": "string",
+ "description": "The ID of the Google Genomics reference associated with this range."
+ },
+ "referenceName": {
+ "type": "string",
+ "description": "The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`."
+ },
+ "start": {
+ "type": "string",
+ "description": "The start position of the range on the reference, 0-based inclusive.",
+ "format": "int64"
+ },
+ "end": {
+ "type": "string",
+ "description": "The end position of the range on the reference, 0-based exclusive.",
+ "format": "int64"
+ },
+ "reverseStrand": {
+ "type": "boolean",
+ "description": "Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand."
+ },
+ "type": {
+ "type": "string",
+ "description": "The data type for this annotation. Must match the containing annotation set's type.",
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ]
+ },
+ "variant": {
+ "$ref": "VariantAnnotation",
+ "description": "A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`."
+ },
+ "transcript": {
+ "$ref": "Transcript",
+ "description": "A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`."
+ },
+ "info": {
+ "type": "object",
+ "description": "A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ }
+ }
+ },
+ "VariantAnnotation": {
+ "id": "VariantAnnotation",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type has been adapted from ClinVar's list of variant types.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_OTHER",
+ "INSERTION",
+ "DELETION",
+ "SUBSTITUTION",
+ "SNP",
+ "STRUCTURAL",
+ "CNV"
+ ]
+ },
+ "effect": {
+ "type": "string",
+ "description": "Effect of the variant on the coding sequence.",
+ "enum": [
+ "EFFECT_UNSPECIFIED",
+ "EFFECT_OTHER",
+ "FRAMESHIFT",
+ "FRAME_PRESERVING_INDEL",
+ "SYNONYMOUS_SNP",
+ "NONSYNONYMOUS_SNP",
+ "STOP_GAIN",
+ "STOP_LOSS",
+ "SPLICE_SITE_DISRUPTION"
+ ]
+ },
+ "alternateBases": {
+ "type": "string",
+ "description": "The alternate allele for this variant. If multiple alternate alleles exist at this location, create a separate variant for each one, as they may represent distinct conditions."
+ },
+ "geneId": {
+ "type": "string",
+ "description": "Google annotation ID of the gene affected by this variant. This should be provided when the variant is created."
+ },
+ "transcriptIds": {
+ "type": "array",
+ "description": "Google annotation IDs of the transcripts affected by this variant. These should be provided when the variant is created.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "conditions": {
+ "type": "array",
+ "description": "The set of conditions associated with this variant. A condition describes the way a variant influences human health.",
+ "items": {
+ "$ref": "ClinicalCondition"
+ }
+ },
+ "clinicalSignificance": {
+ "type": "string",
+ "description": "Describes the clinical significance of a variant. It is adapted from the ClinVar controlled vocabulary for clinical significance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/",
+ "enum": [
+ "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
+ "CLINICAL_SIGNIFICANCE_OTHER",
+ "UNCERTAIN",
+ "BENIGN",
+ "LIKELY_BENIGN",
+ "LIKELY_PATHOGENIC",
+ "PATHOGENIC",
+ "DRUG_RESPONSE",
+ "HISTOCOMPATIBILITY",
+ "CONFERS_SENSITIVITY",
+ "RISK_FACTOR",
+ "ASSOCIATION",
+ "PROTECTIVE",
+ "MULTIPLE_REPORTED"
+ ]
+ }
+ }
+ },
+ "ClinicalCondition": {
+ "id": "ClinicalCondition",
+ "type": "object",
+ "properties": {
+ "names": {
+ "type": "array",
+ "description": "A set of names for the condition.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "externalIds": {
+ "type": "array",
+ "description": "The set of external IDs for this condition.",
+ "items": {
+ "$ref": "ExternalId"
+ }
+ },
+ "conceptId": {
+ "type": "string",
+ "description": "The MedGen concept id associated with this gene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/"
+ },
+ "omimId": {
+ "type": "string",
+ "description": "The OMIM id for this condition. Search for these IDs at http://omim.org/"
+ }
+ }
+ },
+ "ExternalId": {
+ "id": "ExternalId",
+ "type": "object",
+ "properties": {
+ "sourceName": {
+ "type": "string",
+ "description": "The name of the source of this data."
+ },
+ "id": {
+ "type": "string",
+ "description": "The id used by the source of this data."
+ }
+ }
+ },
+ "Transcript": {
+ "id": "Transcript",
+ "type": "object",
+ "description": "A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA.",
+ "properties": {
+ "geneId": {
+ "type": "string",
+ "description": "The annotation ID of the gene from which this transcript is transcribed."
+ },
+ "exons": {
+ "type": "array",
+ "description": "The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes. Introns are regions of the transcript that are not included in the spliced RNA product. Though not explicitly modeled here, intron ranges can be deduced; all regions of this transcript that are not exons are introns. Exonic sequences do not necessarily code for a translational product (amino acids). Only the regions of exons bounded by the `codingSequence` correspond to coding DNA sequence. Exons are ordered by start position and may not overlap.",
+ "items": {
+ "$ref": "Exon"
+ }
+ },
+ "codingSequence": {
+ "$ref": "CodingSequence",
+ "description": "The range of the coding sequence for this transcript, if any. To determine the exact ranges of coding sequence, intersect this range with those of the `exons`, if any. If there are any `exons`, the `codingSequence` must start and end within them. Note that in some cases, the reference genome will not exactly match the observed mRNA transcript e.g. due to variance in the source genome from reference. In these cases, `exon.frame` will not necessarily match the expected reference reading frame and coding exon reference bases cannot necessarily be concatenated to produce the original transcript mRNA."
+ }
+ }
+ },
+ "Exon": {
+ "id": "Exon",
+ "type": "object",
+ "properties": {
+ "start": {
+ "type": "string",
+ "description": "The start position of the exon on this annotation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and **not** the containing annotation start.",
+ "format": "int64"
+ },
+ "end": {
+ "type": "string",
+ "description": "The end position of the exon on this annotation's reference sequence, 0-based exclusive. Note that this is relative to the reference start, and *not* the containing annotation start.",
+ "format": "int64"
+ },
+ "frame": {
+ "type": "integer",
+ "description": "The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon within the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.reverse_strand). For forward stranded annotations, this offset is relative to the `exon.start`. For reverse strand annotations, this offset is relative to the `exon.end - 1`. Unset if this exon does not intersect the coding sequence. Upon creation of a transcript, the frame must be populated for all or none of the coding exons.",
+ "format": "int32"
+ }
+ }
+ },
+ "CodingSequence": {
+ "id": "CodingSequence",
+ "type": "object",
+ "properties": {
+ "start": {
+ "type": "string",
+ "description": "The start of the coding sequence on this annotation's reference sequence, 0-based inclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.",
+ "format": "int64"
+ },
+ "end": {
+ "type": "string",
+ "description": "The end of the coding sequence on this annotation's reference sequence, 0-based exclusive. Note that this position is relative to the reference start, and *not* the containing annotation start.",
+ "format": "int64"
+ }
+ }
+ },
+ "BatchCreateAnnotationsRequest": {
+ "id": "BatchCreateAnnotationsRequest",
+ "type": "object",
+ "properties": {
+ "annotations": {
+ "type": "array",
+ "description": "The annotations to be created. At most 4096 can be specified in a single request.",
+ "items": {
+ "$ref": "Annotation"
+ }
+ }
+ }
+ },
+ "BatchCreateAnnotationsResponse": {
+ "id": "BatchCreateAnnotationsResponse",
+ "type": "object",
+ "properties": {
+ "entries": {
+ "type": "array",
+ "description": "The resulting per-annotation entries, ordered consistently with the original request.",
+ "items": {
+ "$ref": "Entry"
+ }
+ }
+ }
+ },
+ "Entry": {
+ "id": "Entry",
+ "type": "object",
+ "properties": {
+ "status": {
+ "$ref": "Status",
+ "description": "The creation status."
+ },
+ "annotation": {
+ "$ref": "Annotation",
+ "description": "The created annotation, if creation was successful."
+ }
+ }
+ },
+ "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."
+ }
+ }
+ }
+ }
+ },
+ "SearchAnnotationsRequest": {
+ "id": "SearchAnnotationsRequest",
+ "type": "object",
+ "properties": {
+ "annotationSetIds": {
+ "type": "array",
+ "description": "Required. The annotation sets to search within. The caller must have `READ` access to these annotation sets. All queried annotation sets must have the same type.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "referenceId": {
+ "type": "string",
+ "description": "The ID of the reference to query."
+ },
+ "referenceName": {
+ "type": "string",
+ "description": "The name of the reference to query, within the reference set associated with this query."
+ },
+ "start": {
+ "type": "string",
+ "description": "The start position of the range on the reference, 0-based inclusive. If specified, referenceId or referenceName must be specified. Defaults to 0.",
+ "format": "int64"
+ },
+ "end": {
+ "type": "string",
+ "description": "The end position of the range on the reference, 0-based exclusive. If referenceId or referenceName must be specified, Defaults to the length of the reference.",
+ "format": "int64"
+ },
+ "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."
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048.",
+ "format": "int32"
+ }
+ }
+ },
+ "SearchAnnotationsResponse": {
+ "id": "SearchAnnotationsResponse",
+ "type": "object",
+ "properties": {
+ "annotations": {
+ "type": "array",
+ "description": "The matching annotations.",
+ "items": {
+ "$ref": "Annotation"
+ }
+ },
+ "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",
@@ -163,11 +656,6 @@
}
}
},
- "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 `{}`."
- },
"UndeleteDatasetRequest": {
"id": "UndeleteDatasetRequest",
"type": "object"
@@ -293,33 +781,6 @@
}
}
},
- "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."
- }
- }
- }
- }
- },
"ListOperationsResponse": {
"id": "ListOperationsResponse",
"type": "object",
@@ -1157,6 +1618,18 @@
"normalizeReferenceNames": {
"type": "boolean",
"description": "Convert reference names to the canonical representation. hg19 haploytypes (those reference names containing \"_hap\") are not modified in any way. All other reference names are modified according to the following rules: The reference name is capitalized. The \"chr\" prefix is dropped for all autosomes and sex chromsomes. For example \"chr17\" becomes \"17\" and \"chrX\" becomes \"X\". All mitochondrial chromosomes (\"chrM\", \"chrMT\", etc) become \"MT\"."
+ },
+ "infoMergeConfig": {
+ "type": "object",
+ "description": "A mapping between info field keys and the InfoMergeOperations to be performed on them. This is plumbed down to the MergeVariantRequests generated by the resulting import job.",
+ "additionalProperties": {
+ "type": "string",
+ "enum": [
+ "INFO_MERGE_OPERATION_UNSPECIFIED",
+ "IGNORE_NEW",
+ "MOVE_TO_CALLS"
+ ]
+ }
}
}
},
@@ -1544,6 +2017,18 @@
"items": {
"$ref": "Variant"
}
+ },
+ "infoMergeConfig": {
+ "type": "object",
+ "description": "A mapping between info field keys and the InfoMergeOperations to be performed on them.",
+ "additionalProperties": {
+ "type": "string",
+ "enum": [
+ "INFO_MERGE_OPERATION_UNSPECIFIED",
+ "IGNORE_NEW",
+ "MOVE_TO_CALLS"
+ ]
+ }
}
}
},
@@ -1752,6 +2237,258 @@
}
},
"resources": {
+ "annotationsets": {
+ "methods": {
+ "create": {
+ "id": "genomics.annotationsets.create",
+ "path": "v1/annotationsets",
+ "httpMethod": "POST",
+ "description": "Creates a new annotation set. Caller must have WRITE permission for the associated dataset. The following fields are required: * datasetId * referenceSetId All other fields may be optionally specified, unless documented as being server-generated (for example, the `id` field).",
+ "request": {
+ "$ref": "AnnotationSet"
+ },
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "get": {
+ "id": "genomics.annotationsets.get",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "httpMethod": "GET",
+ "description": "Gets an annotation set. Caller must have READ permission for the associated dataset.",
+ "parameters": {
+ "annotationSetId": {
+ "type": "string",
+ "description": "The ID of the annotation set to be retrieved.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ]
+ },
+ "update": {
+ "id": "genomics.annotationsets.update",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "httpMethod": "PUT",
+ "description": "Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.",
+ "parameters": {
+ "annotationSetId": {
+ "type": "string",
+ "description": "The ID of the annotation set to be updated.",
+ "required": true,
+ "location": "path"
+ },
+ "updateMask": {
+ "type": "string",
+ "description": "An optional mask specifying which fields to update. Mutable fields are name, source_uri, and info. If unspecified, all mutable fields will be updated.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "request": {
+ "$ref": "AnnotationSet"
+ },
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "delete": {
+ "id": "genomics.annotationsets.delete",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "httpMethod": "DELETE",
+ "description": "Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.",
+ "parameters": {
+ "annotationSetId": {
+ "type": "string",
+ "description": "The ID of the annotation set to be deleted.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "search": {
+ "id": "genomics.annotationsets.search",
+ "path": "v1/annotationsets/search",
+ "httpMethod": "POST",
+ "description": "Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.",
+ "request": {
+ "$ref": "SearchAnnotationSetsRequest"
+ },
+ "response": {
+ "$ref": "SearchAnnotationSetsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ]
+ }
+ }
+ },
+ "annotations": {
+ "methods": {
+ "create": {
+ "id": "genomics.annotations.create",
+ "path": "v1/annotations",
+ "httpMethod": "POST",
+ "description": "Creates a new annotation. Caller must have WRITE permission for the associated annotation set. The following fields are required: * annotationSetId * referenceName or referenceId ### Transcripts For annotations of type TRANSCRIPT, the following fields of transcript must be provided: * `exons.start` * `exons.end` All other fields may be optionally specified, unless documented as being server-generated (for example, the `id` field). The annotated range must be no longer than 100Mbp (mega base pairs). See the Annotation resource for additional restrictions on each field.",
+ "request": {
+ "$ref": "Annotation"
+ },
+ "response": {
+ "$ref": "Annotation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "batchCreate": {
+ "id": "genomics.annotations.batchCreate",
+ "path": "v1/annotations:batchCreate",
+ "httpMethod": "POST",
+ "description": "Creates one or more new annotations atomically. All annotations must belong to the same annotation set. Caller must have WRITE permission for this annotation set. For optimal performance, batch positionally adjacent annotations together. If the request has a systemic issue, such as an attempt to write to an inaccessible annotation set, the entire RPC will fail accordingly. For lesser data issues, when possible an error will be isolated to the corresponding batch entry in the response; the remaining well formed annotations will be created normally. For details on the requirements for each individual annotation resource, see CreateAnnotation.",
+ "request": {
+ "$ref": "BatchCreateAnnotationsRequest"
+ },
+ "response": {
+ "$ref": "BatchCreateAnnotationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "get": {
+ "id": "genomics.annotations.get",
+ "path": "v1/annotations/{annotationId}",
+ "httpMethod": "GET",
+ "description": "Gets an annotation. Caller must have READ permission for the associated annotation set.",
+ "parameters": {
+ "annotationId": {
+ "type": "string",
+ "description": "The ID of the annotation to be retrieved.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "response": {
+ "$ref": "Annotation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ]
+ },
+ "update": {
+ "id": "genomics.annotations.update",
+ "path": "v1/annotations/{annotationId}",
+ "httpMethod": "PUT",
+ "description": "Updates an annotation. Caller must have WRITE permission for the associated dataset.",
+ "parameters": {
+ "annotationId": {
+ "type": "string",
+ "description": "The ID of the annotation to be updated.",
+ "required": true,
+ "location": "path"
+ },
+ "updateMask": {
+ "type": "string",
+ "description": "An optional mask specifying which fields to update. Mutable fields are name, variant, transcript, and info. If unspecified, all mutable fields will be updated.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "request": {
+ "$ref": "Annotation"
+ },
+ "response": {
+ "$ref": "Annotation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "delete": {
+ "id": "genomics.annotations.delete",
+ "path": "v1/annotations/{annotationId}",
+ "httpMethod": "DELETE",
+ "description": "Deletes an annotation. Caller must have WRITE permission for the associated annotation set.",
+ "parameters": {
+ "annotationId": {
+ "type": "string",
+ "description": "The ID of the annotation to be deleted.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "search": {
+ "id": "genomics.annotations.search",
+ "path": "v1/annotations/search",
+ "httpMethod": "POST",
+ "description": "Searches for annotations that match the given criteria. Results are ordered by genomic coordinate (by reference sequence, then position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.",
+ "request": {
+ "$ref": "SearchAnnotationsRequest"
+ },
+ "response": {
+ "$ref": "SearchAnnotationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ]
+ }
+ }
+ },
"datasets": {
"methods": {
"list": {
@@ -1863,7 +2600,7 @@
"id": "genomics.datasets.delete",
"path": "v1/datasets/{datasetId}",
"httpMethod": "DELETE",
- "description": "Deletes a dataset. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "description": "Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the datasets.undelete operation. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"parameters": {
"datasetId": {
"type": "string",
@@ -2495,7 +3232,7 @@
"id": "genomics.variants.import",
"path": "v1/variants:import",
"httpMethod": "POST",
- "description": "Creates variant data by asynchronously importing the provided information. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The variants for import will be merged with any 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. 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. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The variants for import will be merged with any 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 Variant info fields are merged as specified in infoMergeConfig. 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"
},
@@ -2626,7 +3363,7 @@
"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.",
+ "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. Variant info fields are merged as specified in the infoMergeConfig field of the MergeVariantsRequest. Please exercise caution when using this method! It is easy to introduce mistakes in existing variants and difficult to back out of them. For example, suppose you were trying to merge a new variant with an existing one and both variants contain calls that belong to callsets with the same callset ID. // Existing variant - irrelevant fields trimmed for clarity { \"variantSetId\": \"10473108253681171589\", \"referenceName\": \"1\", \"start\": \"10582\", \"referenceBases\": \"G\", \"alternateBases\": [ \"A\" ], \"calls\": [ { \"callSetId\": \"10473108253681171589-0\", \"callSetName\": \"CALLSET0\", \"genotype\": [ 0, 1 ], } ] } // New variant with conflicting call information { \"variantSetId\": \"10473108253681171589\", \"referenceName\": \"1\", \"start\": \"10582\", \"referenceBases\": \"G\", \"alternateBases\": [ \"A\" ], \"calls\": [ { \"callSetId\": \"10473108253681171589-0\", \"callSetName\": \"CALLSET0\", \"genotype\": [ 1, 1 ], } ] } The resulting merged variant would overwrite the existing calls with those from the new variant: { \"variantSetId\": \"10473108253681171589\", \"referenceName\": \"1\", \"start\": \"10582\", \"referenceBases\": \"G\", \"alternateBases\": [ \"A\" ], \"calls\": [ { \"callSetId\": \"10473108253681171589-0\", \"callSetName\": \"CALLSET0\", \"genotype\": [ 1, 1 ], } ] } This may be the desired outcome, but it is up to the user to determine if if that is indeed the case.",
"request": {
"$ref": "MergeVariantsRequest"
},
diff --git a/etc/api/genomics/v1alpha2/genomics-api.json b/etc/api/genomics/v1alpha2/genomics-api.json
index 7c5934d649..d0df227418 100644
--- a/etc/api/genomics/v1alpha2/genomics-api.json
+++ b/etc/api/genomics/v1alpha2/genomics-api.json
@@ -1,20 +1,20 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Ew7uJtCvtBtC91IhtqB2TFZFFcU\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/mfYjmG0m6Pr2oEdtUYff_W8RPzw\"",
"discoveryVersion": "v1",
"id": "genomics:v1alpha2",
"name": "genomics",
"version": "v1alpha2",
- "revision": "20160224",
+ "revision": "20160407",
"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.",
+ "description": "Stores, processes, explores and shares genomic data. This API implements the Global Alliance for Genomics and Health (GA4GH) v0.5.1 API as well as several extensions.",
"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": "",
+ "documentationLink": "https://cloud.google.com/genomics/",
"protocol": "rest",
"baseUrl": "https://genomics.googleapis.com/",
"basePath": "",
@@ -218,7 +218,7 @@
},
"description": {
"type": "string",
- "description": "Optional. User-specified description."
+ "description": "User-specified description."
},
"inputParameters": {
"type": "array",
@@ -259,7 +259,7 @@
},
"description": {
"type": "string",
- "description": "Optional. Human-readable description."
+ "description": "Human-readable description."
},
"defaultValue": {
"type": "string",
@@ -308,16 +308,16 @@
"properties": {
"minimumCpuCores": {
"type": "integer",
- "description": "Required at create time; optional at run time. The minimum number of cores to use.",
+ "description": "The minimum number of cores to use. Defaults to 1.",
"format": "int32"
},
"preemptible": {
"type": "boolean",
- "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."
+ "description": "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. Defaults to `false`."
},
"minimumRamGb": {
"type": "number",
- "description": "Required at create time; optional at run time. The minimum amount of RAM to use.",
+ "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
"format": "double"
},
"disks": {
@@ -333,6 +333,11 @@
"items": {
"type": "string"
}
+ },
+ "bootDiskSizeGb": {
+ "type": "integer",
+ "description": "The size of the boot disk. Defaults to 10 (GB).",
+ "format": "int32"
}
}
},
@@ -357,7 +362,7 @@
},
"sizeGb": {
"type": "integer",
- "description": "The size of the disk. This field is not applicable for local SSD.",
+ "description": "The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.",
"format": "int32"
},
"source": {
@@ -366,7 +371,7 @@
},
"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. 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."
+ "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. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time."
},
"readOnly": {
"type": "boolean",
@@ -426,7 +431,7 @@
},
"clientId": {
"type": "string",
- "description": "Optional. For callers to use in filtering operations returned by this request."
+ "description": "Client-specified pipeline operation identifier."
},
"resources": {
"$ref": "PipelineResources",
@@ -445,11 +450,11 @@
"properties": {
"email": {
"type": "string",
- "description": "Required. Email address of the service account. 'default' is a valid option and uses the compute service account associated with the project."
+ "description": "Email address of the service account. Defaults to `default`, which 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. Should include * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control",
+ "description": "List of scopes to be enabled for this service account on the pipeline virtual machine. The following scopes are automatically included: * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control",
"items": {
"type": "string"
}
@@ -540,10 +545,10 @@
}
}
},
- "UpdateStatusRequest": {
- "id": "UpdateStatusRequest",
+ "SetOperationStatusRequest": {
+ "id": "SetOperationStatusRequest",
"type": "object",
- "description": "Request to update operation status. Should only be used by VMs created by the Pipelines Service and not by end users.",
+ "description": "Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users.",
"properties": {
"operationId": {
"type": "string"
@@ -840,18 +845,18 @@
},
"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.",
+ "description": "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.",
+ "description": "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.",
+ "description": "Token to use to indicate where to start getting results. If unspecified, returns the first page of results.",
"location": "query"
}
},
@@ -887,13 +892,38 @@
"https://www.googleapis.com/auth/genomics"
]
},
- "update_status": {
- "id": "genomics.pipelines.update_status",
- "path": "v1alpha2/pipelines:update_status",
+ "getControllerConfig": {
+ "id": "genomics.pipelines.getControllerConfig",
+ "path": "v1alpha2/pipelines:getControllerConfig",
+ "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.",
+ "location": "query"
+ },
+ "validationToken": {
+ "type": "string",
+ "format": "uint64",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "ControllerConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "setOperationStatus": {
+ "id": "genomics.pipelines.setOperationStatus",
+ "path": "v1alpha2/pipelines:setOperationStatus",
"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.",
+ "description": "Sets status of a given operation. All timestamps are sent on each call, and the whole series of events is replaced, in case intermediate calls are lost. Should only be called by VMs created by the Pipelines Service and not by end users.",
"request": {
- "$ref": "UpdateStatusRequest"
+ "$ref": "SetOperationStatusRequest"
},
"response": {
"$ref": "Empty"
@@ -903,41 +933,6 @@
"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/v1beta2/genomics-api.json b/etc/api/genomics/v1beta2/genomics-api.json
index 4638c68e3d..0e79e55b81 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/bPOvNJ-TScJWjZAQGjSpdLC3xoY\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/MOL6g3e203UhwfxwVIGCu1WDtHU\"",
"discoveryVersion": "v1",
"id": "genomics:v1beta2",
"name": "genomics",
"version": "v1beta2",
- "revision": "20160225",
+ "revision": "20160406",
"title": "Genomics API",
"description": "Provides access to Genomics data.",
"ownerDomain": "google.com",
@@ -994,7 +994,7 @@
"QueryRange": {
"id": "QueryRange",
"type": "object",
- "description": "A 0-based half-open genomic coordinate range for search requests.",
+ "description": "A 0-based half-open genomic coordinate range for search requests. reference_id or reference_name must be set.",
"properties": {
"end": {
"type": "string",
@@ -1003,11 +1003,11 @@
},
"referenceId": {
"type": "string",
- "description": "The ID of the reference to query. At most one of referenceId and referenceName should be specified."
+ "description": "The ID of the reference to query."
},
"referenceName": {
"type": "string",
- "description": "The name of the reference to query, within the reference set associated with this query. At most one of referenceId and referenceName pshould be specified."
+ "description": "The name of the reference to query, within the reference set associated with this query."
},
"start": {
"type": "string",
@@ -2724,7 +2724,7 @@
"id": "genomics.datasets.delete",
"path": "datasets/{datasetId}",
"httpMethod": "DELETE",
- "description": "Deletes a dataset.",
+ "description": "Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the UndeleteDataset operation.",
"parameters": {
"datasetId": {
"type": "string",
@@ -3543,7 +3543,7 @@
"parameters": {
"variantSetId": {
"type": "string",
- "description": "Required. The ID of the variant set.",
+ "description": "The ID of the variant set.",
"required": true,
"location": "path"
}
@@ -3564,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 unless otherwise specified in the InfoMergeConfig field of ImportVariantsRequest. 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",
@@ -3592,7 +3592,7 @@
"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.",
+ "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. Variant info fields are merged as specified in the InfoMergeConfig field of the MergeVariantsRequest.",
"parameters": {
"variantSetId": {
"type": "string",
@@ -3620,7 +3620,7 @@
"parameters": {
"variantSetId": {
"type": "string",
- "description": "The ID of the variant to be updated (must already exist).",
+ "description": "The ID of the variant set to be updated (must already exist).",
"required": true,
"location": "path"
}
@@ -3664,7 +3664,7 @@
"parameters": {
"variantSetId": {
"type": "string",
- "description": "The ID of the variant to be updated (must already exist).",
+ "description": "The ID of the variant set to be updated (must already exist).",
"required": true,
"location": "path"
}
diff --git a/etc/api/gmail/v1/gmail-api.json b/etc/api/gmail/v1/gmail-api.json
index 34916a5b06..9392b27e67 100644
--- a/etc/api/gmail/v1/gmail-api.json
+++ b/etc/api/gmail/v1/gmail-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/o-i_EQ3AewMJPACv-srQz117MuQ\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/zPbxFrF5pjvpdJALHZzVyfTBzGU\"",
"discoveryVersion": "v1",
"id": "gmail:v1",
"name": "gmail",
"version": "v1",
- "revision": "20160216",
+ "revision": "20160316",
"title": "Gmail API",
- "description": "The Gmail REST API.",
+ "description": "Access Gmail mailboxes including sending user email.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/groupssettings/v1/groupssettings-api.json b/etc/api/groupssettings/v1/groupssettings-api.json
index 561ca0012a..672bde795f 100644
--- a/etc/api/groupssettings/v1/groupssettings-api.json
+++ b/etc/api/groupssettings/v1/groupssettings-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/LB7tBnj-DijcSgrB8b68OQtvDh0\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Py5HOWHJ0CMbcB0y6Fw5QYwibOE\"",
"discoveryVersion": "v1",
"id": "groupssettings:v1",
"name": "groupssettings",
"version": "v1",
- "revision": "20140428",
+ "revision": "20160323",
"title": "Groups Settings API",
"description": "Lets you manage permission levels and related settings of a group.",
"ownerDomain": "google.com",
@@ -169,13 +169,17 @@
"type": "string",
"description": "Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT"
},
+ "whoCanAdd": {
+ "type": "string",
+ "description": "Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD"
+ },
"whoCanContactOwner": {
"type": "string",
- "description": "Permission to contact owner of the group via web UI. Possbile values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT"
+ "description": "Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT"
},
"whoCanInvite": {
"type": "string",
- "description": "Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE"
+ "description": "Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE"
},
"whoCanJoin": {
"type": "string",
@@ -183,7 +187,7 @@
},
"whoCanLeaveGroup": {
"type": "string",
- "description": "Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE"
+ "description": "Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE"
},
"whoCanPostMessage": {
"type": "string",
@@ -191,11 +195,11 @@
},
"whoCanViewGroup": {
"type": "string",
- "description": "Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW"
+ "description": "Permissions to view group. Possible values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW"
},
"whoCanViewMembership": {
"type": "string",
- "description": "Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW"
+ "description": "Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW"
}
}
}
diff --git a/etc/api/identitytoolkit/v3/identitytoolkit-api.json b/etc/api/identitytoolkit/v3/identitytoolkit-api.json
index 8ec72f993d..255117d756 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/SoW4IfHxlJosFzXZJhzy3m0A7CE\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Oi0KnpKPJva7LMe3W0nV9ypaEjo\"",
"discoveryVersion": "v1",
"id": "identitytoolkit:v3",
"name": "identitytoolkit",
"canonicalName": "Identity Toolkit",
"version": "v3",
- "revision": "20160216",
+ "revision": "20160324",
"title": "Google Identity Toolkit API",
"description": "Help the third party sites to implement federated login.",
"ownerDomain": "google.com",
@@ -146,6 +146,37 @@
}
}
},
+ "EmailTemplate": {
+ "id": "EmailTemplate",
+ "type": "object",
+ "description": "Template for an email template.",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Email body."
+ },
+ "format": {
+ "type": "string",
+ "description": "Email body format."
+ },
+ "from": {
+ "type": "string",
+ "description": "From address of the email."
+ },
+ "fromDisplayName": {
+ "type": "string",
+ "description": "From display name."
+ },
+ "replyTo": {
+ "type": "string",
+ "description": "Reply-to address."
+ },
+ "subject": {
+ "type": "string",
+ "description": "Subject of the email."
+ }
+ }
+ },
"GetAccountInfoResponse": {
"id": "GetAccountInfoResponse",
"type": "object",
@@ -262,6 +293,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 or STS id token of the authenticated user."
+ },
"localId": {
"type": "string",
"description": "The local ID of the user."
@@ -294,6 +329,11 @@
"type": "object",
"description": "Request to get the account information.",
"properties": {
+ "delegatedProjectNumber": {
+ "type": "string",
+ "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.",
+ "format": "int64"
+ },
"email": {
"type": "array",
"description": "The list of emails of the users to inquiry.",
@@ -327,6 +367,21 @@
"type": "string",
"description": "Browser API key, needed when making http request to Apiary."
},
+ "authorizedDomains": {
+ "type": "array",
+ "description": "Authorized domains.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "changeEmailTemplate": {
+ "$ref": "EmailTemplate",
+ "description": "Change email template."
+ },
+ "enableAnonymousUser": {
+ "type": "boolean",
+ "description": "Whether anonymous user is enabled."
+ },
"idpConfig": {
"type": "array",
"description": "OAuth2 provider configuration.",
@@ -334,9 +389,25 @@
"$ref": "IdpConfig"
}
},
+ "legacyResetPasswordTemplate": {
+ "$ref": "EmailTemplate",
+ "description": "Legacy reset password email template."
+ },
"projectId": {
"type": "string",
"description": "Project ID of the relying party."
+ },
+ "resetPasswordTemplate": {
+ "$ref": "EmailTemplate",
+ "description": "Reset password email template."
+ },
+ "useEmailSending": {
+ "type": "boolean",
+ "description": "Whether to use email sending provided by Firebear."
+ },
+ "verifyEmailTemplate": {
+ "$ref": "EmailTemplate",
+ "description": "Verify email template."
}
}
},
@@ -389,6 +460,20 @@
"description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.",
"format": "int64"
},
+ "deleteAttribute": {
+ "type": "array",
+ "description": "The attributes users request to delete.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deleteProvider": {
+ "type": "array",
+ "description": "The IDPs the user request to delete.",
+ "items": {
+ "type": "string"
+ }
+ },
"disableUser": {
"type": "boolean",
"description": "Whether to disable the user."
@@ -436,6 +521,10 @@
"type": "string"
}
},
+ "returnSecureToken": {
+ "type": "boolean",
+ "description": "Whether return sts id token and refresh token instead of gitkit token."
+ },
"upgradeToFederatedLogin": {
"type": "boolean",
"description": "Mark the user to upgrade to federated login."
@@ -447,6 +536,68 @@
}
}
},
+ "IdentitytoolkitRelyingpartySetProjectConfigRequest": {
+ "id": "IdentitytoolkitRelyingpartySetProjectConfigRequest",
+ "type": "object",
+ "description": "Request to set the project configuration.",
+ "properties": {
+ "allowPasswordUser": {
+ "type": "boolean",
+ "description": "Whether to allow password user sign in or sign up."
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "Browser API key, needed when making http request to Apiary."
+ },
+ "changeEmailTemplate": {
+ "$ref": "EmailTemplate",
+ "description": "Change email template."
+ },
+ "delegatedProjectNumber": {
+ "type": "string",
+ "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.",
+ "format": "int64"
+ },
+ "enableAnonymousUser": {
+ "type": "boolean",
+ "description": "Whether to enable anonymous user."
+ },
+ "idpConfig": {
+ "type": "array",
+ "description": "Oauth2 provider configuration.",
+ "items": {
+ "$ref": "IdpConfig"
+ }
+ },
+ "legacyResetPasswordTemplate": {
+ "$ref": "EmailTemplate",
+ "description": "Legacy reset password email template."
+ },
+ "resetPasswordTemplate": {
+ "$ref": "EmailTemplate",
+ "description": "Reset password email template."
+ },
+ "useEmailSending": {
+ "type": "boolean",
+ "description": "Whether to use email sending provided by Firebear."
+ },
+ "verifyEmailTemplate": {
+ "$ref": "EmailTemplate",
+ "description": "Verify email template."
+ }
+ }
+ },
+ "IdentitytoolkitRelyingpartySetProjectConfigResponse": {
+ "id": "IdentitytoolkitRelyingpartySetProjectConfigResponse",
+ "type": "object",
+ "description": "Response of setting the project configuration.",
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "description": "Project ID of the relying party."
+ }
+ }
+ },
"IdentitytoolkitRelyingpartySignOutUserRequest": {
"id": "IdentitytoolkitRelyingpartySignOutUserRequest",
"type": "object",
@@ -505,6 +656,10 @@
"password": {
"type": "string",
"description": "The new password of the user."
+ },
+ "returnSecureToken": {
+ "type": "boolean",
+ "description": "Whether return sts id token and refresh token instead of gitkit token."
}
}
},
@@ -585,6 +740,10 @@
"type": "boolean",
"description": "Whether to return refresh tokens."
},
+ "returnSecureToken": {
+ "type": "boolean",
+ "description": "Whether return sts id token and refresh token instead of gitkit token."
+ },
"sessionId": {
"type": "string",
"description": "Session ID, which should match the one in previous createAuthUri request."
@@ -600,6 +759,10 @@
"type": "string",
"description": "Instance id token of the app."
},
+ "returnSecureToken": {
+ "type": "boolean",
+ "description": "Whether return sts id token and refresh token instead of gitkit token."
+ },
"token": {
"type": "string",
"description": "The custom token to verify"
@@ -643,6 +806,10 @@
"pendingIdToken": {
"type": "string",
"description": "The GITKit token for the non-trusted IDP, which is to be confirmed by the user."
+ },
+ "returnSecureToken": {
+ "type": "boolean",
+ "description": "Whether return sts id token and refresh token instead of gitkit token."
}
}
},
@@ -667,6 +834,10 @@
"provider": {
"type": "string",
"description": "OAuth2 provider."
+ },
+ "secret": {
+ "type": "string",
+ "description": "OAuth2 client secret."
}
}
},
@@ -739,6 +910,11 @@
"type": "string",
"description": "The email of the user."
},
+ "expiresIn": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be expiration time of STS id token in seconds.",
+ "format": "int64"
+ },
"idToken": {
"type": "string",
"description": "The Gitkit id token to login the newly sign up user."
@@ -776,6 +952,10 @@
}
}
}
+ },
+ "refreshToken": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be refresh token."
}
}
},
@@ -792,6 +972,11 @@
"type": "string",
"description": "The email of the user."
},
+ "expiresIn": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be expiration time of STS id token in seconds.",
+ "format": "int64"
+ },
"idToken": {
"type": "string",
"description": "The Gitkit id token to login the newly sign up user."
@@ -800,6 +985,14 @@
"type": "string",
"description": "The fixed string \"identitytoolkit#SignupNewUserResponse\".",
"default": "identitytoolkit#SignupNewUserResponse"
+ },
+ "localId": {
+ "type": "string",
+ "description": "The RP local ID of the user."
+ },
+ "refreshToken": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be refresh token."
}
}
},
@@ -897,6 +1090,10 @@
"providerId": {
"type": "string",
"description": "The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier."
+ },
+ "rawId": {
+ "type": "string",
+ "description": "User's raw identifier directly returned from IDP."
}
}
}
@@ -959,6 +1156,11 @@
"type": "boolean",
"description": "The value is true if the IDP is also the email provider. It means the user owns the email."
},
+ "expiresIn": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be expiration time of STS id token in seconds.",
+ "format": "int64"
+ },
"federatedId": {
"type": "string",
"description": "The unique ID identifies the IdP account."
@@ -1029,6 +1231,10 @@
"type": "string",
"description": "The scope for the OpenID OAuth extension."
},
+ "oauthTokenSecret": {
+ "type": "string",
+ "description": "The OAuth1 access token secret."
+ },
"originalEmail": {
"type": "string",
"description": "The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email."
@@ -1041,6 +1247,10 @@
"type": "string",
"description": "The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the \"providerId\" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the \"identifier\" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned."
},
+ "refreshToken": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be refresh token."
+ },
"timeZone": {
"type": "string",
"description": "The timezone of the user."
@@ -1059,6 +1269,11 @@
"type": "object",
"description": "Response from verifying a custom token",
"properties": {
+ "expiresIn": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be expiration time of STS id token in seconds.",
+ "format": "int64"
+ },
"idToken": {
"type": "string",
"description": "The GITKit token for authenticated user."
@@ -1067,6 +1282,10 @@
"type": "string",
"description": "The fixed string \"identitytoolkit#VerifyCustomTokenResponse\".",
"default": "identitytoolkit#VerifyCustomTokenResponse"
+ },
+ "refreshToken": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be refresh token."
}
}
},
@@ -1083,6 +1302,11 @@
"type": "string",
"description": "The email returned by the IdP. NOTE: The federated login user may not own the email."
},
+ "expiresIn": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be expiration time of STS id token in seconds.",
+ "format": "int64"
+ },
"idToken": {
"type": "string",
"description": "The GITKit token for authenticated user."
@@ -1113,6 +1337,10 @@
"type": "string",
"description": "The URI of the user's photo at IdP"
},
+ "refreshToken": {
+ "type": "string",
+ "description": "If idToken is STS id token, then this field will be refresh token."
+ },
"registered": {
"type": "boolean",
"description": "Whether the email is registered."
@@ -1188,6 +1416,18 @@
"path": "getProjectConfig",
"httpMethod": "GET",
"description": "Get project configuration.",
+ "parameters": {
+ "delegatedProjectNumber": {
+ "type": "string",
+ "description": "Delegated GCP project number of the request.",
+ "location": "query"
+ },
+ "projectNumber": {
+ "type": "string",
+ "description": "GCP project number of the request.",
+ "location": "query"
+ }
+ },
"response": {
"$ref": "IdentitytoolkitRelyingpartyGetProjectConfigResponse"
}
@@ -1234,6 +1474,18 @@
"$ref": "SetAccountInfoResponse"
}
},
+ "setProjectConfig": {
+ "id": "identitytoolkit.relyingparty.setProjectConfig",
+ "path": "setProjectConfig",
+ "httpMethod": "POST",
+ "description": "Set project configuration.",
+ "request": {
+ "$ref": "IdentitytoolkitRelyingpartySetProjectConfigRequest"
+ },
+ "response": {
+ "$ref": "IdentitytoolkitRelyingpartySetProjectConfigResponse"
+ }
+ },
"signOutUser": {
"id": "identitytoolkit.relyingparty.signOutUser",
"path": "signOutUser",
diff --git a/etc/api/logging/v2beta1/logging-api.json b/etc/api/logging/v2beta1/logging-api.json
index 60a1665ece..b3a0d88dfe 100644
--- a/etc/api/logging/v2beta1/logging-api.json
+++ b/etc/api/logging/v2beta1/logging-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/wmRq-yRsUWybxv4zTNUlygH9dXc\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/AGY2FGWaHRZwgyAazem2sSX20dM\"",
"discoveryVersion": "v1",
"id": "logging:v2beta1",
"name": "logging",
"version": "v2beta1",
- "revision": "20160104",
+ "revision": "20160322",
"title": "Google Cloud Logging API",
- "description": "The Google Cloud Logging API lets you write log entries and manage your logs, log sinks and logs-based metrics.",
+ "description": "Writes log entries and manages your logs, log sinks, and logs-based metrics.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -154,21 +154,25 @@
"items": {
"$ref": "LogEntry"
}
+ },
+ "partialSuccess": {
+ "type": "boolean",
+ "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors."
}
}
},
"MonitoredResource": {
"id": "MonitoredResource",
"type": "object",
- "description": "A specific monitored resource or a group of monitored resources.",
+ "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `\"gce_instance\"` has labels `\"instance_id\"` and `\"zone\"`: { \"type\": \"gce_instance\", \"labels\": { \"instance_id\": \"my-instance\", \"zone\": \"us-central1-a\" }}",
"properties": {
"type": {
"type": "string",
- "description": "The type of monitored resource. This field must match the value of the `type` field in a MonitoredResourceDescriptor object. For example, `\"cloudsql_database\"` represents Cloud SQL databases."
+ "description": "Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `\"cloudsql_database\"`."
},
"labels": {
"type": "object",
- "description": "Values for some or all of the labels listed in the associated monitored resource descriptor. For example, specify a specific Cloud SQL database by supplying values for both the `\"database_id\"` and `\"zone\"` labels. Specify the set of all Cloud SQL databases in a particular location by supplying a value for only the `\"zone\"` label.",
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `\"database_id\"` and `\"zone\"`.",
"additionalProperties": {
"type": "string"
}
@@ -182,7 +186,7 @@
"properties": {
"logName": {
"type": "string",
- "description": "Required. The resource name of the log to which this log entry belongs. The format of the name is `projects/\u003cproject-id\u003e/logs/\u003clog-id%gt;`. Examples: `\"projects/my-projectid/logs/syslog\"`, `\"projects/1234567890/logs/library.googleapis.com%2Fbook_log\"`. The log ID part of resource name must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters: [A-Za-z0-9]; and punctuation characters: forward-slash, underscore, hyphen, and period. Forward-slash (`/`) characters in the log ID must be URL-encoded."
+ "description": "Required. The resource name of the log to which this log entry belongs. The format of the name is `\"projects/\n/logs/\"`. Examples: `\"projects/my-projectid/logs/syslog\"`, `\"projects/1234567890/logs/library.googleapis.com%2Fbook_log\"`. The log ID part of resource name must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters: [A-Za-z0-9]; and punctuation characters: forward-slash, underscore, hyphen, and period. Forward-slash (`/`) characters in the log ID must be URL-encoded."
},
"resource": {
"$ref": "MonitoredResource",
@@ -288,13 +292,22 @@
"type": "string",
"description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)."
},
+ "cacheLookup": {
+ "type": "boolean",
+ "description": "Whether or not a cache lookup was attempted."
+ },
"cacheHit": {
"type": "boolean",
"description": "Whether or not an entity was served from cache (with or without validation)."
},
- "validatedWithOriginServer": {
+ "cacheValidatedWithOriginServer": {
"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."
+ },
+ "cacheFillBytes": {
+ "type": "string",
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "format": "int64"
}
}
},
@@ -344,16 +357,20 @@
},
"orderBy": {
"type": "string",
- "description": "Optional. How the results should be sorted. Presently, the only permitted values are `\"timestamp\"` (default) and `\"timestamp desc\"`. The first option returns entries in order of increasing values of `LogEntry.timestamp` (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of `LogEntry.insertId`."
+ "description": "Optional. How the results should be sorted. Presently, the only permitted values are `\"timestamp asc\"` (default) and `\"timestamp desc\"`. The first option returns entries in order of increasing values of `LogEntry.timestamp` (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of `LogEntry.insertId`."
},
"pageSize": {
"type": "integer",
- "description": "Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.",
+ "description": "Optional. The maximum number of results to return from this request. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.",
"format": "int32"
},
"pageToken": {
"type": "string",
- "description": "Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request. The values of `projectIds`, `filter`, and `orderBy` must be the same as in the previous request."
+ "description": "Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response. The values of `projectIds`, `filter`, and `orderBy` must be the same as in the previous request."
+ },
+ "partialSuccess": {
+ "type": "boolean",
+ "description": "Optional. If true, read access to all projects is not required and results will be returned for the subset of projects for which read access is permitted (empty subset is permitted)."
}
}
},
@@ -371,7 +388,41 @@
},
"nextPageToken": {
"type": "string",
- "description": "If there are more results than were returned, then `nextPageToken` is given a value in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`."
+ "description": "If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`."
+ },
+ "projectIdErrors": {
+ "type": "object",
+ "description": "If partial_success is true, contains the project ids that had errors and the associated errors.",
+ "additionalProperties": {
+ "$ref": "Status"
+ }
+ }
+ }
+ },
+ "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."
+ }
+ }
}
}
},
@@ -389,30 +440,34 @@
},
"nextPageToken": {
"type": "string",
- "description": "If there are more results than were returned, then `nextPageToken` is returned in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`."
+ "description": "If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`."
}
}
},
"MonitoredResourceDescriptor": {
"id": "MonitoredResourceDescriptor",
"type": "object",
- "description": "A description of a type of monitored resource.",
+ "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.",
"properties": {
+ "name": {
+ "type": "string",
+ "description": "Optional. The resource name of the monitored resource descriptor: `\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `\"monitoredResourceDescriptors/{type}\"`."
+ },
"type": {
"type": "string",
- "description": "The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL."
+ "description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL."
},
"displayName": {
"type": "string",
- "description": "A concise name for the monitored resource type, which is displayed in user interfaces. For example, `\"Cloud SQL Database\"`."
+ "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. For example, `\"Google Cloud SQL Database\"`."
},
"description": {
"type": "string",
- "description": "A detailed description of the monitored resource type, which is used in documentation."
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation."
},
"labels": {
"type": "array",
- "description": "A set of labels that can be used to describe instances of this monitored resource type. For example, Cloud SQL databases can be labeled with their `\"database_id\"` and their `\"zone\"`.",
+ "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `\"database_id\"` and `\"zone\"`.",
"items": {
"$ref": "LabelDescriptor"
}
@@ -457,7 +512,7 @@
},
"nextPageToken": {
"type": "string",
- "description": "If there are more results than were returned, then `nextPageToken` is given a value in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`."
+ "description": "If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`."
}
}
},
@@ -476,11 +531,11 @@
},
"filter": {
"type": "string",
- "description": "An [advanced logs filter](/logging/docs/view/advanced_filters) that defines the log entries to be exported. The filter must be consistent with the log entry format designed by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example: `\"logName:syslog AND severity\u003e=ERROR\"`."
+ "description": "An [advanced logs filter](/logging/docs/view/advanced_filters). Only log entries matching that filter are exported. The filter must be consistent with the log entry format specified by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example (V2 format): `\"logName=projects/my-projectid/logs/syslog AND severity\u003e=ERROR\"`."
},
"outputVersionFormat": {
"type": "string",
- "description": "The log entry version used when exporting log entries from this sink. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.",
+ "description": "The log entry version to use for this sink's exported log entries. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.",
"enum": [
"VERSION_FORMAT_UNSPECIFIED",
"V2",
@@ -503,7 +558,7 @@
},
"nextPageToken": {
"type": "string",
- "description": "If there are more results than were returned, then `nextPageToken` is given a value in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`."
+ "description": "If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`."
}
}
},
@@ -640,6 +695,10 @@
"type": "boolean",
"description": "Whether this request is finished or active."
},
+ "first": {
+ "type": "boolean",
+ "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Cloud Logging, this field will be set for one of them."
+ },
"instanceId": {
"type": "string",
"description": "An identifier for the instance that handled the request."
@@ -780,19 +839,19 @@
"parameters": {
"projectName": {
"type": "string",
- "description": "Required. The resource name of the project containing the sinks. Example: `\"projects/my-logging-project\"`, `\"projects/01234567890\"`.",
+ "description": "Required. The resource name of the project containing the sinks. Example: `\"projects/my-logging-project\"`.",
"required": true,
"pattern": "^projects/[^/]*$",
"location": "path"
},
"pageToken": {
"type": "string",
- "description": "Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request. The value of `projectName` must be the same as in the previous request.",
+ "description": "Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response. The value of `projectName` must be the same as in the previous request.",
"location": "query"
},
"pageSize": {
"type": "integer",
- "description": "Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.",
+ "description": "Optional. The maximum number of results to return from this request. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.",
"format": "int32",
"location": "query"
}
@@ -937,12 +996,12 @@
},
"pageToken": {
"type": "string",
- "description": "Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request. The value of `projectName` must be the same as in the previous request.",
+ "description": "Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response. The value of `projectName` must be the same as in the previous request.",
"location": "query"
},
"pageSize": {
"type": "integer",
- "description": "Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.",
+ "description": "Optional. The maximum number of results to return from this request. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.",
"format": "int32",
"location": "query"
}
@@ -1124,13 +1183,13 @@
"parameters": {
"pageSize": {
"type": "integer",
- "description": "Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.",
+ "description": "Optional. The maximum number of results to return from this request. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.",
"format": "int32",
"location": "query"
},
"pageToken": {
"type": "string",
- "description": "Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request.",
+ "description": "Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response.",
"location": "query"
}
},
diff --git a/etc/api/monitoring/v3/monitoring-api.json b/etc/api/monitoring/v3/monitoring-api.json
new file mode 100644
index 0000000000..af3f7684dc
--- /dev/null
+++ b/etc/api/monitoring/v3/monitoring-api.json
@@ -0,0 +1,1517 @@
+{
+ "kind": "discovery#restDescription",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/W_DehY1ieVoEybycxDkoZdKE5Bk\"",
+ "discoveryVersion": "v1",
+ "id": "monitoring:v3",
+ "name": "monitoring",
+ "version": "v3",
+ "revision": "20160321",
+ "title": "Google Monitoring API",
+ "description": "The Google Monitoring API lets you manage your monitoring data and configurations.",
+ "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/monitoring/api/",
+ "protocol": "rest",
+ "baseUrl": "https://monitoring.googleapis.com/",
+ "basePath": "",
+ "rootUrl": "https://monitoring.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/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/monitoring": {
+ "description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
+ },
+ "https://www.googleapis.com/auth/monitoring.read": {
+ "description": "View monitoring data for all of your Google Cloud and third-party projects"
+ },
+ "https://www.googleapis.com/auth/monitoring.write": {
+ "description": "Publish metric data to your Google Cloud projects"
+ }
+ }
+ }
+ },
+ "schemas": {
+ "CreateCollectdTimeSeriesRequest": {
+ "id": "CreateCollectdTimeSeriesRequest",
+ "type": "object",
+ "description": "The `CreateCollectdTimeSeries` request.",
+ "properties": {
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "The monitored resource associated with the time series."
+ },
+ "collectdVersion": {
+ "type": "string",
+ "description": "The version of `collectd` that collected the data. Example: `\"5.3.0-192.el6\"`."
+ },
+ "collectdPayloads": {
+ "type": "array",
+ "description": "The `collectd` payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields `plugin`, `plugin_instance`, `type`, and `type_instance`.",
+ "items": {
+ "$ref": "CollectdPayload"
+ }
+ }
+ }
+ },
+ "MonitoredResource": {
+ "id": "MonitoredResource",
+ "type": "object",
+ "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `\"gce_instance\"` has labels `\"instance_id\"` and `\"zone\"`: { \"type\": \"gce_instance\", \"labels\": { \"instance_id\": \"my-instance\", \"zone\": \"us-central1-a\" }}",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `\"cloudsql_database\"`."
+ },
+ "labels": {
+ "type": "object",
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `\"database_id\"` and `\"zone\"`.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "CollectdPayload": {
+ "id": "CollectdPayload",
+ "type": "object",
+ "description": "A collection of data points sent from a `collectd`-based plugin. See the `collectd` documentation for more information.",
+ "properties": {
+ "values": {
+ "type": "array",
+ "description": "The measured values during this time interval. Each value must have a different `dataSourceName`.",
+ "items": {
+ "$ref": "CollectdValue"
+ }
+ },
+ "startTime": {
+ "type": "string",
+ "description": "The start time of the interval."
+ },
+ "endTime": {
+ "type": "string",
+ "description": "The end time of the interval."
+ },
+ "plugin": {
+ "type": "string",
+ "description": "The name of the plugin. Example: `\"disk\"`."
+ },
+ "pluginInstance": {
+ "type": "string",
+ "description": "The instance name of the plugin Example: `\"hdcl\"`."
+ },
+ "type": {
+ "type": "string",
+ "description": "The measurement type. Example: `\"memory\"`."
+ },
+ "typeInstance": {
+ "type": "string",
+ "description": "The measurement type instance. Example: `\"used\"`."
+ },
+ "metadata": {
+ "type": "object",
+ "description": "The measurement metadata. Example: `\"process_id\" -\u003e 12345`",
+ "additionalProperties": {
+ "$ref": "TypedValue"
+ }
+ }
+ }
+ },
+ "CollectdValue": {
+ "id": "CollectdValue",
+ "type": "object",
+ "description": "A single data point from a `collectd`-based plugin.",
+ "properties": {
+ "dataSourceName": {
+ "type": "string",
+ "description": "The data source for the `collectd` value. For example there are two data sources for network measurements: `\"rx\"` and `\"tx\"`."
+ },
+ "dataSourceType": {
+ "type": "string",
+ "description": "The type of measurement.",
+ "enum": [
+ "UNSPECIFIED_DATA_SOURCE_TYPE",
+ "GAUGE",
+ "COUNTER",
+ "DERIVE",
+ "ABSOLUTE"
+ ]
+ },
+ "value": {
+ "$ref": "TypedValue",
+ "description": "The measurement value."
+ }
+ }
+ },
+ "TypedValue": {
+ "id": "TypedValue",
+ "type": "object",
+ "description": "A single strongly-typed value.",
+ "properties": {
+ "boolValue": {
+ "type": "boolean",
+ "description": "A Boolean value: `true` or `false`."
+ },
+ "int64Value": {
+ "type": "string",
+ "description": "A 64-bit integer. Its range is approximately ±9.2x1018.",
+ "format": "int64"
+ },
+ "doubleValue": {
+ "type": "number",
+ "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.",
+ "format": "double"
+ },
+ "stringValue": {
+ "type": "string",
+ "description": "A variable-length string value."
+ },
+ "distributionValue": {
+ "$ref": "Distribution",
+ "description": "A distribution value."
+ }
+ }
+ },
+ "Distribution": {
+ "id": "Distribution",
+ "type": "object",
+ "description": "Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width). Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.",
+ "properties": {
+ "count": {
+ "type": "string",
+ "description": "The number of values in the population. Must be non-negative.",
+ "format": "int64"
+ },
+ "mean": {
+ "type": "number",
+ "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.",
+ "format": "double"
+ },
+ "sumOfSquaredDeviation": {
+ "type": "number",
+ "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.",
+ "format": "double"
+ },
+ "range": {
+ "$ref": "Range",
+ "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero."
+ },
+ "bucketOptions": {
+ "$ref": "BucketOptions",
+ "description": "Defines the histogram bucket boundaries."
+ },
+ "bucketCounts": {
+ "type": "array",
+ "description": "If `bucket_options` is given, then the sum of the values in `bucket_counts` must equal the value in `count`. If `bucket_options` is not given, no `bucket_counts` fields may be given. Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1). The size of `bucket_counts` must be no greater than N as defined in `bucket_options`. Any suffix of trailing zero bucket_count fields may be omitted.",
+ "items": {
+ "type": "string",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "Range": {
+ "id": "Range",
+ "type": "object",
+ "description": "The range of the population values.",
+ "properties": {
+ "min": {
+ "type": "number",
+ "description": "The minimum of the population values.",
+ "format": "double"
+ },
+ "max": {
+ "type": "number",
+ "description": "The maximum of the population values.",
+ "format": "double"
+ }
+ }
+ },
+ "BucketOptions": {
+ "id": "BucketOptions",
+ "type": "object",
+ "description": "A Distribution may optionally contain a histogram of the values in the population. The histogram is given in `bucket_counts` as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by `bucket_options`. A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound. The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. `BucketOptions` describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly. If `bucket_boundaries` is not given, then no `bucket_counts` may be given.",
+ "properties": {
+ "linearBuckets": {
+ "$ref": "Linear",
+ "description": "The linear bucket."
+ },
+ "exponentialBuckets": {
+ "$ref": "Exponential",
+ "description": "The exponential buckets."
+ },
+ "explicitBuckets": {
+ "$ref": "Explicit",
+ "description": "The explicit buckets."
+ }
+ }
+ },
+ "Linear": {
+ "id": "Linear",
+ "type": "object",
+ "description": "Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket `i`: Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
+ "properties": {
+ "numFiniteBuckets": {
+ "type": "integer",
+ "description": "Must be greater than 0.",
+ "format": "int32"
+ },
+ "width": {
+ "type": "number",
+ "description": "Must be greater than 0.",
+ "format": "double"
+ },
+ "offset": {
+ "type": "number",
+ "description": "Lower bound of the first bucket.",
+ "format": "double"
+ }
+ }
+ },
+ "Exponential": {
+ "id": "Exponential",
+ "type": "object",
+ "description": "Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket i: Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
+ "properties": {
+ "numFiniteBuckets": {
+ "type": "integer",
+ "description": "must be greater than 0",
+ "format": "int32"
+ },
+ "growthFactor": {
+ "type": "number",
+ "description": "Must be greater than 1",
+ "format": "double"
+ },
+ "scale": {
+ "type": "number",
+ "description": "Must be greater than 0",
+ "format": "double"
+ }
+ }
+ },
+ "Explicit": {
+ "id": "Explicit",
+ "type": "object",
+ "description": "A set of buckets with arbitrary widths. Defines `size(bounds) + 1` (= N) buckets with these boundaries for bucket i: Upper bound (0 \u003c= i \u003c N-1): bounds[i] Lower bound (1 \u003c= i \u003c N); bounds[i - 1] There must be at least one element in `bounds`. If `bounds` has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
+ "properties": {
+ "bounds": {
+ "type": "array",
+ "description": "The values must be monotonically increasing.",
+ "items": {
+ "type": "number",
+ "format": "double"
+ }
+ }
+ }
+ },
+ "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 `{}`."
+ },
+ "ListGroupsResponse": {
+ "id": "ListGroupsResponse",
+ "type": "object",
+ "description": "The `ListGroups` response.",
+ "properties": {
+ "group": {
+ "type": "array",
+ "description": "The groups that match the specified filters.",
+ "items": {
+ "$ref": "Group"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method."
+ }
+ }
+ },
+ "Group": {
+ "id": "Group",
+ "type": "object",
+ "description": "The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups. Groups can be nested in parent-child hierarchies. The `parentName` field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource. For example, consider an infrastructure running a set of instances with two user-defined tags: `\"environment\"` and `\"role\"`. A parent group has a filter, `environment=\"production\"`. A child of that parent group has a filter, `role=\"transcoder\"`. The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role *and* are in the production environment. The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of this group. The format is `\"projects/{project_id_or_number}/groups/{group_id}\"`. When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. @OutputOnly"
+ },
+ "displayName": {
+ "type": "string",
+ "description": "A user-assigned name for this group, used only for display purposes."
+ },
+ "parentName": {
+ "type": "string",
+ "description": "The name of the group's parent, if it has one. The format is `\"projects/{project_id_or_number}/groups/{group_id}\"`. For groups with no parent, `parentName` is the empty string, `\"\"`."
+ },
+ "filter": {
+ "type": "string",
+ "description": "The filter used to determine which monitored resources belong to this group."
+ },
+ "isCluster": {
+ "type": "boolean",
+ "description": "If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters."
+ }
+ }
+ },
+ "ListGroupMembersResponse": {
+ "id": "ListGroupMembersResponse",
+ "type": "object",
+ "description": "The `ListGroupMembers` response.",
+ "properties": {
+ "members": {
+ "type": "array",
+ "description": "A set of monitored resources in the group.",
+ "items": {
+ "$ref": "MonitoredResource"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method."
+ },
+ "totalSize": {
+ "type": "integer",
+ "description": "The total number of elements matching this request.",
+ "format": "int32"
+ }
+ }
+ },
+ "ListMonitoredResourceDescriptorsResponse": {
+ "id": "ListMonitoredResourceDescriptorsResponse",
+ "type": "object",
+ "description": "The `ListMonitoredResourcDescriptors` response.",
+ "properties": {
+ "resourceDescriptors": {
+ "type": "array",
+ "description": "The monitored resource descriptors that are available to this project and that match `filter`, if present.",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method."
+ }
+ }
+ },
+ "MonitoredResourceDescriptor": {
+ "id": "MonitoredResourceDescriptor",
+ "type": "object",
+ "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Optional. The resource name of the monitored resource descriptor: `\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `\"monitoredResourceDescriptors/{type}\"`."
+ },
+ "type": {
+ "type": "string",
+ "description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL."
+ },
+ "displayName": {
+ "type": "string",
+ "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. For example, `\"Google Cloud SQL Database\"`."
+ },
+ "description": {
+ "type": "string",
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation."
+ },
+ "labels": {
+ "type": "array",
+ "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `\"database_id\"` and `\"zone\"`.",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ }
+ }
+ },
+ "LabelDescriptor": {
+ "id": "LabelDescriptor",
+ "type": "object",
+ "description": "A description of a label.",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "The label key."
+ },
+ "valueType": {
+ "type": "string",
+ "description": "The type of data that can be assigned to the label.",
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "description": "A human-readable description for the label."
+ }
+ }
+ },
+ "ListMetricDescriptorsResponse": {
+ "id": "ListMetricDescriptorsResponse",
+ "type": "object",
+ "description": "The `ListMetricDescriptors` response.",
+ "properties": {
+ "metricDescriptors": {
+ "type": "array",
+ "description": "The metric descriptors that are available to the project and that match the value of `filter`, if present.",
+ "items": {
+ "$ref": "MetricDescriptor"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method."
+ }
+ }
+ },
+ "MetricDescriptor": {
+ "id": "MetricDescriptor",
+ "type": "object",
+ "description": "Defines a metric type and its schema.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Resource name. The format of the name may vary between different implementations. For examples: projects/{project_id}/metricDescriptors/{type=**} metricDescriptors/{type=**}"
+ },
+ "type": {
+ "type": "string",
+ "description": "The metric type including a DNS name prefix, for example `\"compute.googleapis.com/instance/cpu/utilization\"`. Metric types should use a natural hierarchical grouping such as the following: compute.googleapis.com/instance/cpu/utilization compute.googleapis.com/instance/disk/read_ops_count compute.googleapis.com/instance/network/received_bytes_count Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable."
+ },
+ "labels": {
+ "type": "array",
+ "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the `compute.googleapis.com/instance/network/received_bytes_count` metric type has a label, `loadbalanced`, that specifies whether the traffic was received through a load balanced IP address.",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ },
+ "metricKind": {
+ "type": "string",
+ "description": "Whether the metric records instantaneous values, changes to a value, etc.",
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ]
+ },
+ "valueType": {
+ "type": "string",
+ "description": "Whether the measurement is an integer, a floating-point number, etc.",
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ]
+ },
+ "unit": {
+ "type": "string",
+ "description": "The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar includes the dimensionless unit `1`, such as `1/s`. The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = [ PREFIX ] UNIT [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'."
+ },
+ "description": {
+ "type": "string",
+ "description": "A detailed description of the metric, which can be used in documentation."
+ },
+ "displayName": {
+ "type": "string",
+ "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\"."
+ }
+ }
+ },
+ "ListTimeSeriesResponse": {
+ "id": "ListTimeSeriesResponse",
+ "type": "object",
+ "description": "The `ListTimeSeries` response.",
+ "properties": {
+ "timeSeries": {
+ "type": "array",
+ "description": "One or more time series that match the filter included in the request.",
+ "items": {
+ "$ref": "TimeSeries"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as `pageToken` in the next call to this method."
+ }
+ }
+ },
+ "TimeSeries": {
+ "id": "TimeSeries",
+ "type": "object",
+ "description": "A collection of data points that describes the time-varying nature of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric.",
+ "properties": {
+ "metric": {
+ "$ref": "Metric",
+ "description": "The fully-specified metric used to identify the time series."
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "The fully-specified monitored resource used to identify the time series."
+ },
+ "metricKind": {
+ "type": "string",
+ "description": "The metric kind of the time series. This can be different than the metric kind specified in [google.api.MetricDescriptor] because of alignment and reduction operations on the data. This field is ignored when writing data; the value specified in the descriptor is used instead. @OutputOnly",
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ]
+ },
+ "valueType": {
+ "type": "string",
+ "description": "The value type of the time series. This can be different than the value type specified in [google.api.MetricDescriptor] because of alignment and reduction operations on the data. This field is ignored when writing data; the value specified in the descriptor is used instead. @OutputOnly",
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ]
+ },
+ "points": {
+ "type": "array",
+ "description": "The data points of this time series. When used as output, points will be sorted by decreasing time order. When used as input, points could be written in any orders.",
+ "items": {
+ "$ref": "Point"
+ }
+ }
+ }
+ },
+ "Metric": {
+ "id": "Metric",
+ "type": "object",
+ "description": "A specific metric identified by specifying values for all of the labels of a `MetricDescriptor`.",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "An existing metric type, see google.api.MetricDescriptor. For example, `compute.googleapis.com/instance/cpu/usage_time`."
+ },
+ "labels": {
+ "type": "object",
+ "description": "The set of labels that uniquely identify a metric. To specify a metric, all labels enumerated in the `MetricDescriptor` must be assigned values.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "Point": {
+ "id": "Point",
+ "type": "object",
+ "description": "A single data point in a time series.",
+ "properties": {
+ "interval": {
+ "$ref": "TimeInterval",
+ "description": "The time interval to which the value applies."
+ },
+ "value": {
+ "$ref": "TypedValue",
+ "description": "The value of the data point."
+ }
+ }
+ },
+ "TimeInterval": {
+ "id": "TimeInterval",
+ "type": "object",
+ "description": "A time interval extending from after `startTime` through `endTime`. If `startTime` is omitted, the interval is the single point in time, `endTime`.",
+ "properties": {
+ "endTime": {
+ "type": "string",
+ "description": "(required) The end of the interval. The interval includes this time."
+ },
+ "startTime": {
+ "type": "string",
+ "description": "(optional) If omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`."
+ }
+ }
+ },
+ "CreateTimeSeriesRequest": {
+ "id": "CreateTimeSeriesRequest",
+ "type": "object",
+ "description": "The `CreateTimeSeries` request.",
+ "properties": {
+ "timeSeries": {
+ "type": "array",
+ "description": "The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each `TimeSeries` value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.",
+ "items": {
+ "$ref": "TimeSeries"
+ }
+ }
+ }
+ },
+ "Type": {
+ "id": "Type",
+ "type": "object",
+ "description": "A protocol buffer message type.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The fully qualified message name."
+ },
+ "fields": {
+ "type": "array",
+ "description": "The list of fields.",
+ "items": {
+ "$ref": "Field"
+ }
+ },
+ "oneofs": {
+ "type": "array",
+ "description": "The list of types appearing in `oneof` definitions in this type.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "options": {
+ "type": "array",
+ "description": "The protocol buffer options.",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ },
+ "syntax": {
+ "type": "string",
+ "description": "The source syntax.",
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ]
+ }
+ }
+ },
+ "Field": {
+ "id": "Field",
+ "type": "object",
+ "description": "A single field of a message type.",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "The field type.",
+ "enum": [
+ "TYPE_UNKNOWN",
+ "TYPE_DOUBLE",
+ "TYPE_FLOAT",
+ "TYPE_INT64",
+ "TYPE_UINT64",
+ "TYPE_INT32",
+ "TYPE_FIXED64",
+ "TYPE_FIXED32",
+ "TYPE_BOOL",
+ "TYPE_STRING",
+ "TYPE_GROUP",
+ "TYPE_MESSAGE",
+ "TYPE_BYTES",
+ "TYPE_UINT32",
+ "TYPE_ENUM",
+ "TYPE_SFIXED32",
+ "TYPE_SFIXED64",
+ "TYPE_SINT32",
+ "TYPE_SINT64"
+ ]
+ },
+ "cardinality": {
+ "type": "string",
+ "description": "The field cardinality.",
+ "enum": [
+ "CARDINALITY_UNKNOWN",
+ "CARDINALITY_OPTIONAL",
+ "CARDINALITY_REQUIRED",
+ "CARDINALITY_REPEATED"
+ ]
+ },
+ "number": {
+ "type": "integer",
+ "description": "The field number.",
+ "format": "int32"
+ },
+ "name": {
+ "type": "string",
+ "description": "The field name."
+ },
+ "typeUrl": {
+ "type": "string",
+ "description": "The field type URL, without the scheme, for message or enumeration types. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`."
+ },
+ "oneofIndex": {
+ "type": "integer",
+ "description": "The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.",
+ "format": "int32"
+ },
+ "packed": {
+ "type": "boolean",
+ "description": "Whether to use alternative packed wire representation."
+ },
+ "options": {
+ "type": "array",
+ "description": "The protocol buffer options.",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "jsonName": {
+ "type": "string",
+ "description": "The field JSON name."
+ },
+ "defaultValue": {
+ "type": "string",
+ "description": "The string value of the default value of this field. Proto2 syntax only."
+ }
+ }
+ },
+ "Option": {
+ "id": "Option",
+ "type": "object",
+ "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The option's name. For example, `\"java_package\"`."
+ },
+ "value": {
+ "type": "object",
+ "description": "The option's value. For example, `\"com.google.protobuf\"`.",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @ype with type URL."
+ }
+ }
+ }
+ },
+ "SourceContext": {
+ "id": "SourceContext",
+ "type": "object",
+ "description": "`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.",
+ "properties": {
+ "fileName": {
+ "type": "string",
+ "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: `\"google/protobuf/source.proto\"`."
+ }
+ }
+ }
+ },
+ "resources": {
+ "projects": {
+ "resources": {
+ "collectdTimeSeries": {
+ "methods": {
+ "create": {
+ "id": "monitoring.projects.collectdTimeSeries.create",
+ "path": "v3/{+name}/collectdTimeSeries",
+ "httpMethod": "POST",
+ "description": "Creates a new time series with the given data points. This method is only for use in `collectd`-related code, including the Google Monitoring Agent. See [google.monitoring.v3.MetricService.CreateTimeSeries] instead.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The project in which to create the time series. The format is `\"projects/PROJECT_ID_OR_NUMBER\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*$",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "request": {
+ "$ref": "CreateCollectdTimeSeriesRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ]
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "list": {
+ "id": "monitoring.projects.groups.list",
+ "path": "v3/{+name}/groups",
+ "httpMethod": "GET",
+ "description": "Lists the existing groups.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The project whose groups are to be listed. The format is `\"projects/{project_id_or_number}\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*$",
+ "location": "path"
+ },
+ "childrenOfGroup": {
+ "type": "string",
+ "description": "A group name: `\"projects/{project_id_or_number}/groups/{group_id}\"`. Returns groups whose `parentName` field contains the group name. If no groups have this parent, the results are empty.",
+ "location": "query"
+ },
+ "ancestorsOfGroup": {
+ "type": "string",
+ "description": "A group name: `\"projects/{project_id_or_number}/groups/{group_id}\"`. Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.",
+ "location": "query"
+ },
+ "descendantsOfGroup": {
+ "type": "string",
+ "description": "A group name: `\"projects/{project_id_or_number}/groups/{group_id}\"`. Returns the descendants of the specified group. This is a superset of the results returned by the `childrenOfGroup` filter, and includes children-of-children, and so forth.",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListGroupsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ]
+ },
+ "get": {
+ "id": "monitoring.projects.groups.get",
+ "path": "v3/{+name}",
+ "httpMethod": "GET",
+ "description": "Gets a single group.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The group to retrieve. The format is `\"projects/{project_id_or_number}/groups/{group_id}\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*/groups/[^/]*$",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ]
+ },
+ "create": {
+ "id": "monitoring.projects.groups.create",
+ "path": "v3/{+name}/groups",
+ "httpMethod": "POST",
+ "description": "Creates a new group.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The project in which to create the group. The format is `\"projects/{project_id_or_number}\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*$",
+ "location": "path"
+ },
+ "validateOnly": {
+ "type": "boolean",
+ "description": "If true, validate this request but do not create the group.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "request": {
+ "$ref": "Group"
+ },
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ]
+ },
+ "update": {
+ "id": "monitoring.projects.groups.update",
+ "path": "v3/{+name}",
+ "httpMethod": "PUT",
+ "description": "Updates an existing group. You can change any group attributes except `name`.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The name of this group. The format is `\"projects/{project_id_or_number}/groups/{group_id}\"`. When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. @OutputOnly",
+ "required": true,
+ "pattern": "^projects/[^/]*/groups/[^/]*$",
+ "location": "path"
+ },
+ "validateOnly": {
+ "type": "boolean",
+ "description": "If true, validate this request but do not update the existing group.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "request": {
+ "$ref": "Group"
+ },
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ]
+ },
+ "delete": {
+ "id": "monitoring.projects.groups.delete",
+ "path": "v3/{+name}",
+ "httpMethod": "DELETE",
+ "description": "Deletes an existing group.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The group to delete. The format is `\"projects/{project_id_or_number}/groups/{group_id}\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*/groups/[^/]*$",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ]
+ }
+ },
+ "resources": {
+ "members": {
+ "methods": {
+ "list": {
+ "id": "monitoring.projects.groups.members.list",
+ "path": "v3/{+name}/members",
+ "httpMethod": "GET",
+ "description": "Lists the monitored resources that are members of a group.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The group whose members are listed. The format is `\"projects/{project_id_or_number}/groups/{group_id}\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*/groups/[^/]*$",
+ "location": "path"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "description": "An optional [list filter](/monitoring/api/learn_more#filtering) describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: resource.type = \"gce_instance\"",
+ "location": "query"
+ },
+ "interval.endTime": {
+ "type": "string",
+ "description": "(required) The end of the interval. The interval includes this time.",
+ "location": "query"
+ },
+ "interval.startTime": {
+ "type": "string",
+ "description": "(optional) If omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListGroupMembersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "id": "monitoring.projects.monitoredResourceDescriptors.list",
+ "path": "v3/{+name}/monitoredResourceDescriptors",
+ "httpMethod": "GET",
+ "description": "Lists monitored resource descriptors that match a filter.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The project on which to execute the request. The format is `\"projects/{project_id_or_number}\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*$",
+ "location": "path"
+ },
+ "filter": {
+ "type": "string",
+ "description": "An optional [filter](/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an `id` label: resource.type = starts_with(\"gce_\") AND resource.label:id",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ]
+ },
+ "get": {
+ "id": "monitoring.projects.monitoredResourceDescriptors.get",
+ "path": "v3/{+name}",
+ "httpMethod": "GET",
+ "description": "Gets a single monitored resource descriptor.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The monitored resource descriptor to get. The format is `\"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}\"`. The `{resource_type}` is a predefined type, such as `cloudsql_database`.",
+ "required": true,
+ "pattern": "^projects/[^/]*/monitoredResourceDescriptors/[^/]*$",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ]
+ }
+ }
+ },
+ "metricDescriptors": {
+ "methods": {
+ "list": {
+ "id": "monitoring.projects.metricDescriptors.list",
+ "path": "v3/{+name}/metricDescriptors",
+ "httpMethod": "GET",
+ "description": "Lists metric descriptors that match a filter.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The project on which to execute the request. The format is `\"projects/{project_id_or_number}\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*$",
+ "location": "path"
+ },
+ "filter": {
+ "type": "string",
+ "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the [filter](/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all [custom metrics](/monitoring/custom-metrics): metric.type = starts_with(\"custom.googleapis.com/\")",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListMetricDescriptorsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ]
+ },
+ "get": {
+ "id": "monitoring.projects.metricDescriptors.get",
+ "path": "v3/{+name}",
+ "httpMethod": "GET",
+ "description": "Gets a single metric descriptor.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The metric descriptor on which to execute the request. The format is `\"projects/{project_id_or_number}/metricDescriptors/{metric_id}\"`. An example value of `{metric_id}` is `\"compute.googleapis.com/instance/disk/read_bytes_count\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*/metricDescriptors/.*$",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ]
+ },
+ "create": {
+ "id": "monitoring.projects.metricDescriptors.create",
+ "path": "v3/{+name}/metricDescriptors",
+ "httpMethod": "POST",
+ "description": "Creates a new metric descriptor. User-created metric descriptors define [custom metrics](/monitoring/custom-metrics).",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The project on which to execute the request. The format is `\"projects/{project_id_or_number}\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*$",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "request": {
+ "$ref": "MetricDescriptor"
+ },
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ]
+ },
+ "delete": {
+ "id": "monitoring.projects.metricDescriptors.delete",
+ "path": "v3/{+name}",
+ "httpMethod": "DELETE",
+ "description": "Deletes a metric descriptor. Only user-created [custom metrics](/monitoring/custom-metrics) can be deleted.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The metric descriptor on which to execute the request. The format is `\"projects/{project_id_or_number}/metricDescriptors/{metric_id}\"`. An example of `{metric_id}` is: `\"custom.googleapis.com/my_test_metric\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*/metricDescriptors/.*$",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ]
+ }
+ }
+ },
+ "timeSeries": {
+ "methods": {
+ "list": {
+ "id": "monitoring.projects.timeSeries.list",
+ "path": "v3/{+name}/timeSeries",
+ "httpMethod": "GET",
+ "description": "Lists time series that match a filter.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "pattern": "^projects/[^/]*$",
+ "location": "path"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A [monitoring filter](/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND metric.label.instance_name = \"my-instance-name\"",
+ "location": "query"
+ },
+ "interval.endTime": {
+ "type": "string",
+ "description": "(required) The end of the interval. The interval includes this time.",
+ "location": "query"
+ },
+ "interval.startTime": {
+ "type": "string",
+ "description": "(optional) If omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`.",
+ "location": "query"
+ },
+ "aggregation.alignmentPeriod": {
+ "type": "string",
+ "description": "The alignment period for per-[time series](TimeSeries) alignment. If present, `alignmentPeriod` must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If `perSeriesAligner` is not specified or equals `ALIGN_NONE`, then this field is ignored. If `perSeriesAligner` is specified and does not equal `ALIGN_NONE`, then this field must be defined; otherwise an error is returned.",
+ "location": "query"
+ },
+ "aggregation.perSeriesAligner": {
+ "type": "string",
+ "description": "The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If `crossSeriesReducer` is specified, then `perSeriesAligner` must be specified and not equal `ALIGN_NONE` and `alignmentPeriod` must be specified; otherwise, an error is returned.",
+ "enum": [
+ "ALIGN_NONE",
+ "ALIGN_DELTA",
+ "ALIGN_RATE",
+ "ALIGN_INTERPOLATE",
+ "ALIGN_NEXT_OLDER",
+ "ALIGN_MIN",
+ "ALIGN_MAX",
+ "ALIGN_MEAN",
+ "ALIGN_COUNT",
+ "ALIGN_SUM",
+ "ALIGN_STDDEV",
+ "ALIGN_COUNT_TRUE",
+ "ALIGN_FRACTION_TRUE"
+ ],
+ "location": "query"
+ },
+ "aggregation.crossSeriesReducer": {
+ "type": "string",
+ "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If `crossSeriesReducer` is specified, then `perSeriesAligner` must be specified and not equal `ALIGN_NONE` and `alignmentPeriod` must be specified; otherwise, an error is returned.",
+ "enum": [
+ "REDUCE_NONE",
+ "REDUCE_MEAN",
+ "REDUCE_MIN",
+ "REDUCE_MAX",
+ "REDUCE_SUM",
+ "REDUCE_STDDEV",
+ "REDUCE_COUNT",
+ "REDUCE_COUNT_TRUE",
+ "REDUCE_FRACTION_TRUE",
+ "REDUCE_PERCENTILE_99",
+ "REDUCE_PERCENTILE_95",
+ "REDUCE_PERCENTILE_50",
+ "REDUCE_PERCENTILE_05"
+ ],
+ "location": "query"
+ },
+ "aggregation.groupByFields": {
+ "type": "string",
+ "description": "The set of fields to preserve when `crossSeriesReducer` is specified. The `groupByFields` determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The `crossSeriesReducer` is applied to each subset of time series. Fields not specified in `groupByFields` are aggregated away. If `groupByFields` is not specified, the time series are aggregated into a single output time series. If `crossSeriesReducer` is not defined, this field is ignored.",
+ "repeated": true,
+ "location": "query"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.",
+ "location": "query"
+ },
+ "view": {
+ "type": "string",
+ "description": "Specifies which information is returned about the time series.",
+ "enum": [
+ "FULL",
+ "HEADERS"
+ ],
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "A positive number that is the maximum number of results to return. When `view` field sets to `FULL`, it limits the number of `Points` server will return; if `view` field is `HEADERS`, it limits the number of `TimeSeries` server will return.",
+ "format": "int32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListTimeSeriesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ]
+ },
+ "create": {
+ "id": "monitoring.projects.timeSeries.create",
+ "path": "v3/{+name}/timeSeries",
+ "httpMethod": "POST",
+ "description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "The project on which to execute the request. The format is `\"projects/{project_id_or_number}\"`.",
+ "required": true,
+ "pattern": "^projects/[^/]*$",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "request": {
+ "$ref": "CreateTimeSeriesRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/etc/api/oauth2/v1/oauth2-api.json b/etc/api/oauth2/v1/oauth2-api.json
index 31f02861e9..9f388e9d23 100644
--- a/etc/api/oauth2/v1/oauth2-api.json
+++ b/etc/api/oauth2/v1/oauth2-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/4JDZ62MhN4YOflSJ_PcU8BbcPPg\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/PQ_1F4pNNpN_zLZBj8ylJsEn9Cc\"",
"discoveryVersion": "v1",
"id": "oauth2:v1",
"name": "oauth2",
"version": "v1",
- "revision": "20160217",
+ "revision": "20160330",
"title": "Google OAuth2 API",
- "description": "Lets you access OAuth2 protocol related APIs.",
+ "description": "Obtains end-user authorization grants for use with other Google APIs.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/oauth2/v2/oauth2-api.json b/etc/api/oauth2/v2/oauth2-api.json
index 9588fd2e9c..838cec0578 100644
--- a/etc/api/oauth2/v2/oauth2-api.json
+++ b/etc/api/oauth2/v2/oauth2-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/x_XzcmeoKnijhPh0Qy2TxVp6WB4\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/VY5CxwtmcPmH-ruiSL2amW9TN0Q\"",
"discoveryVersion": "v1",
"id": "oauth2:v2",
"name": "oauth2",
"version": "v2",
- "revision": "20160217",
+ "revision": "20160330",
"title": "Google OAuth2 API",
- "description": "Lets you access OAuth2 protocol related APIs.",
+ "description": "Obtains end-user authorization grants for use with other Google APIs.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/pagespeedonline/v1/pagespeedonline-api.json b/etc/api/pagespeedonline/v1/pagespeedonline-api.json
index 87bb734ae3..99bb68e957 100644
--- a/etc/api/pagespeedonline/v1/pagespeedonline-api.json
+++ b/etc/api/pagespeedonline/v1/pagespeedonline-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/BukGAprNRptNiZfFq1zx1Gn3Fhs\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/CJghsXEgZLiP1-h9GgP6hIBiCaU\"",
"discoveryVersion": "v1",
"id": "pagespeedonline:v1",
"name": "pagespeedonline",
"version": "v1",
- "revision": "20150317",
+ "revision": "20160306",
"title": "PageSpeed Insights API",
- "description": "Lets you analyze the performance of a web page and get tailored suggestions to make that page faster.",
+ "description": "Analyzes the performance of a web page and provides tailored suggestions to make that page faster.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/pagespeedonline/v2/pagespeedonline-api.json b/etc/api/pagespeedonline/v2/pagespeedonline-api.json
index 53ed1b08a6..f3abf6a0b8 100644
--- a/etc/api/pagespeedonline/v2/pagespeedonline-api.json
+++ b/etc/api/pagespeedonline/v2/pagespeedonline-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/GZCsO1AHQNW3s7om8yb-wxZmYlo\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/d7F7K6zTJF8Xit9ALBgCq_mDhJ8\"",
"discoveryVersion": "v1",
"id": "pagespeedonline:v2",
"name": "pagespeedonline",
"version": "v2",
- "revision": "20150317",
+ "revision": "20160306",
"title": "PageSpeed Insights API",
- "description": "Lets you analyze the performance of a web page and get tailored suggestions to make that page faster.",
+ "description": "Analyzes the performance of a web page and provides tailored suggestions to make that page faster.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/plus/v1/plus-api.json b/etc/api/plus/v1/plus-api.json
index f74dc13a68..7b22ac09aa 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/bMK4HDuMxZCglZimId2SHixJJ1U\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/2vvSQyuQJOh4ikgDsqf2pMot4NU\"",
"discoveryVersion": "v1",
"id": "plus:v1",
"name": "plus",
"version": "v1",
- "revision": "20160223",
+ "revision": "20160406",
"title": "Google+ API",
"description": "The Google+ API enables developers to build on top of the Google+ platform.",
"ownerDomain": "google.com",
diff --git a/etc/api/plusdomains/v1/plusdomains-api.json b/etc/api/plusdomains/v1/plusdomains-api.json
index cd483901da..b709330afe 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/JRdppZMB2jDawAN9d9uTwBcbPSU\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Tn35i12A9GyQ0AejqKgEYZmxqyc\"",
"discoveryVersion": "v1",
"id": "plusDomains:v1",
"name": "plusDomains",
"version": "v1",
- "revision": "20160223",
+ "revision": "20160406",
"title": "Google+ Domains API",
"description": "The Google+ API enables developers to build on top of the Google+ platform.",
"ownerDomain": "google.com",
diff --git a/etc/api/prediction/v1.2/prediction-api.json b/etc/api/prediction/v1.2/prediction-api.json
index 9b81e41035..28ee6aa731 100644
--- a/etc/api/prediction/v1.2/prediction-api.json
+++ b/etc/api/prediction/v1.2/prediction-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/utsLXLo_baRB5gCmP4liFP80RTs\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/uOPG2v5jeVLJtny04P49X_F7TJc\"",
"discoveryVersion": "v1",
"id": "prediction:v1.2",
"name": "prediction",
"version": "v1.2",
- "revision": "20151102",
+ "revision": "20160304",
"title": "Prediction API",
"description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
"ownerDomain": "google.com",
diff --git a/etc/api/prediction/v1.3/prediction-api.json b/etc/api/prediction/v1.3/prediction-api.json
index 2d370da71b..778311800d 100644
--- a/etc/api/prediction/v1.3/prediction-api.json
+++ b/etc/api/prediction/v1.3/prediction-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/E9FnjCwoMqxTk9RpZ1wB6ZhkIes\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/aaVIo31ii7i6px6zykQ4WWwkpqo\"",
"discoveryVersion": "v1",
"id": "prediction:v1.3",
"name": "prediction",
"version": "v1.3",
- "revision": "20151102",
+ "revision": "20160304",
"title": "Prediction API",
"description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
"ownerDomain": "google.com",
diff --git a/etc/api/prediction/v1.4/prediction-api.json b/etc/api/prediction/v1.4/prediction-api.json
index 5ab944911b..7ee516d5d4 100644
--- a/etc/api/prediction/v1.4/prediction-api.json
+++ b/etc/api/prediction/v1.4/prediction-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/GvPRJFNKC6lOkPLP7j67r_oY_l4\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/YV3parOl1hNGwmeOYq30KREjphM\"",
"discoveryVersion": "v1",
"id": "prediction:v1.4",
"name": "prediction",
"version": "v1.4",
- "revision": "20151102",
+ "revision": "20160304",
"title": "Prediction API",
"description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
"ownerDomain": "google.com",
diff --git a/etc/api/prediction/v1.5/prediction-api.json b/etc/api/prediction/v1.5/prediction-api.json
index 855e7ff9ba..d43fee860f 100644
--- a/etc/api/prediction/v1.5/prediction-api.json
+++ b/etc/api/prediction/v1.5/prediction-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/S6Qe32sEfkDM7uWZBxUvVowSzs0\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/gF5ZfFPL3IKTqBN1E3xrLTL2wHA\"",
"discoveryVersion": "v1",
"id": "prediction:v1.5",
"name": "prediction",
"version": "v1.5",
- "revision": "20151102",
+ "revision": "20160304",
"title": "Prediction API",
"description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
"ownerDomain": "google.com",
diff --git a/etc/api/prediction/v1.6/prediction-api.json b/etc/api/prediction/v1.6/prediction-api.json
index 726d96d33d..7a57b126c9 100644
--- a/etc/api/prediction/v1.6/prediction-api.json
+++ b/etc/api/prediction/v1.6/prediction-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/HYxQmWzK4tWCV6pRcVcSPHPB5zI\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Rb8Il9CxYvuIPXx3em3nY6uZPfg\"",
"discoveryVersion": "v1",
"id": "prediction:v1.6",
"name": "prediction",
"version": "v1.6",
- "revision": "20151102",
+ "revision": "20160304",
"title": "Prediction API",
"description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
"ownerDomain": "google.com",
diff --git a/etc/api/pubsub/v1/pubsub-api.json b/etc/api/pubsub/v1/pubsub-api.json
index ee1b7a4030..4e161e97a3 100644
--- a/etc/api/pubsub/v1/pubsub-api.json
+++ b/etc/api/pubsub/v1/pubsub-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/hbQtG3uMFD1QEGQS0K7qrH-ar90\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/liyzgLngirW3xU7Tt2Pd1AnSK1c\"",
"discoveryVersion": "v1",
"id": "pubsub:v1",
"name": "pubsub",
"version": "v1",
- "revision": "20151103",
+ "revision": "20160317",
"title": "Google Cloud Pub/Sub API",
"description": "Provides reliable, many-to-many, asynchronous messaging between applications.",
"ownerDomain": "google.com",
@@ -127,7 +127,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",
@@ -143,7 +143,7 @@
},
"etag": {
"type": "string",
- "description": "Can be used to perform a read-modify-write.",
+ "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"
}
}
@@ -159,7 +159,7 @@
},
"members": {
"type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `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`.",
+ "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"
}
@@ -173,7 +173,7 @@
"properties": {
"permissions": {
"type": "array",
- "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
+ "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"
}
@@ -320,7 +320,7 @@
},
"ackDeadlineSeconds": {
"type": "integer",
- "description": "This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull delivery this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id`. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.",
+ "description": "This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.",
"format": "int32"
}
}
@@ -464,7 +464,7 @@
"parameters": {
"resource": {
"type": "string",
- "description": "REQUIRED: The resource for which 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 documentation for the respective SetIamPolicy rpc.",
+ "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/[^/]*/topics/[^/]*$",
"location": "path"
@@ -488,11 +488,11 @@
"id": "pubsub.projects.topics.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"httpMethod": "GET",
- "description": "Gets the access control policy for a `resource`. Is empty if the policy or the resource does not exist.",
+ "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 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 documentation for the respective GetIamPolicy rpc.",
+ "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/[^/]*/topics/[^/]*$",
"location": "path"
@@ -517,7 +517,7 @@
"parameters": {
"resource": {
"type": "string",
- "description": "REQUIRED: The resource for which 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 documentation for the respective TestIamPermissions rpc.",
+ "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/[^/]*/topics/[^/]*$",
"location": "path"
@@ -733,7 +733,7 @@
"parameters": {
"resource": {
"type": "string",
- "description": "REQUIRED: The resource for which 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 documentation for the respective SetIamPolicy rpc.",
+ "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/[^/]*/subscriptions/[^/]*$",
"location": "path"
@@ -757,11 +757,11 @@
"id": "pubsub.projects.subscriptions.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"httpMethod": "GET",
- "description": "Gets the access control policy for a `resource`. Is empty if the policy or the resource does not exist.",
+ "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 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 documentation for the respective GetIamPolicy rpc.",
+ "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/[^/]*/subscriptions/[^/]*$",
"location": "path"
@@ -786,7 +786,7 @@
"parameters": {
"resource": {
"type": "string",
- "description": "REQUIRED: The resource for which 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 documentation for the respective TestIamPermissions rpc.",
+ "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/[^/]*/subscriptions/[^/]*$",
"location": "path"
@@ -810,7 +810,7 @@
"id": "pubsub.projects.subscriptions.create",
"path": "v1/{+name}",
"httpMethod": "PUT",
- "description": "Creates a subscription to 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`. If 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.",
+ "description": "Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If 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.",
"parameters": {
"name": {
"type": "string",
diff --git a/etc/api/pubsub/v1beta1a/pubsub-api.json b/etc/api/pubsub/v1beta1a/pubsub-api.json
index fc5573d3db..e809d5d9f0 100644
--- a/etc/api/pubsub/v1beta1a/pubsub-api.json
+++ b/etc/api/pubsub/v1beta1a/pubsub-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ft5e0mAa0pM0yLl11xc0-o7HfkI\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/3hphN7YPNWxdqtNsR-OsHOV5JBk\"",
"discoveryVersion": "v1",
"id": "pubsub:v1beta1a",
"name": "pubsub",
"version": "v1beta1a",
- "revision": "20151103",
+ "revision": "20160317",
"title": "Google Cloud Pub/Sub API",
"description": "Provides reliable, many-to-many, asynchronous messaging between applications.",
"ownerDomain": "google.com",
diff --git a/etc/api/pubsub/v1beta2/pubsub-api.json b/etc/api/pubsub/v1beta2/pubsub-api.json
index cf27836c6e..58efed2669 100644
--- a/etc/api/pubsub/v1beta2/pubsub-api.json
+++ b/etc/api/pubsub/v1beta2/pubsub-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/e81N9_-NKWD4yW0CepJ6w9tAxdg\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/bCHPJ2BvROiKtNiRgnXJErIP0lU\"",
"discoveryVersion": "v1",
"id": "pubsub:v1beta2",
"name": "pubsub",
"version": "v1beta2",
- "revision": "20151103",
+ "revision": "20160317",
"title": "Google Cloud Pub/Sub API",
"description": "Provides reliable, many-to-many, asynchronous messaging between applications.",
"ownerDomain": "google.com",
@@ -127,7 +127,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",
@@ -143,7 +143,7 @@
},
"etag": {
"type": "string",
- "description": "Can be used to perform a read-modify-write.",
+ "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"
}
}
@@ -159,7 +159,7 @@
},
"members": {
"type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `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`.",
+ "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"
}
@@ -173,7 +173,7 @@
"properties": {
"permissions": {
"type": "array",
- "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
+ "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"
}
@@ -320,7 +320,7 @@
},
"ackDeadlineSeconds": {
"type": "integer",
- "description": "This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull delivery this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id`. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.",
+ "description": "This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.",
"format": "int32"
}
}
@@ -468,7 +468,7 @@
"parameters": {
"resource": {
"type": "string",
- "description": "REQUIRED: The resource for which 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 documentation for the respective SetIamPolicy rpc.",
+ "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/[^/]*/topics/[^/]*$",
"location": "path"
@@ -492,11 +492,11 @@
"id": "pubsub.projects.topics.getIamPolicy",
"path": "v1beta2/{+resource}:getIamPolicy",
"httpMethod": "GET",
- "description": "Gets the access control policy for a `resource`. Is empty if the policy or the resource does not exist.",
+ "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 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 documentation for the respective GetIamPolicy rpc.",
+ "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/[^/]*/topics/[^/]*$",
"location": "path"
@@ -521,7 +521,7 @@
"parameters": {
"resource": {
"type": "string",
- "description": "REQUIRED: The resource for which 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 documentation for the respective TestIamPermissions rpc.",
+ "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/[^/]*/topics/[^/]*$",
"location": "path"
@@ -737,7 +737,7 @@
"parameters": {
"resource": {
"type": "string",
- "description": "REQUIRED: The resource for which 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 documentation for the respective SetIamPolicy rpc.",
+ "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/[^/]*/subscriptions/[^/]*$",
"location": "path"
@@ -761,11 +761,11 @@
"id": "pubsub.projects.subscriptions.getIamPolicy",
"path": "v1beta2/{+resource}:getIamPolicy",
"httpMethod": "GET",
- "description": "Gets the access control policy for a `resource`. Is empty if the policy or the resource does not exist.",
+ "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 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 documentation for the respective GetIamPolicy rpc.",
+ "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/[^/]*/subscriptions/[^/]*$",
"location": "path"
@@ -790,7 +790,7 @@
"parameters": {
"resource": {
"type": "string",
- "description": "REQUIRED: The resource for which 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 documentation for the respective TestIamPermissions rpc.",
+ "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/[^/]*/subscriptions/[^/]*$",
"location": "path"
@@ -814,7 +814,7 @@
"id": "pubsub.projects.subscriptions.create",
"path": "v1beta2/{+name}",
"httpMethod": "PUT",
- "description": "Creates a subscription to 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`. If 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.",
+ "description": "Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If 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.",
"parameters": {
"name": {
"type": "string",
diff --git a/etc/api/qpxexpress/v1/qpxexpress-api.json b/etc/api/qpxexpress/v1/qpxexpress-api.json
index 8a9faf6bac..6e505f8a91 100644
--- a/etc/api/qpxexpress/v1/qpxexpress-api.json
+++ b/etc/api/qpxexpress/v1/qpxexpress-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/StW58-Tr7fPYuJhxtPUkc-L2PGM\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/mP0X0J9scme9uxhB3oYtWrSUhT0\"",
"discoveryVersion": "v1",
"id": "qpxExpress:v1",
"name": "qpxExpress",
"canonicalName": "QPX Express",
"version": "v1",
- "revision": "20140321",
+ "revision": "20160307",
"title": "QPX Express API",
- "description": "Lets you find the least expensive flights between an origin and a destination.",
+ "description": "Finds the least expensive flights between an origin and a destination.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/replicapoolupdater/v1beta1/replicapoolupdater-api.json b/etc/api/replicapoolupdater/v1beta1/replicapoolupdater-api.json
index e9756f20b0..db316cd9ea 100644
--- a/etc/api/replicapoolupdater/v1beta1/replicapoolupdater-api.json
+++ b/etc/api/replicapoolupdater/v1beta1/replicapoolupdater-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/YuIMI_aCa8aogA59H4jyEZS09RQ\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Qa39yJM3yH1r8biVjTDz07Q6Imo\"",
"discoveryVersion": "v1",
"id": "replicapoolupdater:v1beta1",
"name": "replicapoolupdater",
"version": "v1beta1",
- "revision": "20160107",
+ "revision": "20160229",
"title": "Google Compute Engine Instance Group Updater API",
- "description": "The Google Compute Engine Instance Group Updater API provides services for updating groups of Compute Engine Instances.",
+ "description": "Updates groups of Compute Engine instances.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/reseller/v1/reseller-api.json b/etc/api/reseller/v1/reseller-api.json
index eb347b77a7..1a408f6f53 100644
--- a/etc/api/reseller/v1/reseller-api.json
+++ b/etc/api/reseller/v1/reseller-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/yL30z3C9YHBf-lvM-9oMs2T8Dhc\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/YYt2cLTkBPBrBPF_Oe4KxSogSAI\"",
"discoveryVersion": "v1",
"id": "reseller:v1",
"name": "reseller",
"version": "v1",
- "revision": "20160218",
+ "revision": "20160329",
"title": "Enterprise Apps Reseller API",
- "description": "Lets you create and manage your customers and their subscriptions.",
+ "description": "Creates and manages your customers and their subscriptions.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -135,6 +135,10 @@
"type": "object",
"description": "JSON template for the ChangePlan rpc request.",
"properties": {
+ "dealCode": {
+ "type": "string",
+ "description": "External name of the deal code applicable for the subscription. This field is optional. If missing, the deal price plan won't be used."
+ },
"kind": {
"type": "string",
"description": "Identifies the resource as a subscription change plan request.",
@@ -259,6 +263,10 @@
"type": "string",
"description": "The id of the customer to whom the subscription belongs."
},
+ "dealCode": {
+ "type": "string",
+ "description": "External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty."
+ },
"kind": {
"type": "string",
"description": "Identifies the resource as a Subscription.",
@@ -324,7 +332,7 @@
},
"suspensionReasons": {
"type": "array",
- "description": "field listing all current reasons the subscription is suspended. It is possible for a subscription to have multiple suspension reasons. A subscription's status is SUSPENDED until all pending suspensions are removed. Possible options include: \n- PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. \n- RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. \n- RESELLER_INITIATED — A manual suspension invoked by a Reseller. \n- TRIAL_ENDED — The customer's trial expired without a plan selected. \n- OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise).",
+ "description": "Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include: \n- PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services. \n- RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. \n- RESELLER_INITIATED - A manual suspension invoked by a Reseller. \n- TRIAL_ENDED - The customer's trial expired without a plan selected. \n- OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).",
"items": {
"type": "string"
}
diff --git a/etc/api/reseller/v1sandbox/reseller-api.json b/etc/api/reseller/v1sandbox/reseller-api.json
index 58f9729507..7964c265db 100644
--- a/etc/api/reseller/v1sandbox/reseller-api.json
+++ b/etc/api/reseller/v1sandbox/reseller-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/hNu-Nus6SKWU6_S5x4KRk5Cik8I\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/zpwH7w7bR6BAdeTnRKUv47yUoks\"",
"discoveryVersion": "v1",
"id": "reseller:v1sandbox",
"name": "reseller",
"version": "v1sandbox",
- "revision": "20160218",
+ "revision": "20160329",
"title": "Enterprise Apps Reseller API",
- "description": "Lets you create and manage your customers and their subscriptions.",
+ "description": "Creates and manages your customers and their subscriptions.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -135,6 +135,10 @@
"type": "object",
"description": "JSON template for the ChangePlan rpc request.",
"properties": {
+ "dealCode": {
+ "type": "string",
+ "description": "External name of the deal code applicable for the subscription. This field is optional. If missing, the deal price plan won't be used."
+ },
"kind": {
"type": "string",
"description": "Identifies the resource as a subscription change plan request.",
@@ -259,6 +263,10 @@
"type": "string",
"description": "The id of the customer to whom the subscription belongs."
},
+ "dealCode": {
+ "type": "string",
+ "description": "External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty."
+ },
"kind": {
"type": "string",
"description": "Identifies the resource as a Subscription.",
@@ -324,7 +332,7 @@
},
"suspensionReasons": {
"type": "array",
- "description": "field listing all current reasons the subscription is suspended. It is possible for a subscription to have multiple suspension reasons. A subscription's status is SUSPENDED until all pending suspensions are removed. Possible options include: \n- PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. \n- RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. \n- RESELLER_INITIATED — A manual suspension invoked by a Reseller. \n- TRIAL_ENDED — The customer's trial expired without a plan selected. \n- OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise).",
+ "description": "Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include: \n- PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services. \n- RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. \n- RESELLER_INITIATED - A manual suspension invoked by a Reseller. \n- TRIAL_ENDED - The customer's trial expired without a plan selected. \n- OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).",
"items": {
"type": "string"
}
diff --git a/etc/api/serviceregistry/alpha/serviceregistry-api.json b/etc/api/serviceregistry/alpha/serviceregistry-api.json
index 2388e64970..e19cc2329d 100644
--- a/etc/api/serviceregistry/alpha/serviceregistry-api.json
+++ b/etc/api/serviceregistry/alpha/serviceregistry-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/0fXgArWlo2qaFZ4FRbwHwQJZMfg\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/fG7ncR1U1YjXewXa-HSP8s-g360\"",
"discoveryVersion": "v1",
"id": "serviceregistry:alpha",
"name": "serviceregistry",
"canonicalName": "Service Registry",
"version": "alpha",
- "revision": "20160225",
+ "revision": "20160401",
"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.",
+ "description": "Manages service endpoints in Service Registry and provides integration with DNS for service discovery and name resolution.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -134,7 +134,7 @@
},
"visibility": {
"$ref": "EndpointEndpointVisibility",
- "description": "The visibility of this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks."
+ "description": "The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks."
}
}
},
@@ -237,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": {
@@ -449,7 +449,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, 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.",
+ "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: When 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. Use filtering on nested fields to take advantage of labels to organize and search for 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": {
@@ -607,7 +607,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, 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.",
+ "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: When 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. Use filtering on nested fields to take advantage of labels to organize and search for 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": {
diff --git a/etc/api/siteverification/v1/siteverification-api.json b/etc/api/siteverification/v1/siteverification-api.json
index 3892557d7f..db4b2054b9 100644
--- a/etc/api/siteverification/v1/siteverification-api.json
+++ b/etc/api/siteverification/v1/siteverification-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Cjm5hmgjW1rn6VFfCZ9yc8i4_oM\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7Wh2BL46-ycQBGZrIfJ_r7nrkOo\"",
"discoveryVersion": "v1",
"id": "siteVerification:v1",
"name": "siteVerification",
"version": "v1",
- "revision": "20151007",
+ "revision": "20160228",
"title": "Google Site Verification API",
- "description": "Lets you programatically verify ownership of websites or domains with Google.",
+ "description": "Verifies ownership of websites or domains with Google.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/sqladmin/v1beta3/sqladmin-api.json b/etc/api/sqladmin/v1beta3/sqladmin-api.json
index cb337fb2f5..d296190a2b 100644
--- a/etc/api/sqladmin/v1beta3/sqladmin-api.json
+++ b/etc/api/sqladmin/v1beta3/sqladmin-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/aZQ0aXsmAhNDAeFcsfFvnGiC3G8\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/4TC4F7Xm6e7jG0NqseTCtK84pBM\"",
"discoveryVersion": "v1",
"id": "sqladmin:v1beta3",
"name": "sqladmin",
"canonicalName": "SQL Admin",
"version": "v1beta3",
- "revision": "20160222",
+ "revision": "20160321",
"title": "Cloud SQL Administration API",
- "description": "API for Cloud SQL database instance management.",
+ "description": "Creates and configures Cloud SQL instances, which provide fully-managed MySQL databases.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/sqladmin/v1beta4/sqladmin-api.json b/etc/api/sqladmin/v1beta4/sqladmin-api.json
index c6672c2f10..3816228a13 100644
--- a/etc/api/sqladmin/v1beta4/sqladmin-api.json
+++ b/etc/api/sqladmin/v1beta4/sqladmin-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/OLx7eYKI1NQCi-ys96oQ7ZJUHE8\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/QBvZSnJ2Tk6w96gxgwGXIFQ4mzk\"",
"discoveryVersion": "v1",
"id": "sqladmin:v1beta4",
"name": "sqladmin",
"canonicalName": "SQL Admin",
"version": "v1beta4",
- "revision": "20160222",
+ "revision": "20160321",
"title": "Cloud SQL Administration API",
- "description": "API for Cloud SQL database instance management.",
+ "description": "Creates and configures Cloud SQL instances, which provide fully-managed MySQL databases.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -332,7 +332,7 @@
},
"databaseVersion": {
"type": "string",
- "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."
+ "description": "The database engine type and version. The databaseVersion can not be changed after instance creation. Can be MYSQL_5_5, MYSQL_5_6 or MYSQL_5_7. Defaults to MYSQL_5_6. MYSQL_5_7 is applicable only to Second Generation instances."
},
"etag": {
"type": "string",
@@ -552,7 +552,7 @@
},
"appliesTo": {
"type": "array",
- "description": "The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or both.",
+ "description": "The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or MYSQL_5_7. MYSQL_5_7 is applicable only to Second Generation instances.",
"items": {
"type": "string"
}
diff --git a/etc/api/storage/v1/storage-api.json b/etc/api/storage/v1/storage-api.json
index b6e636bd2e..1480524ba2 100644
--- a/etc/api/storage/v1/storage-api.json
+++ b/etc/api/storage/v1/storage-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ku_ywallhiDnwLLrgaS2pSJTLQQ\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/D9L7Gz83wLZBP5vnhQkaryC2v0M\"",
"discoveryVersion": "v1",
"id": "storage:v1",
"name": "storage",
"version": "v1",
- "revision": "20160210",
+ "revision": "20160330",
"title": "Cloud Storage JSON API",
- "description": "Lets you store and retrieve potentially-large, immutable data objects.",
+ "description": "Stores and retrieves potentially large, immutable data objects.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/storage/v1beta1/storage-api.json b/etc/api/storage/v1beta1/storage-api.json
index 943cd03354..3ac978e484 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/wHrP9YW4hU3AbG-pup9P6DwMYQU\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/mtXDCRI563Bdh-wRnvM8Gls-dAM\"",
"discoveryVersion": "v1",
"id": "storage:v1beta1",
"name": "storage",
"version": "v1beta1",
- "revision": "20160210",
+ "revision": "20160330",
"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 d406dd996e..d3f605d9f6 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/7e9AEE6nMvl8ls54aDLLtTvMSL8\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/WuMBOT8e9zIA7kQbjcnxmedPAcM\"",
"discoveryVersion": "v1",
"id": "storage:v1beta2",
"name": "storage",
"version": "v1beta2",
- "revision": "20160210",
+ "revision": "20160330",
"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 912ae507b9..e37bd8b093 100644
--- a/etc/api/tagmanager/v1/tagmanager-api.json
+++ b/etc/api/tagmanager/v1/tagmanager-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/pnXlM7y29o5LG03NvN8ZSd6TmA4\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ZLA8VC_y6gockbSXUvDfNtkMoaM\"",
"discoveryVersion": "v1",
"id": "tagmanager:v1",
"name": "tagmanager",
"canonicalName": "Tag Manager",
"version": "v1",
- "revision": "20160209",
+ "revision": "20160310",
"title": "Tag Manager API",
- "description": "API for accessing Tag Manager accounts and containers.",
+ "description": "Accesses Tag Manager accounts and containers.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/toolresults/v1beta3/toolresults-api.json b/etc/api/toolresults/v1beta3/toolresults-api.json
new file mode 100644
index 0000000000..f0b6c5028c
--- /dev/null
+++ b/etc/api/toolresults/v1beta3/toolresults-api.json
@@ -0,0 +1,1412 @@
+{
+ "kind": "discovery#restDescription",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/n7AmCzc0mgID2ZFdDZyGjjdrh_w\"",
+ "discoveryVersion": "v1",
+ "id": "toolresults:v1beta3",
+ "name": "toolresults",
+ "canonicalName": "Tool Results",
+ "version": "v1beta3",
+ "revision": "20160408",
+ "title": "Cloud Tool Results API",
+ "description": "Read and publish results from Cloud Test Lab.",
+ "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-test-lab/",
+ "protocol": "rest",
+ "baseUrl": "https://www.googleapis.com/toolresults/v1beta3/projects/",
+ "basePath": "/toolresults/v1beta3/projects/",
+ "rootUrl": "https://www.googleapis.com/",
+ "servicePath": "toolresults/v1beta3/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": {
+ "Any": {
+ "id": "Any",
+ "type": "object",
+ "description": "`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }\n\nThe pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\".\n\n\n\nJSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:\n\npackage google.profile; message Person { string first_name = 1; string last_name = 2; }\n\n{ \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": , \"lastName\": }\n\nIf the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):\n\n{ \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }",
+ "properties": {
+ "typeUrl": {
+ "type": "string",
+ "description": "A URL/resource name whose content describes the type of the serialized protocol buffer message.\n\nFor URLs which use the schema `http`, `https`, or no schema, the following restrictions and interpretations apply:\n\n* If no schema is provided, `https` is assumed. * The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)\n\nSchemas other than `http`, `https` (or the empty schema) might be used with implementation specific semantics."
+ },
+ "value": {
+ "type": "string",
+ "description": "Must be a valid serialized protocol buffer of the above specified type.",
+ "format": "byte"
+ }
+ }
+ },
+ "Duration": {
+ "id": "Duration",
+ "type": "object",
+ "description": "A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.\n\nExample 1: Compute Duration from two Timestamps in pseudo code.\n\nTimestamp start = ...; Timestamp end = ...; Duration duration = ...;\n\nduration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;\n\nif (duration.seconds 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds \u003e 0 && duration.nanos \u003c 0) { duration.seconds -= 1; duration.nanos += 1000000000; }\n\nExample 2: Compute Timestamp from Timestamp + Duration in pseudo code.\n\nTimestamp start = ...; Duration duration = ...; Timestamp end = ...;\n\nend.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;\n\nif (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }",
+ "properties": {
+ "nanos": {
+ "type": "integer",
+ "description": "Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.",
+ "format": "int32"
+ },
+ "seconds": {
+ "type": "string",
+ "description": "Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.",
+ "format": "int64"
+ }
+ }
+ },
+ "Execution": {
+ "id": "Execution",
+ "type": "object",
+ "description": "An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step\n\nThe maximum size of an execution message is 1 MiB.\n\nAn Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.",
+ "properties": {
+ "completionTime": {
+ "$ref": "Timestamp",
+ "description": "The time when the Execution status transitioned to COMPLETE.\n\nThis value will be set automatically when state transitions to COMPLETE.\n\n- In response: set if the execution state is COMPLETE. - In create/update request: never set"
+ },
+ "creationTime": {
+ "$ref": "Timestamp",
+ "description": "The time when the Execution was created.\n\nThis value will be set automatically when CreateExecution is called.\n\n- In response: always set - In create/update request: never set"
+ },
+ "executionId": {
+ "type": "string",
+ "description": "A unique identifier within a History for this Execution.\n\nReturns INVALID_ARGUMENT if this field is set or overwritten by the caller.\n\n- In response always set - In create/update request: never set"
+ },
+ "outcome": {
+ "$ref": "Outcome",
+ "description": "Classify the result, for example into SUCCESS or FAILURE\n\n- In response: present if set by create/update request - In create/update request: optional"
+ },
+ "state": {
+ "type": "string",
+ "description": "The initial state is IN_PROGRESS.\n\nThe only legal state transitions is from IN_PROGRESS to COMPLETE.\n\nA PRECONDITION_FAILED will be returned if an invalid transition is requested.\n\nThe state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times.\n\nIf the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE.\n\n- In response always set - In create/update request: optional",
+ "enum": [
+ "complete",
+ "inProgress",
+ "pending",
+ "unknownState"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "testExecutionMatrixId": {
+ "type": "string",
+ "description": "TestExecution Matrix ID that the Test Service uses.\n\n- In response: present if set by create - In create: optional - In update: never set"
+ }
+ }
+ },
+ "FailureDetail": {
+ "id": "FailureDetail",
+ "type": "object",
+ "properties": {
+ "crashed": {
+ "type": "boolean",
+ "description": "If the failure was severe because the system under test crashed."
+ },
+ "notInstalled": {
+ "type": "boolean",
+ "description": "If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform."
+ },
+ "otherNativeCrash": {
+ "type": "boolean",
+ "description": "If a native process other than the app crashed."
+ },
+ "timedOut": {
+ "type": "boolean",
+ "description": "If the test overran some time limit, and that is why it failed."
+ }
+ }
+ },
+ "FileReference": {
+ "id": "FileReference",
+ "type": "object",
+ "description": "A reference to a file.",
+ "properties": {
+ "fileUri": {
+ "type": "string",
+ "description": "The URI of a file stored in Google Cloud Storage.\n\nFor example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000\n\nAn INVALID_ARGUMENT error will be returned if the URI format is not supported.\n\n- In response: always set - In create/update request: always set"
+ }
+ }
+ },
+ "History": {
+ "id": "History",
+ "type": "object",
+ "description": "A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build.\n\nNote that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.",
+ "properties": {
+ "displayName": {
+ "type": "string",
+ "description": "A short human-readable (plain text) name to display in the UI. Maximum of 100 characters.\n\n- In response: present if set during create. - In create request: optional"
+ },
+ "historyId": {
+ "type": "string",
+ "description": "A unique identifier within a project for this History.\n\nReturns INVALID_ARGUMENT if this field is set or overwritten by the caller.\n\n- In response always set - In create request: never set"
+ },
+ "name": {
+ "type": "string",
+ "description": "A name to uniquely identify a history within a project. Maximum of 100 characters.\n\n- In response always set - In create request: always set"
+ }
+ }
+ },
+ "Image": {
+ "id": "Image",
+ "type": "object",
+ "description": "An image, with a link to the main image and a thumbnail.",
+ "properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "An error explaining why the thumbnail could not be rendered."
+ },
+ "sourceImage": {
+ "$ref": "ToolOutputReference",
+ "description": "A reference to the full-size, original image.\n\nThis is the same as the tool_outputs entry for the image under its Step.\n\nAlways set."
+ },
+ "stepId": {
+ "type": "string",
+ "description": "The step to which the image is attached.\n\nAlways set."
+ },
+ "thumbnail": {
+ "$ref": "Thumbnail",
+ "description": "The thumbnail."
+ }
+ }
+ },
+ "InconclusiveDetail": {
+ "id": "InconclusiveDetail",
+ "type": "object",
+ "properties": {
+ "abortedByUser": {
+ "type": "boolean",
+ "description": "If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running."
+ },
+ "infrastructureFailure": {
+ "type": "boolean",
+ "description": "If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed.\n\nFor example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail."
+ },
+ "nativeCrash": {
+ "type": "boolean",
+ "description": "A native process crashed on the device, producing a tombstone. It is unclear whether the crash was related to the app under test.\n\nFor example, OpenGL crashed, but it is unclear if the app is responsible."
+ }
+ }
+ },
+ "ListExecutionsResponse": {
+ "id": "ListExecutionsResponse",
+ "type": "object",
+ "properties": {
+ "executions": {
+ "type": "array",
+ "description": "Executions.\n\nAlways set.",
+ "items": {
+ "$ref": "Execution"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "A continuation token to resume the query at the next item.\n\nWill only be set if there are more Executions to fetch."
+ }
+ }
+ },
+ "ListHistoriesResponse": {
+ "id": "ListHistoriesResponse",
+ "type": "object",
+ "description": "Response message for HistoryService.List",
+ "properties": {
+ "histories": {
+ "type": "array",
+ "description": "Histories.",
+ "items": {
+ "$ref": "History"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "A continuation token to resume the query at the next item.\n\nWill only be set if there are more histories to fetch.\n\nTokens are valid for up to one hour from the time of the first list request. For instance, if you make a list request at 1PM and use the token from this first request 10 minutes later, the token from this second response will only be valid for 50 minutes."
+ }
+ }
+ },
+ "ListStepThumbnailsResponse": {
+ "id": "ListStepThumbnailsResponse",
+ "type": "object",
+ "description": "A response containing the thumbnails in a step.",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "A continuation token to resume the query at the next item.\n\nIf set, indicates that there are more thumbnails to read, by calling list again with this value in the page_token field."
+ },
+ "thumbnails": {
+ "type": "array",
+ "description": "A list of image data.\n\nImages are returned in a deterministic order; they are ordered by these factors, in order of importance: * First, by their associated test case. Images without a test case are considered greater than images with one. * Second, by their creation time. Images without a creation time are greater than images with one. * Third, by the order in which they were added to the step (by calls to CreateStep or UpdateStep).",
+ "items": {
+ "$ref": "Image"
+ }
+ }
+ }
+ },
+ "ListStepsResponse": {
+ "id": "ListStepsResponse",
+ "type": "object",
+ "description": "Response message for StepService.List.",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "A continuation token to resume the query at the next item.\n\nIf set, indicates that there are more steps to read, by calling list again with this value in the page_token field."
+ },
+ "steps": {
+ "type": "array",
+ "description": "Steps.",
+ "items": {
+ "$ref": "Step"
+ }
+ }
+ }
+ },
+ "Outcome": {
+ "id": "Outcome",
+ "type": "object",
+ "description": "Interprets a result so that humans and machines can act on it.",
+ "properties": {
+ "failureDetail": {
+ "$ref": "FailureDetail",
+ "description": "More information about a FAILURE outcome.\n\nReturns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.\n\nOptional"
+ },
+ "inconclusiveDetail": {
+ "$ref": "InconclusiveDetail",
+ "description": "More information about an INCONCLUSIVE outcome.\n\nReturns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.\n\nOptional"
+ },
+ "skippedDetail": {
+ "$ref": "SkippedDetail",
+ "description": "More information about a SKIPPED outcome.\n\nReturns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.\n\nOptional"
+ },
+ "successDetail": {
+ "$ref": "SuccessDetail",
+ "description": "More information about a SUCCESS outcome.\n\nReturns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.\n\nOptional"
+ },
+ "summary": {
+ "type": "string",
+ "description": "The simplest way to interpret a result.\n\nRequired",
+ "enum": [
+ "failure",
+ "inconclusive",
+ "skipped",
+ "success",
+ "unset"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ },
+ "ProjectSettings": {
+ "id": "ProjectSettings",
+ "type": "object",
+ "description": "Per-project settings for the Tool Results service.",
+ "properties": {
+ "defaultBucket": {
+ "type": "string",
+ "description": "The name of the Google Cloud Storage bucket to which results are written.\n\nBy default, this is unset.\n\nIn update request: optional In response: optional"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the project's settings.\n\nAlways of the form: projects/{project-id}/settings\n\nIn update request: never set In response: always set"
+ }
+ }
+ },
+ "PublishXunitXmlFilesRequest": {
+ "id": "PublishXunitXmlFilesRequest",
+ "type": "object",
+ "description": "Request message for StepService.PublishXunitXmlFiles.",
+ "properties": {
+ "xunitXmlFiles": {
+ "type": "array",
+ "description": "URI of the Xunit XML files to publish.\n\nThe maximum size of the file this reference is pointing to is 50MB.\n\nRequired.",
+ "items": {
+ "$ref": "FileReference"
+ }
+ }
+ }
+ },
+ "SkippedDetail": {
+ "id": "SkippedDetail",
+ "type": "object",
+ "properties": {
+ "incompatibleAppVersion": {
+ "type": "boolean",
+ "description": "If the App doesn't support the specific API level."
+ },
+ "incompatibleArchitecture": {
+ "type": "boolean",
+ "description": "If the App doesn't run on the specific architecture, for example, x86."
+ },
+ "incompatibleDevice": {
+ "type": "boolean",
+ "description": "If the requested OS version doesn't run on the specific device model."
+ }
+ }
+ },
+ "StackTrace": {
+ "id": "StackTrace",
+ "type": "object",
+ "description": "A stacktrace.",
+ "properties": {
+ "exception": {
+ "type": "string",
+ "description": "The stack trace message.\n\nRequired"
+ }
+ }
+ },
+ "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:\n\n- Simple to use and understand for most users - Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `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.\n\n# Language mapping\n\nThe `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.\n\n# Other uses\n\nThe 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.\n\nExample uses of this error model include:\n\n- 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.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose.\n\n- 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.\n\n- 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.\n\n- 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"
+ },
+ "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": {
+ "$ref": "Any"
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "Step": {
+ "id": "Step",
+ "type": "object",
+ "description": "A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler).\n\nSteps can overlap (for instance two steps might have the same start time if some operations are done in parallel).\n\nHere is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE\n\nA Step can be updated until its state is set to COMPLETE at which points it becomes immutable.",
+ "properties": {
+ "completionTime": {
+ "$ref": "Timestamp",
+ "description": "The time when the step status was set to complete.\n\nThis value will be set automatically when state transitions to COMPLETE.\n\n- In response: set if the execution state is COMPLETE. - In create/update request: never set"
+ },
+ "creationTime": {
+ "$ref": "Timestamp",
+ "description": "The time when the step was created.\n\n- In response: always set - In create/update request: never set"
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of this tool For example: mvn clean package -D skipTests=true\n\n- In response: present if set by create/update request - In create/update request: optional"
+ },
+ "deviceUsageDuration": {
+ "$ref": "Duration",
+ "description": "How much the device resource is used to perform the test.\n\nThis is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage.\n\nPRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set.\n\n- In response: present if previously set. - In create request: optional - In update request: optional"
+ },
+ "dimensionValue": {
+ "type": "array",
+ "description": "If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions.\n\nThe keys must exactly match the dimension_definition of the execution.\n\nFor example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']`\n\nIf a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']`\n\nIf the step does not participate in any dimensions of the matrix, it may leave dimension_value unset.\n\nA PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution.\n\nA PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different.\n\nA PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys.\n\n- In response: present if set by create - In create request: optional - In update request: never set",
+ "items": {
+ "$ref": "StepDimensionValueEntry"
+ }
+ },
+ "hasImages": {
+ "type": "boolean",
+ "description": "Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.\n\n- In response: always set - In create/update request: never set"
+ },
+ "labels": {
+ "type": "array",
+ "description": "Arbitrary user-supplied key/value pairs that are associated with the step.\n\nUsers are responsible for managing the key namespace such that keys don't accidentally collide.\n\nAn INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters.\n\n- In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value",
+ "items": {
+ "$ref": "StepLabelsEntry"
+ }
+ },
+ "name": {
+ "type": "string",
+ "description": "A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build\n\nA PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name.\n\n- In response: always set - In create request: always set - In update request: never set"
+ },
+ "outcome": {
+ "$ref": "Outcome",
+ "description": "Classification of the result, for example into SUCCESS or FAILURE\n\n- In response: present if set by create/update request - In create/update request: optional"
+ },
+ "runDuration": {
+ "$ref": "Duration",
+ "description": "How long it took for this step to run.\n\nIf unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration.\n\nPRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set.\n\n- In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional"
+ },
+ "state": {
+ "type": "string",
+ "description": "The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -\u003e COMPLETE\n\nA PRECONDITION_FAILED will be returned if an invalid transition is requested.\n\nIt is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times.\n\n- In response: always set - In create/update request: optional",
+ "enum": [
+ "complete",
+ "inProgress",
+ "pending",
+ "unknownState"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "stepId": {
+ "type": "string",
+ "description": "A unique identifier within a Execution for this Step.\n\nReturns INVALID_ARGUMENT if this field is set or overwritten by the caller.\n\n- In response: always set - In create/update request: never set"
+ },
+ "testExecutionStep": {
+ "$ref": "TestExecutionStep",
+ "description": "An execution of a test runner."
+ },
+ "toolExecutionStep": {
+ "$ref": "ToolExecutionStep",
+ "description": "An execution of a tool (used for steps we don't explicitly support)."
+ }
+ }
+ },
+ "StepDimensionValueEntry": {
+ "id": "StepDimensionValueEntry",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ },
+ "StepLabelsEntry": {
+ "id": "StepLabelsEntry",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ },
+ "SuccessDetail": {
+ "id": "SuccessDetail",
+ "type": "object",
+ "properties": {
+ "otherNativeCrash": {
+ "type": "boolean",
+ "description": "If a native process other than the app crashed."
+ }
+ }
+ },
+ "TestCaseReference": {
+ "id": "TestCaseReference",
+ "type": "object",
+ "description": "A reference to a test case.\n\nTest case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name.",
+ "properties": {
+ "className": {
+ "type": "string",
+ "description": "The name of the class."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the test case.\n\nRequired."
+ },
+ "testSuiteName": {
+ "type": "string",
+ "description": "The name of the test suite to which this test case belongs."
+ }
+ }
+ },
+ "TestExecutionStep": {
+ "id": "TestExecutionStep",
+ "type": "object",
+ "description": "A step that represents running tests.\n\nIt accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted.\n\nUsers can also add test results manually by using the test_result field.",
+ "properties": {
+ "testIssues": {
+ "type": "array",
+ "description": "Issues observed during the test execution.\n\nFor example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging.\n\n- In response: present if set by create or update - In create/update request: optional",
+ "items": {
+ "$ref": "TestIssue"
+ }
+ },
+ "testSuiteOverviews": {
+ "type": "array",
+ "description": "List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.\n\nThe maximum allowed number of test suite overviews per step is 1000.\n\n- In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead)",
+ "items": {
+ "$ref": "TestSuiteOverview"
+ }
+ },
+ "testTiming": {
+ "$ref": "TestTiming",
+ "description": "The timing break down of the test execution.\n\n- In response: present if set by create or update - In create/update request: optional"
+ },
+ "toolExecution": {
+ "$ref": "ToolExecution",
+ "description": "Represents the execution of the test runner.\n\nThe exit code of this tool will be used to determine if the test passed.\n\n- In response: always set - In create/update request: optional"
+ }
+ }
+ },
+ "TestIssue": {
+ "id": "TestIssue",
+ "type": "object",
+ "description": "An abnormal event observed during the test execution.",
+ "properties": {
+ "errorMessage": {
+ "type": "string",
+ "description": "A brief human-readable message describing the abnormal event.\n\nRequired."
+ },
+ "stackTrace": {
+ "$ref": "StackTrace",
+ "description": "Optional."
+ }
+ }
+ },
+ "TestSuiteOverview": {
+ "id": "TestSuiteOverview",
+ "type": "object",
+ "description": "A summary of a test suite result either parsed from XML or uploaded directly by a user.\n\nNote: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.",
+ "properties": {
+ "errorCount": {
+ "type": "integer",
+ "description": "Number of test cases in error, typically set by the service by parsing the xml_source.\n\n- In create/response: always set - In update request: never",
+ "format": "int32"
+ },
+ "failureCount": {
+ "type": "integer",
+ "description": "Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user.\n\n- In create/response: always set - In update request: never",
+ "format": "int32"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the test suite.\n\n- In create/response: always set - In update request: never"
+ },
+ "skippedCount": {
+ "type": "integer",
+ "description": "Number of test cases not run, typically set by the service by parsing the xml_source.\n\n- In create/response: always set - In update request: never",
+ "format": "int32"
+ },
+ "totalCount": {
+ "type": "integer",
+ "description": "Number of test cases, typically set by the service by parsing the xml_source.\n\n- In create/response: always set - In update request: never",
+ "format": "int32"
+ },
+ "xmlSource": {
+ "$ref": "FileReference",
+ "description": "If this test suite was parsed from XML, this is the URI where the original XML file is stored.\n\nNote: Multiple test suites can share the same xml_source\n\nReturns INVALID_ARGUMENT if the uri format is not supported.\n\n- In create/response: optional - In update request: never"
+ }
+ }
+ },
+ "TestTiming": {
+ "id": "TestTiming",
+ "type": "object",
+ "description": "Testing timing break down to know phases.",
+ "properties": {
+ "testProcessDuration": {
+ "$ref": "Duration",
+ "description": "How long it took to run the test process.\n\n- In response: present if previously set. - In create/update request: optional"
+ }
+ }
+ },
+ "Thumbnail": {
+ "id": "Thumbnail",
+ "type": "object",
+ "description": "A single thumbnail, with its size and format.",
+ "properties": {
+ "contentType": {
+ "type": "string",
+ "description": "The thumbnail's content type, i.e. \"image/png\".\n\nAlways set."
+ },
+ "data": {
+ "type": "string",
+ "description": "The thumbnail file itself.\n\nThat is, the bytes here are precisely the bytes that make up the thumbnail file; they can be served as an image as-is (with the appropriate content type.)\n\nAlways set.",
+ "format": "byte"
+ },
+ "heightPx": {
+ "type": "integer",
+ "description": "The height of the thumbnail, in pixels.\n\nAlways set.",
+ "format": "int32"
+ },
+ "widthPx": {
+ "type": "integer",
+ "description": "The width of the thumbnail, in pixels.\n\nAlways set.",
+ "format": "int32"
+ }
+ }
+ },
+ "Timestamp": {
+ "id": "Timestamp",
+ "type": "object",
+ "description": "A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are \"smeared\" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).\n\nExample 1: Compute Timestamp from POSIX `time()`.\n\nTimestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0);\n\nExample 2: Compute Timestamp from POSIX `gettimeofday()`.\n\nstruct timeval tv; gettimeofday(&tv, NULL);\n\nTimestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000);\n\nExample 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.\n\nFILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) \u003c\u003c 32) | ft.dwLowDateTime;\n\n// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));\n\nExample 4: Compute Timestamp from Java `System.currentTimeMillis()`.\n\nlong millis = System.currentTimeMillis();\n\nTimestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build();\n\n\n\nExample 5: Compute Timestamp from current time in Python.\n\nnow = time.time() seconds = int(now) nanos = int((now - seconds) * 10**9) timestamp = Timestamp(seconds=seconds, nanos=nanos)",
+ "properties": {
+ "nanos": {
+ "type": "integer",
+ "description": "Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.",
+ "format": "int32"
+ },
+ "seconds": {
+ "type": "string",
+ "description": "Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.",
+ "format": "int64"
+ }
+ }
+ },
+ "ToolExecution": {
+ "id": "ToolExecution",
+ "type": "object",
+ "description": "An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code.",
+ "properties": {
+ "commandLineArguments": {
+ "type": "array",
+ "description": "The full tokenized command line including the program name (equivalent to argv in a C program).\n\n- In response: present if set by create request - In create request: optional - In update request: never set",
+ "items": {
+ "type": "string"
+ }
+ },
+ "exitCode": {
+ "$ref": "ToolExitCode",
+ "description": "Tool execution exit code. This field will be set once the tool has exited.\n\n- In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set."
+ },
+ "toolLogs": {
+ "type": "array",
+ "description": "References to any plain text logs output the tool execution.\n\nThis field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running.\n\nThe maximum allowed number of tool logs per step is 1000.\n\n- In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list",
+ "items": {
+ "$ref": "FileReference"
+ }
+ },
+ "toolOutputs": {
+ "type": "array",
+ "description": "References to opaque files of any format output by the tool execution.\n\nThe maximum allowed number of tool outputs per step is 1000.\n\n- In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list",
+ "items": {
+ "$ref": "ToolOutputReference"
+ }
+ }
+ }
+ },
+ "ToolExecutionStep": {
+ "id": "ToolExecutionStep",
+ "type": "object",
+ "description": "Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another.",
+ "properties": {
+ "toolExecution": {
+ "$ref": "ToolExecution",
+ "description": "A Tool execution.\n\n- In response: present if set by create/update request - In create/update request: optional"
+ }
+ }
+ },
+ "ToolExitCode": {
+ "id": "ToolExitCode",
+ "type": "object",
+ "description": "Exit code from a tool execution.",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "Tool execution exit code. A value of 0 means that the execution was successful.\n\n- In response: always set - In create/update request: always set",
+ "format": "int32"
+ }
+ }
+ },
+ "ToolOutputReference": {
+ "id": "ToolOutputReference",
+ "type": "object",
+ "description": "A reference to a ToolExecution output file.",
+ "properties": {
+ "creationTime": {
+ "$ref": "Timestamp",
+ "description": "The creation time of the file.\n\n- In response: present if set by create/update request - In create/update request: optional"
+ },
+ "output": {
+ "$ref": "FileReference",
+ "description": "A FileReference to an output file.\n\n- In response: always set - In create/update request: always set"
+ },
+ "testCase": {
+ "$ref": "TestCaseReference",
+ "description": "The test case to which this output file belongs.\n\n- In response: present if set by create/update request - In create/update request: optional"
+ }
+ }
+ }
+ },
+ "resources": {
+ "projects": {
+ "methods": {
+ "getSettings": {
+ "id": "toolresults.projects.getSettings",
+ "path": "{projectId}/settings",
+ "httpMethod": "GET",
+ "description": "Gets the Tool Results settings for a project.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read from project",
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "ProjectSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "initializeSettings": {
+ "id": "toolresults.projects.initializeSettings",
+ "path": "{projectId}:initializeSettings",
+ "httpMethod": "POST",
+ "description": "Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in the name of the user calling. Except in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the project-private ACL: All project team members are given permissions to the bucket and objects created within it according to their roles. Project owners have owners rights, and so on. The default ACL on objects created in the bucket is project-private as well. See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deteleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage",
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "ProjectSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "histories": {
+ "methods": {
+ "create": {
+ "id": "toolresults.projects.histories.create",
+ "path": "{projectId}/histories",
+ "httpMethod": "POST",
+ "description": "Creates a History.\n\nThe returned History will have the id set.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist",
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "description": "A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "request": {
+ "$ref": "History"
+ },
+ "response": {
+ "$ref": "History"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "id": "toolresults.projects.histories.get",
+ "path": "{projectId}/histories/{historyId}",
+ "httpMethod": "GET",
+ "description": "Gets a History.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist",
+ "parameters": {
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId"
+ ],
+ "response": {
+ "$ref": "History"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "id": "toolresults.projects.histories.list",
+ "path": "{projectId}/histories",
+ "httpMethod": "GET",
+ "description": "Lists Histories for a given Project.\n\nThe histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist",
+ "parameters": {
+ "filterByName": {
+ "type": "string",
+ "description": "If set, only return histories with the given name.\n\nOptional.",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The maximum number of Histories to fetch.\n\nDefault value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100.\n\nOptional.",
+ "format": "int32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "A continuation token to resume the query at the next item.\n\nOptional.",
+ "location": "query"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "ListHistoriesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "executions": {
+ "methods": {
+ "create": {
+ "id": "toolresults.projects.histories.executions.create",
+ "path": "{projectId}/histories/{historyId}/executions",
+ "httpMethod": "POST",
+ "description": "Creates an Execution.\n\nThe returned Execution will have the id set.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist",
+ "parameters": {
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "description": "A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId"
+ ],
+ "request": {
+ "$ref": "Execution"
+ },
+ "response": {
+ "$ref": "Execution"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "id": "toolresults.projects.histories.executions.get",
+ "path": "{projectId}/histories/{historyId}/executions/{executionId}",
+ "httpMethod": "GET",
+ "description": "Gets an Execution.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist",
+ "parameters": {
+ "executionId": {
+ "type": "string",
+ "description": "An Execution id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId",
+ "executionId"
+ ],
+ "response": {
+ "$ref": "Execution"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "id": "toolresults.projects.histories.executions.list",
+ "path": "{projectId}/histories/{historyId}/executions",
+ "httpMethod": "GET",
+ "description": "Lists Histories for a given Project.\n\nThe executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist",
+ "parameters": {
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The maximum number of Executions to fetch.\n\nDefault value: 25. The server will use this default if the field is not set or has a value of 0.\n\nOptional.",
+ "format": "int32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "A continuation token to resume the query at the next item.\n\nOptional.",
+ "location": "query"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId"
+ ],
+ "response": {
+ "$ref": "ListExecutionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "id": "toolresults.projects.histories.executions.patch",
+ "path": "{projectId}/histories/{historyId}/executions/{executionId}",
+ "httpMethod": "PATCH",
+ "description": "Updates an existing Execution with the supplied partial entity.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist",
+ "parameters": {
+ "executionId": {
+ "type": "string",
+ "description": "Required.",
+ "required": true,
+ "location": "path"
+ },
+ "historyId": {
+ "type": "string",
+ "description": "Required.",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id. Required.",
+ "required": true,
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "description": "A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId",
+ "executionId"
+ ],
+ "request": {
+ "$ref": "Execution"
+ },
+ "response": {
+ "$ref": "Execution"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "steps": {
+ "methods": {
+ "create": {
+ "id": "toolresults.projects.histories.executions.steps.create",
+ "path": "{projectId}/histories/{historyId}/executions/{executionId}/steps",
+ "httpMethod": "POST",
+ "description": "Creates a Step.\n\nThe returned Step will have the id set.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist",
+ "parameters": {
+ "executionId": {
+ "type": "string",
+ "description": "A Execution id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "description": "A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId",
+ "executionId"
+ ],
+ "request": {
+ "$ref": "Step"
+ },
+ "response": {
+ "$ref": "Step"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "id": "toolresults.projects.histories.executions.steps.get",
+ "path": "{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}",
+ "httpMethod": "GET",
+ "description": "Gets a Step.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does not exist",
+ "parameters": {
+ "executionId": {
+ "type": "string",
+ "description": "A Execution id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "stepId": {
+ "type": "string",
+ "description": "A Step id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId",
+ "executionId",
+ "stepId"
+ ],
+ "response": {
+ "$ref": "Step"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "id": "toolresults.projects.histories.executions.steps.list",
+ "path": "{projectId}/histories/{historyId}/executions/{executionId}/steps",
+ "httpMethod": "GET",
+ "description": "Lists Steps for a given Execution.\n\nThe steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist",
+ "parameters": {
+ "executionId": {
+ "type": "string",
+ "description": "A Execution id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The maximum number of Steps to fetch.\n\nDefault value: 25. The server will use this default if the field is not set or has a value of 0.\n\nOptional.",
+ "format": "int32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "A continuation token to resume the query at the next item.\n\nOptional.",
+ "location": "query"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId",
+ "executionId"
+ ],
+ "response": {
+ "$ref": "ListStepsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "id": "toolresults.projects.histories.executions.steps.patch",
+ "path": "{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}",
+ "httpMethod": "PATCH",
+ "description": "Updates an existing Step with the supplied partial entity.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist",
+ "parameters": {
+ "executionId": {
+ "type": "string",
+ "description": "A Execution id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "description": "A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.",
+ "location": "query"
+ },
+ "stepId": {
+ "type": "string",
+ "description": "A Step id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId",
+ "executionId",
+ "stepId"
+ ],
+ "request": {
+ "$ref": "Step"
+ },
+ "response": {
+ "$ref": "Step"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "publishXunitXmlFiles": {
+ "id": "toolresults.projects.histories.executions.steps.publishXunitXmlFiles",
+ "path": "{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles",
+ "httpMethod": "POST",
+ "description": "Publish xml files to an existing Step.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist",
+ "parameters": {
+ "executionId": {
+ "type": "string",
+ "description": "A Execution id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "stepId": {
+ "type": "string",
+ "description": "A Step id. Note: This step must include a TestExecutionStep.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId",
+ "executionId",
+ "stepId"
+ ],
+ "request": {
+ "$ref": "PublishXunitXmlFilesRequest"
+ },
+ "response": {
+ "$ref": "Step"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "thumbnails": {
+ "methods": {
+ "list": {
+ "id": "toolresults.projects.histories.executions.steps.thumbnails.list",
+ "path": "{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails",
+ "httpMethod": "GET",
+ "description": "Lists thumbnails of images attached to a step.\n\nMay return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist",
+ "parameters": {
+ "executionId": {
+ "type": "string",
+ "description": "An Execution id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "historyId": {
+ "type": "string",
+ "description": "A History id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "The maximum number of thumbnails to fetch.\n\nDefault value: 50. The server will use this default if the field is not set or has a value of 0.\n\nOptional.",
+ "format": "int32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "A continuation token to resume the query at the next item.\n\nOptional.",
+ "location": "query"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "A Project id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ },
+ "stepId": {
+ "type": "string",
+ "description": "A Step id.\n\nRequired.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "projectId",
+ "historyId",
+ "executionId",
+ "stepId"
+ ],
+ "response": {
+ "$ref": "ListStepThumbnailsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/etc/api/type-api.yaml b/etc/api/type-api.yaml
index 70d5ef638e..6022197d55 100644
--- a/etc/api/type-api.yaml
+++ b/etc/api/type-api.yaml
@@ -25,7 +25,7 @@ make:
- source: build.rs
output_dir: src
cargo:
- build_version: "0.1.12"
+ build_version: "0.1.13"
build_script: src/build.rs
keywords: [protocol, web, api]
dependencies:
diff --git a/etc/api/type-cli.yaml b/etc/api/type-cli.yaml
index e5ac6a47ce..3082b72440 100644
--- a/etc/api/type-cli.yaml
+++ b/etc/api/type-cli.yaml
@@ -22,7 +22,7 @@ make:
- source: main.rs
output_dir: src
cargo:
- build_version: "0.3.3"
+ build_version: "0.3.4"
keywords: [cli]
is_executable: YES
dependencies:
diff --git a/etc/api/webfonts/v1/webfonts-api.json b/etc/api/webfonts/v1/webfonts-api.json
index dbab88bdd0..4ae9ab0539 100644
--- a/etc/api/webfonts/v1/webfonts-api.json
+++ b/etc/api/webfonts/v1/webfonts-api.json
@@ -1,18 +1,18 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/g4uYoMy9XgF6f50jnkNXIWBoFUw\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/Knx7w96lfDrwO6_VUi53vC5n2dE\"",
"discoveryVersion": "v1",
"id": "webfonts:v1",
"name": "webfonts",
"version": "v1",
- "revision": "20140210",
+ "revision": "20160302",
"title": "Google Fonts Developer API",
- "description": "The Google Fonts Developer API.",
+ "description": "Accesses the metadata for all families served by Google Fonts, providing a list of families currently available (including available styles and a list of supported script subsets).",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
- "x16": "http://www.google.com/images/icons/feature/font_api-16.png",
- "x32": "http://www.google.com/images/icons/feature/font_api-32.gif"
+ "x16": "https://www.google.com/images/icons/feature/font_api-16.png",
+ "x32": "https://www.google.com/images/icons/feature/font_api-32.gif"
},
"documentationLink": "https://developers.google.com/fonts/docs/developer_api",
"protocol": "rest",
diff --git a/etc/api/webmasters/v3/webmasters-api.json b/etc/api/webmasters/v3/webmasters-api.json
index 608d0a50fd..cbab49ea00 100644
--- a/etc/api/webmasters/v3/webmasters-api.json
+++ b/etc/api/webmasters/v3/webmasters-api.json
@@ -1,13 +1,13 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ik6t4leMi4molj3h1DobZhP-feU\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/P1nSOVfcIgLwg7Nv_EHtJFN7Dbw\"",
"discoveryVersion": "v1",
"id": "webmasters:v3",
"name": "webmasters",
"version": "v3",
- "revision": "20151229",
+ "revision": "20160317",
"title": "Search Console API",
- "description": "Lets you view Google Search Console data for your verified sites.",
+ "description": "View Google Search Console data for your verified sites.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -175,6 +175,11 @@
"startDate": {
"type": "string",
"description": "[Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range."
+ },
+ "startRow": {
+ "type": "integer",
+ "description": "[Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.",
+ "format": "int32"
}
}
},
@@ -673,6 +678,7 @@
"description": "The crawl error category. For example: serverError. If not specified, returns results for all categories.",
"enum": [
"authPermissions",
+ "flashContent",
"manyToOneRedirect",
"notFollowed",
"notFound",
@@ -689,6 +695,7 @@
"",
"",
"",
+ "",
""
],
"location": "query"
@@ -748,6 +755,7 @@
"required": true,
"enum": [
"authPermissions",
+ "flashContent",
"manyToOneRedirect",
"notFollowed",
"notFound",
@@ -764,6 +772,7 @@
"",
"",
"",
+ "",
""
],
"location": "query"
@@ -823,6 +832,7 @@
"required": true,
"enum": [
"authPermissions",
+ "flashContent",
"manyToOneRedirect",
"notFollowed",
"notFound",
@@ -839,6 +849,7 @@
"",
"",
"",
+ "",
""
],
"location": "query"
@@ -891,6 +902,7 @@
"required": true,
"enum": [
"authPermissions",
+ "flashContent",
"manyToOneRedirect",
"notFollowed",
"notFound",
@@ -907,6 +919,7 @@
"",
"",
"",
+ "",
""
],
"location": "query"
diff --git a/etc/api/youtubeanalytics/v1/youtubeanalytics-api.json b/etc/api/youtubeanalytics/v1/youtubeanalytics-api.json
index d3cbad2734..4d5baf58a9 100644
--- a/etc/api/youtubeanalytics/v1/youtubeanalytics-api.json
+++ b/etc/api/youtubeanalytics/v1/youtubeanalytics-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/X9BsPo2WfOoxifneb4ohU1JftMc\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/e0s-XRd_GK8-7V2zCNYp-dj9JOw\"",
"discoveryVersion": "v1",
"id": "youtubeAnalytics:v1",
"name": "youtubeAnalytics",
"canonicalName": "YouTube Analytics",
"version": "v1",
- "revision": "20160204",
+ "revision": "20160301",
"title": "YouTube Analytics API",
- "description": "Retrieve your YouTube Analytics reports.",
+ "description": "Retrieves your YouTube Analytics reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/youtubeanalytics/v1beta1/youtubeanalytics-api.json b/etc/api/youtubeanalytics/v1beta1/youtubeanalytics-api.json
index 08519f8135..8d63b83797 100644
--- a/etc/api/youtubeanalytics/v1beta1/youtubeanalytics-api.json
+++ b/etc/api/youtubeanalytics/v1beta1/youtubeanalytics-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/vkTkjcNNnD8GFnQCKJ3_EPvhr7A\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/wytolOEnvwHHHxTR-iCKeZttdbw\"",
"discoveryVersion": "v1",
"id": "youtubeAnalytics:v1beta1",
"name": "youtubeAnalytics",
"canonicalName": "YouTube Analytics",
"version": "v1beta1",
- "revision": "20160204",
+ "revision": "20160301",
"title": "YouTube Analytics API",
- "description": "Retrieve your YouTube Analytics reports.",
+ "description": "Retrieves your YouTube Analytics reports.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
diff --git a/etc/api/youtubereporting/v1/youtubereporting-api.json b/etc/api/youtubereporting/v1/youtubereporting-api.json
index 63e3623e18..ea0cd67e79 100644
--- a/etc/api/youtubereporting/v1/youtubereporting-api.json
+++ b/etc/api/youtubereporting/v1/youtubereporting-api.json
@@ -1,14 +1,14 @@
{
"kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/q7HuPi4zz1Oz_O1187etqiN47V4\"",
+ "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/7J4iznCtmcD9toSKCYeTFY9hpTw\"",
"discoveryVersion": "v1",
"id": "youtubereporting:v1",
"name": "youtubereporting",
"canonicalName": "YouTube Reporting",
"version": "v1",
- "revision": "20151026",
+ "revision": "20160315",
"title": "YouTube Reporting API",
- "description": "An API to schedule reporting jobs and download the resulting bulk data reports about YouTube channels, videos etc. in the form of CSV files.",
+ "description": "Schedules reporting jobs and downloads the resulting bulk data reports about YouTube channels, videos, etc. in the form of CSV files.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
@@ -155,6 +155,10 @@
"name": {
"type": "string",
"description": "The name of the report type (max. 100 characters)."
+ },
+ "systemManaged": {
+ "type": "boolean",
+ "description": "True if this a system-managed report type; otherwise false. Reporting jobs for system-managed report types are created automatically and can thus not be used in the `CreateJob` method."
}
}
},
@@ -173,11 +177,15 @@
},
"name": {
"type": "string",
- "description": "The name of the job (max. 100 characters). TODO(lanthaler) Clarify what this will actually be used for"
+ "description": "The name of the job (max. 100 characters)."
},
"createTime": {
"type": "string",
"description": "The creation date/time of the job."
+ },
+ "systemManaged": {
+ "type": "boolean",
+ "description": "True if this a system-managed job that cannot be modified by the user; otherwise false."
}
}
},
@@ -265,7 +273,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"
@@ -308,6 +316,11 @@
"type": "string",
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListReportTypes` method.",
"location": "query"
+ },
+ "includeSystemManaged": {
+ "type": "boolean",
+ "description": "If set to true, also system-managed report types will be returned; otherwise only the report types that can be used to create new reporting jobs will be returned.",
+ "location": "query"
}
},
"response": {
@@ -366,6 +379,11 @@
"type": "string",
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListJobs` method.",
"location": "query"
+ },
+ "includeSystemManaged": {
+ "type": "boolean",
+ "description": "If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted.",
+ "location": "query"
}
},
"response": {
@@ -470,6 +488,16 @@
"type": "string",
"description": "If set, only reports created after the specified date/time are returned.",
"location": "query"
+ },
+ "startTimeAtOrAfter": {
+ "type": "string",
+ "description": "If set, only reports whose start time is greater than or equal the specified date/time are returned.",
+ "location": "query"
+ },
+ "startTimeBefore": {
+ "type": "string",
+ "description": "If set, only reports whose start time is smaller than the specified date/time are returned.",
+ "location": "query"
}
},
"parameterOrder": [